|
47 | 47 | | [`ST_GeomFromHEXWKB`](#st_geomfromhexwkb) | Creates a GEOMETRY from a HEXWKB string | |
48 | 48 | | [`ST_GeomFromText`](#st_geomfromtext) | Deserializes a GEOMETRY from a WKT string, optionally ignoring invalid geometries | |
49 | 49 | | [`ST_GeomFromWKB`](#st_geomfromwkb) | Deserializes a GEOMETRY from a WKB encoded blob | |
50 | | -| [`ST_GeometryType`](#st_geometrytype) | Returns a 'GEOMETRY_TYPE' enum identifying the input geometry type. | |
| 50 | +| [`ST_GeometryType`](#st_geometrytype) | Returns a 'GEOMETRY_TYPE' enum identifying the input geometry type. Possible enum return types are: `POINT`, `LINESTRING`, `POLYGON`, `MULTIPOINT`, `MULTILINESTRING`, `MULTIPOLYGON`, and `GEOMETRYCOLLECTION`. | |
51 | 51 | | [`ST_HasM`](#st_hasm) | Check if the input geometry has M values. | |
52 | 52 | | [`ST_HasZ`](#st_hasz) | Check if the input geometry has Z values. | |
53 | 53 | | [`ST_Hilbert`](#st_hilbert) | Encodes the X and Y values as the hilbert curve index for a curve covering the given bounding box. | |
@@ -610,14 +610,14 @@ Returns if two geometries are within a target distance of each-other |
610 | 610 | #### Signature |
611 | 611 |
|
612 | 612 | ```sql |
613 | | -DOUBLE ST_DWithin_Spheroid (col0 POINT_2D, col1 POINT_2D, col2 DOUBLE) |
| 613 | +BOOLEAN ST_DWithin_Spheroid (col0 POINT_2D, col1 POINT_2D, col2 DOUBLE) |
614 | 614 | ``` |
615 | 615 |
|
616 | 616 | #### Description |
617 | 617 |
|
618 | 618 | Returns if two POINT_2D's are within a target distance in meters, using an ellipsoidal model of the earths surface |
619 | 619 |
|
620 | | -The input geometry is assumed to be in the [EPSG:4326](https://en.wikipedia.org/wiki/World_Geodetic_System) coordinate system (WGS84), with [latitude, longitude] axis order and the distance is returned in meters. This function uses the [GeographicLib](https://geographiclib.sourceforge.io/) library to solve the [inverse geodesic problem](https://en.wikipedia.org/wiki/Geodesics_on_an_ellipsoid#Solution_of_the_direct_and_inverse_problems), calculating the distance between two points using an ellipsoidal model of the earth. This is a highly accurate method for calculating the distance between two arbitrary points taking the curvature of the earths surface into account, but is also the slowest. |
| 620 | + The input geometry is assumed to be in the [EPSG:4326](https://en.wikipedia.org/wiki/World_Geodetic_System) coordinate system (WGS84), with [latitude, longitude] axis order and the distance is returned in meters. This function uses the [GeographicLib](https://geographiclib.sourceforge.io/) library to solve the [inverse geodesic problem](https://en.wikipedia.org/wiki/Geodesics_on_an_ellipsoid#Solution_of_the_direct_and_inverse_problems), calculating the distance between two points using an ellipsoidal model of the earth. This is a highly accurate method for calculating the distance between two arbitrary points taking the curvature of the earths surface into account, but is also the slowest. |
621 | 621 |
|
622 | 622 | ---- |
623 | 623 |
|
@@ -1059,7 +1059,15 @@ ANY ST_GeometryType (col0 WKB_BLOB) |
1059 | 1059 |
|
1060 | 1060 | #### Description |
1061 | 1061 |
|
1062 | | -Returns a 'GEOMETRY_TYPE' enum identifying the input geometry type. |
| 1062 | +Returns a 'GEOMETRY_TYPE' enum identifying the input geometry type. Possible enum return types are: `POINT`, `LINESTRING`, `POLYGON`, `MULTIPOINT`, `MULTILINESTRING`, `MULTIPOLYGON`, and `GEOMETRYCOLLECTION`. |
| 1063 | + |
| 1064 | +#### Example |
| 1065 | + |
| 1066 | +```sql |
| 1067 | +SELECT DISTINCT ST_GeometryType(ST_GeomFromText('POINT(1 1)')); |
| 1068 | +---- |
| 1069 | +POINT |
| 1070 | +``` |
1063 | 1071 |
|
1064 | 1072 | ---- |
1065 | 1073 |
|
@@ -2342,7 +2350,7 @@ SELECT * FROM ST_Drivers(); |
2342 | 2350 | #### Signature |
2343 | 2351 |
|
2344 | 2352 | ```sql |
2345 | | -ST_Read (col0 VARCHAR, keep_wkb BOOLEAN, max_batch_size INTEGER, sequential_layer_scan BOOLEAN, layer VARCHAR, sibling_files VARCHAR[], spatial_filter WKB_BLOB, spatial_filter_box BOX_2D, allowed_drivers VARCHAR[], open_options VARCHAR[]) |
| 2353 | +ST_Read (col0 VARCHAR, keep_wkb BOOLEAN, max_batch_size INTEGER, sequential_layer_scan BOOLEAN, layer VARCHAR, spatial_filter WKB_BLOB, spatial_filter_box BOX_2D, sibling_files VARCHAR[], allowed_drivers VARCHAR[], open_options VARCHAR[]) |
2346 | 2354 | ``` |
2347 | 2355 |
|
2348 | 2356 | #### Description |
|
0 commit comments