epic: st function coverage

[MrPowers]

This document outlines the ST functions implemented in the latest version of SedonaDB. Feel free to create PRs to add support for more ST functions!

The full list is from SedonaSpark: https://sedona.apache.org/latest/api/sql/Function/

Constructor Functions

• ST_GeogPoint (v0.2)
• ST_GeogFromWKB (v0.2)
• ST_GeogFromWKT (v0.2)
• ST_GeomCollFromText (rust/sedona-functions: Implement ST_xxxFromText() functions #205)
• ST_GeomFromEWKB
• ST_GeomFromEWKT
• ST_GeomFromGML
• ST_GeomFromGeoHash
• ST_GeomFromGeoJSON
• ST_GeomFromKML
• ST_GeomFromText (alias for ST_GeomFromWKT) (v0.1)
• ST_GeomFromWKB (v0.1)
• ST_GeomFromWKT (v0.1)
• ST_GeometryFromText (feat: Implement aliases for existing functions #200)
• ST_LineFromText (rust/sedona-functions: Implement ST_xxxFromText() functions #205)
• ST_LineFromWKB (rust/sedona-functions: Add ST_xxxFromWKB() functions #206)
• ST_LineStringFromText (rust/sedona-functions: Implement ST_xxxFromText() functions #205)
• ST_LinestringFromWKB (rust/sedona-functions: Add ST_xxxFromWKB() functions #206)
• ST_MakeEnvelope
• ST_MLineFromText (rust/sedona-functions: Implement ST_xxxFromText() functions #205)
• ST_MPointFromText (rust/sedona-functions: Implement ST_xxxFromText() functions #205)
• ST_MPolyFromText (rust/sedona-functions: Implement ST_xxxFromText() functions #205)
• ST_MakePoint
• ST_MakePointM
• ST_Point (v0.1)
• ST_PointFromGeoHash
• ST_PointFromText (rust/sedona-functions: Implement ST_xxxFromText() functions #205)
• ST_PointZ (v0.1)
• ST_PointM (v0.1)
• ST_PointZM (v0.1)
• ST_PointFromWKB (rust/sedona-functions: Add ST_xxxFromWKB() functions #206)
• ST_PolygonFromEnvelope
• ST_PolygonFromText (rust/sedona-functions: Implement ST_xxxFromText() functions #205)

Geometry Functions

• GeometryType
• ST_3DDistance
• ST_AddMeasure
• ST_AddPoint
• ST_Affine
• ST_Angle
• ST_Area (v0.1)
• ST_AreaSpheroid
• ST_AsBinary (v0.1)
• ST_AsEWKB
• ST_AsEWKT
• ST_AsGeoJSON
• ST_AsGML
• ST_AsHEXEWKB
• ST_AsKML
• ST_AsText (v0.1)
• ST_Azimuth (v0.2)
• ST_BestSRID
• ST_BinaryDistanceBandColumn
• ST_Boundary (v0.2)
• ST_BoundingDiagonal
• ST_Buffer (v0.1)
• ST_BuildArea
• ST_Centroid (v0.1)
• ST_ClosestPoint (v0.2)
• ST_Collect (v0.1)
• ST_CollectionExtract
• ST_ConcaveHull
• ST_ConvexHull (v0.2)
• ST_CoordDim
• ST_CrossesDateLine
• ST_CRS (v0.2)
• ST_DBSCAN
• ST_Degrees
• ST_DelaunayTriangles
• ST_Difference (v0.1)
• ST_Dimension (v0.1)
• ST_Distance (v0.1)
• ST_DistanceSphere
• ST_DistanceSpheroid
• ST_Dump (v0.2)
• ST_DumpPoints
• ST_EndPoint (v0.2)
• ST_Envelope (v0.1)
• ST_Expand
• ST_ExteriorRing
• ST_FlipCoordinates (v0.1)
• ST_Force_2D
• ST_Force2D
• ST_Force3D
• ST_Force3DM
• ST_Force3DZ
• ST_Force4D
• ST_ForceCollection
• ST_ForcePolygonCCW
• ST_ForcePolygonCW
• ST_ForceRHR
• ST_FrechetDistance (v0.1)
• ST_GeneratePoints
• ST_GeoHash
• ST_GeometricMedian
• ST_GeometryN (v0.2)
• ST_GeometryType (v0.1)
• ST_GLocal
• ST_H3CellDistance
• ST_H3CellIDs
• ST_H3KRing
• ST_H3ToGeom
• ST_HasM (v0.1)
• ST_HasZ (v0.1)
• ST_HausdorffDistance
• ST_InteriorRingN
• ST_InterpolatePoint
• ST_Intersection (v0.1)
• ST_IsClosed (v0.2)
• ST_IsCollection
• ST_IsEmpty (v0.1)
• ST_IsPolygonCCW
• ST_IsPolygonCW
• ST_IsRing (v0.2)
• ST_IsSimple (v0.2)
• ST_IsValid (v0.2)
• ST_IsValidDetail
• ST_IsValidReason (v0.2)
• ST_IsValidTrajectory
• ST_LabelPoint
• ST_Length (v0.1)
• ST_Length2D
• ST_LengthSpheroid
• ST_LineFromMultiPoint
• ST_LineInterpolatePoint (v0.2)
• ST_LineLocatePoint (v0.2)
• ST_LineMerge
• ST_LineSegments
• ST_LineSubstring
• ST_LocalOutlierFactor
• ST_LocateAlong
• ST_LongestLine
• ST_M (v0.1)
• ST_MMax (v0.1)
• ST_MMin (v0.1)
• ST_MakeLine (v0.1)
• ST_MakePolygon
• ST_MakeValid (v0.2)
• ST_MaximumInscribedCircle
• ST_MaxDistance (v0.1)
• ST_MinimumClearance (v0.2)
• ST_MinimumClearanceLine (v0.2)
• ST_MinimumBoundingCircle
• ST_MinimumBoundingRadius
• ST_Multi
• ST_NDims
• ST_Normalize
• ST_NPoints (v0.2)
• ST_NRings
• ST_NumGeometries (v0.2)
• ST_NumInteriorRing
• ST_NumInteriorRings
• ST_NumPoints
• ST_Perimeter (v0.1)
• ST_Perimeter2D
• ST_PointN (v0.2)
• ST_PointOnSurface
• ST_Point (v0.1)
• ST_Points (v0.2)
• ST_Polygon
• ST_Polygonize (v0.2)
• ST_Project
• ST_ReducePrecision
• ST_RemovePoint
• ST_RemoveRepeatedPoints
• ST_Reverse (v0.2)
• ST_Rotate
• ST_RotateX
• ST_RotateY
• ST_SetCRS (v0.2)
• ST_S2CellIDs
• ST_S2ToGeom
• ST_Scale
• ST_ScaleGeom
• ST_SetPoint
• ST_SetSRID (v0.1)
• ST_ShiftLongitude
• ST_Simplify (v0.2)
• ST_SimplifyPolygonHull
• ST_SimplifyPreserveTopology (v0.2)
• ST_SimplifyVW
• ST_Snap (v0.2)
• ST_Split
• ST_SRID (v0.1)
• ST_StartPoint (v0.2)
• ST_SubDivide
• ST_SubDivideExplode
• ST_SymDifference (v0.1)
• ST_Transform (v0.1)
• ST_Translate (v0.2)
• ST_TriangulatePolygon
• ST_UnaryUnion (v0.2)
• ST_Union (v0.1)
• ST_VoronoiPolygons
• ST_WeightedDistanceBandColumn
• ST_X (v0.1)
• ST_XMax (v0.1)
• ST_XMin (v0.1)
• ST_Y (v0.1)
• ST_YMax (v0.1)
• ST_YMin (v0.1)
• ST_Z (v0.1)
• ST_ZMax (v0.1)
• ST_ZMin (v0.1)
• ST_Zmflag (v0.2)

Predicate Functions

• ST_Contains (v0.1)
• ST_Covers (v0.1)
• ST_CoveredBy (v0.1)
• ST_Crosses (v0.2)
• ST_Disjoint (v0.1)
• ST_DWithin (v0.1)
• ST_Equals (v0.1)
• ST_Intersects (v0.1)
• ST_OrderingEquals
• ST_Overlaps (v0.2)
• ST_Relate
• ST_RelateMatch
• ST_Touches (v0.1)
• ST_Within (v0.1)

Aggregate Functions

• ST_Analyze_Agg (v0.1)
• ST_Collect_Agg (v0.2)
• ST_Envelope_Agg (v0.1)
• ST_Intersection_Agg (v0.1)
• ST_Polygonize_Agg (v0.2)
• ST_Union_Agg (v0.1)

Advanced Functions

• ST_KNN (v0.1)

[petern48]

Hmm, some functions have been marked as completed in this list, and their documentations exist in sql.md, even though we haven't actually implemented them. It's because we have stubs for the functions, and the docs got generated for them (e.g ST_HausdorffDistance)

[jiayuasu]

One thing I noticed is that the recent ST function PR do not have doc update. I think we should require doc update per function. We do that for Apache Sedona. @petern48 @paleolimbot

[paleolimbot]

Peter noticed that in the latest PRs...when we get the SQL documentation generated we can have a CI job that checks this. Right now the story regarding SQL documentation is a little fuzzy and I'm fine not requiring it until I fix that so as not to subject new contributors to any fuziness that we haven't worked out yet (e.g., I'm not sure exactly how the generation script is supposed to work or whose job it will be to run it yet).