[DOCS] Document SedonaFlink geography functions - #3078
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds SedonaFlink documentation for the newly exposed Geography SQL API (constructors, measurement/output functions, and predicates), and wires the new overview page into the MkDocs navigation so it is discoverable alongside existing Flink geometry docs.
Changes:
- Add a Flink Geography API overview page with categorized function tables (constructors, functions, predicates).
- Add per-function documentation pages for 9 constructors/conversions, 11 functions, and 5 predicates.
- Update
mkdocs.ymlto include the new Flink “Geography Functions” overview page in the nav.
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Adds the Flink Geography Functions overview page to the docs navigation. |
| docs/api/flink/Geography-Functions.md | New overview page summarizing Flink geography constructors, functions, and predicates with links to per-function docs. |
| docs/api/flink/Geography-Constructors/ST_GeogCollFromText.md | Documents ST_GeogCollFromText constructor behavior and examples. |
| docs/api/flink/Geography-Constructors/ST_GeogFromEWKB.md | Documents ST_GeogFromEWKB constructor behavior and examples. |
| docs/api/flink/Geography-Constructors/ST_GeogFromEWKT.md | Documents ST_GeogFromEWKT constructor behavior and examples. |
| docs/api/flink/Geography-Constructors/ST_GeogFromGeoHash.md | Documents ST_GeogFromGeoHash constructor behavior and examples. |
| docs/api/flink/Geography-Constructors/ST_GeogFromText.md | Documents ST_GeogFromText constructor behavior and examples. |
| docs/api/flink/Geography-Constructors/ST_GeogFromWKB.md | Documents ST_GeogFromWKB constructor behavior and examples. |
| docs/api/flink/Geography-Constructors/ST_GeogFromWKT.md | Documents ST_GeogFromWKT constructor behavior and examples (with/without SRID). |
| docs/api/flink/Geography-Constructors/ST_GeogToGeometry.md | Documents conversion from Geography to Geometry and precision considerations. |
| docs/api/flink/Geography-Constructors/ST_GeomToGeography.md | Documents conversion from Geometry to Geography and CRS/SRID caveats. |
| docs/api/flink/Geography-Functions/ST_Area.md | Documents ST_Area geodesic area behavior and example output. |
| docs/api/flink/Geography-Functions/ST_AsEWKT.md | Documents ST_AsEWKT formatting and example output. |
| docs/api/flink/Geography-Functions/ST_AsText.md | Documents ST_AsText formatting and example output. |
| docs/api/flink/Geography-Functions/ST_Buffer.md | Documents geography ST_Buffer semantics and supported overloads. |
| docs/api/flink/Geography-Functions/ST_Centroid.md | Documents ST_Centroid behavior and example output. |
| docs/api/flink/Geography-Functions/ST_Distance.md | Documents ST_Distance geodesic distance behavior and example output. |
| docs/api/flink/Geography-Functions/ST_Envelope.md | Documents ST_Envelope and antimeridian-splitting option. |
| docs/api/flink/Geography-Functions/ST_GeometryType.md | Documents ST_GeometryType output for geography inputs. |
| docs/api/flink/Geography-Functions/ST_Length.md | Documents ST_Length geodesic length behavior and example output. |
| docs/api/flink/Geography-Functions/ST_NPoints.md | Documents ST_NPoints behavior and example output. |
| docs/api/flink/Geography-Functions/ST_NumGeometries.md | Documents ST_NumGeometries behavior and example output. |
| docs/api/flink/Geography-Predicates/ST_Contains.md | Documents ST_Contains predicate and example (with illustration). |
| docs/api/flink/Geography-Predicates/ST_DWithin.md | Documents ST_DWithin predicate and example (with illustration). |
| docs/api/flink/Geography-Predicates/ST_Equals.md | Documents ST_Equals predicate and example. |
| docs/api/flink/Geography-Predicates/ST_Intersects.md | Documents ST_Intersects predicate and example (with illustration). |
| docs/api/flink/Geography-Predicates/ST_Within.md | Documents ST_Within predicate and example (with illustration). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * Geography represents shapes on the Earth's surface (spherical). | ||
| * Geometry represents shapes on a flat, Euclidean plane. | ||
|
|
||
| Because geography vertices are stored as points on the sphere, converting back to planar coordinates can introduce small floating-point differences. Wrap the result with [ST_ReducePrecision](../Geometry-Functions.md) if you need a fixed number of decimals. |
Member
Author
There was a problem hiding this comment.
Fixed: the link now points to the dedicated ST_ReducePrecision page (../Geometry-Processing/ST_ReducePrecision.md) instead of the geometry functions overview. Commit e4b30f6.
jiayuasu
force-pushed
the
flink-geography-docs
branch
from
June 21, 2026 05:43
1d4d7c8 to
e4b30f6
Compare
jiayuasu
force-pushed
the
flink-geography-docs
branch
from
June 21, 2026 16:06
e4b30f6 to
1ffbf08
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Did you read the Contributor Guide?
Is this PR related to a ticket?
[DOCS] my subject. Closes SedonaFlink: document geography constructor functions #3069.What changes were proposed in this PR?
Final piece of the SedonaFlink geography support effort (#3054): documents the geography API now exposed by SedonaFlink, mirroring the structure of the existing SedonaFlink geometry docs and the Spark geography docs.
docs/api/flink/Geography-Functions.md— overview page with three sections: Geography Constructors, Geography Functions, and Geography Predicates.docs/api/flink/Geography-Constructors/— 9 per-function pages (constructors/conversions).docs/api/flink/Geography-Functions/— 11 per-function pages (ST_Area,ST_Length,ST_Distance,ST_Buffer,ST_Centroid,ST_Envelope,ST_NPoints,ST_NumGeometries,ST_GeometryType,ST_AsText,ST_AsEWKT).docs/api/flink/Geography-Predicates/— 5 per-function pages (ST_Contains,ST_Intersects,ST_Within,ST_Equals,ST_DWithin).mkdocs.yml— adds the Geography Functions page to the SedonaFlink API nav.All SQL examples and their outputs were captured by running the functions end-to-end through the Flink Table API, so the documented outputs match real behavior (including geodesic units and the spherical right-hand rule for polygon orientation). The 9 concepts that have illustrations (
ST_Area,ST_Length,ST_Distance,ST_NPoints,ST_Buffer,ST_Contains,ST_Intersects,ST_Within,ST_DWithin) reuse the existing engine-agnostic geography SVGs underdocs/image/, matching the Spark geography docs.How was this patch tested?
mkdocs buildsucceeds with no warnings for the new pages, and all internal links and embedded SVG paths resolve.Did this PR include necessary documentation updates?
Since: v1.9.1, the current SNAPSHOT version.