This is an automated email from the ASF dual-hosted git repository. jiayu pushed a commit to branch branch-1.7.0 in repository https://gitbox.apache.org/repos/asf/sedona.git
commit a12b5373b9413239e9f7cfc3fb6a7ea539aebcdc 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 cf1fce91d3..d03483e63d 100644 --- a/docs/api/sql/NearestNeighbourSearching.md +++ b/docs/api/sql/NearestNeighbourSearching.md @@ -15,6 +15,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 ```
