This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sedona.git
The following commit(s) were added to refs/heads/master by this push:
new a8da3cdb09 [DOC] Update ST_KNN documentation for left inner join
support and inner kNN join details (#1821)
a8da3cdb09 is described below
commit a8da3cdb0953ca06d1eb5a64e799f2da75d0e712
Author: Feng Zhang <[email protected]>
AuthorDate: Tue Feb 18 13:52:53 2025 -0800
[DOC] Update ST_KNN documentation for left inner join support and inner kNN
join details (#1821)
---
docs/api/sql/NearestNeighbourSearching.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/api/sql/NearestNeighbourSearching.md
b/docs/api/sql/NearestNeighbourSearching.md
index 39f61a6591..f45dccc064 100644
--- a/docs/api/sql/NearestNeighbourSearching.md
+++ b/docs/api/sql/NearestNeighbourSearching.md
@@ -34,6 +34,12 @@ When either queries or objects data contain non-point data
(geometries), we take
In case there are ties in the distance, the result will include all the tied
geometries only when the following sedona config is set to true:
+**Note for Inner Join:**
+
+- The `ST_KNN` join only supports left inner join.
+- It returns only pairs where there is at least one matching neighbor within
the k nearest neighbors.
+- If a query point has no valid neighbor (e.g., because k is too large), it is
excluded from the result.
+
```
spark.sedona.join.knn.includeTieBreakers=true
```
