Documentation

geo.ST_DWithin() function

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

geo.ST_DWithin() tests if the specified region is within a defined distance from the specified GIS geometry and returns true or false.

Function type signature
(distance: A, geometry: B, region: C, ?units: {distance: string}) => bool where A: Comparable + Equatable, B: Record, C: Record
  • Copy
  • Fill window

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.

distance

(Required) Maximum distance allowed between the region and geometry. Define distance units with the geo.units option.

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!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

Now Generally Available

InfluxDB 3 Core and Enterprise

Start fast. Scale faster.

Get the Updates

InfluxDB 3 Core is an open source, high-speed, recent-data engine that collects and processes data in real-time and persists it to local disk or object storage. InfluxDB 3 Enterprise builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries and optimized storage. A free tier of InfluxDB 3 Enterprise is available for non-commercial at-home or hobbyist use.

For more information, check out: