Documentation

geo.ST_Distance() function

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

geo.ST_Distance() returns the distance from a given region to a specified GIS geometry.

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

Parameters

region

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

geometry

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

units

Record that defines the unit of measurement for distance. Default is the geo.units option.


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.