[feature](geo) support 3 spatial functions: ST_Distance, ST_GeometryType, ST_Length #60170
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…; run clang-format.sh to format code
Contributor
|
Thank you for your contribution to Apache Doris. Please clearly describe your PR:
|
Author
|
run buildall |
There was a problem hiding this comment.
Pull request overview
This PR implements three spatial SQL functions (ST_Distance, ST_GeometryType, ST_Length) to improve compatibility with other database systems like Trino, Presto, and PostgreSQL, as part of the broader effort outlined in issue #48203.
Changes:
- Adds ST_Length function to calculate the length/perimeter of geometry objects (in meters for LineString/Polygon/Circle, 0 for Point)
- Adds ST_GeometryType function to return the geometry type name (e.g., "ST_POINT", "ST_LINESTRING")
- Adds ST_Distance function to calculate the geodesic distance between two geometry objects (in meters)
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| be/src/geo/geo_types.h | Adds virtual method declarations for GeometryType(), Length(), and Distance() to the GeoShape base class and implements them in all derived classes |
| be/src/geo/st_length.cpp | Implements Length() calculations for all geometry types using S2Earth library for geodesic measurements |
| be/src/geo/st_distance.cpp | Implements Distance() calculations between all geometry type combinations with helper functions for point-to-segment, point-to-polyline, and point-to-polygon distances |
| be/src/geo/CMakeLists.txt | Updates build configuration to include the new st_length.cpp and st_distance.cpp source files |
| be/src/vec/functions/functions_geo.cpp | Registers the three new functions (StLength, StGeometryType, StDistance) with the function factory |
| be/test/geo/geo_types_test.cpp | Adds comprehensive C++ unit tests covering all geometry types and type combinations for the new functions |
| fe/fe-core/src/main/java/org/apache/doris/nereids/trees/expressions/functions/scalar/StLength.java | Frontend scalar function class for ST_Length with proper signature (VARCHAR -> DOUBLE) |
| fe/fe-core/src/main/java/org/apache/doris/nereids/trees/expressions/functions/scalar/StGeometryType.java | Frontend scalar function class for ST_GeometryType with proper signature (VARCHAR -> VARCHAR) |
| fe/fe-core/src/main/java/org/apache/doris/nereids/trees/expressions/functions/scalar/StDistance.java | Frontend scalar function class for ST_Distance with proper signature (VARCHAR, VARCHAR -> DOUBLE) |
| fe/fe-core/src/main/java/org/apache/doris/nereids/trees/expressions/visitor/ScalarFunctionVisitor.java | Adds visitor methods for the three new function types |
| fe/fe-core/src/main/java/org/apache/doris/catalog/BuiltinScalarFunctions.java | Registers the three new scalar functions in the builtin function catalog |
| regression-test/suites/nereids_p0/sql_functions/spatial_functions/test_gis_function.groovy | Adds extensive regression test cases covering all geometry type combinations for the new functions |
| regression-test/data/nereids_p0/sql_functions/spatial_functions/test_gis_function.out | Expected output for the regression tests |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
TPC-H: Total hot run time: 31037 ms |
Author
|
oops, I forgot to modify be-ut testcase after changing geometry_type |
TPC-DS: Total hot run time: 172396 ms |
ClickBench: Total hot run time: 26.78 s |
Contributor
FE UT Coverage ReportIncrement line coverage |
Contributor
FE Regression Coverage ReportIncrement line coverage |
Author
|
run buildall |
TPC-H: Total hot run time: 31328 ms |
TPC-DS: Total hot run time: 172939 ms |
ClickBench: Total hot run time: 26.8 s |
Contributor
FE UT Coverage ReportIncrement line coverage |
BE UT Coverage ReportIncrement line coverage Increment coverage report
|
Contributor
BE Regression && UT Coverage ReportIncrement line coverage Increment coverage report
|
Contributor
FE Regression Coverage ReportIncrement line coverage |
zclllyybb
reviewed
Jan 25, 2026
| qt_sql "SELECT ST_ANGLE_SPHERE(116.35620117, 39.939093, 116.4274406433, 39.9020987219);" | ||
| qt_sql "SELECT ST_ANGLE_SPHERE(0, 0, 45, 0);" | ||
|
|
||
| // ST_Length tests for all geometry types |
Contributor
There was a problem hiding this comment.
need more testcases of data in tables.
| const size_t size) { | ||
| std::vector<std::unique_ptr<GeoShape>> shapes(2); | ||
| for (int row = 0; row < size; ++row) { | ||
| auto lhs_value = left_column->get_data_at(row); |
Contributor
There was a problem hiding this comment.
all get_data_at here may be virtual function. you can assert_cast column ptrs and pass with concrete types
Author
There was a problem hiding this comment.
ok, shall I use assert_cast() or check_and_get_column()?
Contributor
There was a problem hiding this comment.
when you know what the type this column should be, use assert_cast.
be/src/geo/st_length.cpp
Outdated
| double GeoPolygon::Length() const { | ||
| // GeoPolygon is always valid with at least one loop (guaranteed by constructor) | ||
| double perimeter = 0.0; | ||
| const S2Loop* outer_loop = _polygon->loop(0); |
Contributor
There was a problem hiding this comment.
why only consider loop0? what if compute with others within holes?
be/src/geo/st_distance.cpp
Outdated
| return S2Earth::GetDistanceMeters(point_ll, start_ll); | ||
| } | ||
|
|
||
| double t = ((px - x1) * dx + (py - y1) * dy) / (dx * dx + dy * dy); |
Contributor
There was a problem hiding this comment.
it's this a planar projection? I think lat and lng have no absolute relation with distance. so maybe directly use S2Earth's function?
be/src/geo/st_distance.cpp
Outdated
| const GeoPoint* point = static_cast<const GeoPoint*>(rhs); | ||
| return distance_point_to_polyline(*point->point(), _polyline.get()); | ||
| } | ||
| case GEO_SHAPE_LINE_STRING: { |
Contributor
There was a problem hiding this comment.
plygon-polygon and circle-line seem to have this issue as well
linrrzqqq
reviewed
Jan 26, 2026
| ColumnFloat64::MutablePtr& res, NullMap& null_map, int row) { | ||
| StringRef* strs[2] = {&lhs_value, &rhs_value}; | ||
| for (int i = 0; i < 2; ++i) { | ||
| std::unique_ptr<GeoShape> shape(GeoShape::from_encoded(strs[i]->data, strs[i]->size)); |
Contributor
There was a problem hiding this comment.
Can we decode const column outside the loop to avoid unnecessary repeated calculations?
…ction short-circuits; include all polygon loops in length; refactor vectorized StDistance and move implementations into geo_types.cpp;
Contributor
|
btw, @zxc20041 if you'd like to easier communicate, you can add my wechat torch-wood_ |
zxc20041
commented
Jan 27, 2026
zxc20041
commented
Jan 27, 2026
zxc20041
commented
Jan 27, 2026
| return -1.0; | ||
| } | ||
| } | ||
|
|
Author
There was a problem hiding this comment.
now lines and polygons will consider Intersect first
zxc20041
commented
Jan 27, 2026
|
|
||
| return total_length; | ||
| } | ||
|
|
zxc20041
commented
Jan 27, 2026
| qt_sql "SELECT ST_AsText(ST_GeomFromWKB(ST_AsBinary(ST_GeometryFromText(\"LINESTRING (1 1, 2 2)\"))));" | ||
| qt_sql "SELECT ST_AsText(ST_GeomFromWKB(ST_AsBinary(ST_Polygon(\"POLYGON ((114.104486 22.547119,114.093758 22.547753,114.096504 22.532057,114.104229 22.539826,114.106203 22.542680,114.104486 22.547119))\"))));" | ||
|
|
||
| // table-driven tests for ST_Length/ST_GeometryType/ST_Distance |
Author
There was a problem hiding this comment.
create a table to test 3 functions
Author
|
run buildall |
TPC-H: Total hot run time: 32889 ms |
ClickBench: Total hot run time: 28.73 s |
Contributor
BE UT Coverage ReportIncrement line coverage Increment coverage report
|
Author
|
run buildall |
TPC-H: Total hot run time: 32826 ms |
ClickBench: Total hot run time: 27.94 s |
BE UT Coverage ReportIncrement line coverage Increment coverage report
|
Contributor
BE Regression && UT Coverage ReportIncrement line coverage Increment coverage report
|
Contributor
FE Regression Coverage ReportIncrement line coverage |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What problem does this PR solve?
Issue Number: close #48203
Related PR: #48695
Problem Summary:
Support for ST_Distance, ST_GeometryType, ST_Length sql functions.
Release note
None
Check List (For Author)
Test
Behavior changed:
Does this need documentation?
Check List (For Reviewer who merge this PR)