docs/generated/sql/functions.md
| d e f y_off | | y | | g h i z_off | | z | \ 0 0 0 1 / \ 0 /</p> </span></td><td>Immutable</td></tr>
<tr><td><a name="st_affine"></a><code>st_affine(geometry: geometry, a: <a href="float.html">float</a>, b: <a href="float.html">float</a>, d: <a href="float.html">float</a>, e: <a href="float.html">float</a>, x_off: <a href="float.html">float</a>, y_off: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Applies a 2D affine transformation to the given geometry.</p> <p>The matrix transformation will be applied as follows for each coordinate: / a b x_off \ / x| d e y_off | | y | \ 0 0 1 / \ 0 /</p> </span></td><td>Immutable</td></tr>
<tr><td><a name="st_angle"></a><code>st_angle(line1: geometry, line2: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the clockwise angle between two LINESTRING geometries, treating them as vectors between their start- and endpoints. Returns NULL if any vectors have 0 length.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_angle"></a><code>st_angle(point1: geometry, point2: geometry, point3: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the clockwise angle between the vectors formed by point2,point1 and point2,point3. The arguments must be POINT geometries. Returns NULL if any vectors have 0 length.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_angle"></a><code>st_angle(point1: geometry, point2: geometry, point3: geometry, point4: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the clockwise angle between the vectors formed by point1,point2 and point3,point4. The arguments must be POINT geometries. Returns NULL if any vectors have 0 length.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_area"></a><code>st_area(geography: geography) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the area of the given geography in meters^2. Uses a spheroid to perform the operation.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_area"></a><code>st_area(geography: geography, use_spheroid: <a href="bool.html">bool</a>) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the area of the given geography in meters^2.</p> <p>This function utilizes the S2 library for spherical calculations.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_area"></a><code>st_area(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the area of the given geometry.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_area"></a><code>st_area(geometry_str: <a href="string.html">string</a>) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the area of the given geometry.</p> <p>This function utilizes the GEOS module.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_area2d"></a><code>st_area2d(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the area of the given geometry.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asbinary"></a><code>st_asbinary(geography: geography) → <a href="bytes.html">bytes</a></code></td><td><span class="funcdesc"><p>Returns the WKB representation of a given Geography.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asbinary"></a><code>st_asbinary(geography: geography, xdr_or_ndr: <a href="string.html">string</a>) → <a href="bytes.html">bytes</a></code></td><td><span class="funcdesc"><p>Returns the WKB representation of a given Geography. This variant has a second argument denoting the encoding - <code>xdr</code> for big endian and <code>ndr</code> for little endian.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asbinary"></a><code>st_asbinary(geometry: geometry) → <a href="bytes.html">bytes</a></code></td><td><span class="funcdesc"><p>Returns the WKB representation of a given Geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asbinary"></a><code>st_asbinary(geometry: geometry, xdr_or_ndr: <a href="string.html">string</a>) → <a href="bytes.html">bytes</a></code></td><td><span class="funcdesc"><p>Returns the WKB representation of a given Geometry. This variant has a second argument denoting the encoding - <code>xdr</code> for big endian and <code>ndr</code> for little endian.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asencodedpolyline"></a><code>st_asencodedpolyline(geometry: geometry) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the geometry as an Encoded Polyline. This format is used by Google Maps with precision=5 and by Open Source Routing Machine with precision=5 and 6. Preserves 5 decimal places.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asencodedpolyline"></a><code>st_asencodedpolyline(geometry: geometry, precision: int4) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the geometry as an Encoded Polyline. This format is used by Google Maps with precision=5 and by Open Source Routing Machine with precision=5 and 6. Precision specifies how many decimal places will be preserved in Encoded Polyline. Value should be the same on encoding and decoding, or coordinates will be incorrect.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asewkb"></a><code>st_asewkb(geography: geography) → <a href="bytes.html">bytes</a></code></td><td><span class="funcdesc"><p>Returns the EWKB representation of a given Geography.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asewkb"></a><code>st_asewkb(geometry: geometry) → <a href="bytes.html">bytes</a></code></td><td><span class="funcdesc"><p>Returns the EWKB representation of a given Geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asewkt"></a><code>st_asewkt(geography: geography) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the EWKT representation of a given Geography. A default of 15 decimal digits is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asewkt"></a><code>st_asewkt(geography: geography, max_decimal_digits: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the EWKT representation of a given Geography. The max_decimal_digits parameter controls the maximum decimal digits to print after the <code>.</code>. Use -1 to print as many digits as required to rebuild the same number.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asewkt"></a><code>st_asewkt(geometry: geometry) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the EWKT representation of a given Geometry. A maximum of 15 decimal digits is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asewkt"></a><code>st_asewkt(geometry: geometry, max_decimal_digits: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the WKT representation of a given Geometry. The max_decimal_digits parameter controls the maximum decimal digits to print after the <code>.</code>. Use -1 to print as many digits as required to rebuild the same number.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asewkt"></a><code>st_asewkt(geometry_str: <a href="string.html">string</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the EWKT representation of a given Geometry. A maximum of 15 decimal digits is used.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asewkt"></a><code>st_asewkt(geometry_str: <a href="string.html">string</a>, max_decimal_digits: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the WKT representation of a given Geometry. The max_decimal_digits parameter controls the maximum decimal digits to print after the <code>.</code>. Use -1 to print as many digits as required to rebuild the same number.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(geography: geography) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geography. Coordinates have a maximum of 9 decimal digits.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(geography: geography, max_decimal_digits: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geography with max_decimal_digits output for each coordinate value.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(geography: geography, max_decimal_digits: <a href="int.html">int</a>, options: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geography with max_decimal_digits output for each coordinate value.</p> <p>Options is a flag that can be bitmasked. The options are:</p> <ul> <li>0: no option (default for Geography)</li> <li>1: GeoJSON BBOX</li> <li>2: GeoJSON Short CRS (e.g EPSG:4326)</li> <li>4: GeoJSON Long CRS (e.g urn:ogc:def:crs:EPSG::4326)</li> <li>8: GeoJSON Short CRS if not EPSG:4326</li> </ul> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(geometry: geometry) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geometry. Coordinates have a maximum of 9 decimal digits.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(geometry: geometry, max_decimal_digits: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geometry with max_decimal_digits output for each coordinate value.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(geometry: geometry, max_decimal_digits: <a href="int.html">int</a>, options: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geometry with max_decimal_digits output for each coordinate value.</p> <p>Options is a flag that can be bitmasked. The options are:</p> <ul> <li>0: no option</li> <li>1: GeoJSON BBOX</li> <li>2: GeoJSON Short CRS (e.g EPSG:4326)</li> <li>4: GeoJSON Long CRS (e.g urn:ogc:def:crs:EPSG::4326)</li> <li>8: GeoJSON Short CRS if not EPSG:4326 (default for Geometry)</li> </ul> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(geometry_str: <a href="string.html">string</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geometry. Coordinates have a maximum of 9 decimal digits.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(geometry_str: <a href="string.html">string</a>, max_decimal_digits: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geometry with max_decimal_digits output for each coordinate value.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(geometry_str: <a href="string.html">string</a>, max_decimal_digits: <a href="int.html">int</a>, options: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geometry with max_decimal_digits output for each coordinate value.</p> <p>Options is a flag that can be bitmasked. The options are:</p> <ul> <li>0: no option</li> <li>1: GeoJSON BBOX</li> <li>2: GeoJSON Short CRS (e.g EPSG:4326)</li> <li>4: GeoJSON Long CRS (e.g urn:ogc:def:crs:EPSG::4326)</li> <li>8: GeoJSON Short CRS if not EPSG:4326 (default for Geometry)</li> </ul> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(row: tuple) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geometry. Coordinates have a maximum of 9 decimal digits.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(row: tuple, geo_column: <a href="string.html">string</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geometry, using geo_column as the geometry for the given Feature. Coordinates have a maximum of 9 decimal digits.</p> </span></td><td>Stable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(row: tuple, geo_column: <a href="string.html">string</a>, max_decimal_digits: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geometry, using geo_column as the geometry for the given Feature. max_decimal_digits will be output for each coordinate value.</p> </span></td><td>Stable</td></tr> <tr><td><a name="st_asgeojson"></a><code>st_asgeojson(row: tuple, geo_column: <a href="string.html">string</a>, max_decimal_digits: <a href="int.html">int</a>, pretty: <a href="bool.html">bool</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the GeoJSON representation of a given Geometry, using geo_column as the geometry for the given Feature. max_decimal_digits will be output for each coordinate value. Output will be pretty printed in JSON if pretty is true.</p> </span></td><td>Stable</td></tr> <tr><td><a name="st_ashexewkb"></a><code>st_ashexewkb(geography: geography) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the EWKB representation in hex of a given Geography.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_ashexewkb"></a><code>st_ashexewkb(geography: geography, xdr_or_ndr: <a href="string.html">string</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the EWKB representation in hex of a given Geography. This variant has a second argument denoting the encoding - <code>xdr</code> for big endian and <code>ndr</code> for little endian.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_ashexewkb"></a><code>st_ashexewkb(geometry: geometry) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the EWKB representation in hex of a given Geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_ashexewkb"></a><code>st_ashexewkb(geometry: geometry, xdr_or_ndr: <a href="string.html">string</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the EWKB representation in hex of a given Geometry. This variant has a second argument denoting the encoding - <code>xdr</code> for big endian and <code>ndr</code> for little endian.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_ashexwkb"></a><code>st_ashexwkb(geography: geography) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the WKB representation in hex of a given Geography.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_ashexwkb"></a><code>st_ashexwkb(geometry: geometry) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the WKB representation in hex of a given Geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_askml"></a><code>st_askml(geography: geography) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the KML representation of a given Geography.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_askml"></a><code>st_askml(geometry: geometry) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the KML representation of a given Geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_askml"></a><code>st_askml(geometry_str: <a href="string.html">string</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the KML representation of a given Geometry.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asmvtgeom"></a><code>st_asmvtgeom(geometry: geometry, bbox: box2d) → geometry</code></td><td><span class="funcdesc"><p>Transforms a geometry into the coordinate space of a MVT (Mapbox Vector Tile) tile, clipping it to the tile bounds. Uses 256 as the buffer size in tile coordinate space for geometry clipping. Uses 4096 as the tile extent size in tile coordinate space.</p> <p>The geometry must be in the coordinate system of the target map. The function attempts to preserve geometry validity, and corrects it if needed. This may cause the result geometry to collapse to a lower dimension. The rectangular bounds of the tile in the target map coordinate space must be provided, so the geometry will be clipped can be transformed.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asmvtgeom"></a><code>st_asmvtgeom(geometry: geometry, bbox: box2d, extent: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Transforms a geometry into the coordinate space of a MVT (Mapbox Vector Tile) tile, clipping it to the tile bounds. Uses 256 as the buffer size in tile coordinate space for geometry clipping.</p> <p>The geometry must be in the coordinate system of the target map. The function attempts to preserve geometry validity, and corrects it if needed. This may cause the result geometry to collapse to a lower dimension. The rectangular bounds of the tile in the target map coordinate space must be provided, so the geometry will be clipped can be transformed.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asmvtgeom"></a><code>st_asmvtgeom(geometry: geometry, bbox: box2d, extent: <a href="int.html">int</a>, buffer: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Transforms a geometry into the coordinate space of a MVT (Mapbox Vector Tile) tile, clipping it to the tile bounds.</p> <p>The geometry must be in the coordinate system of the target map. The function attempts to preserve geometry validity, and corrects it if needed. This may cause the result geometry to collapse to a lower dimension. The rectangular bounds of the tile in the target map coordinate space must be provided, so the geometry will be clipped can be transformed.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_asmvtgeom"></a><code>st_asmvtgeom(geometry: geometry, bbox: box2d, extent: <a href="int.html">int</a>, buffer: <a href="int.html">int</a>, clip: <a href="bool.html">bool</a>) → geometry</code></td><td><span class="funcdesc"><p>Transforms a geometry into the coordinate space of a MVT (Mapbox Vector Tile) tile, clipping it to the tile bounds if required.</p> <p>The geometry must be in the coordinate system of the target map. The function attempts to preserve geometry validity, and corrects it if needed. This may cause the result geometry to collapse to a lower dimension. The rectangular bounds of the tile in the target map coordinate space must be provided, so the geometry can be transformed, and clipped if required.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_astext"></a><code>st_astext(geography: geography) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the WKT representation of a given Geography. A default of 15 decimal digits is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_astext"></a><code>st_astext(geography: geography, max_decimal_digits: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the WKT representation of a given Geography. The max_decimal_digits parameter controls the maximum decimal digits to print after the <code>.</code>. Use -1 to print as many digits as required to rebuild the same number.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_astext"></a><code>st_astext(geometry: geometry) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the WKT representation of a given Geometry. A maximum of 15 decimal digits is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_astext"></a><code>st_astext(geometry: geometry, max_decimal_digits: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the WKT representation of a given Geometry. The max_decimal_digits parameter controls the maximum decimal digits to print after the <code>.</code>. Use -1 to print as many digits as required to rebuild the same number.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_astext"></a><code>st_astext(geometry_str: <a href="string.html">string</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the WKT representation of a given Geometry. A maximum of 15 decimal digits is used.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_astext"></a><code>st_astext(geometry_str: <a href="string.html">string</a>, max_decimal_digits: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the WKT representation of a given Geometry. The max_decimal_digits parameter controls the maximum decimal digits to print after the <code>.</code>. Use -1 to print as many digits as required to rebuild the same number.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_astwkb"></a><code>st_astwkb(geometry: geometry, precision_xy: <a href="int.html">int</a>) → <a href="bytes.html">bytes</a></code></td><td><span class="funcdesc"><p>Returns the TWKB representation of a given geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_astwkb"></a><code>st_astwkb(geometry: geometry, precision_xy: <a href="int.html">int</a>, precision_z: <a href="int.html">int</a>) → <a href="bytes.html">bytes</a></code></td><td><span class="funcdesc"><p>Returns the TWKB representation of a given geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_astwkb"></a><code>st_astwkb(geometry: geometry, precision_xy: <a href="int.html">int</a>, precision_z: <a href="int.html">int</a>, precision_m: <a href="int.html">int</a>) → <a href="bytes.html">bytes</a></code></td><td><span class="funcdesc"><p>Returns the TWKB representation of a given geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_azimuth"></a><code>st_azimuth(geography_a: geography, geography_b: geography) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the azimuth in radians of the segment defined by the given point geographies, or NULL if the two points are coincident. It is solved using the Inverse geodesic problem.</p> <p>The azimuth is angle is referenced from north, and is positive clockwise: North = 0; East = π/2; South = π; West = 3π/2.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_azimuth"></a><code>st_azimuth(geometry_a: geometry, geometry_b: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the azimuth in radians of the segment defined by the given point geometries, or NULL if the two points are coincident.</p> <p>The azimuth is angle is referenced from north, and is positive clockwise: North = 0; East = π/2; South = π; West = 3π/2.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_bdpolyfromtext"></a><code>st_bdpolyfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Polygon from multilinestring WKT with a SRID. If the input is not a multilinestring an error will be thrown.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_boundary"></a><code>st_boundary(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the closure of the combinatorial boundary of this Geometry.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_box2dfromgeohash"></a><code>st_box2dfromgeohash(geohash: <a href="string.html">string</a>) → box2d</code></td><td><span class="funcdesc"><p>Return a Box2D from a GeoHash string with max precision.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_box2dfromgeohash"></a><code>st_box2dfromgeohash(geohash: <a href="string.html">string</a>, precision: <a href="int.html">int</a>) → box2d</code></td><td><span class="funcdesc"><p>Return a Box2D from a GeoHash string with supplied precision.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geography: geography, distance: <a href="float.html">float</a>) → geography</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This function utilizes the GEOS module.</p> <p>This operation is done by transforming the object into a Geometry. This occurs by translating the Geography objects into Geometry objects before applying an LAEA, UTM or Web Mercator based projection based on the bounding boxes of the given Geography objects. When the result is calculated, the result is transformed back into a Geography with SRID 4326.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geography: geography, distance: <a href="float.html">float</a>, buffer_style_params: <a href="string.html">string</a>) → geography</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This variant takes in a space separate parameter string, which will augment the buffer styles. Valid parameters are:</p> <ul> <li>quad_segs=<int>, default 8</li> <li>endcap=<round|flat|butt|square>, default round</li> <li>join=<round|mitre|miter|bevel>, default round</li> <li>side=<both|left|right>, default both</li> <li>mitre_limit=<float>, default 5.0</li> </ul> <p>This function utilizes the GEOS module.</p> <p>This operation is done by transforming the object into a Geometry. This occurs by translating the Geography objects into Geometry objects before applying an LAEA, UTM or Web Mercator based projection based on the bounding boxes of the given Geography objects. When the result is calculated, the result is transformed back into a Geography with SRID 4326.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geography: geography, distance: <a href="float.html">float</a>, quad_segs: <a href="int.html">int</a>) → geography</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This variant approximates the circle into quad_seg segments per line (the default is 8).</p> <p>This function utilizes the GEOS module.</p> <p>This operation is done by transforming the object into a Geometry. This occurs by translating the Geography objects into Geometry objects before applying an LAEA, UTM or Web Mercator based projection based on the bounding boxes of the given Geography objects. When the result is calculated, the result is transformed back into a Geography with SRID 4326.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geometry: geometry, distance: <a href="decimal.html">decimal</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geometry: geometry, distance: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geometry: geometry, distance: <a href="float.html">float</a>, buffer_style_params: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This variant takes in a space separate parameter string, which will augment the buffer styles. Valid parameters are:</p> <ul> <li>quad_segs=<int>, default 8</li> <li>endcap=<round|flat|butt|square>, default round</li> <li>join=<round|mitre|miter|bevel>, default round</li> <li>side=<both|left|right>, default both</li> <li>mitre_limit=<float>, default 5.0</li> </ul> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geometry: geometry, distance: <a href="float.html">float</a>, quad_segs: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This variant approximates the circle into quad_seg segments per line (the default is 8).</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geometry: geometry, distance: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geometry_str: <a href="string.html">string</a>, distance: <a href="decimal.html">decimal</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This function utilizes the GEOS module.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geometry_str: <a href="string.html">string</a>, distance: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This function utilizes the GEOS module.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geometry_str: <a href="string.html">string</a>, distance: <a href="float.html">float</a>, buffer_style_params: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This variant takes in a space separate parameter string, which will augment the buffer styles. Valid parameters are:</p> <ul> <li>quad_segs=<int>, default 8</li> <li>endcap=<round|flat|butt|square>, default round</li> <li>join=<round|mitre|miter|bevel>, default round</li> <li>side=<both|left|right>, default both</li> <li>mitre_limit=<float>, default 5.0</li> </ul> <p>This function utilizes the GEOS module.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geometry_str: <a href="string.html">string</a>, distance: <a href="float.html">float</a>, quad_segs: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This variant approximates the circle into quad_seg segments per line (the default is 8).</p> <p>This function utilizes the GEOS module.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_buffer"></a><code>st_buffer(geometry_str: <a href="string.html">string</a>, distance: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that represents all points whose distance is less than or equal to the given distance from the given Geometry.</p> <p>This function utilizes the GEOS module.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_centroid"></a><code>st_centroid(geography: geography) → geography</code></td><td><span class="funcdesc"><p>Returns the centroid of given geography. Uses a spheroid to perform the operation.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_centroid"></a><code>st_centroid(geography: geography, use_spheroid: <a href="bool.html">bool</a>) → geography</code></td><td><span class="funcdesc"><p>Returns the centroid of given geography.</p> <p>This function utilizes the S2 library for spherical calculations.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_centroid"></a><code>st_centroid(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the centroid of the given geometry.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_centroid"></a><code>st_centroid(geometry_str: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the centroid of the given geometry.</p> <p>This function utilizes the GEOS module.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_clipbybox2d"></a><code>st_clipbybox2d(geometry: geometry, box2d: box2d) → geometry</code></td><td><span class="funcdesc"><p>Clips the geometry to conform to the bounding box specified by box2d.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_closestpoint"></a><code>st_closestpoint(geometry_a: geometry, geometry_b: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the 2-dimensional point on geometry_a that is closest to geometry_b. This is the first point of the shortest line.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_collectionextract"></a><code>st_collectionextract(geometry: geometry, type: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Given a collection, returns a multitype consisting only of elements of the specified type. If there are no elements of the given type, an EMPTY geometry is returned. Types are specified as 1=POINT, 2=LINESTRING, 3=POLYGON - other types are not supported.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_collectionhomogenize"></a><code>st_collectionhomogenize(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the “simplest” representation of a collection’s contents. Collections of a single type will be returned as an appopriate multitype, or a singleton if it only contains a single geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_combinebbox"></a><code>st_combinebbox(box2d: box2d, geometry: geometry) → box2d</code></td><td><span class="funcdesc"><p>Combines the current bounding box with the bounding box of the Geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_contains"></a><code>st_contains(geometry_a: geometry, geometry_b: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if no points of geometry_b lie in the exterior of geometry_a, and there is at least one point in the interior of geometry_b that lies in the interior of geometry_a.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_containsproperly"></a><code>st_containsproperly(geometry_a: geometry, geometry_b: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if geometry_b intersects the interior of geometry_a but not the boundary or exterior of geometry_a.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_convexhull"></a><code>st_convexhull(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a geometry that represents the Convex Hull of the given geometry.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_coorddim"></a><code>st_coorddim(geometry: geometry) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns the number of coordinate dimensions of a given Geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_coveredby"></a><code>st_coveredby(geography_a: geography, geography_b: geography) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if no point in geography_a is outside geography_b.</p> <p>The calculations performed are have a precision of 1cm.</p> <p>This function utilizes the S2 library for spherical calculations.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_coveredby"></a><code>st_coveredby(geometry_a: geometry, geometry_b: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if no point in geometry_a is outside geometry_b.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_coveredby"></a><code>st_coveredby(geometry_a_str: <a href="string.html">string</a>, geometry_b_str: <a href="string.html">string</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if no point in geometry_a is outside geometry_b.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_covers"></a><code>st_covers(geography_a: geography, geography_b: geography) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if no point in geography_b is outside geography_a.</p> <p>This function utilizes the S2 library for spherical calculations.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_covers"></a><code>st_covers(geometry_a: geometry, geometry_b: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if no point in geometry_b is outside geometry_a.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_covers"></a><code>st_covers(geometry_a_str: <a href="string.html">string</a>, geometry_b_str: <a href="string.html">string</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if no point in geometry_b is outside geometry_a.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_crosses"></a><code>st_crosses(geometry_a: geometry, geometry_b: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if geometry_a has some - but not all - interior points in common with geometry_b.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_dfullywithin"></a><code>st_dfullywithin(geometry_a: geometry, geometry_b: geometry, distance: <a href="float.html">float</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if every pair of points comprising geometry_a and geometry_b are within distance units, inclusive. In other words, the ST_MaxDistance between geometry_a and geometry_b is less than or equal to distance units.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_dfullywithinexclusive"></a><code>st_dfullywithinexclusive(geometry_a: geometry, geometry_b: geometry, distance: <a href="float.html">float</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if every pair of points comprising geometry_a and geometry_b are within distance units, exclusive. In other words, the ST_MaxDistance between geometry_a and geometry_b is less than distance units.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_difference"></a><code>st_difference(geometry_a: geometry, geometry_b: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the difference of two Geometries.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_dimension"></a><code>st_dimension(geometry: geometry) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns the number of topological dimensions of a given Geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_disjoint"></a><code>st_disjoint(geometry_a: geometry, geometry_b: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if geometry_a does not overlap, touch or is within geometry_b.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_distance"></a><code>st_distance(geography_a: geography, geography_b: geography) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the distance in meters between geography_a and geography_b. Uses a spheroid to perform the operation.</p> <p>When operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_distance"></a><code>st_distance(geography_a: geography, geography_b: geography, use_spheroid: <a href="bool.html">bool</a>) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the distance in meters between geography_a and geography_b.</p> <p>When operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.</p> <p>This function utilizes the S2 library for spherical calculations.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_distance"></a><code>st_distance(geometry_a: geometry, geometry_b: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the distance between the given geometries.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_distance"></a><code>st_distance(geometry_a_str: <a href="string.html">string</a>, geometry_b_str: <a href="string.html">string</a>) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the distance between the given geometries.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_distancesphere"></a><code>st_distancesphere(geometry_a: geometry, geometry_b: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the distance in meters between geometry_a and geometry_b assuming the coordinates represent lng/lat points on a sphere.</p> <p>This function utilizes the S2 library for spherical calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_distancespheroid"></a><code>st_distancespheroid(geometry_a: geometry, geometry_b: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the distance in meters between geometry_a and geometry_b assuming the coordinates represent lng/lat points on a spheroid.</p> <p>When operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.</p> <p>This function utilizes the S2 library for spherical calculations.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_dwithin"></a><code>st_dwithin(geography_a: geography, geography_b: geography, distance: <a href="float.html">float</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if any of geography_a is within distance meters of geography_b, inclusive. Uses a spheroid to perform the operation.</p> <p>When operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.</p> <p>The calculations performed are have a precision of 1cm.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_dwithin"></a><code>st_dwithin(geography_a: geography, geography_b: geography, distance: <a href="float.html">float</a>, use_spheroid: <a href="bool.html">bool</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if any of geography_a is within distance meters of geography_b, inclusive.</p> <p>When operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.</p> <p>The calculations performed are have a precision of 1cm.</p> <p>This function utilizes the S2 library for spherical calculations.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_dwithin"></a><code>st_dwithin(geometry_a: geometry, geometry_b: geometry, distance: <a href="float.html">float</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if any of geometry_a is within distance units of geometry_b, inclusive.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_dwithin"></a><code>st_dwithin(geometry_a_str: <a href="string.html">string</a>, geometry_b_str: <a href="string.html">string</a>, distance: <a href="float.html">float</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if any of geometry_a is within distance units of geometry_b, inclusive.</p> <p>This function variant will attempt to utilize any available spatial index.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_dwithinexclusive"></a><code>st_dwithinexclusive(geography_a: geography, geography_b: geography, distance: <a href="float.html">float</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if any of geography_a is within distance meters of geography_b, exclusive. Uses a spheroid to perform the operation.</p> <p>When operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.</p> <p>The calculations performed are have a precision of 1cm.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_dwithinexclusive"></a><code>st_dwithinexclusive(geography_a: geography, geography_b: geography, distance: <a href="float.html">float</a>, use_spheroid: <a href="bool.html">bool</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if any of geography_a is within distance meters of geography_b, exclusive.</p> <p>When operating on a spheroid, this function will use the sphere to calculate the closest two points. The spheroid distance between these two points is calculated using GeographicLib. This follows observed PostGIS behavior.</p> <p>The calculations performed are have a precision of 1cm.</p> <p>This function utilizes the S2 library for spherical calculations.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_dwithinexclusive"></a><code>st_dwithinexclusive(geometry_a: geometry, geometry_b: geometry, distance: <a href="float.html">float</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if any of geometry_a is within distance units of geometry_b, exclusive.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_dwithinexclusive"></a><code>st_dwithinexclusive(geometry_a_str: <a href="string.html">string</a>, geometry_b_str: <a href="string.html">string</a>, distance: <a href="float.html">float</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if any of geometry_a is within distance units of geometry_b, exclusive.</p> <p>This function variant will attempt to utilize any available spatial index.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_endpoint"></a><code>st_endpoint(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the last point of a geometry which has shape LineString. Returns NULL if the geometry is not a LineString.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_envelope"></a><code>st_envelope(box2d: box2d) → geometry</code></td><td><span class="funcdesc"><p>Returns a bounding geometry for the given box.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_envelope"></a><code>st_envelope(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a bounding envelope for the given geometry.</p> <p>For geometries which have a POINT or LINESTRING bounding box (i.e. is a single point or a horizontal or vertical line), a POINT or LINESTRING is returned. Otherwise, the returned POLYGON will be ordered Bottom Left, Top Left, Top Right, Bottom Right, Bottom Left.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_equals"></a><code>st_equals(geometry_a: geometry, geometry_b: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if geometry_a is spatially equal to geometry_b, i.e. ST_Within(geometry_a, geometry_b) = ST_Within(geometry_b, geometry_a) = true.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_estimatedextent"></a><code>st_estimatedextent(schema_name: <a href="string.html">string</a>, table_name: <a href="string.html">string</a>, geocolumn_name: <a href="string.html">string</a>) → box2d</code></td><td><span class="funcdesc"><p>Returns the estimated extent of the geometries in the column of the given table. This currently always returns NULL.</p> </span></td><td>Stable</td></tr> <tr><td><a name="st_estimatedextent"></a><code>st_estimatedextent(schema_name: <a href="string.html">string</a>, table_name: <a href="string.html">string</a>, geocolumn_name: <a href="string.html">string</a>, parent_only: <a href="bool.html">bool</a>) → box2d</code></td><td><span class="funcdesc"><p>Returns the estimated extent of the geometries in the column of the given table. This currently always returns NULL.</p> <p>The parent_only boolean is always ignored.</p> </span></td><td>Stable</td></tr> <tr><td><a name="st_estimatedextent"></a><code>st_estimatedextent(table_name: <a href="string.html">string</a>, geocolumn_name: <a href="string.html">string</a>) → box2d</code></td><td><span class="funcdesc"><p>Returns the estimated extent of the geometries in the column of the given table. This currently always returns NULL.</p> </span></td><td>Stable</td></tr> <tr><td><a name="st_expand"></a><code>st_expand(box2d: box2d, delta: <a href="float.html">float</a>) → box2d</code></td><td><span class="funcdesc"><p>Extends the box2d by delta units across all dimensions.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_expand"></a><code>st_expand(box2d: box2d, delta_x: <a href="float.html">float</a>, delta_y: <a href="float.html">float</a>) → box2d</code></td><td><span class="funcdesc"><p>Extends the box2d by delta_x units in the x dimension and delta_y units in the y dimension.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_expand"></a><code>st_expand(geometry: geometry, delta: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Extends the bounding box represented by the geometry by delta units across all dimensions, returning a Polygon representing the new bounding box.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_expand"></a><code>st_expand(geometry: geometry, delta_x: <a href="float.html">float</a>, delta_y: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Extends the bounding box represented by the geometry by delta_x units in the x dimension and delta_y units in the y dimension, returning a Polygon representing the new bounding box.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_exteriorring"></a><code>st_exteriorring(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the exterior ring of a Polygon as a LineString. Returns NULL if the shape is not a Polygon.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_flipcoordinates"></a><code>st_flipcoordinates(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a new geometry with the X and Y axes flipped.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_force2d"></a><code>st_force2d(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that is forced into XY layout with any Z or M dimensions discarded.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_force3d"></a><code>st_force3d(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that is forced into XYZ layout. If a Z coordinate doesn’t exist, it will be set to 0. If a M coordinate is present, it will be discarded.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_force3d"></a><code>st_force3d(geometry: geometry, defaultZ: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that is forced into XYZ layout. If a Z coordinate doesn’t exist, it will be set to the specified default Z value. If a M coordinate is present, it will be discarded.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_force3dm"></a><code>st_force3dm(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that is forced into XYM layout. If a M coordinate doesn’t exist, it will be set to 0. If a Z coordinate is present, it will be discarded.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_force3dm"></a><code>st_force3dm(geometry: geometry, defaultM: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that is forced into XYM layout. If a M coordinate doesn’t exist, it will be set to the specified default M value. If a Z coordinate is present, it will be discarded.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_force3dz"></a><code>st_force3dz(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that is forced into XYZ layout. If a Z coordinate doesn’t exist, it will be set to 0. If a M coordinate is present, it will be discarded.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_force3dz"></a><code>st_force3dz(geometry: geometry, defaultZ: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that is forced into XYZ layout. If a Z coordinate doesn’t exist, it will be set to the specified default Z value. If a M coordinate is present, it will be discarded.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_force4d"></a><code>st_force4d(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that is forced into XYZM layout. If a Z coordinate doesn’t exist, it will be set to 0. If a M coordinate doesn’t exist, it will be set to 0.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_force4d"></a><code>st_force4d(geometry: geometry, defaultZ: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that is forced into XYZ layout. If a Z coordinate doesn’t exist, it will be set to the specified default Z value. If a M coordinate doesn’t exist, it will be set to 0.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_force4d"></a><code>st_force4d(geometry: geometry, defaultZ: <a href="float.html">float</a>, defaultM: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry that is forced into XYZ layout. If a Z coordinate doesn’t exist, it will be set to the specified Z value. If a M coordinate doesn’t exist, it will be set to the specified M value.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_forcecollection"></a><code>st_forcecollection(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Converts the geometry into a GeometryCollection.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_forcepolygonccw"></a><code>st_forcepolygonccw(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry where all Polygon objects have exterior rings in the counter-clockwise orientation and interior rings in the clockwise orientation. Non-Polygon objects are unchanged.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_forcepolygoncw"></a><code>st_forcepolygoncw(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a Geometry where all Polygon objects have exterior rings in the clockwise orientation and interior rings in the counter-clockwise orientation. Non-Polygon objects are unchanged.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_frechetdistance"></a><code>st_frechetdistance(geometry_a: geometry, geometry_b: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the Frechet distance between the given geometries.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_frechetdistance"></a><code>st_frechetdistance(geometry_a: geometry, geometry_b: geometry, densify_frac: <a href="float.html">float</a>) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the Frechet distance between the given geometries, with the given segment densification (range 0.0-1.0, -1 to disable).</p> <p>Smaller densify_frac gives a more accurate Fréchet distance. However, the computation time and memory usage increases with the square of the number of subsegments.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_generatepoints"></a><code>st_generatepoints(geometry: geometry, npoints: int4) → geometry</code></td><td><span class="funcdesc"><p>Generates pseudo-random points until the requested number are found within the input area. Uses system time as a seed. The requested number of points must be not larger than 65336.</p> </span></td><td>Volatile</td></tr> <tr><td><a name="st_generatepoints"></a><code>st_generatepoints(geometry: geometry, npoints: int4, seed: int4) → geometry</code></td><td><span class="funcdesc"><p>Generates pseudo-random points until the requested number are found within the input area. The requested number of points must be not larger than 65336.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geogfromewkb"></a><code>st_geogfromewkb(val: <a href="bytes.html">bytes</a>) → geography</code></td><td><span class="funcdesc"><p>Returns the Geography from an EWKB representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geogfromewkt"></a><code>st_geogfromewkt(val: <a href="string.html">string</a>) → geography</code></td><td><span class="funcdesc"><p>Returns the Geography from an EWKT representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geogfromgeojson"></a><code>st_geogfromgeojson(val: <a href="string.html">string</a>) → geography</code></td><td><span class="funcdesc"><p>Returns the Geography from an GeoJSON representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geogfromgeojson"></a><code>st_geogfromgeojson(val: jsonb) → geography</code></td><td><span class="funcdesc"><p>Returns the Geography from an GeoJSON representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geogfromtext"></a><code>st_geogfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geography</code></td><td><span class="funcdesc"><p>Returns the Geography from a WKT or EWKT representation with an SRID. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geogfromtext"></a><code>st_geogfromtext(val: <a href="string.html">string</a>) → geography</code></td><td><span class="funcdesc"><p>Returns the Geography from a WKT or EWKT representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geogfromwkb"></a><code>st_geogfromwkb(bytes: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geography</code></td><td><span class="funcdesc"><p>Returns the Geography from a WKB (or EWKB) representation with the given SRID set.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geogfromwkb"></a><code>st_geogfromwkb(val: <a href="bytes.html">bytes</a>) → geography</code></td><td><span class="funcdesc"><p>Returns the Geography from a WKB (or EWKB) representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geographyfromtext"></a><code>st_geographyfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geography</code></td><td><span class="funcdesc"><p>Returns the Geography from a WKT or EWKT representation with an SRID. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geographyfromtext"></a><code>st_geographyfromtext(val: <a href="string.html">string</a>) → geography</code></td><td><span class="funcdesc"><p>Returns the Geography from a WKT or EWKT representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geohash"></a><code>st_geohash(geography: geography) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns a GeoHash representation of the geeographywith full precision if a point is provided, or with variable precision based on the size of the feature.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geohash"></a><code>st_geohash(geography: geography, precision: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns a GeoHash representation of the geography with the supplied precision.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geohash"></a><code>st_geohash(geometry: geometry) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns a GeoHash representation of the geometry with full precision if a point is provided, or with variable precision based on the size of the feature. This will error any coordinates are outside the bounds of longitude/latitude.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geohash"></a><code>st_geohash(geometry: geometry, precision: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns a GeoHash representation of the geometry with the supplied precision. This will error any coordinates are outside the bounds of longitude/latitude.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomcollfromtext"></a><code>st_geomcollfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not GeometryCollection, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomcollfromtext"></a><code>st_geomcollfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not GeometryCollection, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomcollfromwkb"></a><code>st_geomcollfromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not GeometryCollection, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomcollfromwkb"></a><code>st_geomcollfromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not GeometryCollection, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geometryfromtext"></a><code>st_geometryfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geometryfromtext"></a><code>st_geometryfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geometryn"></a><code>st_geometryn(geometry: geometry, n: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the n-th Geometry (1-indexed). Returns NULL if out of bounds.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geometrytype"></a><code>st_geometrytype(geometry: geometry) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the type of geometry as a string prefixed with <code>ST_</code>.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomfromewkb"></a><code>st_geomfromewkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from an EWKB representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomfromewkt"></a><code>st_geomfromewkt(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from an EWKT representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomfromgeohash"></a><code>st_geomfromgeohash(geohash: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Return a POLYGON Geometry from a GeoHash string with max precision.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomfromgeohash"></a><code>st_geomfromgeohash(geohash: <a href="string.html">string</a>, precision: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Return a POLYGON Geometry from a GeoHash string with supplied precision.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomfromgeojson"></a><code>st_geomfromgeojson(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from an GeoJSON representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomfromgeojson"></a><code>st_geomfromgeojson(val: jsonb) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from an GeoJSON representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomfromtext"></a><code>st_geomfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomfromtext"></a><code>st_geomfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomfromwkb"></a><code>st_geomfromwkb(bytes: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with the given SRID set.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_geomfromwkb"></a><code>st_geomfromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_hasarc"></a><code>st_hasarc(geometry: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns whether there is a CIRCULARSTRING in the geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_hausdorffdistance"></a><code>st_hausdorffdistance(geometry_a: geometry, geometry_b: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the Hausdorff distance between the given geometries.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_hausdorffdistance"></a><code>st_hausdorffdistance(geometry_a: geometry, geometry_b: geometry, densify_frac: <a href="float.html">float</a>) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the Hausdorff distance between the given geometries, with the given segment densification (range 0.0-1.0).</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_interiorringn"></a><code>st_interiorringn(geometry: geometry, n: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the n-th (1-indexed) interior ring of a Polygon as a LineString. Returns NULL if the shape is not a Polygon, or the ring does not exist.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_intersection"></a><code>st_intersection(geography_a: geography, geography_b: geography) → geography</code></td><td><span class="funcdesc"><p>Returns the point intersections of the given geographies.</p> <p>This operation is done by transforming the object into a Geometry. This occurs by translating the Geography objects into Geometry objects before applying an LAEA, UTM or Web Mercator based projection based on the bounding boxes of the given Geography objects. When the result is calculated, the result is transformed back into a Geography with SRID 4326.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_intersection"></a><code>st_intersection(geometry_a: geometry, geometry_b: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the point intersections of the given geometries.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_intersection"></a><code>st_intersection(geometry_a_str: <a href="string.html">string</a>, geometry_b_str: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the point intersections of the given geometries.</p> <p>This function utilizes the GEOS module.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_intersects"></a><code>st_intersects(geography_a: geography, geography_b: geography) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if geography_a shares any portion of space with geography_b.</p> <p>The calculations performed are have a precision of 1cm.</p> <p>This function utilizes the S2 library for spherical calculations.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_intersects"></a><code>st_intersects(geometry_a: geometry, geometry_b: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if geometry_a shares any portion of space with geometry_b.</p> <p>The calculations performed are have a precision of 1cm.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_intersects"></a><code>st_intersects(geometry_a_str: <a href="string.html">string</a>, geometry_b_str: <a href="string.html">string</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if geometry_a shares any portion of space with geometry_b.</p> <p>The calculations performed are have a precision of 1cm.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_isclosed"></a><code>st_isclosed(geometry: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns whether the geometry is closed as defined by whether the start and end points are coincident. Points are considered closed, empty geometries are not. For collections and multi-types, all members must be closed, as must all polygon rings.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_iscollection"></a><code>st_iscollection(geometry: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns whether the geometry is of a collection type (including multi-types).</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_isempty"></a><code>st_isempty(geometry: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns whether the geometry is empty.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_ispolygonccw"></a><code>st_ispolygonccw(geometry: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns whether the Polygon objects inside the Geometry have exterior rings in the counter-clockwise orientation and interior rings in the clockwise orientation. Non-Polygon objects are considered counter-clockwise.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_ispolygoncw"></a><code>st_ispolygoncw(geometry: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns whether the Polygon objects inside the Geometry have exterior rings in the clockwise orientation and interior rings in the counter-clockwise orientation. Non-Polygon objects are considered clockwise.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_isring"></a><code>st_isring(geometry: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns whether the geometry is a single linestring that is closed and simple, as defined by ST_IsClosed and ST_IsSimple.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_issimple"></a><code>st_issimple(geometry: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if the geometry has no anomalous geometric points, e.g. that it intersects with or lies tangent to itself.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_isvalid"></a><code>st_isvalid(geometry: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns whether the geometry is valid as defined by the OGC spec.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_isvalid"></a><code>st_isvalid(geometry: geometry, flags: <a href="int.html">int</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns whether the geometry is valid.</p> <p>For flags=0, validity is defined by the OGC spec.</p> <p>For flags=1, validity considers self-intersecting rings forming holes as valid as per ESRI. This is not valid under OGC and CRDB spatial operations may not operate correctly.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_isvalidreason"></a><code>st_isvalidreason(geometry: geometry) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns a string containing the reason the geometry is invalid along with the point of interest, or “Valid Geometry” if it is valid. Validity is defined by the OGC spec.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_isvalidreason"></a><code>st_isvalidreason(geometry: geometry, flags: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the reason the geometry is invalid or “Valid Geometry” if it is valid.</p> <p>For flags=0, validity is defined by the OGC spec.</p> <p>For flags=1, validity considers self-intersecting rings forming holes as valid as per ESRI. This is not valid under OGC and CRDB spatial operations may not operate correctly.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_isvalidtrajectory"></a><code>st_isvalidtrajectory(geometry: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns whether the geometry encodes a valid trajectory.</p> <p>Note the geometry must be a LineString with M coordinates.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_length"></a><code>st_length(geography: geography) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the length of the given geography in meters. Uses a spheroid to perform the operation.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_length"></a><code>st_length(geography: geography, use_spheroid: <a href="bool.html">bool</a>) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the length of the given geography in meters.</p> <p>This function utilizes the S2 library for spherical calculations.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_length"></a><code>st_length(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the length of the given geometry.</p> <p>Note ST_Length is only valid for LineString - use ST_Perimeter for Polygon.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_length"></a><code>st_length(geometry_str: <a href="string.html">string</a>) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the length of the given geometry.</p> <p>Note ST_Length is only valid for LineString - use ST_Perimeter for Polygon.</p> <p>This function utilizes the GEOS module.</p> <p>This variant will cast all geometry_str arguments into Geometry types.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_length2d"></a><code>st_length2d(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the length of the given geometry.</p> <p>Note ST_Length is only valid for LineString - use ST_Perimeter for Polygon.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linecrossingdirection"></a><code>st_linecrossingdirection(linestring_a: geometry, linestring_b: geometry) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns an interger value defining behavior of crossing of lines: 0: lines do not cross, -1: linestring_b crosses linestring_a from right to left, 1: linestring_b crosses linestring_a from left to right, -2: linestring_b crosses linestring_a multiple times from right to left, 2: linestring_b crosses linestring_a multiple times from left to right, -3: linestring_b crosses linestring_a multiple times from left to left, 3: linestring_b crosses linestring_a multiple times from right to right.</p> <p>Note that the top vertex of the segment touching another line does not count as a crossing, but the bottom vertex of segment touching another line is considered a crossing.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linefromencodedpolyline"></a><code>st_linefromencodedpolyline(encoded_polyline: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Creates a LineString from an Encoded Polyline string.</p> <p>Returns valid results only if the polyline was encoded with 5 decimal places.</p> <p>See <a href="http://developers.google.com/maps/documentation/utilities/polylinealgorithm" rel="nofollow">http://developers.google.com/maps/documentation/utilities/polylinealgorithm</a></p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linefromencodedpolyline"></a><code>st_linefromencodedpolyline(encoded_polyline: <a href="string.html">string</a>, precision: int4) → geometry</code></td><td><span class="funcdesc"><p>Creates a LineString from an Encoded Polyline string.</p> <p>Precision specifies how many decimal places will be preserved in Encoded Polyline. Value should be the same on encoding and decoding, or coordinates will be incorrect.</p> <p>See <a href="http://developers.google.com/maps/documentation/utilities/polylinealgorithm" rel="nofollow">http://developers.google.com/maps/documentation/utilities/polylinealgorithm</a></p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linefrommultipoint"></a><code>st_linefrommultipoint(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Creates a LineString from a MultiPoint geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linefromtext"></a><code>st_linefromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not LineString, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linefromtext"></a><code>st_linefromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not LineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linefromwkb"></a><code>st_linefromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not LineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linefromwkb"></a><code>st_linefromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not LineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_lineinterpolatepoint"></a><code>st_lineinterpolatepoint(geometry: geometry, fraction: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a point along the given LineString which is at given fraction of LineString’s total length.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_lineinterpolatepoints"></a><code>st_lineinterpolatepoints(geometry: geometry, fraction: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns one or more points along the LineString which is at an integral multiples of given fraction of LineString’s total length.</p> <p>Note If the result has zero or one points, it will be returned as a POINT. If it has two or more points, it will be returned as a MULTIPOINT.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_lineinterpolatepoints"></a><code>st_lineinterpolatepoints(geometry: geometry, fraction: <a href="float.html">float</a>, repeat: <a href="bool.html">bool</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns one or more points along the LineString which is at an integral multiples of given fraction of LineString’s total length. If repeat is false (default true) then it returns first point.</p> <p>Note If the result has zero or one points, it will be returned as a POINT. If it has two or more points, it will be returned as a MULTIPOINT.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linelocatepoint"></a><code>st_linelocatepoint(line: geometry, point: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns a float between 0 and 1 representing the location of the closest point on LineString to the given Point, as a fraction of total 2d line length.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linemerge"></a><code>st_linemerge(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a LineString or MultiLineString by joining together constituents of a MultiLineString with matching endpoints. If the input is not a MultiLineString or LineString, an empty GeometryCollection is returned.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linestringfromtext"></a><code>st_linestringfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not LineString, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linestringfromtext"></a><code>st_linestringfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not LineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linestringfromwkb"></a><code>st_linestringfromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not LineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linestringfromwkb"></a><code>st_linestringfromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not LineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linesubstring"></a><code>st_linesubstring(linestring: geometry, start_fraction: <a href="decimal.html">decimal</a>, end_fraction: <a href="decimal.html">decimal</a>) → geometry</code></td><td><span class="funcdesc"><p>Return a linestring being a substring of the input one starting and ending at the given fractions of total 2D length. Second and third arguments are float8 values between 0 and 1.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_linesubstring"></a><code>st_linesubstring(linestring: geometry, start_fraction: <a href="float.html">float</a>, end_fraction: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Return a linestring being a substring of the input one starting and ending at the given fractions of total 2D length. Second and third arguments are float8 values between 0 and 1.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_longestline"></a><code>st_longestline(geometry_a: geometry, geometry_b: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the LineString corresponds to the max distance across every pair of points comprising the given geometries.</p> <p>Note if geometries are the same, it will return the LineString with the maximum distance between the geometry’s vertexes. The function will return the longest line that was discovered first when comparing maximum distances if more than one is found.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_m"></a><code>st_m(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the M coordinate of a geometry if it is a Point.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_makebox2d"></a><code>st_makebox2d(geometry_a: geometry, geometry_b: geometry) → box2d</code></td><td><span class="funcdesc"><p>Creates a box2d from two points. Errors if arguments are not two non-empty points.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_makeenvelope"></a><code>st_makeenvelope(xmin: <a href="float.html">float</a>, ymin: <a href="float.html">float</a>, xmax: <a href="float.html">float</a>, ymax: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Creates a rectangular Polygon from the minimum and maximum values for X and Y with SRID 0.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_makeenvelope"></a><code>st_makeenvelope(xmin: <a href="float.html">float</a>, ymin: <a href="float.html">float</a>, xmax: <a href="float.html">float</a>, ymax: <a href="float.html">float</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Creates a rectangular Polygon from the minimum and maximum values for X and Y with the given SRID.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_makepoint"></a><code>st_makepoint(x: <a href="float.html">float</a>, y: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a new Point with the given X and Y coordinates.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_makepoint"></a><code>st_makepoint(x: <a href="float.html">float</a>, y: <a href="float.html">float</a>, z: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a new Point with the given X, Y, and Z coordinates.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_makepoint"></a><code>st_makepoint(x: <a href="float.html">float</a>, y: <a href="float.html">float</a>, z: <a href="float.html">float</a>, m: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a new Point with the given X, Y, Z, and M coordinates.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_makepointm"></a><code>st_makepointm(x: <a href="float.html">float</a>, y: <a href="float.html">float</a>, m: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a new Point with the given X, Y, and M coordinates.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_makepolygon"></a><code>st_makepolygon(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a new Polygon with the given outer LineString.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_makepolygon"></a><code>st_makepolygon(outer: geometry, interior: anyelement[]) → geometry</code></td><td><span class="funcdesc"><p>Returns a new Polygon with the given outer LineString and interior (hole) LineString(s).</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_makevalid"></a><code>st_makevalid(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a valid form of the given geometry according to the OGC spec.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_maxdistance"></a><code>st_maxdistance(geometry_a: geometry, geometry_b: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the maximum distance across every pair of points comprising the given geometries. Note if the geometries are the same, it will return the maximum distance between the geometry’s vertexes.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_memsize"></a><code>st_memsize(geometry: geometry) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns the amount of memory space (in bytes) the geometry takes.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_minimumboundingcircle"></a><code>st_minimumboundingcircle(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the smallest circle polygon that can fully contain a geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_minimumboundingcircle"></a><code>st_minimumboundingcircle(geometry: geometry, num_segs: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the smallest circle polygon that can fully contain a geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_minimumboundingradius"></a><code>st_minimumboundingradius(geometry: geometry) → tuple{geometry AS center, float AS radius}</code></td><td><span class="funcdesc"><p>Returns a record containing the center point and radius of the smallest circle that can fully contains the given geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_minimumclearance"></a><code>st_minimumclearance(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the minimum distance a vertex can move before producing an invalid geometry. Returns Infinity if no minimum clearance can be found (e.g. for a single point).</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_minimumclearanceline"></a><code>st_minimumclearanceline(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a LINESTRING spanning the minimum distance a vertex can move before producing an invalid geometry. If no minimum clearance can be found (e.g. for a single point), an empty LINESTRING is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_mlinefromtext"></a><code>st_mlinefromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not MultiLineString, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_mlinefromtext"></a><code>st_mlinefromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not MultiLineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_mlinefromwkb"></a><code>st_mlinefromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not MultiLineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_mlinefromwkb"></a><code>st_mlinefromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not MultiLineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_mpointfromtext"></a><code>st_mpointfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not MultiPoint, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_mpointfromtext"></a><code>st_mpointfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not MultiPoint, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_mpointfromwkb"></a><code>st_mpointfromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not MultiPoint, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_mpointfromwkb"></a><code>st_mpointfromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not MultiPoint, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_mpolyfromtext"></a><code>st_mpolyfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not MultiPolygon, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_mpolyfromtext"></a><code>st_mpolyfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not MultiPolygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_mpolyfromwkb"></a><code>st_mpolyfromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not MultiPolygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_mpolyfromwkb"></a><code>st_mpolyfromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not MultiPolygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multi"></a><code>st_multi(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the geometry as a new multi-geometry, e.g converts a POINT to a MULTIPOINT. If the input is already a multitype or collection, it is returned as is.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multilinefromtext"></a><code>st_multilinefromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not MultiLineString, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multilinefromtext"></a><code>st_multilinefromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not MultiLineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multilinefromwkb"></a><code>st_multilinefromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not MultiLineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multilinefromwkb"></a><code>st_multilinefromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not MultiLineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multilinestringfromtext"></a><code>st_multilinestringfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not MultiLineString, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multilinestringfromtext"></a><code>st_multilinestringfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not MultiLineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multilinestringfromwkb"></a><code>st_multilinestringfromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not MultiLineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multilinestringfromwkb"></a><code>st_multilinestringfromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not MultiLineString, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multipointfromtext"></a><code>st_multipointfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not MultiPoint, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multipointfromtext"></a><code>st_multipointfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not MultiPoint, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multipointfromwkb"></a><code>st_multipointfromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not MultiPoint, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multipointfromwkb"></a><code>st_multipointfromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not MultiPoint, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multipolyfromtext"></a><code>st_multipolyfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not MultiPolygon, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multipolyfromtext"></a><code>st_multipolyfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not MultiPolygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multipolyfromwkb"></a><code>st_multipolyfromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not MultiPolygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multipolyfromwkb"></a><code>st_multipolyfromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not MultiPolygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multipolygonfromtext"></a><code>st_multipolygonfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not MultiPolygon, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multipolygonfromtext"></a><code>st_multipolygonfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not MultiPolygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multipolygonfromwkb"></a><code>st_multipolygonfromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not MultiPolygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_multipolygonfromwkb"></a><code>st_multipolygonfromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not MultiPolygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_ndims"></a><code>st_ndims(geometry: geometry) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns the number of coordinate dimensions of a given Geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_node"></a><code>st_node(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Adds a node on a geometry for each intersection. Resulting geometry is always a MultiLineString.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_normalize"></a><code>st_normalize(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the geometry in its normalized form.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_npoints"></a><code>st_npoints(geometry: geometry) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns the number of points in a given Geometry. Works for any shape type.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_nrings"></a><code>st_nrings(geometry: geometry) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns the number of rings in a Polygon Geometry. Returns 0 if the shape is not a Polygon.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_numgeometries"></a><code>st_numgeometries(geometry: geometry) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns the number of shapes inside a given Geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_numinteriorring"></a><code>st_numinteriorring(geometry: geometry) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns the number of interior rings in a Polygon Geometry. Returns NULL if the shape is not a Polygon.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_numinteriorrings"></a><code>st_numinteriorrings(geometry: geometry) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns the number of interior rings in a Polygon Geometry. Returns NULL if the shape is not a Polygon.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_numpoints"></a><code>st_numpoints(geometry: geometry) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns the number of points in a LineString. Returns NULL if the Geometry is not a LineString.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_orderingequals"></a><code>st_orderingequals(geometry_a: geometry, geometry_b: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if geometry_a is exactly equal to geometry_b, having all coordinates in the same order, as well as the same type, SRID, bounding box, and so on.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_orientedenvelope"></a><code>st_orientedenvelope(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a minimum rotated rectangle enclosing a geometry. Note that more than one minimum rotated rectangle may exist. May return a Point or LineString in the case of degenerate inputs.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_overlaps"></a><code>st_overlaps(geometry_a: geometry, geometry_b: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if geometry_a intersects but does not completely contain geometry_b, or vice versa. “Does not completely” implies ST_Within(geometry_a, geometry_b) = ST_Within(geometry_b, geometry_a) = false.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_perimeter"></a><code>st_perimeter(geography: geography) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the perimeter of the given geography in meters. Uses a spheroid to perform the operation.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_perimeter"></a><code>st_perimeter(geography: geography, use_spheroid: <a href="bool.html">bool</a>) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the perimeter of the given geography in meters.</p> <p>This function utilizes the S2 library for spherical calculations.</p> <p>This function utilizes the GeographicLib library for spheroid calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_perimeter"></a><code>st_perimeter(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the perimeter of the given geometry.</p> <p>Note ST_Perimeter is only valid for Polygon - use ST_Length for LineString.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_perimeter2d"></a><code>st_perimeter2d(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the perimeter of the given geometry.</p> <p>Note ST_Perimeter is only valid for Polygon - use ST_Length for LineString.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_point"></a><code>st_point(x: <a href="float.html">float</a>, y: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a new Point with the given X and Y coordinates.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_pointfromgeohash"></a><code>st_pointfromgeohash(geohash: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Return a POINT Geometry from a GeoHash string with max precision.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_pointfromgeohash"></a><code>st_pointfromgeohash(geohash: <a href="string.html">string</a>, precision: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Return a POINT Geometry from a GeoHash string with supplied precision.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_pointfromtext"></a><code>st_pointfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not Point, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_pointfromtext"></a><code>st_pointfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not Point, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_pointfromwkb"></a><code>st_pointfromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not Point, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_pointfromwkb"></a><code>st_pointfromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not Point, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_pointinsidecircle"></a><code>st_pointinsidecircle(geometry: geometry, x_coord: <a href="float.html">float</a>, y_coord: <a href="float.html">float</a>, radius: <a href="float.html">float</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns the true if the geometry is a point and is inside the circle. Returns false otherwise.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_pointn"></a><code>st_pointn(geometry: geometry, n: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the n-th Point of a LineString (1-indexed). Returns NULL if out of bounds or not a LineString.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_pointonsurface"></a><code>st_pointonsurface(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a point that intersects with the given Geometry.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_points"></a><code>st_points(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns all coordinates in the given Geometry as a MultiPoint, including duplicates.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_polyfromtext"></a><code>st_polyfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not Polygon, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_polyfromtext"></a><code>st_polyfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not Polygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_polyfromwkb"></a><code>st_polyfromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not Polygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_polyfromwkb"></a><code>st_polyfromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not Polygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_polygon"></a><code>st_polygon(geometry: geometry, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a new Polygon from the given LineString and sets its SRID. It is equivalent to ST_MakePolygon with a single argument followed by ST_SetSRID.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_polygonfromtext"></a><code>st_polygonfromtext(str: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation with an SRID. If the shape underneath is not Polygon, NULL is returned. If the SRID is present in both the EWKT and the argument, the argument value is used.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_polygonfromtext"></a><code>st_polygonfromtext(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation. If the shape underneath is not Polygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_polygonfromwkb"></a><code>st_polygonfromwkb(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation. If the shape underneath is not Polygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_polygonfromwkb"></a><code>st_polygonfromwkb(wkb: <a href="bytes.html">bytes</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation with an SRID. If the shape underneath is not Polygon, NULL is returned.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_project"></a><code>st_project(geography: geography, distance: <a href="float.html">float</a>, azimuth: <a href="float.html">float</a>) → geography</code></td><td><span class="funcdesc"><p>Returns a point projected from a start point along a geodesic using a given distance and azimuth (bearing). This is known as the direct geodesic problem.</p> <p>The distance is given in meters. Negative values are supported.</p> <p>The azimuth (also known as heading or bearing) is given in radians. It is measured clockwise from true north (azimuth zero). East is azimuth π/2 (90 degrees); south is azimuth π (180 degrees); west is azimuth 3π/2 (270 degrees). Negative azimuth values and values greater than 2π (360 degrees) are supported.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_relate"></a><code>st_relate(geometry_a: geometry, geometry_b: geometry) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the DE-9IM spatial relation between geometry_a and geometry_b.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_relate"></a><code>st_relate(geometry_a: geometry, geometry_b: geometry, bnr: <a href="int.html">int</a>) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns the DE-9IM spatial relation between geometry_a and geometry_b using the given boundary node rule (1:OGC/MOD2, 2:Endpoint, 3:MultivalentEndpoint, 4:MonovalentEndpoint).</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_relate"></a><code>st_relate(geometry_a: geometry, geometry_b: geometry, pattern: <a href="string.html">string</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns whether the DE-9IM spatial relation between geometry_a and geometry_b matches the DE-9IM pattern.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_relatematch"></a><code>st_relatematch(intersection_matrix: <a href="string.html">string</a>, pattern: <a href="string.html">string</a>) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns whether the given DE-9IM intersection matrix satisfies the given pattern.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_removepoint"></a><code>st_removepoint(line_string: geometry, index: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Removes the Point at the given 0-based index and returns the modified LineString geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_removerepeatedpoints"></a><code>st_removerepeatedpoints(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a geometry with repeated points removed.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_removerepeatedpoints"></a><code>st_removerepeatedpoints(geometry: geometry, tolerance: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a geometry with repeated points removed, within the given distance tolerance.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_reverse"></a><code>st_reverse(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified geometry by reversing the order of its vertices.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_rotate"></a><code>st_rotate(g: geometry, angle_radians: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified Geometry whose coordinates are rotated around the origin by a rotation angle.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_rotate"></a><code>st_rotate(g: geometry, angle_radians: <a href="float.html">float</a>, origin_point: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified Geometry whose coordinates are rotated around the provided origin by a rotation angle.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_rotate"></a><code>st_rotate(g: geometry, angle_radians: <a href="float.html">float</a>, origin_x: <a href="float.html">float</a>, origin_y: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified Geometry whose coordinates are rotated around the provided origin by a rotation angle.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_rotatex"></a><code>st_rotatex(g: geometry, angle_radians: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified Geometry whose coordinates are rotated about the x axis by a rotation angle.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_rotatey"></a><code>st_rotatey(g: geometry, angle_radians: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified Geometry whose coordinates are rotated about the y axis by a rotation angle.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_rotatez"></a><code>st_rotatez(g: geometry, angle_radians: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified Geometry whose coordinates are rotated about the z axis by a rotation angle.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_s2covering"></a><code>st_s2covering(geography: geography) → geography</code></td><td><span class="funcdesc"><p>Returns a geography which represents the S2 covering used by the index using the default index configuration.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_s2covering"></a><code>st_s2covering(geography: geography, settings: <a href="string.html">string</a>) → geography</code></td><td><span class="funcdesc"><p>Returns a geography which represents the S2 covering used by the index using the index configuration specified by the settings parameter.</p> <p>The settings parameter uses the same format as the parameters inside the <code>WITH</code> in <code>CREATE INDEX ... WITH (...)</code>, e.g. <code>CREATE INDEX t_idx ON t USING GIST(geom) WITH (s2_max_level=15, s2_level_mod=3)</code> can be tried using <code>SELECT ST_S2Covering(geography, 's2_max_level=15,s2_level_mod=3')</code>.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_s2covering"></a><code>st_s2covering(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a geometry which represents the S2 covering used by the index using the default index configuration.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_s2covering"></a><code>st_s2covering(geometry: geometry, settings: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a geometry which represents the S2 covering used by the index using the index configuration specified by the settings parameter.</p> <p>The settings parameter uses the same format as the parameters inside the <code>WITH</code> in <code>CREATE INDEX ... WITH (...)</code>, e.g. <code>CREATE INDEX t_idx ON t USING GIST(geom) WITH (s2_max_level=15, s2_level_mod=3)</code> can be tried using <code>SELECT ST_S2Covering(geometry, 's2_max_level=15,s2_level_mod=3')</code></p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_scale"></a><code>st_scale(g: geometry, factor: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified Geometry scaled by taking in a Geometry as the factor.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_scale"></a><code>st_scale(g: geometry, factor: geometry, origin: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified Geometry scaled by the Geometry factor relative to a false origin.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_scale"></a><code>st_scale(geometry: geometry, x_factor: <a href="float.html">float</a>, y_factor: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified Geometry scaled by the given factors.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_segmentize"></a><code>st_segmentize(geography: geography, max_segment_length_meters: <a href="float.html">float</a>) → geography</code></td><td><span class="funcdesc"><p>Returns a modified Geography having no segment longer than the given max_segment_length meters.</p> <p>The calculations are done on a sphere.</p> <p>This function utilizes the S2 library for spherical calculations.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_segmentize"></a><code>st_segmentize(geometry: geometry, max_segment_length: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified Geometry having no segment longer than the given max_segment_length. Length units are in units of spatial reference.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_setpoint"></a><code>st_setpoint(line_string: geometry, index: <a href="int.html">int</a>, point: geometry) → geometry</code></td><td><span class="funcdesc"><p>Sets the Point at the given 0-based index and returns the modified LineString geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_setsrid"></a><code>st_setsrid(geography: geography, srid: <a href="int.html">int</a>) → geography</code></td><td><span class="funcdesc"><p>Sets a Geography to a new SRID without transforming the coordinates.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_setsrid"></a><code>st_setsrid(geometry: geometry, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Sets a Geometry to a new SRID without transforming the coordinates.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_sharedpaths"></a><code>st_sharedpaths(geometry_a: geometry, geometry_b: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a collection containing paths shared by the two input geometries.</p> <p>Those going in the same direction are in the first element of the collection, those going in the opposite direction are in the second element. The paths themselves are given in the direction of the first geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_shiftlongitude"></a><code>st_shiftlongitude(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified version of a geometry in which the longitude (X coordinate) of each point is incremented by 360 if it is <0 and decremented by 360 if it is >180. The result is only meaningful if the coordinates are in longitude/latitude.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_shortestline"></a><code>st_shortestline(geometry_a: geometry, geometry_b: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the LineString corresponds to the minimum distance across every pair of points comprising the given geometries.</p> <p>Note if geometries are the same, it will return the LineString with the minimum distance between the geometry’s vertexes. The function will return the shortest line that was discovered first when comparing minimum distances if more than one is found.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_simplify"></a><code>st_simplify(geometry: geometry, tolerance: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Simplifies the given geometry using the Douglas-Peucker algorithm.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_simplify"></a><code>st_simplify(geometry: geometry, tolerance: <a href="float.html">float</a>, preserve_collapsed: <a href="bool.html">bool</a>) → geometry</code></td><td><span class="funcdesc"><p>Simplifies the given geometry using the Douglas-Peucker algorithm, retaining objects that would be too small given the tolerance if preserve_collapsed is set to true.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_simplifypreservetopology"></a><code>st_simplifypreservetopology(geometry: geometry, tolerance: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Simplifies the given geometry using the Douglas-Peucker algorithm, avoiding the creation of invalid geometries.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_snap"></a><code>st_snap(input: geometry, target: geometry, tolerance: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Snaps the vertices and segments of input geometry the target geometry’s vertices. Tolerance is used to control where snapping is performed. The result geometry is the input geometry with the vertices snapped. If no snapping occurs then the input geometry is returned unchanged.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_snaptogrid"></a><code>st_snaptogrid(geometry: geometry, origin: geometry, size_x: <a href="float.html">float</a>, size_y: <a href="float.html">float</a>, size_z: <a href="float.html">float</a>, size_m: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Snap a geometry to a grid defined by the given origin and X, Y, Z, and M cell sizes. Any dimension with a 0 cell size will not be snapped.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_snaptogrid"></a><code>st_snaptogrid(geometry: geometry, origin_x: <a href="float.html">float</a>, origin_y: <a href="float.html">float</a>, size_x: <a href="float.html">float</a>, size_y: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Snap a geometry to a grid of with X coordinates snapped to size_x and Y coordinates snapped to size_y based on an origin of (origin_x, origin_y).</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_snaptogrid"></a><code>st_snaptogrid(geometry: geometry, size: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Snap a geometry to a grid of the given size. The specified size is only used to snap X and Y coordinates.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_snaptogrid"></a><code>st_snaptogrid(geometry: geometry, size_x: <a href="float.html">float</a>, size_y: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Snap a geometry to a grid of with X coordinates snapped to size_x and Y coordinates snapped to size_y.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_srid"></a><code>st_srid(geography: geography) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns the Spatial Reference Identifier (SRID) for the ST_Geography as defined in spatial_ref_sys table.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_srid"></a><code>st_srid(geometry: geometry) → <a href="int.html">int</a></code></td><td><span class="funcdesc"><p>Returns the Spatial Reference Identifier (SRID) for the ST_Geometry as defined in spatial_ref_sys table.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_startpoint"></a><code>st_startpoint(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the first point of a geometry which has shape LineString. Returns NULL if the geometry is not a LineString.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_subdivide"></a><code>st_subdivide(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a geometry divided into parts, where each part contains no more than 256 vertices.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_subdivide"></a><code>st_subdivide(geometry: geometry, max_vertices: int4) → geometry</code></td><td><span class="funcdesc"><p>Returns a geometry divided into parts, where each part contains no more than the number of vertices provided.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_summary"></a><code>st_summary(geography: geography) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns a text summary of the contents of the geography.</p> <p>Flags shown square brackets after the geometry type have the following meaning:</p> <ul> <li>M: has M coordinate</li> <li>Z: has Z coordinate</li> <li>B: has a cached bounding box</li> <li>G: is geography</li> <li>S: has spatial reference system</li> </ul> </span></td><td>Immutable</td></tr> <tr><td><a name="st_summary"></a><code>st_summary(geometry: geometry) → <a href="string.html">string</a></code></td><td><span class="funcdesc"><p>Returns a text summary of the contents of the geometry.</p> <p>Flags shown square brackets after the geometry type have the following meaning:</p> <ul> <li>M: has M coordinate</li> <li>Z: has Z coordinate</li> <li>B: has a cached bounding box</li> <li>G: is geography</li> <li>S: has spatial reference system</li> </ul> </span></td><td>Immutable</td></tr> <tr><td><a name="st_swapordinates"></a><code>st_swapordinates(geometry: geometry, swap_ordinate_string: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a version of the given geometry with given ordinates swapped. The swap_ordinate_string parameter is a 2-character string naming the ordinates to swap. Valid names are: x, y, z and m.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_symdifference"></a><code>st_symdifference(geometry_a: geometry, geometry_b: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the symmetric difference of both geometries.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_symmetricdifference"></a><code>st_symmetricdifference(geometry_a: geometry, geometry_b: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns the symmetric difference of both geometries.</p> <p>This function utilizes the GEOS module.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_tileenvelope"></a><code>st_tileenvelope(tileZoom: int4, tileX: int4, tileY: int4) → geometry</code></td><td><span class="funcdesc"><p>Creates a rectangular Polygon giving the extent of a tile in the XYZ tile system. The tile is specifed by the zoom level Z and the XY index of the tile in the grid at that level. Can be used to define the tile bounds required by ST_AsMVTGeom to convert geometry into the MVT tile coordinate space.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_tileenvelope"></a><code>st_tileenvelope(tileZoom: int4, tileX: int4, tileY: int4, bounds: geometry) → geometry</code></td><td><span class="funcdesc"><p>Creates a rectangular Polygon giving the extent of a tile in the XYZ tile system. The tile is specifed by the zoom level Z and the XY index of the tile in the grid at that level. Can be used to define the tile bounds required by ST_AsMVTGeom to convert geometry into the MVT tile coordinate space.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_tileenvelope"></a><code>st_tileenvelope(tileZoom: int4, tileX: int4, tileY: int4, bounds: geometry, margin: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Creates a rectangular Polygon giving the extent of a tile in the XYZ tile system. The tile is specifed by the zoom level Z and the XY index of the tile in the grid at that level. Can be used to define the tile bounds required by ST_AsMVTGeom to convert geometry into the MVT tile coordinate space.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_touches"></a><code>st_touches(geometry_a: geometry, geometry_b: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if the only points in common between geometry_a and geometry_b are on the boundary. Note points do not touch other points.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_transform"></a><code>st_transform(geometry: geometry, from_proj_text: <a href="string.html">string</a>, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Transforms a geometry into the coordinate reference system assuming the from_proj_text to the new to_proj_text by projecting its coordinates. The supplied SRID is set on the new geometry.</p> <p>This function utilizes the PROJ library for coordinate projections.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_transform"></a><code>st_transform(geometry: geometry, from_proj_text: <a href="string.html">string</a>, to_proj_text: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Transforms a geometry into the coordinate reference system assuming the from_proj_text to the new to_proj_text by projecting its coordinates.</p> <p>This function utilizes the PROJ library for coordinate projections.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_transform"></a><code>st_transform(geometry: geometry, srid: <a href="int.html">int</a>) → geometry</code></td><td><span class="funcdesc"><p>Transforms a geometry into the given SRID coordinate reference system by projecting its coordinates.</p> <p>This function utilizes the PROJ library for coordinate projections.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_transform"></a><code>st_transform(geometry: geometry, to_proj_text: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Transforms a geometry into the coordinate reference system referenced by the projection text by projecting its coordinates.</p> <p>This function utilizes the PROJ library for coordinate projections.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_translate"></a><code>st_translate(g: geometry, delta_x: <a href="float.html">float</a>, delta_y: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified Geometry translated by the given deltas.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_translate"></a><code>st_translate(g: geometry, delta_x: <a href="float.html">float</a>, delta_y: <a href="float.html">float</a>, delta_z: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a modified Geometry translated by the given deltas.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_transscale"></a><code>st_transscale(geometry: geometry, delta_x: <a href="float.html">float</a>, delta_y: <a href="float.html">float</a>, x_factor: <a href="float.html">float</a>, y_factor: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Translates the geometry using the deltaX and deltaY args, then scales it using the XFactor, YFactor args, working in 2D only.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_unaryunion"></a><code>st_unaryunion(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a union of the components for any geometry or geometry collection provided. Dissolves boundaries of a multipolygon.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_voronoilines"></a><code>st_voronoilines(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a two-dimensional Voronoi diagram from the vertices of the supplied geometry asthe boundaries between cells in that diagram as a MultiLineString.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_voronoilines"></a><code>st_voronoilines(geometry: geometry, tolerance: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a two-dimensional Voronoi diagram from the vertices of the supplied geometry asthe boundaries between cells in that diagram as a MultiLineString.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_voronoilines"></a><code>st_voronoilines(geometry: geometry, tolerance: <a href="float.html">float</a>, extend_to: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a two-dimensional Voronoi diagram from the vertices of the supplied geometry asthe boundaries between cells in that diagram as a MultiLineString.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_voronoipolygons"></a><code>st_voronoipolygons(geometry: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a two-dimensional Voronoi diagram from the vertices of the supplied geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_voronoipolygons"></a><code>st_voronoipolygons(geometry: geometry, tolerance: <a href="float.html">float</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns a two-dimensional Voronoi diagram from the vertices of the supplied geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_voronoipolygons"></a><code>st_voronoipolygons(geometry: geometry, tolerance: <a href="float.html">float</a>, extend_to: geometry) → geometry</code></td><td><span class="funcdesc"><p>Returns a two-dimensional Voronoi diagram from the vertices of the supplied geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_within"></a><code>st_within(geometry_a: geometry, geometry_b: geometry) → <a href="bool.html">bool</a></code></td><td><span class="funcdesc"><p>Returns true if geometry_a is completely inside geometry_b.</p> <p>This function utilizes the GEOS module.</p> <p>This function variant will attempt to utilize any available spatial index.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_wkbtosql"></a><code>st_wkbtosql(val: <a href="bytes.html">bytes</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKB (or EWKB) representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_wkttosql"></a><code>st_wkttosql(val: <a href="string.html">string</a>) → geometry</code></td><td><span class="funcdesc"><p>Returns the Geometry from a WKT or EWKT representation.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_x"></a><code>st_x(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the X coordinate of a geometry if it is a Point.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_xmax"></a><code>st_xmax(box2d: box2d) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the maximum X ordinate of a box2d.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_xmax"></a><code>st_xmax(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the maximum X ordinate of a geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_xmin"></a><code>st_xmin(box2d: box2d) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the minimum X ordinate of a box2d.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_xmin"></a><code>st_xmin(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the minimum X ordinate of a geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_y"></a><code>st_y(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the Y coordinate of a geometry if it is a Point.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_ymax"></a><code>st_ymax(box2d: box2d) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the maximum Y ordinate of a box2d.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_ymax"></a><code>st_ymax(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the maximum Y ordinate of a geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_ymin"></a><code>st_ymin(box2d: box2d) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the minimum Y ordinate of a box2d.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_ymin"></a><code>st_ymin(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the minimum Y ordinate of a geometry.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_z"></a><code>st_z(geometry: geometry) → <a href="float.html">float</a></code></td><td><span class="funcdesc"><p>Returns the Z coordinate of a geometry if it is a Point.</p> </span></td><td>Immutable</td></tr> <tr><td><a name="st_zmflag"></a><code>st_zmflag(geometry: geometry) → int2</code></td><td><span class="funcdesc"><p>Returns a code based on the ZM coordinate dimension of a geometry (XY = 0, XYM = 1, XYZ = 2, XYZM = 3).</p> </span></td><td>Immutable</td></tr></tbody> </table>