Copilot commented on code in PR #2680: URL: https://github.com/apache/sedona/pull/2680#discussion_r2882348430
########## docs/api/flink/Geometry-Functions.md: ########## @@ -25,324 +25,324 @@ The `Geometry` type in Sedona represents planar (2D Euclidean) spatial objects s These functions create geometry objects from various textual or binary formats, or from coordinate values. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_GeomCollFromText](Geometry-Constructors/ST_GeomCollFromText.md) | Constructs a GeometryCollection from the WKT with the given SRID. If SRID is not provided then it defaults to 0. It returns `null` if the WKT is not a `GEOMETRYCOLLECTION`. | v1.6.1 | -| [ST_GeometryFromText](Geometry-Constructors/ST_GeometryFromText.md) | Construct a Geometry from WKT. If SRID is not set, it defaults to 0 (unknown). Alias of [ST_GeomFromWKT](Geometry-Constructors/ST_GeomFromWKT.md) | v1.6.1 | -| [ST_GeomFromEWKB](Geometry-Constructors/ST_GeomFromEWKB.md) | Construct a Geometry from EWKB string or Binary. This function is an alias of [ST_GeomFromWKB](Geometry-Constructors/ST_GeomFromWKB.md). | v1.6.1 | -| [ST_GeomFromEWKT](Geometry-Constructors/ST_GeomFromEWKT.md) | Construct a Geometry from OGC Extended WKT | v1.5.0 | -| [ST_GeomFromGeoHash](Geometry-Constructors/ST_GeomFromGeoHash.md) | Create Geometry from geohash string and optional precision | v1.2.1 | -| [ST_GeomFromGeoJSON](Geometry-Constructors/ST_GeomFromGeoJSON.md) | Construct a Geometry from GeoJson | v1.2.0 | -| [ST_GeomFromGML](Geometry-Constructors/ST_GeomFromGML.md) | Construct a Geometry from GML. | v1.3.0 | -| [ST_GeomFromKML](Geometry-Constructors/ST_GeomFromKML.md) | Construct a Geometry from KML. | v1.3.0 | -| [ST_GeomFromText](Geometry-Constructors/ST_GeomFromText.md) | Construct a Geometry from WKT. Alias of [ST_GeomFromWKT](Geometry-Constructors/ST_GeomFromWKT.md) | v1.2.1 | -| [ST_GeomFromWKB](Geometry-Constructors/ST_GeomFromWKB.md) | Construct a Geometry from WKB string or Binary. This function also supports EWKB format. | v1.2.0 | -| [ST_GeomFromWKT](Geometry-Constructors/ST_GeomFromWKT.md) | Construct a Geometry from WKT | v1.2.0 | -| [ST_LineFromText](Geometry-Constructors/ST_LineFromText.md) | Construct a LineString from Text | v1.2.1 | -| [ST_LineFromWKB](Geometry-Constructors/ST_LineFromWKB.md) | Construct a LineString geometry from WKB string or Binary and an optional SRID. This function also supports EWKB format. | v1.6.1 | -| [ST_LineStringFromText](Geometry-Constructors/ST_LineStringFromText.md) | Construct a LineString from Text, delimited by Delimiter (Optional). Alias of [ST_LineFromText](Geometry-Constructors/ST_LineFromText.md) | v1.2.1 | -| [ST_LinestringFromWKB](Geometry-Constructors/ST_LinestringFromWKB.md) | Construct a LineString geometry from WKB string or Binary and an optional SRID. This function also supports EWKB format and it is an alias of [ST_LineFromWKB](Geometry-Constructors/ST_LineFromWKB.md). | v1.6.1 | -| [ST_MakeEnvelope](Geometry-Constructors/ST_MakeEnvelope.md) | Construct a Polygon from MinX, MinY, MaxX, MaxY, and an optional SRID. | v1.7.0 | -| [ST_MakePoint](Geometry-Constructors/ST_MakePoint.md) | Creates a 2D, 3D Z or 4D ZM Point geometry. Use [ST_MakePointM](Geometry-Constructors/ST_MakePointM.md) to make points with XYM coordinates. Z and M values are optional. | v1.5.0 | -| [ST_MakePointM](Geometry-Constructors/ST_MakePointM.md) | Creates a point with X, Y, and M coordinate. Use [ST_MakePoint](Geometry-Constructors/ST_MakePoint.md) to make points with XY, XYZ, or XYZM coordinates. | v1.6.1 | -| [ST_MLineFromText](Geometry-Constructors/ST_MLineFromText.md) | Construct a MultiLineString from Text and Optional SRID | | -| [ST_MPointFromText](Geometry-Constructors/ST_MPointFromText.md) | Constructs a MultiPoint from the WKT with the given SRID. If SRID is not provided then it defaults to 0. It returns `null` if the WKT is not a `MULTIPOINT`. | v1.6.1 | -| [ST_MPolyFromText](Geometry-Constructors/ST_MPolyFromText.md) | Construct a MultiPolygon from Text and Optional SRID | | -| [ST_Point](Geometry-Constructors/ST_Point.md) | Construct a Point from X and Y | v1.2.1 | -| [ST_PointFromGeoHash](Geometry-Constructors/ST_PointFromGeoHash.md) | Generates a Point geometry representing the center of the GeoHash cell defined by the input string. If `precision` is not specified, the full GeoHash precision is used. Providing a `precision` value... | v1.6.1 | -| [ST_PointFromText](Geometry-Constructors/ST_PointFromText.md) | Construct a Point from Text, delimited by Delimiter | v1.2.0 | -| [ST_PointFromWKB](Geometry-Constructors/ST_PointFromWKB.md) | Construct a Point geometry from WKB string or Binary and an optional SRID. This function also supports EWKB format. | v1.6.1 | -| [ST_PointM](Geometry-Constructors/ST_PointM.md) | Construct a Point from X, Y and M and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z and M coordinates. | v1.6.1 | -| [ST_PointZ](Geometry-Constructors/ST_PointZ.md) | Construct a Point from X, Y and Z and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z coordinate. | v1.5.0 | -| [ST_PointZM](Geometry-Constructors/ST_PointZM.md) | Construct a Point from X, Y, Z, M and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z and M coordinates. | v1.6.1 | -| [ST_PolygonFromEnvelope](Geometry-Constructors/ST_PolygonFromEnvelope.md) | Construct a Polygon from MinX, MinY, MaxX, MaxY. | v1.2.0 | -| [ST_PolygonFromText](Geometry-Constructors/ST_PolygonFromText.md) | Construct a Polygon from Text, delimited by Delimiter. Path must be closed | v1.2.0 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_GeomCollFromText](Geometry-Constructors/ST_GeomCollFromText.md) | Geometry | Constructs a GeometryCollection from the WKT with the given SRID. If SRID is not provided then it defaults to 0. It returns `null` if the WKT is not a `GEOMETRYCOLLECTION`. | v1.6.1 | +| [ST_GeometryFromText](Geometry-Constructors/ST_GeometryFromText.md) | Geometry | Construct a Geometry from WKT. If SRID is not set, it defaults to 0 (unknown). Alias of [ST_GeomFromWKT](Geometry-Constructors/ST_GeomFromWKT.md) | v1.6.1 | +| [ST_GeomFromEWKB](Geometry-Constructors/ST_GeomFromEWKB.md) | Geometry | Construct a Geometry from EWKB string or Binary. This function is an alias of [ST_GeomFromWKB](Geometry-Constructors/ST_GeomFromWKB.md). | v1.6.1 | +| [ST_GeomFromEWKT](Geometry-Constructors/ST_GeomFromEWKT.md) | Geometry | Construct a Geometry from OGC Extended WKT | v1.5.0 | +| [ST_GeomFromGeoHash](Geometry-Constructors/ST_GeomFromGeoHash.md) | Geometry | Create Geometry from geohash string and optional precision | v1.2.1 | +| [ST_GeomFromGeoJSON](Geometry-Constructors/ST_GeomFromGeoJSON.md) | Geometry | Construct a Geometry from GeoJson | v1.2.0 | +| [ST_GeomFromGML](Geometry-Constructors/ST_GeomFromGML.md) | Geometry | Construct a Geometry from GML. | v1.3.0 | +| [ST_GeomFromKML](Geometry-Constructors/ST_GeomFromKML.md) | Geometry | Construct a Geometry from KML. | v1.3.0 | +| [ST_GeomFromText](Geometry-Constructors/ST_GeomFromText.md) | Geometry | Construct a Geometry from WKT. Alias of [ST_GeomFromWKT](Geometry-Constructors/ST_GeomFromWKT.md) | v1.2.1 | +| [ST_GeomFromWKB](Geometry-Constructors/ST_GeomFromWKB.md) | Geometry | Construct a Geometry from WKB string or Binary. This function also supports EWKB format. | v1.2.0 | +| [ST_GeomFromWKT](Geometry-Constructors/ST_GeomFromWKT.md) | Geometry | Construct a Geometry from WKT | v1.2.0 | +| [ST_LineFromText](Geometry-Constructors/ST_LineFromText.md) | Geometry | Construct a LineString from Text | v1.2.1 | +| [ST_LineFromWKB](Geometry-Constructors/ST_LineFromWKB.md) | Geometry | Construct a LineString geometry from WKB string or Binary and an optional SRID. This function also supports EWKB format. | v1.6.1 | +| [ST_LineStringFromText](Geometry-Constructors/ST_LineStringFromText.md) | Geometry | Construct a LineString from Text, delimited by Delimiter (Optional). Alias of [ST_LineFromText](Geometry-Constructors/ST_LineFromText.md) | v1.2.1 | +| [ST_LinestringFromWKB](Geometry-Constructors/ST_LinestringFromWKB.md) | Geometry | Construct a LineString geometry from WKB string or Binary and an optional SRID. This function also supports EWKB format and it is an alias of [ST_LineFromWKB](Geometry-Constructors/ST_LineFromWKB.md). | v1.6.1 | +| [ST_MakeEnvelope](Geometry-Constructors/ST_MakeEnvelope.md) | Geometry | Construct a Polygon from MinX, MinY, MaxX, MaxY, and an optional SRID. | v1.7.0 | +| [ST_MakePoint](Geometry-Constructors/ST_MakePoint.md) | Geometry | Creates a 2D, 3D Z or 4D ZM Point geometry. Use [ST_MakePointM](Geometry-Constructors/ST_MakePointM.md) to make points with XYM coordinates. Z and M values are optional. | v1.5.0 | +| [ST_MakePointM](Geometry-Constructors/ST_MakePointM.md) | Geometry | Creates a point with X, Y, and M coordinate. Use [ST_MakePoint](Geometry-Constructors/ST_MakePoint.md) to make points with XY, XYZ, or XYZM coordinates. | v1.6.1 | +| [ST_MLineFromText](Geometry-Constructors/ST_MLineFromText.md) | Geometry | Construct a MultiLineString from Text and Optional SRID | | +| [ST_MPointFromText](Geometry-Constructors/ST_MPointFromText.md) | Geometry | Constructs a MultiPoint from the WKT with the given SRID. If SRID is not provided then it defaults to 0. It returns `null` if the WKT is not a `MULTIPOINT`. | v1.6.1 | +| [ST_MPolyFromText](Geometry-Constructors/ST_MPolyFromText.md) | Geometry | Construct a MultiPolygon from Text and Optional SRID | | +| [ST_Point](Geometry-Constructors/ST_Point.md) | Geometry | Construct a Point from X and Y | v1.2.1 | +| [ST_PointFromGeoHash](Geometry-Constructors/ST_PointFromGeoHash.md) | Geometry | Generates a Point geometry representing the center of the GeoHash cell defined by the input string. If `precision` is not specified, the full GeoHash precision is used. Providing a `precision` value... | v1.6.1 | +| [ST_PointFromText](Geometry-Constructors/ST_PointFromText.md) | Geometry | Construct a Point from Text, delimited by Delimiter | v1.2.0 | +| [ST_PointFromWKB](Geometry-Constructors/ST_PointFromWKB.md) | Geometry | Construct a Point geometry from WKB string or Binary and an optional SRID. This function also supports EWKB format. | v1.6.1 | +| [ST_PointM](Geometry-Constructors/ST_PointM.md) | Geometry | Construct a Point from X, Y and M and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z and M coordinates. | v1.6.1 | +| [ST_PointZ](Geometry-Constructors/ST_PointZ.md) | Geometry | Construct a Point from X, Y and Z and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z coordinate. | v1.5.0 | +| [ST_PointZM](Geometry-Constructors/ST_PointZM.md) | Geometry | Construct a Point from X, Y, Z, M and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z and M coordinates. | v1.6.1 | +| [ST_PolygonFromEnvelope](Geometry-Constructors/ST_PolygonFromEnvelope.md) | Geometry | Construct a Polygon from MinX, MinY, MaxX, MaxY. | v1.2.0 | +| [ST_PolygonFromText](Geometry-Constructors/ST_PolygonFromText.md) | Geometry | Construct a Polygon from Text, delimited by Delimiter. Path must be closed | v1.2.0 | ## Geometry Accessors These functions extract information and properties from geometry objects. -| Function | Description | Since | -| :--- | :--- | :--- | -| [GeometryType](Geometry-Accessors/GeometryType.md) | Returns the type of the geometry as a string. Eg: 'LINESTRING', 'POLYGON', 'MULTIPOINT', etc. This function also indicates if the geometry is measured, by returning a string of the form 'POINTM'. | v1.5.0 | -| [ST_Boundary](Geometry-Accessors/ST_Boundary.md) | Returns the closure of the combinatorial boundary of this Geometry. | v1.3.0 | -| [ST_CoordDim](Geometry-Accessors/ST_CoordDim.md) | Returns the coordinate dimensions of the geometry. It is an alias of `ST_NDims`. | v1.5.0 | -| [ST_CrossesDateLine](Geometry-Accessors/ST_CrossesDateLine.md) | This function determines if a given geometry crosses the International Date Line. It operates by checking if the difference in longitude between any pair of consecutive points in the geometry excee... | v1.6.0 | -| [ST_Dimension](Geometry-Accessors/ST_Dimension.md) | Return the topological dimension of this Geometry object, which must be less than or equal to the coordinate dimension. OGC SPEC s2.1.1.1 - returns 0 for POINT, 1 for LINESTRING, 2 for POLYGON, and... | v1.5.0 | -| [ST_Dump](Geometry-Accessors/ST_Dump.md) | It expands the geometries. If the geometry is simple (Point, Polygon Linestring etc.) it returns the geometry itself, if the geometry is collection or multi it returns record for each of collection... | v1.5.0 | -| [ST_DumpPoints](Geometry-Accessors/ST_DumpPoints.md) | Returns list of Points which geometry consists of. | v1.5.0 | -| [ST_EndPoint](Geometry-Accessors/ST_EndPoint.md) | Returns last point of given linestring. | v1.5.0 | -| [ST_ExteriorRing](Geometry-Accessors/ST_ExteriorRing.md) | Returns a LINESTRING representing the exterior ring (shell) of a POLYGON. Returns NULL if the geometry is not a polygon. | v1.2.1 | -| [ST_GeometryN](Geometry-Accessors/ST_GeometryN.md) | Return the 0-based Nth geometry if the geometry is a GEOMETRYCOLLECTION, (MULTI)POINT, (MULTI)LINESTRING, MULTICURVE or (MULTI)POLYGON. Otherwise, return null | v1.3.0 | -| [ST_GeometryType](Geometry-Accessors/ST_GeometryType.md) | Returns the type of the geometry as a string. EG: 'ST_Linestring', 'ST_Polygon' etc. | v1.5.0 | -| [ST_HasM](Geometry-Accessors/ST_HasM.md) | Checks for the presence of M coordinate values representing measures or linear references. Returns true if the input geometry includes an M coordinate, false otherwise. | v1.6.1 | -| [ST_HasZ](Geometry-Accessors/ST_HasZ.md) | Checks for the presence of Z coordinate values representing measures or linear references. Returns true if the input geometry includes an Z coordinate, false otherwise. | v1.6.1 | -| [ST_InteriorRingN](Geometry-Accessors/ST_InteriorRingN.md) | Returns the Nth interior linestring ring of the polygon geometry. Returns NULL if the geometry is not a polygon or the given N is out of range | v1.3.0 | -| [ST_IsClosed](Geometry-Accessors/ST_IsClosed.md) | RETURNS true if the LINESTRING start and end point are the same. | v1.3.0 | -| [ST_IsCollection](Geometry-Accessors/ST_IsCollection.md) | Returns `TRUE` if the geometry type of the input is a geometry collection type. Collection types are the following: | v1.5.0 | -| [ST_IsEmpty](Geometry-Accessors/ST_IsEmpty.md) | Test if a geometry is empty geometry | v1.2.1 | -| [ST_IsPolygonCCW](Geometry-Accessors/ST_IsPolygonCCW.md) | Returns true if all polygonal components in the input geometry have their exterior rings oriented counter-clockwise and interior rings oriented clockwise. | v1.6.0 | -| [ST_IsPolygonCW](Geometry-Accessors/ST_IsPolygonCW.md) | Returns true if all polygonal components in the input geometry have their exterior rings oriented counter-clockwise and interior rings oriented clockwise. | v1.6.0 | -| [ST_IsRing](Geometry-Accessors/ST_IsRing.md) | RETURN true if LINESTRING is ST_IsClosed and ST_IsSimple. | v1.3.0 | -| [ST_IsSimple](Geometry-Accessors/ST_IsSimple.md) | Test if geometry's only self-intersections are at boundary points. | v1.3.0 | -| [ST_M](Geometry-Accessors/ST_M.md) | Returns M Coordinate of given Point, null otherwise. | v1.6.1 | -| [ST_NDims](Geometry-Accessors/ST_NDims.md) | Returns the coordinate dimension of the geometry. | v1.3.1 | -| [ST_NPoints](Geometry-Accessors/ST_NPoints.md) | Returns the number of points of the geometry | v1.3.0 | -| [ST_NRings](Geometry-Accessors/ST_NRings.md) | Returns the number of rings in a Polygon or MultiPolygon. Contrary to ST_NumInteriorRings, this function also takes into account the number of exterior rings. | v1.4.1 | -| [ST_NumGeometries](Geometry-Accessors/ST_NumGeometries.md) | Returns the number of Geometries. If geometry is a GEOMETRYCOLLECTION (or MULTI*) return the number of geometries, for single geometries will return 1. | v1.3.0 | -| [ST_NumInteriorRing](Geometry-Accessors/ST_NumInteriorRing.md) | Returns number of interior rings of polygon geometries. It is an alias of [ST_NumInteriorRings](Geometry-Accessors/ST_NumInteriorRings.md). | v1.6.1 | -| [ST_NumInteriorRings](Geometry-Accessors/ST_NumInteriorRings.md) | Returns number of interior rings of polygon geometries. | v1.3.0 | -| [ST_NumPoints](Geometry-Accessors/ST_NumPoints.md) | Returns number of points in a LineString. | v1.4.1 | -| [ST_PointN](Geometry-Accessors/ST_PointN.md) | Return the Nth point in a single linestring or circular linestring in the geometry. Negative values are counted backwards from the end of the LineString, so that -1 is the last point. Returns NULL ... | v1.2.1 | -| [ST_Points](Geometry-Accessors/ST_Points.md) | Returns a MultiPoint geometry consisting of all the coordinates of the input geometry. It preserves duplicate points as well as M and Z coordinates. | v1.6.1 | -| [ST_StartPoint](Geometry-Accessors/ST_StartPoint.md) | Returns first point of given linestring. | v1.5.0 | -| [ST_X](Geometry-Accessors/ST_X.md) | Returns X Coordinate of given Point, null otherwise. | v1.3.0 | -| [ST_Y](Geometry-Accessors/ST_Y.md) | Returns Y Coordinate of given Point, null otherwise. | v1.3.0 | -| [ST_Z](Geometry-Accessors/ST_Z.md) | Returns Z Coordinate of given Point, null otherwise. | v1.3.0 | -| [ST_Zmflag](Geometry-Accessors/ST_Zmflag.md) | Returns a code indicating the Z and M coordinate dimensions present in the input geometry. | v1.6.1 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [GeometryType](Geometry-Accessors/GeometryType.md) | String | Returns the type of the geometry as a string. Eg: 'LINESTRING', 'POLYGON', 'MULTIPOINT', etc. This function also indicates if the geometry is measured, by returning a string of the form 'POINTM'. | v1.5.0 | +| [ST_Boundary](Geometry-Accessors/ST_Boundary.md) | Geometry | Returns the closure of the combinatorial boundary of this Geometry. | v1.3.0 | +| [ST_CoordDim](Geometry-Accessors/ST_CoordDim.md) | Integer | Returns the coordinate dimensions of the geometry. It is an alias of `ST_NDims`. | v1.5.0 | +| [ST_CrossesDateLine](Geometry-Accessors/ST_CrossesDateLine.md) | Boolean | This function determines if a given geometry crosses the International Date Line. It operates by checking if the difference in longitude between any pair of consecutive points in the geometry excee... | v1.6.0 | +| [ST_Dimension](Geometry-Accessors/ST_Dimension.md) | Integer | Return the topological dimension of this Geometry object, which must be less than or equal to the coordinate dimension. OGC SPEC s2.1.1.1 - returns 0 for POINT, 1 for LINESTRING, 2 for POLYGON, and... | v1.5.0 | +| [ST_Dump](Geometry-Accessors/ST_Dump.md) | `Array<Geometry>` | It expands the geometries. If the geometry is simple (Point, Polygon Linestring etc.) it returns the geometry itself, if the geometry is collection or multi it returns record for each of collection... | v1.5.0 | +| [ST_DumpPoints](Geometry-Accessors/ST_DumpPoints.md) | `Array<Geometry>` | Returns list of Points which geometry consists of. | v1.5.0 | +| [ST_EndPoint](Geometry-Accessors/ST_EndPoint.md) | Geometry | Returns last point of given linestring. | v1.5.0 | +| [ST_ExteriorRing](Geometry-Accessors/ST_ExteriorRing.md) | Geometry | Returns a LINESTRING representing the exterior ring (shell) of a POLYGON. Returns NULL if the geometry is not a polygon. | v1.2.1 | +| [ST_GeometryN](Geometry-Accessors/ST_GeometryN.md) | Geometry | Return the 0-based Nth geometry if the geometry is a GEOMETRYCOLLECTION, (MULTI)POINT, (MULTI)LINESTRING, MULTICURVE or (MULTI)POLYGON. Otherwise, return null | v1.3.0 | +| [ST_GeometryType](Geometry-Accessors/ST_GeometryType.md) | String | Returns the type of the geometry as a string. EG: 'ST_Linestring', 'ST_Polygon' etc. | v1.5.0 | +| [ST_HasM](Geometry-Accessors/ST_HasM.md) | Boolean | Checks for the presence of M coordinate values representing measures or linear references. Returns true if the input geometry includes an M coordinate, false otherwise. | v1.6.1 | +| [ST_HasZ](Geometry-Accessors/ST_HasZ.md) | Boolean | Checks for the presence of Z coordinate values representing measures or linear references. Returns true if the input geometry includes an Z coordinate, false otherwise. | v1.6.1 | +| [ST_InteriorRingN](Geometry-Accessors/ST_InteriorRingN.md) | Geometry | Returns the Nth interior linestring ring of the polygon geometry. Returns NULL if the geometry is not a polygon or the given N is out of range | v1.3.0 | +| [ST_IsClosed](Geometry-Accessors/ST_IsClosed.md) | Boolean | RETURNS true if the LINESTRING start and end point are the same. | v1.3.0 | +| [ST_IsCollection](Geometry-Accessors/ST_IsCollection.md) | Boolean | Returns `TRUE` if the geometry type of the input is a geometry collection type. Collection types are the following: | v1.5.0 | +| [ST_IsEmpty](Geometry-Accessors/ST_IsEmpty.md) | Boolean | Test if a geometry is empty geometry | v1.2.1 | +| [ST_IsPolygonCCW](Geometry-Accessors/ST_IsPolygonCCW.md) | Boolean | Returns true if all polygonal components in the input geometry have their exterior rings oriented counter-clockwise and interior rings oriented clockwise. | v1.6.0 | +| [ST_IsPolygonCW](Geometry-Accessors/ST_IsPolygonCW.md) | Boolean | Returns true if all polygonal components in the input geometry have their exterior rings oriented counter-clockwise and interior rings oriented clockwise. | v1.6.0 | +| [ST_IsRing](Geometry-Accessors/ST_IsRing.md) | Boolean | RETURN true if LINESTRING is ST_IsClosed and ST_IsSimple. | v1.3.0 | +| [ST_IsSimple](Geometry-Accessors/ST_IsSimple.md) | Boolean | Test if geometry's only self-intersections are at boundary points. | v1.3.0 | +| [ST_M](Geometry-Accessors/ST_M.md) | Double | Returns M Coordinate of given Point, null otherwise. | v1.6.1 | +| [ST_NDims](Geometry-Accessors/ST_NDims.md) | Integer | Returns the coordinate dimension of the geometry. | v1.3.1 | +| [ST_NPoints](Geometry-Accessors/ST_NPoints.md) | Integer | Returns the number of points of the geometry | v1.3.0 | +| [ST_NRings](Geometry-Accessors/ST_NRings.md) | Integer | Returns the number of rings in a Polygon or MultiPolygon. Contrary to ST_NumInteriorRings, this function also takes into account the number of exterior rings. | v1.4.1 | +| [ST_NumGeometries](Geometry-Accessors/ST_NumGeometries.md) | Integer | Returns the number of Geometries. If geometry is a GEOMETRYCOLLECTION (or MULTI*) return the number of geometries, for single geometries will return 1. | v1.3.0 | +| [ST_NumInteriorRing](Geometry-Accessors/ST_NumInteriorRing.md) | Integer | Returns number of interior rings of polygon geometries. It is an alias of [ST_NumInteriorRings](Geometry-Accessors/ST_NumInteriorRings.md). | v1.6.1 | +| [ST_NumInteriorRings](Geometry-Accessors/ST_NumInteriorRings.md) | Integer | Returns number of interior rings of polygon geometries. | v1.3.0 | +| [ST_NumPoints](Geometry-Accessors/ST_NumPoints.md) | Integer | Returns number of points in a LineString. | v1.4.1 | +| [ST_PointN](Geometry-Accessors/ST_PointN.md) | Geometry | Return the Nth point in a single linestring or circular linestring in the geometry. Negative values are counted backwards from the end of the LineString, so that -1 is the last point. Returns NULL ... | v1.2.1 | +| [ST_Points](Geometry-Accessors/ST_Points.md) | Geometry | Returns a MultiPoint geometry consisting of all the coordinates of the input geometry. It preserves duplicate points as well as M and Z coordinates. | v1.6.1 | +| [ST_StartPoint](Geometry-Accessors/ST_StartPoint.md) | Geometry | Returns first point of given linestring. | v1.5.0 | +| [ST_X](Geometry-Accessors/ST_X.md) | Double | Returns X Coordinate of given Point, null otherwise. | v1.3.0 | +| [ST_Y](Geometry-Accessors/ST_Y.md) | Double | Returns Y Coordinate of given Point, null otherwise. | v1.3.0 | +| [ST_Z](Geometry-Accessors/ST_Z.md) | Double | Returns Z Coordinate of given Point, null otherwise. | v1.3.0 | +| [ST_Zmflag](Geometry-Accessors/ST_Zmflag.md) | Integer | Returns a code indicating the Z and M coordinate dimensions present in the input geometry. | v1.6.1 | ## Geometry Editors These functions create modified geometries by changing type, structure, or vertices. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_AddPoint](Geometry-Editors/ST_AddPoint.md) | Return Linestring with additional point at the given index, if position is not available the point will be added at the end of line. | v1.3.0 | -| [ST_Collect](Geometry-Editors/ST_Collect.md) | Returns MultiGeometry object based on geometry column/s or array with geometries | v1.5.0 | -| [ST_CollectionExtract](Geometry-Editors/ST_CollectionExtract.md) | Returns a homogeneous multi-geometry from a given geometry collection. | v1.5.0 | -| [ST_FlipCoordinates](Geometry-Editors/ST_FlipCoordinates.md) | Returns a version of the given geometry with X and Y axis flipped. | v1.2.0 | -| [ST_Force2D](Geometry-Editors/ST_Force2D.md) | Forces the geometries into a "2-dimensional mode" so that all output representations will only have the X and Y coordinates. This function is an alias of [ST_Force_2D](Geometry-Editors/ST_Force_2D.md). | v1.8.0 | -| [ST_Force3D](Geometry-Editors/ST_Force3D.md) | Forces the geometry into a 3-dimensional model so that all output representations will have X, Y and Z coordinates. An optionally given zValue is tacked onto the geometry if the geometry is 2-dimen... | v1.4.1 | -| [ST_Force3DM](Geometry-Editors/ST_Force3DM.md) | Forces the geometry into XYM mode. Retains any existing M coordinate, but removes the Z coordinate if present. Assigns a default M value of 0.0 if `mValue` is not specified. | v1.6.1 | -| [ST_Force3DZ](Geometry-Editors/ST_Force3DZ.md) | Forces the geometry into a 3-dimensional model so that all output representations will have X, Y and Z coordinates. An optionally given zValue is tacked onto the geometry if the geometry is 2-dimen... | v1.6.1 | -| [ST_Force4D](Geometry-Editors/ST_Force4D.md) | Converts the input geometry to 4D XYZM representation. Retains original Z and M values if present. Assigning 0.0 defaults if `mValue` and `zValue` aren't specified. The output contains X, Y, Z, and... | v1.6.1 | -| [ST_Force_2D](Geometry-Editors/ST_Force_2D.md) | Forces the geometries into a "2-dimensional mode" so that all output representations will only have the X and Y coordinates. This function is an alias of [ST_Force2D](Geometry-Editors/ST_Force2D.md). | v1.2.1 | -| [ST_ForceCollection](Geometry-Editors/ST_ForceCollection.md) | This function converts the input geometry into a GeometryCollection, regardless of the original geometry type. If the input is a multipart geometry, such as a MultiPolygon or MultiLineString, it wi... | v1.6.1 | -| [ST_ForcePolygonCCW](Geometry-Editors/ST_ForcePolygonCCW.md) | For (Multi)Polygon geometries, this function sets the exterior ring orientation to counter-clockwise and interior rings to clockwise orientation. Non-polygonal geometries are returned unchanged. | v1.6.0 | -| [ST_ForcePolygonCW](Geometry-Editors/ST_ForcePolygonCW.md) | For (Multi)Polygon geometries, this function sets the exterior ring orientation to clockwise and interior rings to counter-clockwise orientation. Non-polygonal geometries are returned unchanged. | v1.6.0 | -| [ST_ForceRHR](Geometry-Editors/ST_ForceRHR.md) | Sets the orientation of polygon vertex orderings to follow the Right-Hand-Rule convention. The exterior ring will have a clockwise winding order, while any interior rings are oriented counter-clock... | v1.6.1 | -| [ST_LineFromMultiPoint](Geometry-Editors/ST_LineFromMultiPoint.md) | Creates a LineString from a MultiPoint geometry. | v1.3.0 | -| [ST_LineMerge](Geometry-Editors/ST_LineMerge.md) | Returns a LineString or MultiLineString formed by sewing together the constituent line work of a MULTILINESTRING. | v1.5.0 | -| [ST_LineSegments](Geometry-Editors/ST_LineSegments.md) | This function transforms a LineString containing multiple coordinates into an array of LineStrings, each with precisely two coordinates. The `lenient` argument, true by default, prevents an excepti... | v1.7.1 | -| [ST_MakeLine](Geometry-Editors/ST_MakeLine.md) | Creates a LineString containing the points of Point, MultiPoint, or LineString geometries. Other geometry types cause an error. | v1.5.0 | -| [ST_MakePolygon](Geometry-Editors/ST_MakePolygon.md) | Function to convert closed linestring to polygon including holes. If holes are provided, they should be fully contained within the shell. Holes outside the shell will produce an invalid polygon (ma... | v1.5.0 | -| [ST_Multi](Geometry-Editors/ST_Multi.md) | Returns a MultiGeometry object based on the geometry input. ST_Multi is basically an alias for ST_Collect with one geometry. | v1.5.0 | -| [ST_Normalize](Geometry-Editors/ST_Normalize.md) | Returns the input geometry in its normalized form. | v1.3.0 | -| [ST_Polygon](Geometry-Editors/ST_Polygon.md) | Function to create a polygon built from the given LineString and sets the spatial reference system from the srid | v1.5.0 | -| [ST_Project](Geometry-Editors/ST_Project.md) | Calculates a new point location given a starting point, distance, and azimuth. The azimuth indicates the direction, expressed in radians, and is measured in a clockwise manner starting from true no... | v1.7.0 | -| [ST_RemovePoint](Geometry-Editors/ST_RemovePoint.md) | Return Linestring with removed point at given index, position can be omitted and then last one will be removed. | v1.3.0 | -| [ST_RemoveRepeatedPoints](Geometry-Editors/ST_RemoveRepeatedPoints.md) | This function eliminates consecutive duplicate points within a geometry, preserving endpoints of LineStrings. It operates on (Multi)LineStrings, (Multi)Polygons, and MultiPoints, processing Geometr... | v1.7.0 | -| [ST_Reverse](Geometry-Editors/ST_Reverse.md) | Return the geometry with vertex order reversed | v1.2.1 | -| [ST_Segmentize](Geometry-Editors/ST_Segmentize.md) | Returns a modified geometry having no segment longer than the given max_segment_length. | v1.8.0 | -| [ST_SetPoint](Geometry-Editors/ST_SetPoint.md) | Replace Nth point of linestring with given point. Index is 0-based. Negative index are counted backwards, e.g., -1 is last point. | v1.3.0 | -| [ST_ShiftLongitude](Geometry-Editors/ST_ShiftLongitude.md) | Modifies longitude coordinates in geometries, shifting values between -180..0 degrees to 180..360 degrees and vice versa. This is useful for normalizing data across the International Date Line and ... | v1.6.0 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_AddPoint](Geometry-Editors/ST_AddPoint.md) | Geometry | Return Linestring with additional point at the given index, if position is not available the point will be added at the end of line. | v1.3.0 | +| [ST_Collect](Geometry-Editors/ST_Collect.md) | Geometry | Returns MultiGeometry object based on geometry column/s or array with geometries | v1.5.0 | +| [ST_CollectionExtract](Geometry-Editors/ST_CollectionExtract.md) | Geometry | Returns a homogeneous multi-geometry from a given geometry collection. | v1.5.0 | +| [ST_FlipCoordinates](Geometry-Editors/ST_FlipCoordinates.md) | Geometry | Returns a version of the given geometry with X and Y axis flipped. | v1.2.0 | +| [ST_Force2D](Geometry-Editors/ST_Force2D.md) | Geometry | Forces the geometries into a "2-dimensional mode" so that all output representations will only have the X and Y coordinates. This function is an alias of [ST_Force_2D](Geometry-Editors/ST_Force_2D.md). | v1.8.0 | +| [ST_Force3D](Geometry-Editors/ST_Force3D.md) | Geometry | Forces the geometry into a 3-dimensional model so that all output representations will have X, Y and Z coordinates. An optionally given zValue is tacked onto the geometry if the geometry is 2-dimen... | v1.4.1 | +| [ST_Force3DM](Geometry-Editors/ST_Force3DM.md) | Geometry | Forces the geometry into XYM mode. Retains any existing M coordinate, but removes the Z coordinate if present. Assigns a default M value of 0.0 if `mValue` is not specified. | v1.6.1 | +| [ST_Force3DZ](Geometry-Editors/ST_Force3DZ.md) | Geometry | Forces the geometry into a 3-dimensional model so that all output representations will have X, Y and Z coordinates. An optionally given zValue is tacked onto the geometry if the geometry is 2-dimen... | v1.6.1 | +| [ST_Force4D](Geometry-Editors/ST_Force4D.md) | Geometry | Converts the input geometry to 4D XYZM representation. Retains original Z and M values if present. Assigning 0.0 defaults if `mValue` and `zValue` aren't specified. The output contains X, Y, Z, and... | v1.6.1 | +| [ST_Force_2D](Geometry-Editors/ST_Force_2D.md) | Geometry | Forces the geometries into a "2-dimensional mode" so that all output representations will only have the X and Y coordinates. This function is an alias of [ST_Force2D](Geometry-Editors/ST_Force2D.md). | v1.2.1 | +| [ST_ForceCollection](Geometry-Editors/ST_ForceCollection.md) | Geometry | This function converts the input geometry into a GeometryCollection, regardless of the original geometry type. If the input is a multipart geometry, such as a MultiPolygon or MultiLineString, it wi... | v1.6.1 | +| [ST_ForcePolygonCCW](Geometry-Editors/ST_ForcePolygonCCW.md) | Geometry | For (Multi)Polygon geometries, this function sets the exterior ring orientation to counter-clockwise and interior rings to clockwise orientation. Non-polygonal geometries are returned unchanged. | v1.6.0 | +| [ST_ForcePolygonCW](Geometry-Editors/ST_ForcePolygonCW.md) | Geometry | For (Multi)Polygon geometries, this function sets the exterior ring orientation to clockwise and interior rings to counter-clockwise orientation. Non-polygonal geometries are returned unchanged. | v1.6.0 | +| [ST_ForceRHR](Geometry-Editors/ST_ForceRHR.md) | Geometry | Sets the orientation of polygon vertex orderings to follow the Right-Hand-Rule convention. The exterior ring will have a clockwise winding order, while any interior rings are oriented counter-clock... | v1.6.1 | +| [ST_LineFromMultiPoint](Geometry-Editors/ST_LineFromMultiPoint.md) | Geometry | Creates a LineString from a MultiPoint geometry. | v1.3.0 | +| [ST_LineMerge](Geometry-Editors/ST_LineMerge.md) | Geometry | Returns a LineString or MultiLineString formed by sewing together the constituent line work of a MULTILINESTRING. | v1.5.0 | +| [ST_LineSegments](Geometry-Editors/ST_LineSegments.md) | `Array<Geometry>` | This function transforms a LineString containing multiple coordinates into an array of LineStrings, each with precisely two coordinates. The `lenient` argument, true by default, prevents an excepti... | v1.7.1 | +| [ST_MakeLine](Geometry-Editors/ST_MakeLine.md) | Geometry | Creates a LineString containing the points of Point, MultiPoint, or LineString geometries. Other geometry types cause an error. | v1.5.0 | +| [ST_MakePolygon](Geometry-Editors/ST_MakePolygon.md) | Geometry | Function to convert closed linestring to polygon including holes. If holes are provided, they should be fully contained within the shell. Holes outside the shell will produce an invalid polygon (ma... | v1.5.0 | +| [ST_Multi](Geometry-Editors/ST_Multi.md) | Geometry | Returns a MultiGeometry object based on the geometry input. ST_Multi is basically an alias for ST_Collect with one geometry. | v1.5.0 | +| [ST_Normalize](Geometry-Editors/ST_Normalize.md) | Geometry | Returns the input geometry in its normalized form. | v1.3.0 | +| [ST_Polygon](Geometry-Editors/ST_Polygon.md) | Geometry | Function to create a polygon built from the given LineString and sets the spatial reference system from the srid | v1.5.0 | +| [ST_Project](Geometry-Editors/ST_Project.md) | Geometry | Calculates a new point location given a starting point, distance, and azimuth. The azimuth indicates the direction, expressed in radians, and is measured in a clockwise manner starting from true no... | v1.7.0 | +| [ST_RemovePoint](Geometry-Editors/ST_RemovePoint.md) | Geometry | Return Linestring with removed point at given index, position can be omitted and then last one will be removed. | v1.3.0 | +| [ST_RemoveRepeatedPoints](Geometry-Editors/ST_RemoveRepeatedPoints.md) | Geometry | This function eliminates consecutive duplicate points within a geometry, preserving endpoints of LineStrings. It operates on (Multi)LineStrings, (Multi)Polygons, and MultiPoints, processing Geometr... | v1.7.0 | +| [ST_Reverse](Geometry-Editors/ST_Reverse.md) | Geometry | Return the geometry with vertex order reversed | v1.2.1 | +| [ST_Segmentize](Geometry-Editors/ST_Segmentize.md) | Geometry | Returns a modified geometry having no segment longer than the given max_segment_length. | v1.8.0 | +| [ST_SetPoint](Geometry-Editors/ST_SetPoint.md) | Geometry | Replace Nth point of linestring with given point. Index is 0-based. Negative index are counted backwards, e.g., -1 is last point. | v1.3.0 | +| [ST_ShiftLongitude](Geometry-Editors/ST_ShiftLongitude.md) | Geometry | Modifies longitude coordinates in geometries, shifting values between -180..0 degrees to 180..360 degrees and vice versa. This is useful for normalizing data across the International Date Line and ... | v1.6.0 | ## Geometry Output These functions convert geometry objects into various textual or binary formats. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_AsBinary](Geometry-Output/ST_AsBinary.md) | Return the Well-Known Binary representation of a geometry | v1.3.0 | -| [ST_AsEWKB](Geometry-Output/ST_AsEWKB.md) | Return the Extended Well-Known Binary representation of a geometry. EWKB is an extended version of WKB which includes the SRID of the geometry. The format originated in PostGIS but is supported by ... | v1.3.0 | -| [ST_AsEWKT](Geometry-Output/ST_AsEWKT.md) | Return the Extended Well-Known Text representation of a geometry. EWKT is an extended version of WKT which includes the SRID of the geometry. The format originated in PostGIS but is supported by ma... | v1.2.1 | -| [ST_AsGeoJSON](Geometry-Output/ST_AsGeoJSON.md) | Return the [GeoJSON](https://geojson.org/) string representation of a geometry. | v1.6.1 | -| [ST_AsGML](Geometry-Output/ST_AsGML.md) | Return the [GML](https://www.ogc.org/standards/gml) string representation of a geometry | v1.3.0 | -| [ST_AsHEXEWKB](Geometry-Output/ST_AsHEXEWKB.md) | This function returns the input geometry encoded to a text representation in HEXEWKB format. The HEXEWKB encoding can use either little-endian (NDR) or big-endian (XDR) byte ordering. If no encoding... | v1.6.1 | -| [ST_AsKML](Geometry-Output/ST_AsKML.md) | Return the [KML](https://www.ogc.org/standards/kml) string representation of a geometry | v1.3.0 | -| [ST_AsText](Geometry-Output/ST_AsText.md) | Return the Well-Known Text string representation of a geometry. It will support M coordinate if present since v1.5.0. | v1.3.0 | -| [ST_GeoHash](Geometry-Output/ST_GeoHash.md) | Returns GeoHash of the geometry with given precision | v1.2.0 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_AsBinary](Geometry-Output/ST_AsBinary.md) | Binary | Return the Well-Known Binary representation of a geometry | v1.3.0 | +| [ST_AsEWKB](Geometry-Output/ST_AsEWKB.md) | Binary | Return the Extended Well-Known Binary representation of a geometry. EWKB is an extended version of WKB which includes the SRID of the geometry. The format originated in PostGIS but is supported by ... | v1.3.0 | +| [ST_AsEWKT](Geometry-Output/ST_AsEWKT.md) | String | Return the Extended Well-Known Text representation of a geometry. EWKT is an extended version of WKT which includes the SRID of the geometry. The format originated in PostGIS but is supported by ma... | v1.2.1 | +| [ST_AsGeoJSON](Geometry-Output/ST_AsGeoJSON.md) | String | Return the [GeoJSON](https://geojson.org/) string representation of a geometry. | v1.6.1 | +| [ST_AsGML](Geometry-Output/ST_AsGML.md) | String | Return the [GML](https://www.ogc.org/standards/gml) string representation of a geometry | v1.3.0 | +| [ST_AsHEXEWKB](Geometry-Output/ST_AsHEXEWKB.md) | String | This function returns the input geometry encoded to a text representation in HEXEWKB format. The HEXEWKB encoding can use either little-endian (NDR) or big-endian (XDR) byte ordering. If no encoding... | v1.6.1 | +| [ST_AsKML](Geometry-Output/ST_AsKML.md) | String | Return the [KML](https://www.ogc.org/standards/kml) string representation of a geometry | v1.3.0 | +| [ST_AsText](Geometry-Output/ST_AsText.md) | String | Return the Well-Known Text string representation of a geometry. It will support M coordinate if present since v1.5.0. | v1.3.0 | +| [ST_GeoHash](Geometry-Output/ST_GeoHash.md) | String | Returns GeoHash of the geometry with given precision | v1.2.0 | ## Predicates These functions test spatial relationships between geometries, returning boolean values. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_Contains](Predicates/ST_Contains.md) | Return true if A fully contains B | v1.2.0 | -| [ST_CoveredBy](Predicates/ST_CoveredBy.md) | Return true if A is covered by B | v1.3.0 | -| [ST_Covers](Predicates/ST_Covers.md) | Return true if A covers B | v1.3.0 | -| [ST_Crosses](Predicates/ST_Crosses.md) | Return true if A crosses B | v1.5.0 | -| [ST_Disjoint](Predicates/ST_Disjoint.md) | Return true if A and B are disjoint | v1.2.1 | -| [ST_DWithin](Predicates/ST_DWithin.md) | Returns true if 'leftGeometry' and 'rightGeometry' are within a specified 'distance'. | v1.5.1 | -| [ST_Equals](Predicates/ST_Equals.md) | Return true if A equals to B | v1.5.0 | -| [ST_Intersects](Predicates/ST_Intersects.md) | Return true if A intersects B | v1.2.0 | -| [ST_OrderingEquals](Predicates/ST_OrderingEquals.md) | Returns true if the geometries are equal and the coordinates are in the same order | v1.2.1 | -| [ST_Overlaps](Predicates/ST_Overlaps.md) | Return true if A overlaps B | v1.5.0 | -| [ST_Relate](Predicates/ST_Relate.md) | The first variant of the function computes and returns the [Dimensionally Extended 9-Intersection Model (DE-9IM)](https://en.wikipedia.org/wiki/DE-9IM) matrix string representing the spatial relati... | v1.6.1 | -| [ST_RelateMatch](Predicates/ST_RelateMatch.md) | This function tests the relationship between two [Dimensionally Extended 9-Intersection Model (DE-9IM)](https://en.wikipedia.org/wiki/DE-9IM) matrices representing geometry intersections. It evalua... | v1.6.1 | -| [ST_Touches](Predicates/ST_Touches.md) | Return true if A touches B | v1.5.0 | -| [ST_Within](Predicates/ST_Within.md) | Return true if A is within B | v1.3.0 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_Contains](Predicates/ST_Contains.md) | Boolean | Return true if A fully contains B | v1.2.0 | +| [ST_CoveredBy](Predicates/ST_CoveredBy.md) | Boolean | Return true if A is covered by B | v1.3.0 | +| [ST_Covers](Predicates/ST_Covers.md) | Boolean | Return true if A covers B | v1.3.0 | +| [ST_Crosses](Predicates/ST_Crosses.md) | Boolean | Return true if A crosses B | v1.5.0 | +| [ST_Disjoint](Predicates/ST_Disjoint.md) | Boolean | Return true if A and B are disjoint | v1.2.1 | +| [ST_DWithin](Predicates/ST_DWithin.md) | Boolean | Returns true if 'leftGeometry' and 'rightGeometry' are within a specified 'distance'. | v1.5.1 | +| [ST_Equals](Predicates/ST_Equals.md) | Boolean | Return true if A equals to B | v1.5.0 | +| [ST_Intersects](Predicates/ST_Intersects.md) | Boolean | Return true if A intersects B | v1.2.0 | +| [ST_OrderingEquals](Predicates/ST_OrderingEquals.md) | Boolean | Returns true if the geometries are equal and the coordinates are in the same order | v1.2.1 | +| [ST_Overlaps](Predicates/ST_Overlaps.md) | Boolean | Return true if A overlaps B | v1.5.0 | +| [ST_Relate](Predicates/ST_Relate.md) | String | The first variant of the function computes and returns the [Dimensionally Extended 9-Intersection Model (DE-9IM)](https://en.wikipedia.org/wiki/DE-9IM) matrix string representing the spatial relati... | v1.6.1 | +| [ST_RelateMatch](Predicates/ST_RelateMatch.md) | Boolean | This function tests the relationship between two [Dimensionally Extended 9-Intersection Model (DE-9IM)](https://en.wikipedia.org/wiki/DE-9IM) matrices representing geometry intersections. It evalua... | v1.6.1 | +| [ST_Touches](Predicates/ST_Touches.md) | Boolean | Return true if A touches B | v1.5.0 | +| [ST_Within](Predicates/ST_Within.md) | Boolean | Return true if A is within B | v1.3.0 | ## Measurement Functions These functions compute measurements of distance, area, length, and angles. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_3DDistance](Measurement-Functions/ST_3DDistance.md) | Return the 3-dimensional minimum cartesian distance between A and B | v1.3.0 | -| [ST_Angle](Measurement-Functions/ST_Angle.md) | Compute and return the angle between two vectors represented by the provided points or linestrings. | v1.5.0 | -| [ST_Area](Measurement-Functions/ST_Area.md) | Return the area of A | v1.3.0 | -| [ST_AreaSpheroid](Measurement-Functions/ST_AreaSpheroid.md) | Return the geodesic area of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Area` + `ST_Transform`. It is equivalent to PostGIS `ST_Area(geo... | v1.4.1 | -| [ST_Azimuth](Measurement-Functions/ST_Azimuth.md) | Returns Azimuth for two given points in radians. Returns null if the two points are identical. | v1.3.0 | -| [ST_ClosestPoint](Measurement-Functions/ST_ClosestPoint.md) | Returns the 2-dimensional point on geom1 that is closest to geom2. This is the first point of the shortest line between the geometries. If using 3D geometries, the Z coordinates will be ignored. If... | v1.5.0 | -| [ST_Degrees](Measurement-Functions/ST_Degrees.md) | Convert an angle in radian to degrees. | v1.5.0 | -| [ST_Distance](Measurement-Functions/ST_Distance.md) | Return the Euclidean distance between A and B | v1.2.0 | -| [ST_DistanceSphere](Measurement-Functions/ST_DistanceSphere.md) | Return the haversine / great-circle distance of A using a given earth radius (default radius: 6371008.0). Unit is meter. Works better for large geometries (country level) compared to `ST_Distance` ... | v1.4.1 | -| [ST_DistanceSpheroid](Measurement-Functions/ST_DistanceSpheroid.md) | Return the geodesic distance of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Distance` + `ST_Transform`. It is equivalent to PostGIS `ST_... | v1.4.1 | -| [ST_FrechetDistance](Measurement-Functions/ST_FrechetDistance.md) | Computes and returns discrete [Frechet Distance](https://en.wikipedia.org/wiki/Fr%C3%A9chet_distance) between the given two geometries, based on [Computing Discrete Frechet Distance](http://www.kr.... | v1.5.0 | -| [ST_HausdorffDistance](Measurement-Functions/ST_HausdorffDistance.md) | Returns a discretized (and hence approximate) [Hausdorff distance](https://en.wikipedia.org/wiki/Hausdorff_distance) between the given 2 geometries. Optionally, a densityFraction parameter can be s... | v1.5.0 | -| [ST_Length](Measurement-Functions/ST_Length.md) | Returns the perimeter of A. | v1.3.0 | -| [ST_Length2D](Measurement-Functions/ST_Length2D.md) | Returns the perimeter of A. This function is an alias of [ST_Length](Measurement-Functions/ST_Length.md). | v1.6.1 | -| [ST_LengthSpheroid](Measurement-Functions/ST_LengthSpheroid.md) | Return the geodesic perimeter of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Length` + `ST_Transform`. It is equivalent to PostGIS `ST_L... | v1.4.1 | -| [ST_LongestLine](Measurement-Functions/ST_LongestLine.md) | Returns the LineString geometry representing the maximum distance between any two points from the input geometries. | v1.6.1 | -| [ST_MaxDistance](Measurement-Functions/ST_MaxDistance.md) | Calculates and returns the length value representing the maximum distance between any two points across the input geometries. This function is an alias for `ST_LongestDistance`. | v1.6.1 | -| [ST_MinimumClearance](Measurement-Functions/ST_MinimumClearance.md) | The minimum clearance is a metric that quantifies a geometry's tolerance to changes in coordinate precision or vertex positions. It represents the maximum distance by which vertices can be adjusted... | v1.6.1 | -| [ST_MinimumClearanceLine](Measurement-Functions/ST_MinimumClearanceLine.md) | This function returns a two-point LineString geometry representing the minimum clearance distance of the input geometry. If the input geometry does not have a defined minimum clearance, such as for... | v1.6.1 | -| [ST_Perimeter](Measurement-Functions/ST_Perimeter.md) | This function calculates the 2D perimeter of a given geometry. It supports Polygon, MultiPolygon, and GeometryCollection geometries (as long as the GeometryCollection contains polygonal geometries)... | v1.7.0 | -| [ST_Perimeter2D](Measurement-Functions/ST_Perimeter2D.md) | This function calculates the 2D perimeter of a given geometry. It supports Polygon, MultiPolygon, and GeometryCollection geometries (as long as the GeometryCollection contains polygonal geometries)... | v1.7.1 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_3DDistance](Measurement-Functions/ST_3DDistance.md) | Double | Return the 3-dimensional minimum cartesian distance between A and B | v1.3.0 | +| [ST_Angle](Measurement-Functions/ST_Angle.md) | Double | Compute and return the angle between two vectors represented by the provided points or linestrings. | v1.5.0 | +| [ST_Area](Measurement-Functions/ST_Area.md) | Double | Return the area of A | v1.3.0 | +| [ST_AreaSpheroid](Measurement-Functions/ST_AreaSpheroid.md) | Double | Return the geodesic area of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Area` + `ST_Transform`. It is equivalent to PostGIS `ST_Area(geo... | v1.4.1 | +| [ST_Azimuth](Measurement-Functions/ST_Azimuth.md) | Double | Returns Azimuth for two given points in radians. Returns null if the two points are identical. | v1.3.0 | +| [ST_ClosestPoint](Measurement-Functions/ST_ClosestPoint.md) | Geometry | Returns the 2-dimensional point on geom1 that is closest to geom2. This is the first point of the shortest line between the geometries. If using 3D geometries, the Z coordinates will be ignored. If... | v1.5.0 | +| [ST_Degrees](Measurement-Functions/ST_Degrees.md) | Double | Convert an angle in radian to degrees. | v1.5.0 | +| [ST_Distance](Measurement-Functions/ST_Distance.md) | Double | Return the Euclidean distance between A and B | v1.2.0 | +| [ST_DistanceSphere](Measurement-Functions/ST_DistanceSphere.md) | Double | Return the haversine / great-circle distance of A using a given earth radius (default radius: 6371008.0). Unit is meter. Works better for large geometries (country level) compared to `ST_Distance` ... | v1.4.1 | +| [ST_DistanceSpheroid](Measurement-Functions/ST_DistanceSpheroid.md) | Double | Return the geodesic distance of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Distance` + `ST_Transform`. It is equivalent to PostGIS `ST_... | v1.4.1 | +| [ST_FrechetDistance](Measurement-Functions/ST_FrechetDistance.md) | Double | Computes and returns discrete [Frechet Distance](https://en.wikipedia.org/wiki/Fr%C3%A9chet_distance) between the given two geometries, based on [Computing Discrete Frechet Distance](http://www.kr.... | v1.5.0 | +| [ST_HausdorffDistance](Measurement-Functions/ST_HausdorffDistance.md) | Double | Returns a discretized (and hence approximate) [Hausdorff distance](https://en.wikipedia.org/wiki/Hausdorff_distance) between the given 2 geometries. Optionally, a densityFraction parameter can be s... | v1.5.0 | +| [ST_Length](Measurement-Functions/ST_Length.md) | Double | Returns the perimeter of A. | v1.3.0 | +| [ST_Length2D](Measurement-Functions/ST_Length2D.md) | Double | Returns the perimeter of A. This function is an alias of [ST_Length](Measurement-Functions/ST_Length.md). | v1.6.1 | +| [ST_LengthSpheroid](Measurement-Functions/ST_LengthSpheroid.md) | Double | Return the geodesic perimeter of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Length` + `ST_Transform`. It is equivalent to PostGIS `ST_L... | v1.4.1 | +| [ST_LongestLine](Measurement-Functions/ST_LongestLine.md) | Geometry | Returns the LineString geometry representing the maximum distance between any two points from the input geometries. | v1.6.1 | +| [ST_MaxDistance](Measurement-Functions/ST_MaxDistance.md) | Double | Calculates and returns the length value representing the maximum distance between any two points across the input geometries. This function is an alias for `ST_LongestDistance`. | v1.6.1 | +| [ST_MinimumClearance](Measurement-Functions/ST_MinimumClearance.md) | Double | The minimum clearance is a metric that quantifies a geometry's tolerance to changes in coordinate precision or vertex positions. It represents the maximum distance by which vertices can be adjusted... | v1.6.1 | +| [ST_MinimumClearanceLine](Measurement-Functions/ST_MinimumClearanceLine.md) | Geometry | This function returns a two-point LineString geometry representing the minimum clearance distance of the input geometry. If the input geometry does not have a defined minimum clearance, such as for... | v1.6.1 | +| [ST_Perimeter](Measurement-Functions/ST_Perimeter.md) | Double | This function calculates the 2D perimeter of a given geometry. It supports Polygon, MultiPolygon, and GeometryCollection geometries (as long as the GeometryCollection contains polygonal geometries)... | v1.7.0 | +| [ST_Perimeter2D](Measurement-Functions/ST_Perimeter2D.md) | Double | This function calculates the 2D perimeter of a given geometry. It supports Polygon, MultiPolygon, and GeometryCollection geometries (as long as the GeometryCollection contains polygonal geometries)... | v1.7.1 | ## Geometry Processing These functions compute geometric constructions, or alter geometry size or shape. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_ApproximateMedialAxis](Geometry-Processing/ST_ApproximateMedialAxis.md) | Computes an approximate medial axis of a polygonal geometry. The medial axis is a representation of the "centerline" or "skeleton" of the polygon. This function first computes the straight skeleton... | v1.8.0 | -| [ST_Buffer](Geometry-Processing/ST_Buffer.md) | Returns a geometry/geography that represents all points whose distance from this Geometry/geography is less than or equal to distance. The function supports both Planar/Euclidean and Spheroidal/Geo... | v1.6.0 | -| [ST_BuildArea](Geometry-Processing/ST_BuildArea.md) | Returns the areal geometry formed by the constituent linework of the input geometry. | v1.2.1 | -| [ST_Centroid](Geometry-Processing/ST_Centroid.md) | Return the centroid point of A | v1.5.0 | -| [ST_ConcaveHull](Geometry-Processing/ST_ConcaveHull.md) | Return the Concave Hull of polygon A, with alpha set to pctConvex[0, 1] in the Delaunay Triangulation method, the concave hull will not contain a hole unless allowHoles is set to true | v1.4.0 | -| [ST_ConvexHull](Geometry-Processing/ST_ConvexHull.md) | Return the Convex Hull of polygon A | v1.5.0 | -| [ST_DelaunayTriangles](Geometry-Processing/ST_DelaunayTriangles.md) | This function computes the [Delaunay triangulation](https://en.wikipedia.org/wiki/Delaunay_triangulation) for the set of vertices in the input geometry. An optional `tolerance` parameter allows sna... | v1.6.1 | -| [ST_GeneratePoints](Geometry-Processing/ST_GeneratePoints.md) | Generates a specified quantity of pseudo-random points within the boundaries of the provided polygonal geometry. When `seed` is either zero or not defined then output will be random. | v1.6.1 | -| [ST_GeometricMedian](Geometry-Processing/ST_GeometricMedian.md) | Computes the approximate geometric median of a MultiPoint geometry using the Weiszfeld algorithm. The geometric median provides a centrality measure that is less sensitive to outlier points than th... | v1.4.1 | -| [ST_LabelPoint](Geometry-Processing/ST_LabelPoint.md) | `ST_LabelPoint` computes and returns a label point for a given polygon or geometry collection. The label point is chosen to be sufficiently far from boundaries of the geometry. For a regular Polygo... | v1.7.1 | -| [ST_MinimumBoundingCircle](Geometry-Processing/ST_MinimumBoundingCircle.md) | Returns the smallest circle polygon that contains a geometry. The optional quadrantSegments parameter determines how many segments to use per quadrant and the default number of segments is 48. | v1.5.0 | -| [ST_MinimumBoundingRadius](Geometry-Processing/ST_MinimumBoundingRadius.md) | Returns a struct containing the center point and radius of the smallest circle that contains a geometry. | v1.5.0 | -| [ST_OrientedEnvelope](Geometry-Processing/ST_OrientedEnvelope.md) | Returns the minimum-area rotated rectangle enclosing a geometry. The rectangle may be rotated relative to the coordinate axes. Degenerate inputs may result in a Point or LineString being returned. | v1.8.1 | -| [ST_PointOnSurface](Geometry-Processing/ST_PointOnSurface.md) | Returns a POINT guaranteed to lie on the surface. | v1.2.1 | -| [ST_Polygonize](Geometry-Processing/ST_Polygonize.md) | Generates a GeometryCollection composed of polygons that are formed from the linework of an input GeometryCollection. When the input does not contain any linework that forms a polygon, the function... | v1.6.0 | -| [ST_ReducePrecision](Geometry-Processing/ST_ReducePrecision.md) | Reduce the decimals places in the coordinates of the geometry to the given number of decimal places. The last decimal place will be rounded. | v1.5.0 | -| [ST_Simplify](Geometry-Processing/ST_Simplify.md) | This function simplifies the input geometry by applying the Douglas-Peucker algorithm. | v1.7.0 | -| [ST_SimplifyPolygonHull](Geometry-Processing/ST_SimplifyPolygonHull.md) | This function computes a topology-preserving simplified hull, either outer or inner, for a polygonal geometry input. An outer hull fully encloses the original geometry, while an inner hull lies ent... | v1.6.1 | -| [ST_SimplifyPreserveTopology](Geometry-Processing/ST_SimplifyPreserveTopology.md) | Simplifies a geometry and ensures that the result is a valid geometry having the same dimension and number of components as the input, and with the components having the same topological relationship. | v1.5.0 | -| [ST_SimplifyVW](Geometry-Processing/ST_SimplifyVW.md) | This function simplifies the input geometry by applying the Visvalingam-Whyatt algorithm. | v1.6.1 | -| [ST_Snap](Geometry-Processing/ST_Snap.md) | Snaps the vertices and segments of the `input` geometry to `reference` geometry within the specified `tolerance` distance. The `tolerance` parameter controls the maximum snap distance. | v1.6.0 | -| [ST_StraightSkeleton](Geometry-Processing/ST_StraightSkeleton.md) | Computes the straight skeleton of a polygonal geometry. The straight skeleton is a method of representing a polygon by a topological skeleton, formed by a continuous shrinking process where each ed... | v1.8.0 | -| [ST_TriangulatePolygon](Geometry-Processing/ST_TriangulatePolygon.md) | Generates the constrained Delaunay triangulation for the input Polygon. The constrained Delaunay triangulation is a set of triangles created from the Polygon's vertices that covers the Polygon area... | v1.6.1 | -| [ST_VoronoiPolygons](Geometry-Processing/ST_VoronoiPolygons.md) | Returns a two-dimensional Voronoi diagram from the vertices of the supplied geometry. The result is a GeometryCollection of Polygons that covers an envelope larger than the extent of the input vert... | v1.5.0 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_ApproximateMedialAxis](Geometry-Processing/ST_ApproximateMedialAxis.md) | Geometry | Computes an approximate medial axis of a polygonal geometry. The medial axis is a representation of the "centerline" or "skeleton" of the polygon. This function first computes the straight skeleton... | v1.8.0 | +| [ST_Buffer](Geometry-Processing/ST_Buffer.md) | Geometry | Returns a geometry/geography that represents all points whose distance from this Geometry/geography is less than or equal to distance. The function supports both Planar/Euclidean and Spheroidal/Geo... | v1.6.0 | +| [ST_BuildArea](Geometry-Processing/ST_BuildArea.md) | Geometry | Returns the areal geometry formed by the constituent linework of the input geometry. | v1.2.1 | +| [ST_Centroid](Geometry-Processing/ST_Centroid.md) | Geometry | Return the centroid point of A | v1.5.0 | +| [ST_ConcaveHull](Geometry-Processing/ST_ConcaveHull.md) | Geometry | Return the Concave Hull of polygon A, with alpha set to pctConvex[0, 1] in the Delaunay Triangulation method, the concave hull will not contain a hole unless allowHoles is set to true | v1.4.0 | +| [ST_ConvexHull](Geometry-Processing/ST_ConvexHull.md) | Geometry | Return the Convex Hull of polygon A | v1.5.0 | +| [ST_DelaunayTriangles](Geometry-Processing/ST_DelaunayTriangles.md) | Geometry | This function computes the [Delaunay triangulation](https://en.wikipedia.org/wiki/Delaunay_triangulation) for the set of vertices in the input geometry. An optional `tolerance` parameter allows sna... | v1.6.1 | +| [ST_GeneratePoints](Geometry-Processing/ST_GeneratePoints.md) | Geometry | Generates a specified quantity of pseudo-random points within the boundaries of the provided polygonal geometry. When `seed` is either zero or not defined then output will be random. | v1.6.1 | +| [ST_GeometricMedian](Geometry-Processing/ST_GeometricMedian.md) | Geometry | Computes the approximate geometric median of a MultiPoint geometry using the Weiszfeld algorithm. The geometric median provides a centrality measure that is less sensitive to outlier points than th... | v1.4.1 | +| [ST_LabelPoint](Geometry-Processing/ST_LabelPoint.md) | Geometry | `ST_LabelPoint` computes and returns a label point for a given polygon or geometry collection. The label point is chosen to be sufficiently far from boundaries of the geometry. For a regular Polygo... | v1.7.1 | +| [ST_MinimumBoundingCircle](Geometry-Processing/ST_MinimumBoundingCircle.md) | Geometry | Returns the smallest circle polygon that contains a geometry. The optional quadrantSegments parameter determines how many segments to use per quadrant and the default number of segments is 48. | v1.5.0 | +| [ST_MinimumBoundingRadius](Geometry-Processing/ST_MinimumBoundingRadius.md) | Struct | Returns a struct containing the center point and radius of the smallest circle that contains a geometry. | v1.5.0 | Review Comment: This summary row lists the return type as `Struct`, but the corresponding function page documents a more specific shape (e.g., `Struct<center: Geometry, radius: Double>`). Consider aligning the summary table return type with the more precise struct signature (and formatting it as a code span) so the new column remains informative and consistent with the per-function docs. ```suggestion | [ST_MinimumBoundingRadius](Geometry-Processing/ST_MinimumBoundingRadius.md) | `Struct<center: Geometry, radius: Double>` | Returns a struct containing the center point and radius of the smallest circle that contains a geometry. | v1.5.0 | ``` ########## docs/api/flink/Geometry-Functions.md: ########## @@ -25,324 +25,324 @@ The `Geometry` type in Sedona represents planar (2D Euclidean) spatial objects s These functions create geometry objects from various textual or binary formats, or from coordinate values. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_GeomCollFromText](Geometry-Constructors/ST_GeomCollFromText.md) | Constructs a GeometryCollection from the WKT with the given SRID. If SRID is not provided then it defaults to 0. It returns `null` if the WKT is not a `GEOMETRYCOLLECTION`. | v1.6.1 | -| [ST_GeometryFromText](Geometry-Constructors/ST_GeometryFromText.md) | Construct a Geometry from WKT. If SRID is not set, it defaults to 0 (unknown). Alias of [ST_GeomFromWKT](Geometry-Constructors/ST_GeomFromWKT.md) | v1.6.1 | -| [ST_GeomFromEWKB](Geometry-Constructors/ST_GeomFromEWKB.md) | Construct a Geometry from EWKB string or Binary. This function is an alias of [ST_GeomFromWKB](Geometry-Constructors/ST_GeomFromWKB.md). | v1.6.1 | -| [ST_GeomFromEWKT](Geometry-Constructors/ST_GeomFromEWKT.md) | Construct a Geometry from OGC Extended WKT | v1.5.0 | -| [ST_GeomFromGeoHash](Geometry-Constructors/ST_GeomFromGeoHash.md) | Create Geometry from geohash string and optional precision | v1.2.1 | -| [ST_GeomFromGeoJSON](Geometry-Constructors/ST_GeomFromGeoJSON.md) | Construct a Geometry from GeoJson | v1.2.0 | -| [ST_GeomFromGML](Geometry-Constructors/ST_GeomFromGML.md) | Construct a Geometry from GML. | v1.3.0 | -| [ST_GeomFromKML](Geometry-Constructors/ST_GeomFromKML.md) | Construct a Geometry from KML. | v1.3.0 | -| [ST_GeomFromText](Geometry-Constructors/ST_GeomFromText.md) | Construct a Geometry from WKT. Alias of [ST_GeomFromWKT](Geometry-Constructors/ST_GeomFromWKT.md) | v1.2.1 | -| [ST_GeomFromWKB](Geometry-Constructors/ST_GeomFromWKB.md) | Construct a Geometry from WKB string or Binary. This function also supports EWKB format. | v1.2.0 | -| [ST_GeomFromWKT](Geometry-Constructors/ST_GeomFromWKT.md) | Construct a Geometry from WKT | v1.2.0 | -| [ST_LineFromText](Geometry-Constructors/ST_LineFromText.md) | Construct a LineString from Text | v1.2.1 | -| [ST_LineFromWKB](Geometry-Constructors/ST_LineFromWKB.md) | Construct a LineString geometry from WKB string or Binary and an optional SRID. This function also supports EWKB format. | v1.6.1 | -| [ST_LineStringFromText](Geometry-Constructors/ST_LineStringFromText.md) | Construct a LineString from Text, delimited by Delimiter (Optional). Alias of [ST_LineFromText](Geometry-Constructors/ST_LineFromText.md) | v1.2.1 | -| [ST_LinestringFromWKB](Geometry-Constructors/ST_LinestringFromWKB.md) | Construct a LineString geometry from WKB string or Binary and an optional SRID. This function also supports EWKB format and it is an alias of [ST_LineFromWKB](Geometry-Constructors/ST_LineFromWKB.md). | v1.6.1 | -| [ST_MakeEnvelope](Geometry-Constructors/ST_MakeEnvelope.md) | Construct a Polygon from MinX, MinY, MaxX, MaxY, and an optional SRID. | v1.7.0 | -| [ST_MakePoint](Geometry-Constructors/ST_MakePoint.md) | Creates a 2D, 3D Z or 4D ZM Point geometry. Use [ST_MakePointM](Geometry-Constructors/ST_MakePointM.md) to make points with XYM coordinates. Z and M values are optional. | v1.5.0 | -| [ST_MakePointM](Geometry-Constructors/ST_MakePointM.md) | Creates a point with X, Y, and M coordinate. Use [ST_MakePoint](Geometry-Constructors/ST_MakePoint.md) to make points with XY, XYZ, or XYZM coordinates. | v1.6.1 | -| [ST_MLineFromText](Geometry-Constructors/ST_MLineFromText.md) | Construct a MultiLineString from Text and Optional SRID | | -| [ST_MPointFromText](Geometry-Constructors/ST_MPointFromText.md) | Constructs a MultiPoint from the WKT with the given SRID. If SRID is not provided then it defaults to 0. It returns `null` if the WKT is not a `MULTIPOINT`. | v1.6.1 | -| [ST_MPolyFromText](Geometry-Constructors/ST_MPolyFromText.md) | Construct a MultiPolygon from Text and Optional SRID | | -| [ST_Point](Geometry-Constructors/ST_Point.md) | Construct a Point from X and Y | v1.2.1 | -| [ST_PointFromGeoHash](Geometry-Constructors/ST_PointFromGeoHash.md) | Generates a Point geometry representing the center of the GeoHash cell defined by the input string. If `precision` is not specified, the full GeoHash precision is used. Providing a `precision` value... | v1.6.1 | -| [ST_PointFromText](Geometry-Constructors/ST_PointFromText.md) | Construct a Point from Text, delimited by Delimiter | v1.2.0 | -| [ST_PointFromWKB](Geometry-Constructors/ST_PointFromWKB.md) | Construct a Point geometry from WKB string or Binary and an optional SRID. This function also supports EWKB format. | v1.6.1 | -| [ST_PointM](Geometry-Constructors/ST_PointM.md) | Construct a Point from X, Y and M and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z and M coordinates. | v1.6.1 | -| [ST_PointZ](Geometry-Constructors/ST_PointZ.md) | Construct a Point from X, Y and Z and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z coordinate. | v1.5.0 | -| [ST_PointZM](Geometry-Constructors/ST_PointZM.md) | Construct a Point from X, Y, Z, M and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z and M coordinates. | v1.6.1 | -| [ST_PolygonFromEnvelope](Geometry-Constructors/ST_PolygonFromEnvelope.md) | Construct a Polygon from MinX, MinY, MaxX, MaxY. | v1.2.0 | -| [ST_PolygonFromText](Geometry-Constructors/ST_PolygonFromText.md) | Construct a Polygon from Text, delimited by Delimiter. Path must be closed | v1.2.0 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_GeomCollFromText](Geometry-Constructors/ST_GeomCollFromText.md) | Geometry | Constructs a GeometryCollection from the WKT with the given SRID. If SRID is not provided then it defaults to 0. It returns `null` if the WKT is not a `GEOMETRYCOLLECTION`. | v1.6.1 | +| [ST_GeometryFromText](Geometry-Constructors/ST_GeometryFromText.md) | Geometry | Construct a Geometry from WKT. If SRID is not set, it defaults to 0 (unknown). Alias of [ST_GeomFromWKT](Geometry-Constructors/ST_GeomFromWKT.md) | v1.6.1 | +| [ST_GeomFromEWKB](Geometry-Constructors/ST_GeomFromEWKB.md) | Geometry | Construct a Geometry from EWKB string or Binary. This function is an alias of [ST_GeomFromWKB](Geometry-Constructors/ST_GeomFromWKB.md). | v1.6.1 | +| [ST_GeomFromEWKT](Geometry-Constructors/ST_GeomFromEWKT.md) | Geometry | Construct a Geometry from OGC Extended WKT | v1.5.0 | +| [ST_GeomFromGeoHash](Geometry-Constructors/ST_GeomFromGeoHash.md) | Geometry | Create Geometry from geohash string and optional precision | v1.2.1 | +| [ST_GeomFromGeoJSON](Geometry-Constructors/ST_GeomFromGeoJSON.md) | Geometry | Construct a Geometry from GeoJson | v1.2.0 | +| [ST_GeomFromGML](Geometry-Constructors/ST_GeomFromGML.md) | Geometry | Construct a Geometry from GML. | v1.3.0 | +| [ST_GeomFromKML](Geometry-Constructors/ST_GeomFromKML.md) | Geometry | Construct a Geometry from KML. | v1.3.0 | +| [ST_GeomFromText](Geometry-Constructors/ST_GeomFromText.md) | Geometry | Construct a Geometry from WKT. Alias of [ST_GeomFromWKT](Geometry-Constructors/ST_GeomFromWKT.md) | v1.2.1 | +| [ST_GeomFromWKB](Geometry-Constructors/ST_GeomFromWKB.md) | Geometry | Construct a Geometry from WKB string or Binary. This function also supports EWKB format. | v1.2.0 | +| [ST_GeomFromWKT](Geometry-Constructors/ST_GeomFromWKT.md) | Geometry | Construct a Geometry from WKT | v1.2.0 | +| [ST_LineFromText](Geometry-Constructors/ST_LineFromText.md) | Geometry | Construct a LineString from Text | v1.2.1 | +| [ST_LineFromWKB](Geometry-Constructors/ST_LineFromWKB.md) | Geometry | Construct a LineString geometry from WKB string or Binary and an optional SRID. This function also supports EWKB format. | v1.6.1 | +| [ST_LineStringFromText](Geometry-Constructors/ST_LineStringFromText.md) | Geometry | Construct a LineString from Text, delimited by Delimiter (Optional). Alias of [ST_LineFromText](Geometry-Constructors/ST_LineFromText.md) | v1.2.1 | +| [ST_LinestringFromWKB](Geometry-Constructors/ST_LinestringFromWKB.md) | Geometry | Construct a LineString geometry from WKB string or Binary and an optional SRID. This function also supports EWKB format and it is an alias of [ST_LineFromWKB](Geometry-Constructors/ST_LineFromWKB.md). | v1.6.1 | +| [ST_MakeEnvelope](Geometry-Constructors/ST_MakeEnvelope.md) | Geometry | Construct a Polygon from MinX, MinY, MaxX, MaxY, and an optional SRID. | v1.7.0 | +| [ST_MakePoint](Geometry-Constructors/ST_MakePoint.md) | Geometry | Creates a 2D, 3D Z or 4D ZM Point geometry. Use [ST_MakePointM](Geometry-Constructors/ST_MakePointM.md) to make points with XYM coordinates. Z and M values are optional. | v1.5.0 | +| [ST_MakePointM](Geometry-Constructors/ST_MakePointM.md) | Geometry | Creates a point with X, Y, and M coordinate. Use [ST_MakePoint](Geometry-Constructors/ST_MakePoint.md) to make points with XY, XYZ, or XYZM coordinates. | v1.6.1 | +| [ST_MLineFromText](Geometry-Constructors/ST_MLineFromText.md) | Geometry | Construct a MultiLineString from Text and Optional SRID | | +| [ST_MPointFromText](Geometry-Constructors/ST_MPointFromText.md) | Geometry | Constructs a MultiPoint from the WKT with the given SRID. If SRID is not provided then it defaults to 0. It returns `null` if the WKT is not a `MULTIPOINT`. | v1.6.1 | +| [ST_MPolyFromText](Geometry-Constructors/ST_MPolyFromText.md) | Geometry | Construct a MultiPolygon from Text and Optional SRID | | +| [ST_Point](Geometry-Constructors/ST_Point.md) | Geometry | Construct a Point from X and Y | v1.2.1 | +| [ST_PointFromGeoHash](Geometry-Constructors/ST_PointFromGeoHash.md) | Geometry | Generates a Point geometry representing the center of the GeoHash cell defined by the input string. If `precision` is not specified, the full GeoHash precision is used. Providing a `precision` value... | v1.6.1 | +| [ST_PointFromText](Geometry-Constructors/ST_PointFromText.md) | Geometry | Construct a Point from Text, delimited by Delimiter | v1.2.0 | +| [ST_PointFromWKB](Geometry-Constructors/ST_PointFromWKB.md) | Geometry | Construct a Point geometry from WKB string or Binary and an optional SRID. This function also supports EWKB format. | v1.6.1 | +| [ST_PointM](Geometry-Constructors/ST_PointM.md) | Geometry | Construct a Point from X, Y and M and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z and M coordinates. | v1.6.1 | +| [ST_PointZ](Geometry-Constructors/ST_PointZ.md) | Geometry | Construct a Point from X, Y and Z and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z coordinate. | v1.5.0 | +| [ST_PointZM](Geometry-Constructors/ST_PointZM.md) | Geometry | Construct a Point from X, Y, Z, M and an optional srid. If srid is not set, it defaults to 0 (unknown). Must use ST_AsEWKT function to print the Z and M coordinates. | v1.6.1 | +| [ST_PolygonFromEnvelope](Geometry-Constructors/ST_PolygonFromEnvelope.md) | Geometry | Construct a Polygon from MinX, MinY, MaxX, MaxY. | v1.2.0 | +| [ST_PolygonFromText](Geometry-Constructors/ST_PolygonFromText.md) | Geometry | Construct a Polygon from Text, delimited by Delimiter. Path must be closed | v1.2.0 | ## Geometry Accessors These functions extract information and properties from geometry objects. -| Function | Description | Since | -| :--- | :--- | :--- | -| [GeometryType](Geometry-Accessors/GeometryType.md) | Returns the type of the geometry as a string. Eg: 'LINESTRING', 'POLYGON', 'MULTIPOINT', etc. This function also indicates if the geometry is measured, by returning a string of the form 'POINTM'. | v1.5.0 | -| [ST_Boundary](Geometry-Accessors/ST_Boundary.md) | Returns the closure of the combinatorial boundary of this Geometry. | v1.3.0 | -| [ST_CoordDim](Geometry-Accessors/ST_CoordDim.md) | Returns the coordinate dimensions of the geometry. It is an alias of `ST_NDims`. | v1.5.0 | -| [ST_CrossesDateLine](Geometry-Accessors/ST_CrossesDateLine.md) | This function determines if a given geometry crosses the International Date Line. It operates by checking if the difference in longitude between any pair of consecutive points in the geometry excee... | v1.6.0 | -| [ST_Dimension](Geometry-Accessors/ST_Dimension.md) | Return the topological dimension of this Geometry object, which must be less than or equal to the coordinate dimension. OGC SPEC s2.1.1.1 - returns 0 for POINT, 1 for LINESTRING, 2 for POLYGON, and... | v1.5.0 | -| [ST_Dump](Geometry-Accessors/ST_Dump.md) | It expands the geometries. If the geometry is simple (Point, Polygon Linestring etc.) it returns the geometry itself, if the geometry is collection or multi it returns record for each of collection... | v1.5.0 | -| [ST_DumpPoints](Geometry-Accessors/ST_DumpPoints.md) | Returns list of Points which geometry consists of. | v1.5.0 | -| [ST_EndPoint](Geometry-Accessors/ST_EndPoint.md) | Returns last point of given linestring. | v1.5.0 | -| [ST_ExteriorRing](Geometry-Accessors/ST_ExteriorRing.md) | Returns a LINESTRING representing the exterior ring (shell) of a POLYGON. Returns NULL if the geometry is not a polygon. | v1.2.1 | -| [ST_GeometryN](Geometry-Accessors/ST_GeometryN.md) | Return the 0-based Nth geometry if the geometry is a GEOMETRYCOLLECTION, (MULTI)POINT, (MULTI)LINESTRING, MULTICURVE or (MULTI)POLYGON. Otherwise, return null | v1.3.0 | -| [ST_GeometryType](Geometry-Accessors/ST_GeometryType.md) | Returns the type of the geometry as a string. EG: 'ST_Linestring', 'ST_Polygon' etc. | v1.5.0 | -| [ST_HasM](Geometry-Accessors/ST_HasM.md) | Checks for the presence of M coordinate values representing measures or linear references. Returns true if the input geometry includes an M coordinate, false otherwise. | v1.6.1 | -| [ST_HasZ](Geometry-Accessors/ST_HasZ.md) | Checks for the presence of Z coordinate values representing measures or linear references. Returns true if the input geometry includes an Z coordinate, false otherwise. | v1.6.1 | -| [ST_InteriorRingN](Geometry-Accessors/ST_InteriorRingN.md) | Returns the Nth interior linestring ring of the polygon geometry. Returns NULL if the geometry is not a polygon or the given N is out of range | v1.3.0 | -| [ST_IsClosed](Geometry-Accessors/ST_IsClosed.md) | RETURNS true if the LINESTRING start and end point are the same. | v1.3.0 | -| [ST_IsCollection](Geometry-Accessors/ST_IsCollection.md) | Returns `TRUE` if the geometry type of the input is a geometry collection type. Collection types are the following: | v1.5.0 | -| [ST_IsEmpty](Geometry-Accessors/ST_IsEmpty.md) | Test if a geometry is empty geometry | v1.2.1 | -| [ST_IsPolygonCCW](Geometry-Accessors/ST_IsPolygonCCW.md) | Returns true if all polygonal components in the input geometry have their exterior rings oriented counter-clockwise and interior rings oriented clockwise. | v1.6.0 | -| [ST_IsPolygonCW](Geometry-Accessors/ST_IsPolygonCW.md) | Returns true if all polygonal components in the input geometry have their exterior rings oriented counter-clockwise and interior rings oriented clockwise. | v1.6.0 | -| [ST_IsRing](Geometry-Accessors/ST_IsRing.md) | RETURN true if LINESTRING is ST_IsClosed and ST_IsSimple. | v1.3.0 | -| [ST_IsSimple](Geometry-Accessors/ST_IsSimple.md) | Test if geometry's only self-intersections are at boundary points. | v1.3.0 | -| [ST_M](Geometry-Accessors/ST_M.md) | Returns M Coordinate of given Point, null otherwise. | v1.6.1 | -| [ST_NDims](Geometry-Accessors/ST_NDims.md) | Returns the coordinate dimension of the geometry. | v1.3.1 | -| [ST_NPoints](Geometry-Accessors/ST_NPoints.md) | Returns the number of points of the geometry | v1.3.0 | -| [ST_NRings](Geometry-Accessors/ST_NRings.md) | Returns the number of rings in a Polygon or MultiPolygon. Contrary to ST_NumInteriorRings, this function also takes into account the number of exterior rings. | v1.4.1 | -| [ST_NumGeometries](Geometry-Accessors/ST_NumGeometries.md) | Returns the number of Geometries. If geometry is a GEOMETRYCOLLECTION (or MULTI*) return the number of geometries, for single geometries will return 1. | v1.3.0 | -| [ST_NumInteriorRing](Geometry-Accessors/ST_NumInteriorRing.md) | Returns number of interior rings of polygon geometries. It is an alias of [ST_NumInteriorRings](Geometry-Accessors/ST_NumInteriorRings.md). | v1.6.1 | -| [ST_NumInteriorRings](Geometry-Accessors/ST_NumInteriorRings.md) | Returns number of interior rings of polygon geometries. | v1.3.0 | -| [ST_NumPoints](Geometry-Accessors/ST_NumPoints.md) | Returns number of points in a LineString. | v1.4.1 | -| [ST_PointN](Geometry-Accessors/ST_PointN.md) | Return the Nth point in a single linestring or circular linestring in the geometry. Negative values are counted backwards from the end of the LineString, so that -1 is the last point. Returns NULL ... | v1.2.1 | -| [ST_Points](Geometry-Accessors/ST_Points.md) | Returns a MultiPoint geometry consisting of all the coordinates of the input geometry. It preserves duplicate points as well as M and Z coordinates. | v1.6.1 | -| [ST_StartPoint](Geometry-Accessors/ST_StartPoint.md) | Returns first point of given linestring. | v1.5.0 | -| [ST_X](Geometry-Accessors/ST_X.md) | Returns X Coordinate of given Point, null otherwise. | v1.3.0 | -| [ST_Y](Geometry-Accessors/ST_Y.md) | Returns Y Coordinate of given Point, null otherwise. | v1.3.0 | -| [ST_Z](Geometry-Accessors/ST_Z.md) | Returns Z Coordinate of given Point, null otherwise. | v1.3.0 | -| [ST_Zmflag](Geometry-Accessors/ST_Zmflag.md) | Returns a code indicating the Z and M coordinate dimensions present in the input geometry. | v1.6.1 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [GeometryType](Geometry-Accessors/GeometryType.md) | String | Returns the type of the geometry as a string. Eg: 'LINESTRING', 'POLYGON', 'MULTIPOINT', etc. This function also indicates if the geometry is measured, by returning a string of the form 'POINTM'. | v1.5.0 | +| [ST_Boundary](Geometry-Accessors/ST_Boundary.md) | Geometry | Returns the closure of the combinatorial boundary of this Geometry. | v1.3.0 | +| [ST_CoordDim](Geometry-Accessors/ST_CoordDim.md) | Integer | Returns the coordinate dimensions of the geometry. It is an alias of `ST_NDims`. | v1.5.0 | +| [ST_CrossesDateLine](Geometry-Accessors/ST_CrossesDateLine.md) | Boolean | This function determines if a given geometry crosses the International Date Line. It operates by checking if the difference in longitude between any pair of consecutive points in the geometry excee... | v1.6.0 | +| [ST_Dimension](Geometry-Accessors/ST_Dimension.md) | Integer | Return the topological dimension of this Geometry object, which must be less than or equal to the coordinate dimension. OGC SPEC s2.1.1.1 - returns 0 for POINT, 1 for LINESTRING, 2 for POLYGON, and... | v1.5.0 | +| [ST_Dump](Geometry-Accessors/ST_Dump.md) | `Array<Geometry>` | It expands the geometries. If the geometry is simple (Point, Polygon Linestring etc.) it returns the geometry itself, if the geometry is collection or multi it returns record for each of collection... | v1.5.0 | +| [ST_DumpPoints](Geometry-Accessors/ST_DumpPoints.md) | `Array<Geometry>` | Returns list of Points which geometry consists of. | v1.5.0 | +| [ST_EndPoint](Geometry-Accessors/ST_EndPoint.md) | Geometry | Returns last point of given linestring. | v1.5.0 | +| [ST_ExteriorRing](Geometry-Accessors/ST_ExteriorRing.md) | Geometry | Returns a LINESTRING representing the exterior ring (shell) of a POLYGON. Returns NULL if the geometry is not a polygon. | v1.2.1 | +| [ST_GeometryN](Geometry-Accessors/ST_GeometryN.md) | Geometry | Return the 0-based Nth geometry if the geometry is a GEOMETRYCOLLECTION, (MULTI)POINT, (MULTI)LINESTRING, MULTICURVE or (MULTI)POLYGON. Otherwise, return null | v1.3.0 | +| [ST_GeometryType](Geometry-Accessors/ST_GeometryType.md) | String | Returns the type of the geometry as a string. EG: 'ST_Linestring', 'ST_Polygon' etc. | v1.5.0 | +| [ST_HasM](Geometry-Accessors/ST_HasM.md) | Boolean | Checks for the presence of M coordinate values representing measures or linear references. Returns true if the input geometry includes an M coordinate, false otherwise. | v1.6.1 | +| [ST_HasZ](Geometry-Accessors/ST_HasZ.md) | Boolean | Checks for the presence of Z coordinate values representing measures or linear references. Returns true if the input geometry includes an Z coordinate, false otherwise. | v1.6.1 | +| [ST_InteriorRingN](Geometry-Accessors/ST_InteriorRingN.md) | Geometry | Returns the Nth interior linestring ring of the polygon geometry. Returns NULL if the geometry is not a polygon or the given N is out of range | v1.3.0 | +| [ST_IsClosed](Geometry-Accessors/ST_IsClosed.md) | Boolean | RETURNS true if the LINESTRING start and end point are the same. | v1.3.0 | +| [ST_IsCollection](Geometry-Accessors/ST_IsCollection.md) | Boolean | Returns `TRUE` if the geometry type of the input is a geometry collection type. Collection types are the following: | v1.5.0 | +| [ST_IsEmpty](Geometry-Accessors/ST_IsEmpty.md) | Boolean | Test if a geometry is empty geometry | v1.2.1 | +| [ST_IsPolygonCCW](Geometry-Accessors/ST_IsPolygonCCW.md) | Boolean | Returns true if all polygonal components in the input geometry have their exterior rings oriented counter-clockwise and interior rings oriented clockwise. | v1.6.0 | +| [ST_IsPolygonCW](Geometry-Accessors/ST_IsPolygonCW.md) | Boolean | Returns true if all polygonal components in the input geometry have their exterior rings oriented counter-clockwise and interior rings oriented clockwise. | v1.6.0 | +| [ST_IsRing](Geometry-Accessors/ST_IsRing.md) | Boolean | RETURN true if LINESTRING is ST_IsClosed and ST_IsSimple. | v1.3.0 | +| [ST_IsSimple](Geometry-Accessors/ST_IsSimple.md) | Boolean | Test if geometry's only self-intersections are at boundary points. | v1.3.0 | +| [ST_M](Geometry-Accessors/ST_M.md) | Double | Returns M Coordinate of given Point, null otherwise. | v1.6.1 | +| [ST_NDims](Geometry-Accessors/ST_NDims.md) | Integer | Returns the coordinate dimension of the geometry. | v1.3.1 | +| [ST_NPoints](Geometry-Accessors/ST_NPoints.md) | Integer | Returns the number of points of the geometry | v1.3.0 | +| [ST_NRings](Geometry-Accessors/ST_NRings.md) | Integer | Returns the number of rings in a Polygon or MultiPolygon. Contrary to ST_NumInteriorRings, this function also takes into account the number of exterior rings. | v1.4.1 | +| [ST_NumGeometries](Geometry-Accessors/ST_NumGeometries.md) | Integer | Returns the number of Geometries. If geometry is a GEOMETRYCOLLECTION (or MULTI*) return the number of geometries, for single geometries will return 1. | v1.3.0 | +| [ST_NumInteriorRing](Geometry-Accessors/ST_NumInteriorRing.md) | Integer | Returns number of interior rings of polygon geometries. It is an alias of [ST_NumInteriorRings](Geometry-Accessors/ST_NumInteriorRings.md). | v1.6.1 | +| [ST_NumInteriorRings](Geometry-Accessors/ST_NumInteriorRings.md) | Integer | Returns number of interior rings of polygon geometries. | v1.3.0 | +| [ST_NumPoints](Geometry-Accessors/ST_NumPoints.md) | Integer | Returns number of points in a LineString. | v1.4.1 | +| [ST_PointN](Geometry-Accessors/ST_PointN.md) | Geometry | Return the Nth point in a single linestring or circular linestring in the geometry. Negative values are counted backwards from the end of the LineString, so that -1 is the last point. Returns NULL ... | v1.2.1 | +| [ST_Points](Geometry-Accessors/ST_Points.md) | Geometry | Returns a MultiPoint geometry consisting of all the coordinates of the input geometry. It preserves duplicate points as well as M and Z coordinates. | v1.6.1 | +| [ST_StartPoint](Geometry-Accessors/ST_StartPoint.md) | Geometry | Returns first point of given linestring. | v1.5.0 | +| [ST_X](Geometry-Accessors/ST_X.md) | Double | Returns X Coordinate of given Point, null otherwise. | v1.3.0 | +| [ST_Y](Geometry-Accessors/ST_Y.md) | Double | Returns Y Coordinate of given Point, null otherwise. | v1.3.0 | +| [ST_Z](Geometry-Accessors/ST_Z.md) | Double | Returns Z Coordinate of given Point, null otherwise. | v1.3.0 | +| [ST_Zmflag](Geometry-Accessors/ST_Zmflag.md) | Integer | Returns a code indicating the Z and M coordinate dimensions present in the input geometry. | v1.6.1 | ## Geometry Editors These functions create modified geometries by changing type, structure, or vertices. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_AddPoint](Geometry-Editors/ST_AddPoint.md) | Return Linestring with additional point at the given index, if position is not available the point will be added at the end of line. | v1.3.0 | -| [ST_Collect](Geometry-Editors/ST_Collect.md) | Returns MultiGeometry object based on geometry column/s or array with geometries | v1.5.0 | -| [ST_CollectionExtract](Geometry-Editors/ST_CollectionExtract.md) | Returns a homogeneous multi-geometry from a given geometry collection. | v1.5.0 | -| [ST_FlipCoordinates](Geometry-Editors/ST_FlipCoordinates.md) | Returns a version of the given geometry with X and Y axis flipped. | v1.2.0 | -| [ST_Force2D](Geometry-Editors/ST_Force2D.md) | Forces the geometries into a "2-dimensional mode" so that all output representations will only have the X and Y coordinates. This function is an alias of [ST_Force_2D](Geometry-Editors/ST_Force_2D.md). | v1.8.0 | -| [ST_Force3D](Geometry-Editors/ST_Force3D.md) | Forces the geometry into a 3-dimensional model so that all output representations will have X, Y and Z coordinates. An optionally given zValue is tacked onto the geometry if the geometry is 2-dimen... | v1.4.1 | -| [ST_Force3DM](Geometry-Editors/ST_Force3DM.md) | Forces the geometry into XYM mode. Retains any existing M coordinate, but removes the Z coordinate if present. Assigns a default M value of 0.0 if `mValue` is not specified. | v1.6.1 | -| [ST_Force3DZ](Geometry-Editors/ST_Force3DZ.md) | Forces the geometry into a 3-dimensional model so that all output representations will have X, Y and Z coordinates. An optionally given zValue is tacked onto the geometry if the geometry is 2-dimen... | v1.6.1 | -| [ST_Force4D](Geometry-Editors/ST_Force4D.md) | Converts the input geometry to 4D XYZM representation. Retains original Z and M values if present. Assigning 0.0 defaults if `mValue` and `zValue` aren't specified. The output contains X, Y, Z, and... | v1.6.1 | -| [ST_Force_2D](Geometry-Editors/ST_Force_2D.md) | Forces the geometries into a "2-dimensional mode" so that all output representations will only have the X and Y coordinates. This function is an alias of [ST_Force2D](Geometry-Editors/ST_Force2D.md). | v1.2.1 | -| [ST_ForceCollection](Geometry-Editors/ST_ForceCollection.md) | This function converts the input geometry into a GeometryCollection, regardless of the original geometry type. If the input is a multipart geometry, such as a MultiPolygon or MultiLineString, it wi... | v1.6.1 | -| [ST_ForcePolygonCCW](Geometry-Editors/ST_ForcePolygonCCW.md) | For (Multi)Polygon geometries, this function sets the exterior ring orientation to counter-clockwise and interior rings to clockwise orientation. Non-polygonal geometries are returned unchanged. | v1.6.0 | -| [ST_ForcePolygonCW](Geometry-Editors/ST_ForcePolygonCW.md) | For (Multi)Polygon geometries, this function sets the exterior ring orientation to clockwise and interior rings to counter-clockwise orientation. Non-polygonal geometries are returned unchanged. | v1.6.0 | -| [ST_ForceRHR](Geometry-Editors/ST_ForceRHR.md) | Sets the orientation of polygon vertex orderings to follow the Right-Hand-Rule convention. The exterior ring will have a clockwise winding order, while any interior rings are oriented counter-clock... | v1.6.1 | -| [ST_LineFromMultiPoint](Geometry-Editors/ST_LineFromMultiPoint.md) | Creates a LineString from a MultiPoint geometry. | v1.3.0 | -| [ST_LineMerge](Geometry-Editors/ST_LineMerge.md) | Returns a LineString or MultiLineString formed by sewing together the constituent line work of a MULTILINESTRING. | v1.5.0 | -| [ST_LineSegments](Geometry-Editors/ST_LineSegments.md) | This function transforms a LineString containing multiple coordinates into an array of LineStrings, each with precisely two coordinates. The `lenient` argument, true by default, prevents an excepti... | v1.7.1 | -| [ST_MakeLine](Geometry-Editors/ST_MakeLine.md) | Creates a LineString containing the points of Point, MultiPoint, or LineString geometries. Other geometry types cause an error. | v1.5.0 | -| [ST_MakePolygon](Geometry-Editors/ST_MakePolygon.md) | Function to convert closed linestring to polygon including holes. If holes are provided, they should be fully contained within the shell. Holes outside the shell will produce an invalid polygon (ma... | v1.5.0 | -| [ST_Multi](Geometry-Editors/ST_Multi.md) | Returns a MultiGeometry object based on the geometry input. ST_Multi is basically an alias for ST_Collect with one geometry. | v1.5.0 | -| [ST_Normalize](Geometry-Editors/ST_Normalize.md) | Returns the input geometry in its normalized form. | v1.3.0 | -| [ST_Polygon](Geometry-Editors/ST_Polygon.md) | Function to create a polygon built from the given LineString and sets the spatial reference system from the srid | v1.5.0 | -| [ST_Project](Geometry-Editors/ST_Project.md) | Calculates a new point location given a starting point, distance, and azimuth. The azimuth indicates the direction, expressed in radians, and is measured in a clockwise manner starting from true no... | v1.7.0 | -| [ST_RemovePoint](Geometry-Editors/ST_RemovePoint.md) | Return Linestring with removed point at given index, position can be omitted and then last one will be removed. | v1.3.0 | -| [ST_RemoveRepeatedPoints](Geometry-Editors/ST_RemoveRepeatedPoints.md) | This function eliminates consecutive duplicate points within a geometry, preserving endpoints of LineStrings. It operates on (Multi)LineStrings, (Multi)Polygons, and MultiPoints, processing Geometr... | v1.7.0 | -| [ST_Reverse](Geometry-Editors/ST_Reverse.md) | Return the geometry with vertex order reversed | v1.2.1 | -| [ST_Segmentize](Geometry-Editors/ST_Segmentize.md) | Returns a modified geometry having no segment longer than the given max_segment_length. | v1.8.0 | -| [ST_SetPoint](Geometry-Editors/ST_SetPoint.md) | Replace Nth point of linestring with given point. Index is 0-based. Negative index are counted backwards, e.g., -1 is last point. | v1.3.0 | -| [ST_ShiftLongitude](Geometry-Editors/ST_ShiftLongitude.md) | Modifies longitude coordinates in geometries, shifting values between -180..0 degrees to 180..360 degrees and vice versa. This is useful for normalizing data across the International Date Line and ... | v1.6.0 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_AddPoint](Geometry-Editors/ST_AddPoint.md) | Geometry | Return Linestring with additional point at the given index, if position is not available the point will be added at the end of line. | v1.3.0 | +| [ST_Collect](Geometry-Editors/ST_Collect.md) | Geometry | Returns MultiGeometry object based on geometry column/s or array with geometries | v1.5.0 | +| [ST_CollectionExtract](Geometry-Editors/ST_CollectionExtract.md) | Geometry | Returns a homogeneous multi-geometry from a given geometry collection. | v1.5.0 | +| [ST_FlipCoordinates](Geometry-Editors/ST_FlipCoordinates.md) | Geometry | Returns a version of the given geometry with X and Y axis flipped. | v1.2.0 | +| [ST_Force2D](Geometry-Editors/ST_Force2D.md) | Geometry | Forces the geometries into a "2-dimensional mode" so that all output representations will only have the X and Y coordinates. This function is an alias of [ST_Force_2D](Geometry-Editors/ST_Force_2D.md). | v1.8.0 | +| [ST_Force3D](Geometry-Editors/ST_Force3D.md) | Geometry | Forces the geometry into a 3-dimensional model so that all output representations will have X, Y and Z coordinates. An optionally given zValue is tacked onto the geometry if the geometry is 2-dimen... | v1.4.1 | +| [ST_Force3DM](Geometry-Editors/ST_Force3DM.md) | Geometry | Forces the geometry into XYM mode. Retains any existing M coordinate, but removes the Z coordinate if present. Assigns a default M value of 0.0 if `mValue` is not specified. | v1.6.1 | +| [ST_Force3DZ](Geometry-Editors/ST_Force3DZ.md) | Geometry | Forces the geometry into a 3-dimensional model so that all output representations will have X, Y and Z coordinates. An optionally given zValue is tacked onto the geometry if the geometry is 2-dimen... | v1.6.1 | +| [ST_Force4D](Geometry-Editors/ST_Force4D.md) | Geometry | Converts the input geometry to 4D XYZM representation. Retains original Z and M values if present. Assigning 0.0 defaults if `mValue` and `zValue` aren't specified. The output contains X, Y, Z, and... | v1.6.1 | +| [ST_Force_2D](Geometry-Editors/ST_Force_2D.md) | Geometry | Forces the geometries into a "2-dimensional mode" so that all output representations will only have the X and Y coordinates. This function is an alias of [ST_Force2D](Geometry-Editors/ST_Force2D.md). | v1.2.1 | +| [ST_ForceCollection](Geometry-Editors/ST_ForceCollection.md) | Geometry | This function converts the input geometry into a GeometryCollection, regardless of the original geometry type. If the input is a multipart geometry, such as a MultiPolygon or MultiLineString, it wi... | v1.6.1 | +| [ST_ForcePolygonCCW](Geometry-Editors/ST_ForcePolygonCCW.md) | Geometry | For (Multi)Polygon geometries, this function sets the exterior ring orientation to counter-clockwise and interior rings to clockwise orientation. Non-polygonal geometries are returned unchanged. | v1.6.0 | +| [ST_ForcePolygonCW](Geometry-Editors/ST_ForcePolygonCW.md) | Geometry | For (Multi)Polygon geometries, this function sets the exterior ring orientation to clockwise and interior rings to counter-clockwise orientation. Non-polygonal geometries are returned unchanged. | v1.6.0 | +| [ST_ForceRHR](Geometry-Editors/ST_ForceRHR.md) | Geometry | Sets the orientation of polygon vertex orderings to follow the Right-Hand-Rule convention. The exterior ring will have a clockwise winding order, while any interior rings are oriented counter-clock... | v1.6.1 | +| [ST_LineFromMultiPoint](Geometry-Editors/ST_LineFromMultiPoint.md) | Geometry | Creates a LineString from a MultiPoint geometry. | v1.3.0 | +| [ST_LineMerge](Geometry-Editors/ST_LineMerge.md) | Geometry | Returns a LineString or MultiLineString formed by sewing together the constituent line work of a MULTILINESTRING. | v1.5.0 | +| [ST_LineSegments](Geometry-Editors/ST_LineSegments.md) | `Array<Geometry>` | This function transforms a LineString containing multiple coordinates into an array of LineStrings, each with precisely two coordinates. The `lenient` argument, true by default, prevents an excepti... | v1.7.1 | +| [ST_MakeLine](Geometry-Editors/ST_MakeLine.md) | Geometry | Creates a LineString containing the points of Point, MultiPoint, or LineString geometries. Other geometry types cause an error. | v1.5.0 | +| [ST_MakePolygon](Geometry-Editors/ST_MakePolygon.md) | Geometry | Function to convert closed linestring to polygon including holes. If holes are provided, they should be fully contained within the shell. Holes outside the shell will produce an invalid polygon (ma... | v1.5.0 | +| [ST_Multi](Geometry-Editors/ST_Multi.md) | Geometry | Returns a MultiGeometry object based on the geometry input. ST_Multi is basically an alias for ST_Collect with one geometry. | v1.5.0 | +| [ST_Normalize](Geometry-Editors/ST_Normalize.md) | Geometry | Returns the input geometry in its normalized form. | v1.3.0 | +| [ST_Polygon](Geometry-Editors/ST_Polygon.md) | Geometry | Function to create a polygon built from the given LineString and sets the spatial reference system from the srid | v1.5.0 | +| [ST_Project](Geometry-Editors/ST_Project.md) | Geometry | Calculates a new point location given a starting point, distance, and azimuth. The azimuth indicates the direction, expressed in radians, and is measured in a clockwise manner starting from true no... | v1.7.0 | +| [ST_RemovePoint](Geometry-Editors/ST_RemovePoint.md) | Geometry | Return Linestring with removed point at given index, position can be omitted and then last one will be removed. | v1.3.0 | +| [ST_RemoveRepeatedPoints](Geometry-Editors/ST_RemoveRepeatedPoints.md) | Geometry | This function eliminates consecutive duplicate points within a geometry, preserving endpoints of LineStrings. It operates on (Multi)LineStrings, (Multi)Polygons, and MultiPoints, processing Geometr... | v1.7.0 | +| [ST_Reverse](Geometry-Editors/ST_Reverse.md) | Geometry | Return the geometry with vertex order reversed | v1.2.1 | +| [ST_Segmentize](Geometry-Editors/ST_Segmentize.md) | Geometry | Returns a modified geometry having no segment longer than the given max_segment_length. | v1.8.0 | +| [ST_SetPoint](Geometry-Editors/ST_SetPoint.md) | Geometry | Replace Nth point of linestring with given point. Index is 0-based. Negative index are counted backwards, e.g., -1 is last point. | v1.3.0 | +| [ST_ShiftLongitude](Geometry-Editors/ST_ShiftLongitude.md) | Geometry | Modifies longitude coordinates in geometries, shifting values between -180..0 degrees to 180..360 degrees and vice versa. This is useful for normalizing data across the International Date Line and ... | v1.6.0 | ## Geometry Output These functions convert geometry objects into various textual or binary formats. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_AsBinary](Geometry-Output/ST_AsBinary.md) | Return the Well-Known Binary representation of a geometry | v1.3.0 | -| [ST_AsEWKB](Geometry-Output/ST_AsEWKB.md) | Return the Extended Well-Known Binary representation of a geometry. EWKB is an extended version of WKB which includes the SRID of the geometry. The format originated in PostGIS but is supported by ... | v1.3.0 | -| [ST_AsEWKT](Geometry-Output/ST_AsEWKT.md) | Return the Extended Well-Known Text representation of a geometry. EWKT is an extended version of WKT which includes the SRID of the geometry. The format originated in PostGIS but is supported by ma... | v1.2.1 | -| [ST_AsGeoJSON](Geometry-Output/ST_AsGeoJSON.md) | Return the [GeoJSON](https://geojson.org/) string representation of a geometry. | v1.6.1 | -| [ST_AsGML](Geometry-Output/ST_AsGML.md) | Return the [GML](https://www.ogc.org/standards/gml) string representation of a geometry | v1.3.0 | -| [ST_AsHEXEWKB](Geometry-Output/ST_AsHEXEWKB.md) | This function returns the input geometry encoded to a text representation in HEXEWKB format. The HEXEWKB encoding can use either little-endian (NDR) or big-endian (XDR) byte ordering. If no encoding... | v1.6.1 | -| [ST_AsKML](Geometry-Output/ST_AsKML.md) | Return the [KML](https://www.ogc.org/standards/kml) string representation of a geometry | v1.3.0 | -| [ST_AsText](Geometry-Output/ST_AsText.md) | Return the Well-Known Text string representation of a geometry. It will support M coordinate if present since v1.5.0. | v1.3.0 | -| [ST_GeoHash](Geometry-Output/ST_GeoHash.md) | Returns GeoHash of the geometry with given precision | v1.2.0 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_AsBinary](Geometry-Output/ST_AsBinary.md) | Binary | Return the Well-Known Binary representation of a geometry | v1.3.0 | +| [ST_AsEWKB](Geometry-Output/ST_AsEWKB.md) | Binary | Return the Extended Well-Known Binary representation of a geometry. EWKB is an extended version of WKB which includes the SRID of the geometry. The format originated in PostGIS but is supported by ... | v1.3.0 | +| [ST_AsEWKT](Geometry-Output/ST_AsEWKT.md) | String | Return the Extended Well-Known Text representation of a geometry. EWKT is an extended version of WKT which includes the SRID of the geometry. The format originated in PostGIS but is supported by ma... | v1.2.1 | +| [ST_AsGeoJSON](Geometry-Output/ST_AsGeoJSON.md) | String | Return the [GeoJSON](https://geojson.org/) string representation of a geometry. | v1.6.1 | +| [ST_AsGML](Geometry-Output/ST_AsGML.md) | String | Return the [GML](https://www.ogc.org/standards/gml) string representation of a geometry | v1.3.0 | +| [ST_AsHEXEWKB](Geometry-Output/ST_AsHEXEWKB.md) | String | This function returns the input geometry encoded to a text representation in HEXEWKB format. The HEXEWKB encoding can use either little-endian (NDR) or big-endian (XDR) byte ordering. If no encoding... | v1.6.1 | +| [ST_AsKML](Geometry-Output/ST_AsKML.md) | String | Return the [KML](https://www.ogc.org/standards/kml) string representation of a geometry | v1.3.0 | +| [ST_AsText](Geometry-Output/ST_AsText.md) | String | Return the Well-Known Text string representation of a geometry. It will support M coordinate if present since v1.5.0. | v1.3.0 | +| [ST_GeoHash](Geometry-Output/ST_GeoHash.md) | String | Returns GeoHash of the geometry with given precision | v1.2.0 | ## Predicates These functions test spatial relationships between geometries, returning boolean values. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_Contains](Predicates/ST_Contains.md) | Return true if A fully contains B | v1.2.0 | -| [ST_CoveredBy](Predicates/ST_CoveredBy.md) | Return true if A is covered by B | v1.3.0 | -| [ST_Covers](Predicates/ST_Covers.md) | Return true if A covers B | v1.3.0 | -| [ST_Crosses](Predicates/ST_Crosses.md) | Return true if A crosses B | v1.5.0 | -| [ST_Disjoint](Predicates/ST_Disjoint.md) | Return true if A and B are disjoint | v1.2.1 | -| [ST_DWithin](Predicates/ST_DWithin.md) | Returns true if 'leftGeometry' and 'rightGeometry' are within a specified 'distance'. | v1.5.1 | -| [ST_Equals](Predicates/ST_Equals.md) | Return true if A equals to B | v1.5.0 | -| [ST_Intersects](Predicates/ST_Intersects.md) | Return true if A intersects B | v1.2.0 | -| [ST_OrderingEquals](Predicates/ST_OrderingEquals.md) | Returns true if the geometries are equal and the coordinates are in the same order | v1.2.1 | -| [ST_Overlaps](Predicates/ST_Overlaps.md) | Return true if A overlaps B | v1.5.0 | -| [ST_Relate](Predicates/ST_Relate.md) | The first variant of the function computes and returns the [Dimensionally Extended 9-Intersection Model (DE-9IM)](https://en.wikipedia.org/wiki/DE-9IM) matrix string representing the spatial relati... | v1.6.1 | -| [ST_RelateMatch](Predicates/ST_RelateMatch.md) | This function tests the relationship between two [Dimensionally Extended 9-Intersection Model (DE-9IM)](https://en.wikipedia.org/wiki/DE-9IM) matrices representing geometry intersections. It evalua... | v1.6.1 | -| [ST_Touches](Predicates/ST_Touches.md) | Return true if A touches B | v1.5.0 | -| [ST_Within](Predicates/ST_Within.md) | Return true if A is within B | v1.3.0 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_Contains](Predicates/ST_Contains.md) | Boolean | Return true if A fully contains B | v1.2.0 | +| [ST_CoveredBy](Predicates/ST_CoveredBy.md) | Boolean | Return true if A is covered by B | v1.3.0 | +| [ST_Covers](Predicates/ST_Covers.md) | Boolean | Return true if A covers B | v1.3.0 | +| [ST_Crosses](Predicates/ST_Crosses.md) | Boolean | Return true if A crosses B | v1.5.0 | +| [ST_Disjoint](Predicates/ST_Disjoint.md) | Boolean | Return true if A and B are disjoint | v1.2.1 | +| [ST_DWithin](Predicates/ST_DWithin.md) | Boolean | Returns true if 'leftGeometry' and 'rightGeometry' are within a specified 'distance'. | v1.5.1 | +| [ST_Equals](Predicates/ST_Equals.md) | Boolean | Return true if A equals to B | v1.5.0 | +| [ST_Intersects](Predicates/ST_Intersects.md) | Boolean | Return true if A intersects B | v1.2.0 | +| [ST_OrderingEquals](Predicates/ST_OrderingEquals.md) | Boolean | Returns true if the geometries are equal and the coordinates are in the same order | v1.2.1 | +| [ST_Overlaps](Predicates/ST_Overlaps.md) | Boolean | Return true if A overlaps B | v1.5.0 | +| [ST_Relate](Predicates/ST_Relate.md) | String | The first variant of the function computes and returns the [Dimensionally Extended 9-Intersection Model (DE-9IM)](https://en.wikipedia.org/wiki/DE-9IM) matrix string representing the spatial relati... | v1.6.1 | +| [ST_RelateMatch](Predicates/ST_RelateMatch.md) | Boolean | This function tests the relationship between two [Dimensionally Extended 9-Intersection Model (DE-9IM)](https://en.wikipedia.org/wiki/DE-9IM) matrices representing geometry intersections. It evalua... | v1.6.1 | +| [ST_Touches](Predicates/ST_Touches.md) | Boolean | Return true if A touches B | v1.5.0 | +| [ST_Within](Predicates/ST_Within.md) | Boolean | Return true if A is within B | v1.3.0 | ## Measurement Functions These functions compute measurements of distance, area, length, and angles. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_3DDistance](Measurement-Functions/ST_3DDistance.md) | Return the 3-dimensional minimum cartesian distance between A and B | v1.3.0 | -| [ST_Angle](Measurement-Functions/ST_Angle.md) | Compute and return the angle between two vectors represented by the provided points or linestrings. | v1.5.0 | -| [ST_Area](Measurement-Functions/ST_Area.md) | Return the area of A | v1.3.0 | -| [ST_AreaSpheroid](Measurement-Functions/ST_AreaSpheroid.md) | Return the geodesic area of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Area` + `ST_Transform`. It is equivalent to PostGIS `ST_Area(geo... | v1.4.1 | -| [ST_Azimuth](Measurement-Functions/ST_Azimuth.md) | Returns Azimuth for two given points in radians. Returns null if the two points are identical. | v1.3.0 | -| [ST_ClosestPoint](Measurement-Functions/ST_ClosestPoint.md) | Returns the 2-dimensional point on geom1 that is closest to geom2. This is the first point of the shortest line between the geometries. If using 3D geometries, the Z coordinates will be ignored. If... | v1.5.0 | -| [ST_Degrees](Measurement-Functions/ST_Degrees.md) | Convert an angle in radian to degrees. | v1.5.0 | -| [ST_Distance](Measurement-Functions/ST_Distance.md) | Return the Euclidean distance between A and B | v1.2.0 | -| [ST_DistanceSphere](Measurement-Functions/ST_DistanceSphere.md) | Return the haversine / great-circle distance of A using a given earth radius (default radius: 6371008.0). Unit is meter. Works better for large geometries (country level) compared to `ST_Distance` ... | v1.4.1 | -| [ST_DistanceSpheroid](Measurement-Functions/ST_DistanceSpheroid.md) | Return the geodesic distance of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Distance` + `ST_Transform`. It is equivalent to PostGIS `ST_... | v1.4.1 | -| [ST_FrechetDistance](Measurement-Functions/ST_FrechetDistance.md) | Computes and returns discrete [Frechet Distance](https://en.wikipedia.org/wiki/Fr%C3%A9chet_distance) between the given two geometries, based on [Computing Discrete Frechet Distance](http://www.kr.... | v1.5.0 | -| [ST_HausdorffDistance](Measurement-Functions/ST_HausdorffDistance.md) | Returns a discretized (and hence approximate) [Hausdorff distance](https://en.wikipedia.org/wiki/Hausdorff_distance) between the given 2 geometries. Optionally, a densityFraction parameter can be s... | v1.5.0 | -| [ST_Length](Measurement-Functions/ST_Length.md) | Returns the perimeter of A. | v1.3.0 | -| [ST_Length2D](Measurement-Functions/ST_Length2D.md) | Returns the perimeter of A. This function is an alias of [ST_Length](Measurement-Functions/ST_Length.md). | v1.6.1 | -| [ST_LengthSpheroid](Measurement-Functions/ST_LengthSpheroid.md) | Return the geodesic perimeter of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Length` + `ST_Transform`. It is equivalent to PostGIS `ST_L... | v1.4.1 | -| [ST_LongestLine](Measurement-Functions/ST_LongestLine.md) | Returns the LineString geometry representing the maximum distance between any two points from the input geometries. | v1.6.1 | -| [ST_MaxDistance](Measurement-Functions/ST_MaxDistance.md) | Calculates and returns the length value representing the maximum distance between any two points across the input geometries. This function is an alias for `ST_LongestDistance`. | v1.6.1 | -| [ST_MinimumClearance](Measurement-Functions/ST_MinimumClearance.md) | The minimum clearance is a metric that quantifies a geometry's tolerance to changes in coordinate precision or vertex positions. It represents the maximum distance by which vertices can be adjusted... | v1.6.1 | -| [ST_MinimumClearanceLine](Measurement-Functions/ST_MinimumClearanceLine.md) | This function returns a two-point LineString geometry representing the minimum clearance distance of the input geometry. If the input geometry does not have a defined minimum clearance, such as for... | v1.6.1 | -| [ST_Perimeter](Measurement-Functions/ST_Perimeter.md) | This function calculates the 2D perimeter of a given geometry. It supports Polygon, MultiPolygon, and GeometryCollection geometries (as long as the GeometryCollection contains polygonal geometries)... | v1.7.0 | -| [ST_Perimeter2D](Measurement-Functions/ST_Perimeter2D.md) | This function calculates the 2D perimeter of a given geometry. It supports Polygon, MultiPolygon, and GeometryCollection geometries (as long as the GeometryCollection contains polygonal geometries)... | v1.7.1 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_3DDistance](Measurement-Functions/ST_3DDistance.md) | Double | Return the 3-dimensional minimum cartesian distance between A and B | v1.3.0 | +| [ST_Angle](Measurement-Functions/ST_Angle.md) | Double | Compute and return the angle between two vectors represented by the provided points or linestrings. | v1.5.0 | +| [ST_Area](Measurement-Functions/ST_Area.md) | Double | Return the area of A | v1.3.0 | +| [ST_AreaSpheroid](Measurement-Functions/ST_AreaSpheroid.md) | Double | Return the geodesic area of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Area` + `ST_Transform`. It is equivalent to PostGIS `ST_Area(geo... | v1.4.1 | +| [ST_Azimuth](Measurement-Functions/ST_Azimuth.md) | Double | Returns Azimuth for two given points in radians. Returns null if the two points are identical. | v1.3.0 | +| [ST_ClosestPoint](Measurement-Functions/ST_ClosestPoint.md) | Geometry | Returns the 2-dimensional point on geom1 that is closest to geom2. This is the first point of the shortest line between the geometries. If using 3D geometries, the Z coordinates will be ignored. If... | v1.5.0 | +| [ST_Degrees](Measurement-Functions/ST_Degrees.md) | Double | Convert an angle in radian to degrees. | v1.5.0 | +| [ST_Distance](Measurement-Functions/ST_Distance.md) | Double | Return the Euclidean distance between A and B | v1.2.0 | +| [ST_DistanceSphere](Measurement-Functions/ST_DistanceSphere.md) | Double | Return the haversine / great-circle distance of A using a given earth radius (default radius: 6371008.0). Unit is meter. Works better for large geometries (country level) compared to `ST_Distance` ... | v1.4.1 | +| [ST_DistanceSpheroid](Measurement-Functions/ST_DistanceSpheroid.md) | Double | Return the geodesic distance of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Distance` + `ST_Transform`. It is equivalent to PostGIS `ST_... | v1.4.1 | +| [ST_FrechetDistance](Measurement-Functions/ST_FrechetDistance.md) | Double | Computes and returns discrete [Frechet Distance](https://en.wikipedia.org/wiki/Fr%C3%A9chet_distance) between the given two geometries, based on [Computing Discrete Frechet Distance](http://www.kr.... | v1.5.0 | +| [ST_HausdorffDistance](Measurement-Functions/ST_HausdorffDistance.md) | Double | Returns a discretized (and hence approximate) [Hausdorff distance](https://en.wikipedia.org/wiki/Hausdorff_distance) between the given 2 geometries. Optionally, a densityFraction parameter can be s... | v1.5.0 | +| [ST_Length](Measurement-Functions/ST_Length.md) | Double | Returns the perimeter of A. | v1.3.0 | +| [ST_Length2D](Measurement-Functions/ST_Length2D.md) | Double | Returns the perimeter of A. This function is an alias of [ST_Length](Measurement-Functions/ST_Length.md). | v1.6.1 | +| [ST_LengthSpheroid](Measurement-Functions/ST_LengthSpheroid.md) | Double | Return the geodesic perimeter of A using WGS84 spheroid. Unit is meter. Works better for large geometries (country level) compared to `ST_Length` + `ST_Transform`. It is equivalent to PostGIS `ST_L... | v1.4.1 | +| [ST_LongestLine](Measurement-Functions/ST_LongestLine.md) | Geometry | Returns the LineString geometry representing the maximum distance between any two points from the input geometries. | v1.6.1 | +| [ST_MaxDistance](Measurement-Functions/ST_MaxDistance.md) | Double | Calculates and returns the length value representing the maximum distance between any two points across the input geometries. This function is an alias for `ST_LongestDistance`. | v1.6.1 | +| [ST_MinimumClearance](Measurement-Functions/ST_MinimumClearance.md) | Double | The minimum clearance is a metric that quantifies a geometry's tolerance to changes in coordinate precision or vertex positions. It represents the maximum distance by which vertices can be adjusted... | v1.6.1 | +| [ST_MinimumClearanceLine](Measurement-Functions/ST_MinimumClearanceLine.md) | Geometry | This function returns a two-point LineString geometry representing the minimum clearance distance of the input geometry. If the input geometry does not have a defined minimum clearance, such as for... | v1.6.1 | +| [ST_Perimeter](Measurement-Functions/ST_Perimeter.md) | Double | This function calculates the 2D perimeter of a given geometry. It supports Polygon, MultiPolygon, and GeometryCollection geometries (as long as the GeometryCollection contains polygonal geometries)... | v1.7.0 | +| [ST_Perimeter2D](Measurement-Functions/ST_Perimeter2D.md) | Double | This function calculates the 2D perimeter of a given geometry. It supports Polygon, MultiPolygon, and GeometryCollection geometries (as long as the GeometryCollection contains polygonal geometries)... | v1.7.1 | ## Geometry Processing These functions compute geometric constructions, or alter geometry size or shape. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_ApproximateMedialAxis](Geometry-Processing/ST_ApproximateMedialAxis.md) | Computes an approximate medial axis of a polygonal geometry. The medial axis is a representation of the "centerline" or "skeleton" of the polygon. This function first computes the straight skeleton... | v1.8.0 | -| [ST_Buffer](Geometry-Processing/ST_Buffer.md) | Returns a geometry/geography that represents all points whose distance from this Geometry/geography is less than or equal to distance. The function supports both Planar/Euclidean and Spheroidal/Geo... | v1.6.0 | -| [ST_BuildArea](Geometry-Processing/ST_BuildArea.md) | Returns the areal geometry formed by the constituent linework of the input geometry. | v1.2.1 | -| [ST_Centroid](Geometry-Processing/ST_Centroid.md) | Return the centroid point of A | v1.5.0 | -| [ST_ConcaveHull](Geometry-Processing/ST_ConcaveHull.md) | Return the Concave Hull of polygon A, with alpha set to pctConvex[0, 1] in the Delaunay Triangulation method, the concave hull will not contain a hole unless allowHoles is set to true | v1.4.0 | -| [ST_ConvexHull](Geometry-Processing/ST_ConvexHull.md) | Return the Convex Hull of polygon A | v1.5.0 | -| [ST_DelaunayTriangles](Geometry-Processing/ST_DelaunayTriangles.md) | This function computes the [Delaunay triangulation](https://en.wikipedia.org/wiki/Delaunay_triangulation) for the set of vertices in the input geometry. An optional `tolerance` parameter allows sna... | v1.6.1 | -| [ST_GeneratePoints](Geometry-Processing/ST_GeneratePoints.md) | Generates a specified quantity of pseudo-random points within the boundaries of the provided polygonal geometry. When `seed` is either zero or not defined then output will be random. | v1.6.1 | -| [ST_GeometricMedian](Geometry-Processing/ST_GeometricMedian.md) | Computes the approximate geometric median of a MultiPoint geometry using the Weiszfeld algorithm. The geometric median provides a centrality measure that is less sensitive to outlier points than th... | v1.4.1 | -| [ST_LabelPoint](Geometry-Processing/ST_LabelPoint.md) | `ST_LabelPoint` computes and returns a label point for a given polygon or geometry collection. The label point is chosen to be sufficiently far from boundaries of the geometry. For a regular Polygo... | v1.7.1 | -| [ST_MinimumBoundingCircle](Geometry-Processing/ST_MinimumBoundingCircle.md) | Returns the smallest circle polygon that contains a geometry. The optional quadrantSegments parameter determines how many segments to use per quadrant and the default number of segments is 48. | v1.5.0 | -| [ST_MinimumBoundingRadius](Geometry-Processing/ST_MinimumBoundingRadius.md) | Returns a struct containing the center point and radius of the smallest circle that contains a geometry. | v1.5.0 | -| [ST_OrientedEnvelope](Geometry-Processing/ST_OrientedEnvelope.md) | Returns the minimum-area rotated rectangle enclosing a geometry. The rectangle may be rotated relative to the coordinate axes. Degenerate inputs may result in a Point or LineString being returned. | v1.8.1 | -| [ST_PointOnSurface](Geometry-Processing/ST_PointOnSurface.md) | Returns a POINT guaranteed to lie on the surface. | v1.2.1 | -| [ST_Polygonize](Geometry-Processing/ST_Polygonize.md) | Generates a GeometryCollection composed of polygons that are formed from the linework of an input GeometryCollection. When the input does not contain any linework that forms a polygon, the function... | v1.6.0 | -| [ST_ReducePrecision](Geometry-Processing/ST_ReducePrecision.md) | Reduce the decimals places in the coordinates of the geometry to the given number of decimal places. The last decimal place will be rounded. | v1.5.0 | -| [ST_Simplify](Geometry-Processing/ST_Simplify.md) | This function simplifies the input geometry by applying the Douglas-Peucker algorithm. | v1.7.0 | -| [ST_SimplifyPolygonHull](Geometry-Processing/ST_SimplifyPolygonHull.md) | This function computes a topology-preserving simplified hull, either outer or inner, for a polygonal geometry input. An outer hull fully encloses the original geometry, while an inner hull lies ent... | v1.6.1 | -| [ST_SimplifyPreserveTopology](Geometry-Processing/ST_SimplifyPreserveTopology.md) | Simplifies a geometry and ensures that the result is a valid geometry having the same dimension and number of components as the input, and with the components having the same topological relationship. | v1.5.0 | -| [ST_SimplifyVW](Geometry-Processing/ST_SimplifyVW.md) | This function simplifies the input geometry by applying the Visvalingam-Whyatt algorithm. | v1.6.1 | -| [ST_Snap](Geometry-Processing/ST_Snap.md) | Snaps the vertices and segments of the `input` geometry to `reference` geometry within the specified `tolerance` distance. The `tolerance` parameter controls the maximum snap distance. | v1.6.0 | -| [ST_StraightSkeleton](Geometry-Processing/ST_StraightSkeleton.md) | Computes the straight skeleton of a polygonal geometry. The straight skeleton is a method of representing a polygon by a topological skeleton, formed by a continuous shrinking process where each ed... | v1.8.0 | -| [ST_TriangulatePolygon](Geometry-Processing/ST_TriangulatePolygon.md) | Generates the constrained Delaunay triangulation for the input Polygon. The constrained Delaunay triangulation is a set of triangles created from the Polygon's vertices that covers the Polygon area... | v1.6.1 | -| [ST_VoronoiPolygons](Geometry-Processing/ST_VoronoiPolygons.md) | Returns a two-dimensional Voronoi diagram from the vertices of the supplied geometry. The result is a GeometryCollection of Polygons that covers an envelope larger than the extent of the input vert... | v1.5.0 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_ApproximateMedialAxis](Geometry-Processing/ST_ApproximateMedialAxis.md) | Geometry | Computes an approximate medial axis of a polygonal geometry. The medial axis is a representation of the "centerline" or "skeleton" of the polygon. This function first computes the straight skeleton... | v1.8.0 | +| [ST_Buffer](Geometry-Processing/ST_Buffer.md) | Geometry | Returns a geometry/geography that represents all points whose distance from this Geometry/geography is less than or equal to distance. The function supports both Planar/Euclidean and Spheroidal/Geo... | v1.6.0 | +| [ST_BuildArea](Geometry-Processing/ST_BuildArea.md) | Geometry | Returns the areal geometry formed by the constituent linework of the input geometry. | v1.2.1 | +| [ST_Centroid](Geometry-Processing/ST_Centroid.md) | Geometry | Return the centroid point of A | v1.5.0 | +| [ST_ConcaveHull](Geometry-Processing/ST_ConcaveHull.md) | Geometry | Return the Concave Hull of polygon A, with alpha set to pctConvex[0, 1] in the Delaunay Triangulation method, the concave hull will not contain a hole unless allowHoles is set to true | v1.4.0 | +| [ST_ConvexHull](Geometry-Processing/ST_ConvexHull.md) | Geometry | Return the Convex Hull of polygon A | v1.5.0 | +| [ST_DelaunayTriangles](Geometry-Processing/ST_DelaunayTriangles.md) | Geometry | This function computes the [Delaunay triangulation](https://en.wikipedia.org/wiki/Delaunay_triangulation) for the set of vertices in the input geometry. An optional `tolerance` parameter allows sna... | v1.6.1 | +| [ST_GeneratePoints](Geometry-Processing/ST_GeneratePoints.md) | Geometry | Generates a specified quantity of pseudo-random points within the boundaries of the provided polygonal geometry. When `seed` is either zero or not defined then output will be random. | v1.6.1 | +| [ST_GeometricMedian](Geometry-Processing/ST_GeometricMedian.md) | Geometry | Computes the approximate geometric median of a MultiPoint geometry using the Weiszfeld algorithm. The geometric median provides a centrality measure that is less sensitive to outlier points than th... | v1.4.1 | +| [ST_LabelPoint](Geometry-Processing/ST_LabelPoint.md) | Geometry | `ST_LabelPoint` computes and returns a label point for a given polygon or geometry collection. The label point is chosen to be sufficiently far from boundaries of the geometry. For a regular Polygo... | v1.7.1 | +| [ST_MinimumBoundingCircle](Geometry-Processing/ST_MinimumBoundingCircle.md) | Geometry | Returns the smallest circle polygon that contains a geometry. The optional quadrantSegments parameter determines how many segments to use per quadrant and the default number of segments is 48. | v1.5.0 | +| [ST_MinimumBoundingRadius](Geometry-Processing/ST_MinimumBoundingRadius.md) | Struct | Returns a struct containing the center point and radius of the smallest circle that contains a geometry. | v1.5.0 | +| [ST_OrientedEnvelope](Geometry-Processing/ST_OrientedEnvelope.md) | Geometry | Returns the minimum-area rotated rectangle enclosing a geometry. The rectangle may be rotated relative to the coordinate axes. Degenerate inputs may result in a Point or LineString being returned. | v1.8.1 | +| [ST_PointOnSurface](Geometry-Processing/ST_PointOnSurface.md) | Geometry | Returns a POINT guaranteed to lie on the surface. | v1.2.1 | +| [ST_Polygonize](Geometry-Processing/ST_Polygonize.md) | Geometry | Generates a GeometryCollection composed of polygons that are formed from the linework of an input GeometryCollection. When the input does not contain any linework that forms a polygon, the function... | v1.6.0 | +| [ST_ReducePrecision](Geometry-Processing/ST_ReducePrecision.md) | Geometry | Reduce the decimals places in the coordinates of the geometry to the given number of decimal places. The last decimal place will be rounded. | v1.5.0 | +| [ST_Simplify](Geometry-Processing/ST_Simplify.md) | Geometry | This function simplifies the input geometry by applying the Douglas-Peucker algorithm. | v1.7.0 | +| [ST_SimplifyPolygonHull](Geometry-Processing/ST_SimplifyPolygonHull.md) | Geometry | This function computes a topology-preserving simplified hull, either outer or inner, for a polygonal geometry input. An outer hull fully encloses the original geometry, while an inner hull lies ent... | v1.6.1 | +| [ST_SimplifyPreserveTopology](Geometry-Processing/ST_SimplifyPreserveTopology.md) | Geometry | Simplifies a geometry and ensures that the result is a valid geometry having the same dimension and number of components as the input, and with the components having the same topological relationship. | v1.5.0 | +| [ST_SimplifyVW](Geometry-Processing/ST_SimplifyVW.md) | Geometry | This function simplifies the input geometry by applying the Visvalingam-Whyatt algorithm. | v1.6.1 | +| [ST_Snap](Geometry-Processing/ST_Snap.md) | Geometry | Snaps the vertices and segments of the `input` geometry to `reference` geometry within the specified `tolerance` distance. The `tolerance` parameter controls the maximum snap distance. | v1.6.0 | +| [ST_StraightSkeleton](Geometry-Processing/ST_StraightSkeleton.md) | Geometry | Computes the straight skeleton of a polygonal geometry. The straight skeleton is a method of representing a polygon by a topological skeleton, formed by a continuous shrinking process where each ed... | v1.8.0 | +| [ST_TriangulatePolygon](Geometry-Processing/ST_TriangulatePolygon.md) | Geometry | Generates the constrained Delaunay triangulation for the input Polygon. The constrained Delaunay triangulation is a set of triangles created from the Polygon's vertices that covers the Polygon area... | v1.6.1 | +| [ST_VoronoiPolygons](Geometry-Processing/ST_VoronoiPolygons.md) | Geometry | Returns a two-dimensional Voronoi diagram from the vertices of the supplied geometry. The result is a GeometryCollection of Polygons that covers an envelope larger than the extent of the input vert... | v1.5.0 | ## Overlay Functions These functions compute results arising from the overlay of two geometries. These are also known as point-set theoretic boolean operations. -| Function | Description | Since | -| :--- | :--- | :--- | -| [ST_Difference](Overlay-Functions/ST_Difference.md) | Return the difference between geometry A and B (return part of geometry A that does not intersect geometry B) | v1.5.0 | -| [ST_Intersection](Overlay-Functions/ST_Intersection.md) | Return the intersection geometry of A and B | v1.5.0 | -| [ST_SubDivide](Overlay-Functions/ST_SubDivide.md) | Returns list of geometries divided based of given maximum number of vertices. | v1.5.0 | -| [ST_SymDifference](Overlay-Functions/ST_SymDifference.md) | Return the symmetrical difference between geometry A and B (return parts of geometries which are in either of the sets, but not in their intersection) | v1.5.0 | -| [ST_UnaryUnion](Overlay-Functions/ST_UnaryUnion.md) | This variant of [ST_Union](Overlay-Functions/ST_Union.md) operates on a single geometry input. The input geometry can be a simple Geometry type, a MultiGeometry, or a GeometryCollection. The function calculates the ge... | v1.6.1 | -| [ST_Union](Overlay-Functions/ST_Union.md) | Variant 1: Return the union of geometry A and B. | v1.6.0 | +| Function | Return type | Description | Since | +| :--- | :--- | :--- | :--- | +| [ST_Difference](Overlay-Functions/ST_Difference.md) | Geometry | Return the difference between geometry A and B (return part of geometry A that does not intersect geometry B) | v1.5.0 | +| [ST_Intersection](Overlay-Functions/ST_Intersection.md) | Geometry | Return the intersection geometry of A and B | v1.5.0 | +| [ST_SubDivide](Overlay-Functions/ST_SubDivide.md) | Array<Geometry> | Returns list of geometries divided based of given maximum number of vertices. | v1.5.0 | Review Comment: The return type `Array<Geometry>` is not wrapped in a code span here, while other generic/angle-bracket types in this doc are (e.g., `Array<Geometry>`). Without backticks, Markdown may interpret `<Geometry>` as an HTML tag and render it incorrectly. Wrap this return type in backticks for consistent and correct rendering. ```suggestion | [ST_SubDivide](Overlay-Functions/ST_SubDivide.md) | `Array<Geometry>` | Returns list of geometries divided based of given maximum number of vertices. | v1.5.0 | ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
