This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch branch-1.7.1
in repository https://gitbox.apache.org/repos/asf/sedona.git
The following commit(s) were added to refs/heads/branch-1.7.1 by this push:
new 75b3b8f4af [DOCS] add missing useSpheroid argument to ST_DBSCAN docs
(#1870)
75b3b8f4af is described below
commit 75b3b8f4af3b3b8bc2d79e9f42a53a09d3bc8d54
Author: James Willis <[email protected]>
AuthorDate: Wed Mar 19 13:12:46 2025 -0700
[DOCS] add missing useSpheroid argument to ST_DBSCAN docs (#1870)
Co-authored-by: jameswillis <[email protected]>
---
docs/api/sql/Function.md | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/docs/api/sql/Function.md b/docs/api/sql/Function.md
index 2dc28f21ce..d4bda5c44a 100644
--- a/docs/api/sql/Function.md
+++ b/docs/api/sql/Function.md
@@ -1140,15 +1140,16 @@ Returns a struct containing the cluster ID and a
boolean indicating if the recor
- `epsilon` is the maximum distance between two points for them to be
considered as part of the same cluster.
- `minPoints` is the minimum number of neighbors a single record must have to
form a cluster.
+- `useSpheroid` is whether to use ST_DistanceSpheroid or ST_Distance as the
distance metric.
-Format: `ST_DBSCAN(geom: Geometry, epsilon: Double, minPoints: Integer)`
+Format: `ST_DBSCAN(geom: Geometry, epsilon: Double, minPoints: Integer,
useSpheroid: Boolean)`
Since: `v1.7.1`
SQL Example
```sql
-SELECT ST_DBSCAN(geom, 1.0, 2)
+SELECT ST_DBSCAN(geom, 1.0, 2, False)
```
Output:
