geo.stContains() function

geo.stContains() is experimental and subject to change at any time.

geo.stContains() returns boolean indicating whether the defined region contains a specified GIS geometry.

geo.stContains is used as a helper function for geo.ST_Contains().

Function type signature
(geometry: A, region: B, units: {distance: string}) => bool where A: Record, B: Record
For more information, see Function type signatures.



(Required) Region to test. Specify record properties for the shape.


(Required) GIS geometry to test. Can be either point or linestring geometry.


(Required) Record that defines the unit of measurement for distance.

Was this page helpful?

Thank you for your feedback!

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.