This is an automated email from the ASF dual-hosted git repository. jiayu pushed a commit to branch issue-2679-doc-return-types in repository https://gitbox.apache.org/repos/asf/sedona.git
commit 05d63cee3f2ebce3b2e434e00c95a0000b8a0a14 Author: Jia Yu <[email protected]> AuthorDate: Tue Mar 3 23:45:36 2026 -0800 Fix escaped angle brackets in summary table return types Remove backslash escapes and wrap complex return types (Array<>, Struct<>) in backtick code spans to prevent MkDocs from stripping them as HTML tags. --- docs/api/flink/Geometry-Functions.md | 26 ++++++++--------- docs/api/sql/Geometry-Functions.md | 34 +++++++++++------------ docs/api/sql/Raster-Functions.md | 54 ++++++++++++++++++------------------ 3 files changed, 57 insertions(+), 57 deletions(-) diff --git a/docs/api/flink/Geometry-Functions.md b/docs/api/flink/Geometry-Functions.md index b8976ea379..70621127b3 100644 --- a/docs/api/flink/Geometry-Functions.md +++ b/docs/api/flink/Geometry-Functions.md @@ -69,8 +69,8 @@ These functions extract information and properties from geometry objects. | [ST_CoordDim](Geometry-Accessors/ST_CoordDim.md) | Integer | Returns the coordinate dimensions of the geometry. It is an alias of `ST_NDims`. | v1.5.0 | | [ST_CrossesDateLine](Geometry-Accessors/ST_CrossesDateLine.md) | Boolean | This function determines if a given geometry crosses the International Date Line. It operates by checking if the difference in longitude between any pair of consecutive points in the geometry excee... | v1.6.0 | | [ST_Dimension](Geometry-Accessors/ST_Dimension.md) | Integer | Return the topological dimension of this Geometry object, which must be less than or equal to the coordinate dimension. OGC SPEC s2.1.1.1 - returns 0 for POINT, 1 for LINESTRING, 2 for POLYGON, and... | v1.5.0 | -| [ST_Dump](Geometry-Accessors/ST_Dump.md) | Array\<Geometry\> | It expands the geometries. If the geometry is simple (Point, Polygon Linestring etc.) it returns the geometry itself, if the geometry is collection or multi it returns record for each of collection... | v1.5.0 | -| [ST_DumpPoints](Geometry-Accessors/ST_DumpPoints.md) | Array\<Geometry\> | Returns list of Points which geometry consists of. | v1.5.0 | +| [ST_Dump](Geometry-Accessors/ST_Dump.md) | `Array<Geometry>` | It expands the geometries. If the geometry is simple (Point, Polygon Linestring etc.) it returns the geometry itself, if the geometry is collection or multi it returns record for each of collection... | v1.5.0 | +| [ST_DumpPoints](Geometry-Accessors/ST_DumpPoints.md) | `Array<Geometry>` | Returns list of Points which geometry consists of. | v1.5.0 | | [ST_EndPoint](Geometry-Accessors/ST_EndPoint.md) | Geometry | Returns last point of given linestring. | v1.5.0 | | [ST_ExteriorRing](Geometry-Accessors/ST_ExteriorRing.md) | Geometry | Returns a LINESTRING representing the exterior ring (shell) of a POLYGON. Returns NULL if the geometry is not a polygon. | v1.2.1 | | [ST_GeometryN](Geometry-Accessors/ST_GeometryN.md) | Geometry | Return the 0-based Nth geometry if the geometry is a GEOMETRYCOLLECTION, (MULTI)POINT, (MULTI)LINESTRING, MULTICURVE or (MULTI)POLYGON. Otherwise, return null | v1.3.0 | @@ -123,7 +123,7 @@ These functions create modified geometries by changing type, structure, or verti | [ST_ForceRHR](Geometry-Editors/ST_ForceRHR.md) | Geometry | Sets the orientation of polygon vertex orderings to follow the Right-Hand-Rule convention. The exterior ring will have a clockwise winding order, while any interior rings are oriented counter-clock... | v1.6.1 | | [ST_LineFromMultiPoint](Geometry-Editors/ST_LineFromMultiPoint.md) | Geometry | Creates a LineString from a MultiPoint geometry. | v1.3.0 | | [ST_LineMerge](Geometry-Editors/ST_LineMerge.md) | Geometry | Returns a LineString or MultiLineString formed by sewing together the constituent line work of a MULTILINESTRING. | v1.5.0 | -| [ST_LineSegments](Geometry-Editors/ST_LineSegments.md) | Array\<Geometry\> | This function transforms a LineString containing multiple coordinates into an array of LineStrings, each with precisely two coordinates. The `lenient` argument, true by default, prevents an excepti... | v1.7.1 | +| [ST_LineSegments](Geometry-Editors/ST_LineSegments.md) | `Array<Geometry>` | This function transforms a LineString containing multiple coordinates into an array of LineStrings, each with precisely two coordinates. The `lenient` argument, true by default, prevents an excepti... | v1.7.1 | | [ST_MakeLine](Geometry-Editors/ST_MakeLine.md) | Geometry | Creates a LineString containing the points of Point, MultiPoint, or LineString geometries. Other geometry types cause an error. | v1.5.0 | | [ST_MakePolygon](Geometry-Editors/ST_MakePolygon.md) | Geometry | Function to convert closed linestring to polygon including holes. If holes are provided, they should be fully contained within the shell. Holes outside the shell will produce an invalid polygon (ma... | v1.5.0 | | [ST_Multi](Geometry-Editors/ST_Multi.md) | Geometry | Returns a MultiGeometry object based on the geometry input. ST_Multi is basically an alias for ST_Collect with one geometry. | v1.5.0 | @@ -241,7 +241,7 @@ These functions compute results arising from the overlay of two geometries. Thes | :--- | :--- | :--- | :--- | | [ST_Difference](Overlay-Functions/ST_Difference.md) | Geometry | Return the difference between geometry A and B (return part of geometry A that does not intersect geometry B) | v1.5.0 | | [ST_Intersection](Overlay-Functions/ST_Intersection.md) | Geometry | Return the intersection geometry of A and B | v1.5.0 | -| [ST_SubDivide](Overlay-Functions/ST_SubDivide.md) | Array\<Geometry\> | Returns list of geometries divided based of given maximum number of vertices. | v1.5.0 | +| [ST_SubDivide](Overlay-Functions/ST_SubDivide.md) | Array<Geometry> | Returns list of geometries divided based of given maximum number of vertices. | v1.5.0 | | [ST_SymDifference](Overlay-Functions/ST_SymDifference.md) | Geometry | Return the symmetrical difference between geometry A and B (return parts of geometries which are in either of the sets, but not in their intersection) | v1.5.0 | | [ST_UnaryUnion](Overlay-Functions/ST_UnaryUnion.md) | Geometry | This variant of [ST_Union](Overlay-Functions/ST_Union.md) operates on a single geometry input. The input geometry can be a simple Geometry type, a MultiGeometry, or a GeometryCollection. The function calculates the ge... | v1.6.1 | | [ST_Union](Overlay-Functions/ST_Union.md) | Geometry | Variant 1: Return the union of geometry A and B. | v1.6.0 | @@ -331,18 +331,18 @@ These functions work with spatial indexing systems including Bing Tiles, H3, S2, | :--- | :--- | :--- | :--- | | [ST_BingTile](Spatial-Indexing/ST_BingTile.md) | String | Creates a Bing Tile quadkey from tile XY coordinates and a zoom level. | v1.9.0 | | [ST_BingTileAt](Spatial-Indexing/ST_BingTileAt.md) | String | Returns the Bing Tile quadkey for a given point (longitude, latitude) at a specified zoom level. | v1.9.0 | -| [ST_BingTileCellIDs](Spatial-Indexing/ST_BingTileCellIDs.md) | Array\<String\> | Returns an array of Bing Tile quadkey strings that cover the given geometry at the specified zoom level. | v1.9.0 | +| [ST_BingTileCellIDs](Spatial-Indexing/ST_BingTileCellIDs.md) | `Array<String>` | Returns an array of Bing Tile quadkey strings that cover the given geometry at the specified zoom level. | v1.9.0 | | [ST_BingTilePolygon](Spatial-Indexing/ST_BingTilePolygon.md) | Geometry | Returns the bounding polygon (Geometry) of the Bing Tile identified by the given quadkey. | v1.9.0 | -| [ST_BingTilesAround](Spatial-Indexing/ST_BingTilesAround.md) | Array\<String\> | Returns an array of Bing Tile quadkey strings representing the neighborhood tiles around the tile that contains the given point (longitude, latitude) at the specified zoom level. Returns the 3×3 ne... | v1.9.0 | -| [ST_BingTileToGeom](Spatial-Indexing/ST_BingTileToGeom.md) | Array\<Geometry\> | Returns an array of Polygons for the corresponding Bing Tile quadkeys. | v1.9.0 | +| [ST_BingTilesAround](Spatial-Indexing/ST_BingTilesAround.md) | `Array<String>` | Returns an array of Bing Tile quadkey strings representing the neighborhood tiles around the tile that contains the given point (longitude, latitude) at the specified zoom level. Returns the 3×3 ne... | v1.9.0 | +| [ST_BingTileToGeom](Spatial-Indexing/ST_BingTileToGeom.md) | `Array<Geometry>` | Returns an array of Polygons for the corresponding Bing Tile quadkeys. | v1.9.0 | | [ST_BingTileX](Spatial-Indexing/ST_BingTileX.md) | Integer | Returns the tile X coordinate of the Bing Tile identified by the given quadkey. | v1.9.0 | | [ST_BingTileY](Spatial-Indexing/ST_BingTileY.md) | Integer | Returns the tile Y coordinate of the Bing Tile identified by the given quadkey. | v1.9.0 | | [ST_BingTileZoomLevel](Spatial-Indexing/ST_BingTileZoomLevel.md) | Integer | Returns the zoom level of the Bing Tile identified by the given quadkey. | v1.9.0 | | [ST_GeoHashNeighbor](Spatial-Indexing/ST_GeoHashNeighbor.md) | String | Returns the neighbor geohash cell in the given direction. Valid directions are: `n`, `ne`, `e`, `se`, `s`, `sw`, `w`, `nw` (case-insensitive). | v1.9.0 | -| [ST_GeoHashNeighbors](Spatial-Indexing/ST_GeoHashNeighbors.md) | Array\<String\> | Returns the 8 neighboring geohash cells of a given geohash string. The result is an array of 8 geohash strings in the order: N, NE, E, SE, S, SW, W, NW. | v1.9.0 | +| [ST_GeoHashNeighbors](Spatial-Indexing/ST_GeoHashNeighbors.md) | `Array<String>` | Returns the 8 neighboring geohash cells of a given geohash string. The result is an array of 8 geohash strings in the order: N, NE, E, SE, S, SW, W, NW. | v1.9.0 | | [ST_H3CellDistance](Spatial-Indexing/ST_H3CellDistance.md) | Long | return result of h3 function [gridDistance(cel1, cell2)](https://h3geo.org/docs/api/traversal#griddistance). As described by H3 documentation > Finding the distance can fail because the two indexes... | v1.5.0 | -| [ST_H3CellIDs](Spatial-Indexing/ST_H3CellIDs.md) | Array\<Long\> | Cover the geometry by H3 cell IDs with the given resolution(level). To understand the cell statistics please refer to [H3 Doc](https://h3geo.org/docs/core-library/restable) H3 native fill functions... | v1.5.0 | -| [ST_H3KRing](Spatial-Indexing/ST_H3KRing.md) | Array\<Long\> | return the result of H3 function [gridDisk(cell, k)](https://h3geo.org/docs/api/traversal#griddisk). | v1.5.0 | -| [ST_H3ToGeom](Spatial-Indexing/ST_H3ToGeom.md) | Array\<Geometry\> | Return the result of H3 function [cellsToMultiPolygon(cells)](https://h3geo.org/docs/api/regions#cellstolinkedmultipolygon--cellstomultipolygon). | v1.6.0 | -| [ST_S2CellIDs](Spatial-Indexing/ST_S2CellIDs.md) | Array\<Long\> | Cover the geometry with Google S2 Cells, return the corresponding cell IDs with the given level. The level indicates the [size of cells](https://s2geometry.io/resources/s2cell_statistics.html). With... | v1.4.0 | -| [ST_S2ToGeom](Spatial-Indexing/ST_S2ToGeom.md) | Array\<Geometry\> | Returns an array of Polygons for the corresponding S2 cell IDs. | v1.6.0 | +| [ST_H3CellIDs](Spatial-Indexing/ST_H3CellIDs.md) | `Array<Long>` | Cover the geometry by H3 cell IDs with the given resolution(level). To understand the cell statistics please refer to [H3 Doc](https://h3geo.org/docs/core-library/restable) H3 native fill functions... | v1.5.0 | +| [ST_H3KRing](Spatial-Indexing/ST_H3KRing.md) | `Array<Long>` | return the result of H3 function [gridDisk(cell, k)](https://h3geo.org/docs/api/traversal#griddisk). | v1.5.0 | +| [ST_H3ToGeom](Spatial-Indexing/ST_H3ToGeom.md) | `Array<Geometry>` | Return the result of H3 function [cellsToMultiPolygon(cells)](https://h3geo.org/docs/api/regions#cellstolinkedmultipolygon--cellstomultipolygon). | v1.6.0 | +| [ST_S2CellIDs](Spatial-Indexing/ST_S2CellIDs.md) | `Array<Long>` | Cover the geometry with Google S2 Cells, return the corresponding cell IDs with the given level. The level indicates the [size of cells](https://s2geometry.io/resources/s2cell_statistics.html). With... | v1.4.0 | +| [ST_S2ToGeom](Spatial-Indexing/ST_S2ToGeom.md) | `Array<Geometry>` | Returns an array of Polygons for the corresponding S2 cell IDs. | v1.6.0 | diff --git a/docs/api/sql/Geometry-Functions.md b/docs/api/sql/Geometry-Functions.md index a7bbdb7165..1369f9a883 100644 --- a/docs/api/sql/Geometry-Functions.md +++ b/docs/api/sql/Geometry-Functions.md @@ -70,8 +70,8 @@ These functions extract information and properties from geometry objects. | [ST_CoordDim](Geometry-Accessors/ST_CoordDim.md) | Integer | Returns the coordinate dimensions of the geometry. It is an alias of `ST_NDims`. | v1.5.0 | | [ST_CrossesDateLine](Geometry-Accessors/ST_CrossesDateLine.md) | Boolean | This function determines if a given geometry crosses the International Date Line. It operates by checking if the difference in longitude between any pair of consecutive points in the geometry excee... | v1.6.0 | | [ST_Dimension](Geometry-Accessors/ST_Dimension.md) | Integer | Return the topological dimension of this Geometry object, which must be less than or equal to the coordinate dimension. OGC SPEC s2.1.1.1 - returns 0 for POINT, 1 for LINESTRING, 2 for POLYGON, and... | v1.5.0 | -| [ST_Dump](Geometry-Accessors/ST_Dump.md) | Array\<Geometry\> | It expands the geometries. If the geometry is simple (Point, Polygon Linestring etc.) it returns the geometry itself, if the geometry is collection or multi it returns record for each of collection... | v1.0.0 | -| [ST_DumpPoints](Geometry-Accessors/ST_DumpPoints.md) | Array\<Geometry\> | Returns list of Points which geometry consists of. | v1.0.0 | +| [ST_Dump](Geometry-Accessors/ST_Dump.md) | `Array<Geometry>` | It expands the geometries. If the geometry is simple (Point, Polygon Linestring etc.) it returns the geometry itself, if the geometry is collection or multi it returns record for each of collection... | v1.0.0 | +| [ST_DumpPoints](Geometry-Accessors/ST_DumpPoints.md) | `Array<Geometry>` | Returns list of Points which geometry consists of. | v1.0.0 | | [ST_EndPoint](Geometry-Accessors/ST_EndPoint.md) | Geometry | Returns last point of given linestring. | v1.0.0 | | [ST_ExteriorRing](Geometry-Accessors/ST_ExteriorRing.md) | Geometry | Returns a line string representing the exterior ring of the POLYGON geometry. Return NULL if the geometry is not a polygon. | v1.0.0 | | [ST_GeometryN](Geometry-Accessors/ST_GeometryN.md) | Geometry | Return the 0-based Nth geometry if the geometry is a GEOMETRYCOLLECTION, (MULTI)POINT, (MULTI)LINESTRING, MULTICURVE or (MULTI)POLYGON. Otherwise, return null | v1.0.0 | @@ -124,7 +124,7 @@ These functions create modified geometries by changing type, structure, or verti | [ST_ForceRHR](Geometry-Editors/ST_ForceRHR.md) | Geometry | Sets the orientation of polygon vertex orderings to follow the Right-Hand-Rule convention. The exterior ring will have a clockwise winding order, while any interior rings are oriented counter-clock... | v1.6.1 | | [ST_LineFromMultiPoint](Geometry-Editors/ST_LineFromMultiPoint.md) | Geometry | Creates a LineString from a MultiPoint geometry. | v1.3.0 | | [ST_LineMerge](Geometry-Editors/ST_LineMerge.md) | Geometry | Returns a LineString or MultiLineString formed by sewing together the constituent line work of a MULTILINESTRING. | v1.0.0 | -| [ST_LineSegments](Geometry-Editors/ST_LineSegments.md) | Array\<Geometry\> | This function transforms a LineString containing multiple coordinates into an array of LineStrings, each with precisely two coordinates. The `lenient` argument, true by default, prevents an excepti... | v1.7.1 | +| [ST_LineSegments](Geometry-Editors/ST_LineSegments.md) | `Array<Geometry>` | This function transforms a LineString containing multiple coordinates into an array of LineStrings, each with precisely two coordinates. The `lenient` argument, true by default, prevents an excepti... | v1.7.1 | | [ST_MakeLine](Geometry-Editors/ST_MakeLine.md) | Geometry | Creates a LineString containing the points of Point, MultiPoint, or LineString geometries. Other geometry types cause an error. | v1.5.0 | | [ST_MakePolygon](Geometry-Editors/ST_MakePolygon.md) | Geometry | Function to convert closed linestring to polygon including holes. If holes are provided, they should be fully contained within the shell. Holes outside the shell will produce an invalid polygon (ma... | v1.1.0 | | [ST_Multi](Geometry-Editors/ST_Multi.md) | Geometry | Returns a MultiGeometry object based on the geometry input. ST_Multi is basically an alias for ST_Collect with one geometry. | v1.2.0 | @@ -244,7 +244,7 @@ These functions compute results arising from the overlay of two geometries. Thes | [ST_Difference](Overlay-Functions/ST_Difference.md) | Geometry | Return the difference between geometry A and B (return part of geometry A that does not intersect geometry B) | v1.2.0 | | [ST_Intersection](Overlay-Functions/ST_Intersection.md) | Geometry | Return the intersection geometry of A and B | v1.0.0 | | [ST_Split](Overlay-Functions/ST_Split.md) | Geometry | Split an input geometry by another geometry (called the blade). Linear (LineString or MultiLineString) geometry can be split by a Point, MultiPoint, LineString, MultiLineString, Polygon, or MultiPo... | v1.4.0 | -| [ST_SubDivide](Overlay-Functions/ST_SubDivide.md) | Array\<Geometry\> | Returns list of geometries divided based of given maximum number of vertices. | v1.1.0 | +| [ST_SubDivide](Overlay-Functions/ST_SubDivide.md) | Array<Geometry> | Returns list of geometries divided based of given maximum number of vertices. | v1.1.0 | | [ST_SubDivideExplode](Overlay-Functions/ST_SubDivideExplode.md) | Geometry | It works the same as ST_SubDivide but returns new rows with geometries instead of list. | v1.1.0 | | [ST_SymDifference](Overlay-Functions/ST_SymDifference.md) | Geometry | Return the symmetrical difference between geometry A and B (return parts of geometries which are in either of the sets, but not in their intersection) | v1.2.0 | | [ST_UnaryUnion](Overlay-Functions/ST_UnaryUnion.md) | Geometry | This variant of [ST_Union](Overlay-Functions/ST_Union.md) operates on a single geometry input. The input geometry can be a simple Geometry type, a MultiGeometry, or a GeometryCollection. The function calculates the ge... | v1.6.1 | @@ -337,21 +337,21 @@ These functions work with spatial indexing systems including Bing Tiles, H3, S2, | :--- | :--- | :--- | :--- | | [ST_BingTile](Spatial-Indexing/ST_BingTile.md) | String | Creates a Bing Tile quadkey from tile XY coordinates and a zoom level. | v1.9.0 | | [ST_BingTileAt](Spatial-Indexing/ST_BingTileAt.md) | String | Returns the Bing Tile quadkey for a given point (longitude, latitude) at a specified zoom level. | v1.9.0 | -| [ST_BingTileCellIDs](Spatial-Indexing/ST_BingTileCellIDs.md) | Array\<String\> | Returns an array of Bing Tile quadkey strings that cover the given geometry at the specified zoom level. | v1.9.0 | +| [ST_BingTileCellIDs](Spatial-Indexing/ST_BingTileCellIDs.md) | `Array<String>` | Returns an array of Bing Tile quadkey strings that cover the given geometry at the specified zoom level. | v1.9.0 | | [ST_BingTilePolygon](Spatial-Indexing/ST_BingTilePolygon.md) | Geometry | Returns the bounding polygon (Geometry) of the Bing Tile identified by the given quadkey. | v1.9.0 | -| [ST_BingTilesAround](Spatial-Indexing/ST_BingTilesAround.md) | Array\<String\> | Returns an array of Bing Tile quadkey strings representing the neighborhood tiles around the tile that contains the given point (longitude, latitude) at the specified zoom level. Returns the 3×3 ne... | v1.9.0 | -| [ST_BingTileToGeom](Spatial-Indexing/ST_BingTileToGeom.md) | Array\<Geometry\> | Returns an array of Polygons for the corresponding Bing Tile quadkeys. | v1.9.0 | +| [ST_BingTilesAround](Spatial-Indexing/ST_BingTilesAround.md) | `Array<String>` | Returns an array of Bing Tile quadkey strings representing the neighborhood tiles around the tile that contains the given point (longitude, latitude) at the specified zoom level. Returns the 3×3 ne... | v1.9.0 | +| [ST_BingTileToGeom](Spatial-Indexing/ST_BingTileToGeom.md) | `Array<Geometry>` | Returns an array of Polygons for the corresponding Bing Tile quadkeys. | v1.9.0 | | [ST_BingTileX](Spatial-Indexing/ST_BingTileX.md) | Integer | Returns the tile X coordinate of the Bing Tile identified by the given quadkey. | v1.9.0 | | [ST_BingTileY](Spatial-Indexing/ST_BingTileY.md) | Integer | Returns the tile Y coordinate of the Bing Tile identified by the given quadkey. | v1.9.0 | | [ST_BingTileZoomLevel](Spatial-Indexing/ST_BingTileZoomLevel.md) | Integer | Returns the zoom level of the Bing Tile identified by the given quadkey. | v1.9.0 | | [ST_GeoHashNeighbor](Spatial-Indexing/ST_GeoHashNeighbor.md) | String | Returns the neighbor geohash cell in the given direction. Valid directions are: `n`, `ne`, `e`, `se`, `s`, `sw`, `w`, `nw` (case-insensitive). | v1.9.0 | -| [ST_GeoHashNeighbors](Spatial-Indexing/ST_GeoHashNeighbors.md) | Array\<String\> | Returns the 8 neighboring geohash cells of a given geohash string. The result is an array of 8 geohash strings in the order: N, NE, E, SE, S, SW, W, NW. | v1.9.0 | +| [ST_GeoHashNeighbors](Spatial-Indexing/ST_GeoHashNeighbors.md) | `Array<String>` | Returns the 8 neighboring geohash cells of a given geohash string. The result is an array of 8 geohash strings in the order: N, NE, E, SE, S, SW, W, NW. | v1.9.0 | | [ST_H3CellDistance](Spatial-Indexing/ST_H3CellDistance.md) | Long | return result of h3 function [gridDistance(cel1, cell2)](https://h3geo.org/docs/api/traversal#griddistance). As described by H3 documentation > Finding the distance can fail because the two indexes... | v1.5.0 | -| [ST_H3CellIDs](Spatial-Indexing/ST_H3CellIDs.md) | Array\<Long\> | Cover the geometry by H3 cell IDs with the given resolution(level). To understand the cell statistics please refer to [H3 Doc](https://h3geo.org/docs/core-library/restable) H3 native fill functions... | v1.5.0 | -| [ST_H3KRing](Spatial-Indexing/ST_H3KRing.md) | Array\<Long\> | return the result of H3 function [gridDisk(cell, k)](https://h3geo.org/docs/api/traversal#griddisk). | v1.5.0 | -| [ST_H3ToGeom](Spatial-Indexing/ST_H3ToGeom.md) | Array\<Geometry\> | Return the result of H3 function [cellsToMultiPolygon(cells)](https://h3geo.org/docs/api/regions#cellstolinkedmultipolygon--cellstomultipolygon). | v1.6.0 | -| [ST_S2CellIDs](Spatial-Indexing/ST_S2CellIDs.md) | Array\<Long\> | Cover the geometry with Google S2 Cells, return the corresponding cell IDs with the given level. The level indicates the [size of cells](https://s2geometry.io/resources/s2cell_statistics.html). With... | v1.4.0 | -| [ST_S2ToGeom](Spatial-Indexing/ST_S2ToGeom.md) | Array\<Geometry\> | Returns an array of Polygons for the corresponding S2 cell IDs. | v1.6.0 | +| [ST_H3CellIDs](Spatial-Indexing/ST_H3CellIDs.md) | `Array<Long>` | Cover the geometry by H3 cell IDs with the given resolution(level). To understand the cell statistics please refer to [H3 Doc](https://h3geo.org/docs/core-library/restable) H3 native fill functions... | v1.5.0 | +| [ST_H3KRing](Spatial-Indexing/ST_H3KRing.md) | `Array<Long>` | return the result of H3 function [gridDisk(cell, k)](https://h3geo.org/docs/api/traversal#griddisk). | v1.5.0 | +| [ST_H3ToGeom](Spatial-Indexing/ST_H3ToGeom.md) | `Array<Geometry>` | Return the result of H3 function [cellsToMultiPolygon(cells)](https://h3geo.org/docs/api/regions#cellstolinkedmultipolygon--cellstomultipolygon). | v1.6.0 | +| [ST_S2CellIDs](Spatial-Indexing/ST_S2CellIDs.md) | `Array<Long>` | Cover the geometry with Google S2 Cells, return the corresponding cell IDs with the given level. The level indicates the [size of cells](https://s2geometry.io/resources/s2cell_statistics.html). With... | v1.4.0 | +| [ST_S2ToGeom](Spatial-Indexing/ST_S2ToGeom.md) | `Array<Geometry>` | Returns an array of Polygons for the corresponding S2 cell IDs. | v1.6.0 | ## Clustering Functions @@ -368,9 +368,9 @@ These functions compute spatial statistics and spatial weights. | Function | Return type | Description | Since | | :--- | :--- | :--- | :--- | -| [ST_BinaryDistanceBandColumn](Spatial-Statistics/ST_BinaryDistanceBandColumn.md) | Array\<Struct\> | Introduction: Returns a `weights` column containing every record in a dataframe within a specified `threshold` distance. | v1.7.1 | +| [ST_BinaryDistanceBandColumn](Spatial-Statistics/ST_BinaryDistanceBandColumn.md) | `Array<Struct>` | Introduction: Returns a `weights` column containing every record in a dataframe within a specified `threshold` distance. | v1.7.1 | | [ST_GLocal](Spatial-Statistics/ST_GLocal.md) | Struct | Runs Getis and Ord's G Local (Gi or Gi*) statistic on the geometry given the `weights` and `level`. | v1.7.1 | -| [ST_WeightedDistanceBandColumn](Spatial-Statistics/ST_WeightedDistanceBandColumn.md) | Array\<Struct\> | Introduction: Returns a `weights` column containing every record in a dataframe within a specified `threshold` distance. | v1.7.1 | +| [ST_WeightedDistanceBandColumn](Spatial-Statistics/ST_WeightedDistanceBandColumn.md) | `Array<Struct>` | Introduction: Returns a `weights` column containing every record in a dataframe within a specified `threshold` distance. | v1.7.1 | ## Address Functions @@ -378,5 +378,5 @@ These functions parse and expand street addresses using the libpostal library. | Function | Return type | Description | Since | | :--- | :--- | :--- | :--- | -| [ExpandAddress](Address-Functions/ExpandAddress.md) | Array\<String\> | Returns an array of expanded forms of the input address string. This is backed by the [libpostal](https://github.com/openvenues/libpostal) library's address expanding functionality. | v1.8.0 | -| [ParseAddress](Address-Functions/ParseAddress.md) | Array\<Struct\> | Returns an array of the components (e.g. street, postal code) of the input address string. This is backed by the [libpostal](https://github.com/openvenues/libpostal) library's address parsing funct... | v1.8.0 | +| [ExpandAddress](Address-Functions/ExpandAddress.md) | Array<String> | Returns an array of expanded forms of the input address string. This is backed by the [libpostal](https://github.com/openvenues/libpostal) library's address expanding functionality. | v1.8.0 | +| [ParseAddress](Address-Functions/ParseAddress.md) | Array<Struct> | Returns an array of the components (e.g. street, postal code) of the input address string. This is backed by the [libpostal](https://github.com/openvenues/libpostal) library's address parsing funct... | v1.8.0 | diff --git a/docs/api/sql/Raster-Functions.md b/docs/api/sql/Raster-Functions.md index 2c10c7001f..e42193edf9 100644 --- a/docs/api/sql/Raster-Functions.md +++ b/docs/api/sql/Raster-Functions.md @@ -39,11 +39,11 @@ These functions work with individual pixel geometry representations. | Function | Return type | Description | Since | | :--- | :--- | :--- | :--- | | [RS_PixelAsCentroid](Pixel-Functions/RS_PixelAsCentroid.md) | Geometry | Returns the centroid (point geometry) of the specified pixel's area. The pixel coordinates specified are 1-indexed. If `colX` and `rowY` are out of bounds for the raster, they are interpolated assu... | v1.5.0 | -| [RS_PixelAsCentroids](Pixel-Functions/RS_PixelAsCentroids.md) | Array\<Struct\> | Returns a list of the centroid point geometry, the pixel value and its raster X and Y coordinates for each pixel in the raster at the specified band. Each centroid represents the geometric center o... | v1.5.1 | +| [RS_PixelAsCentroids](Pixel-Functions/RS_PixelAsCentroids.md) | Array<Struct> | Returns a list of the centroid point geometry, the pixel value and its raster X and Y coordinates for each pixel in the raster at the specified band. Each centroid represents the geometric center o... | v1.5.1 | | [RS_PixelAsPoint](Pixel-Functions/RS_PixelAsPoint.md) | Geometry | Returns a point geometry of the specified pixel's upper-left corner. The pixel coordinates specified are 1-indexed. | v1.5.0 | -| [RS_PixelAsPoints](Pixel-Functions/RS_PixelAsPoints.md) | Array\<Struct\> | Returns a list of the pixel's upper-left corner point geometry, the pixel value and its raster X and Y coordinates for each pixel in the raster at the specified band. | v1.5.1 | +| [RS_PixelAsPoints](Pixel-Functions/RS_PixelAsPoints.md) | Array<Struct> | Returns a list of the pixel's upper-left corner point geometry, the pixel value and its raster X and Y coordinates for each pixel in the raster at the specified band. | v1.5.1 | | [RS_PixelAsPolygon](Pixel-Functions/RS_PixelAsPolygon.md) | Geometry | Returns a polygon geometry that bounds the specified pixel. The pixel coordinates specified are 1-indexed. If `colX` and `rowY` are out of bounds for the raster, they are interpolated assuming the ... | v1.5.0 | -| [RS_PixelAsPolygons](Pixel-Functions/RS_PixelAsPolygons.md) | Array\<Struct\> | Returns a list of the polygon geometry, the pixel value and its raster X and Y coordinates for each pixel in the raster at the specified band. | v1.5.1 | +| [RS_PixelAsPolygons](Pixel-Functions/RS_PixelAsPolygons.md) | Array<Struct> | Returns a list of the polygon geometry, the pixel value and its raster X and Y coordinates for each pixel in the raster at the specified band. | v1.5.1 | ## Raster Geometry Functions @@ -114,7 +114,7 @@ These functions perform operations on raster objects. | [RS_AddBand](Raster-Operators/RS_AddBand.md) | Raster | Adds a new band to a raster `toRaster` at a specified index `toRasterIndex`. The new band's values are copied from `fromRaster` at a specified band index `fromBand`. If no `toRasterIndex` is provided... | v1.5.0 | | [RS_Clip](Raster-Operators/RS_Clip.md) | Raster | Returns a raster that is clipped by the given geometry. | v1.5.1 | | [RS_Interpolate](Raster-Operators/RS_Interpolate.md) | Raster | This function performs interpolation on a raster using the Inverse Distance Weighted (IDW) method. This method estimates cell values by averaging the values of sample data points in the vicinity of... | v1.6.0 | -| [RS_MetaData](Raster-Operators/RS_MetaData.md) | Array\<Double\> | Returns the metadata of the raster as a struct. The struct has the following schema: | v1.4.1 | +| [RS_MetaData](Raster-Operators/RS_MetaData.md) | `Array<Double>` | Returns the metadata of the raster as a struct. The struct has the following schema: | v1.4.1 | | [RS_NormalizeAll](Raster-Operators/RS_NormalizeAll.md) | Raster | Normalizes values in all bands of a raster between a given normalization range. The function maintains the data type of the raster values by ensuring that the normalized values are cast back to the... | v1.6.0 | | [RS_NumBands](Raster-Operators/RS_NumBands.md) | Integer | Returns the number of the bands in the raster. | v1.4.0 | | [RS_ReprojectMatch](Raster-Operators/RS_ReprojectMatch.md) | Raster | Reproject a raster to match the geo-reference, CRS, and envelope of a reference raster. The output raster always have the same extent and resolution as the reference raster. For pixels not covered ... | v1.6.0 | @@ -130,7 +130,7 @@ These functions perform operations on raster objects. | [RS_CRS](Raster-Operators/RS_CRS.md) | String | Returns the coordinate reference system (CRS) of the raster as a string in the specified format (projjson, wkt2, wkt1, proj). Defaults to PROJJSON. | v1.9.0 | | [RS_Union](Raster-Operators/RS_Union.md) | Raster | Returns a combined multi-band raster from 2 or more input Rasters. The order of bands in the resultant raster will be in the order of the input rasters. For example if `RS_Union` is called on two 2... | v1.6.0 | | [RS_Value](Raster-Operators/RS_Value.md) | Double | Returns the value at the given point in the raster. If no band number is specified it defaults to 1. | v1.4.0 | -| [RS_Values](Raster-Operators/RS_Values.md) | Array\<Double\> | Returns the values at the given points or grid coordinates in the raster. If no band number is specified it defaults to 1. | v1.4.0 | +| [RS_Values](Raster-Operators/RS_Values.md) | `Array<Double>` | Returns the values at the given points or grid coordinates in the raster. If no band number is specified it defaults to 1. | v1.4.0 | ## Raster Tiles @@ -138,7 +138,7 @@ These functions split rasters into tiles. | Function | Return type | Description | Since | | :--- | :--- | :--- | :--- | -| [RS_Tile](Raster-Tiles/RS_Tile.md) | Array\<Raster\> | Returns an array of rasters resulting from the split of the input raster based upon the desired dimensions of the output rasters. | v1.5.1 | +| [RS_Tile](Raster-Tiles/RS_Tile.md) | `Array<Raster>` | Returns an array of rasters resulting from the split of the input raster based upon the desired dimensions of the output rasters. | v1.5.1 | | [RS_TileExplode](Raster-Tiles/RS_TileExplode.md) | Struct | Generates records containing raster tiles resulting from the split of the input raster based upon the desired dimensions of the output rasters. | v1.5.0 | ## Raster Map Algebra Operators @@ -148,7 +148,7 @@ These functions convert between raster bands and arrays for map algebra operatio | Function | Return type | Description | Since | | :--- | :--- | :--- | :--- | | [RS_AddBandFromArray](Raster-Map-Algebra-Operators/RS_AddBandFromArray.md) | Raster | Add a band to a raster from an array of doubles. | v1.5.0 | -| [RS_BandAsArray](Raster-Map-Algebra-Operators/RS_BandAsArray.md) | Array\<Double\> | Extract a band from a raster as an array of doubles. | v1.4.1 | +| [RS_BandAsArray](Raster-Map-Algebra-Operators/RS_BandAsArray.md) | `Array<Double>` | Extract a band from a raster as an array of doubles. | v1.4.1 | | [RS_MapAlgebra](Raster-Map-Algebra-Operators/RS_MapAlgebra.md) | Raster | Apply a map algebra script on a raster. | v1.5.0 | ## Map Algebra Operators @@ -157,28 +157,28 @@ These functions perform per-pixel mathematical operations on raster band arrays. | Function | Return type | Description | Since | | :--- | :--- | :--- | :--- | -| [RS_Add](Map-Algebra-Operators/RS_Add.md) | Array\<Double\> | Add two spectral bands in a Geotiff image | v1.1.0 | -| [RS_Array](Map-Algebra-Operators/RS_Array.md) | Array\<Double\> | Create an array that is filled by the given value | v1.1.0 | -| [RS_BitwiseAND](Map-Algebra-Operators/RS_BitwiseAND.md) | Array\<Double\> | Find Bitwise AND between two bands of Geotiff image | v1.1.0 | -| [RS_BitwiseOR](Map-Algebra-Operators/RS_BitwiseOR.md) | Array\<Double\> | Find Bitwise OR between two bands of Geotiff image | v1.1.0 | +| [RS_Add](Map-Algebra-Operators/RS_Add.md) | `Array<Double>` | Add two spectral bands in a Geotiff image | v1.1.0 | +| [RS_Array](Map-Algebra-Operators/RS_Array.md) | `Array<Double>` | Create an array that is filled by the given value | v1.1.0 | +| [RS_BitwiseAND](Map-Algebra-Operators/RS_BitwiseAND.md) | `Array<Double>` | Find Bitwise AND between two bands of Geotiff image | v1.1.0 | +| [RS_BitwiseOR](Map-Algebra-Operators/RS_BitwiseOR.md) | `Array<Double>` | Find Bitwise OR between two bands of Geotiff image | v1.1.0 | | [RS_CountValue](Map-Algebra-Operators/RS_CountValue.md) | Integer | Returns count of a particular value from a spectral band in a raster image | v1.1.0 | -| [RS_Divide](Map-Algebra-Operators/RS_Divide.md) | Array\<Double\> | Divide band1 with band2 from a geotiff image | v1.1.0 | -| [RS_FetchRegion](Map-Algebra-Operators/RS_FetchRegion.md) | Array\<Double\> | Fetch a subset of region from given Geotiff image based on minimumX, minimumY, maximumX and maximumY index as well original height and width of image | v1.1.0 | -| [RS_GreaterThan](Map-Algebra-Operators/RS_GreaterThan.md) | Array\<Double\> | Mask all the values with 1 which are greater than a particular target value | v1.1.0 | -| [RS_GreaterThanEqual](Map-Algebra-Operators/RS_GreaterThanEqual.md) | Array\<Double\> | Mask all the values with 1 which are greater than equal to a particular target value | v1.1.0 | -| [RS_LessThan](Map-Algebra-Operators/RS_LessThan.md) | Array\<Double\> | Mask all the values with 1 which are less than a particular target value | v1.1.0 | -| [RS_LessThanEqual](Map-Algebra-Operators/RS_LessThanEqual.md) | Array\<Double\> | Mask all the values with 1 which are less than equal to a particular target value | v1.1.0 | -| [RS_LogicalDifference](Map-Algebra-Operators/RS_LogicalDifference.md) | Array\<Double\> | Return value from band 1 if a value in band1 and band2 are different, else return 0 | v1.1.0 | -| [RS_LogicalOver](Map-Algebra-Operators/RS_LogicalOver.md) | Array\<Double\> | Return value from band1 if it's not equal to 0, else return band2 value | v1.1.0 | +| [RS_Divide](Map-Algebra-Operators/RS_Divide.md) | `Array<Double>` | Divide band1 with band2 from a geotiff image | v1.1.0 | +| [RS_FetchRegion](Map-Algebra-Operators/RS_FetchRegion.md) | `Array<Double>` | Fetch a subset of region from given Geotiff image based on minimumX, minimumY, maximumX and maximumY index as well original height and width of image | v1.1.0 | +| [RS_GreaterThan](Map-Algebra-Operators/RS_GreaterThan.md) | `Array<Double>` | Mask all the values with 1 which are greater than a particular target value | v1.1.0 | +| [RS_GreaterThanEqual](Map-Algebra-Operators/RS_GreaterThanEqual.md) | `Array<Double>` | Mask all the values with 1 which are greater than equal to a particular target value | v1.1.0 | +| [RS_LessThan](Map-Algebra-Operators/RS_LessThan.md) | `Array<Double>` | Mask all the values with 1 which are less than a particular target value | v1.1.0 | +| [RS_LessThanEqual](Map-Algebra-Operators/RS_LessThanEqual.md) | `Array<Double>` | Mask all the values with 1 which are less than equal to a particular target value | v1.1.0 | +| [RS_LogicalDifference](Map-Algebra-Operators/RS_LogicalDifference.md) | `Array<Double>` | Return value from band 1 if a value in band1 and band2 are different, else return 0 | v1.1.0 | +| [RS_LogicalOver](Map-Algebra-Operators/RS_LogicalOver.md) | `Array<Double>` | Return value from band1 if it's not equal to 0, else return band2 value | v1.1.0 | | [RS_Mean](Map-Algebra-Operators/RS_Mean.md) | Double | Returns Mean value for a spectral band in a Geotiff image | v1.1.0 | -| [RS_Mode](Map-Algebra-Operators/RS_Mode.md) | Array\<Double\> | Returns Mode from a spectral band in a Geotiff image in form of an array | v1.1.0 | -| [RS_Modulo](Map-Algebra-Operators/RS_Modulo.md) | Array\<Double\> | Find modulo of pixels with respect to a particular value | v1.1.0 | -| [RS_Multiply](Map-Algebra-Operators/RS_Multiply.md) | Array\<Double\> | Multiply two spectral bands in a Geotiff image | v1.1.0 | -| [RS_MultiplyFactor](Map-Algebra-Operators/RS_MultiplyFactor.md) | Array\<Double\> | Multiply a factor to a spectral band in a geotiff image | v1.1.0 | -| [RS_Normalize](Map-Algebra-Operators/RS_Normalize.md) | Array\<Double\> | Normalize the value in the array to [0, 255]. Uniform arrays are set to 0 after normalization. | v1.1.0 | -| [RS_NormalizedDifference](Map-Algebra-Operators/RS_NormalizedDifference.md) | Array\<Double\> | Returns Normalized Difference between two bands(band2 and band1) in a Geotiff image(example: NDVI, NDBI) | v1.1.0 | -| [RS_SquareRoot](Map-Algebra-Operators/RS_SquareRoot.md) | Array\<Double\> | Find Square root of band values in a geotiff image | v1.1.0 | -| [RS_Subtract](Map-Algebra-Operators/RS_Subtract.md) | Array\<Double\> | Subtract two spectral bands in a Geotiff image(band2 - band1) | v1.1.0 | +| [RS_Mode](Map-Algebra-Operators/RS_Mode.md) | `Array<Double>` | Returns Mode from a spectral band in a Geotiff image in form of an array | v1.1.0 | +| [RS_Modulo](Map-Algebra-Operators/RS_Modulo.md) | `Array<Double>` | Find modulo of pixels with respect to a particular value | v1.1.0 | +| [RS_Multiply](Map-Algebra-Operators/RS_Multiply.md) | `Array<Double>` | Multiply two spectral bands in a Geotiff image | v1.1.0 | +| [RS_MultiplyFactor](Map-Algebra-Operators/RS_MultiplyFactor.md) | `Array<Double>` | Multiply a factor to a spectral band in a geotiff image | v1.1.0 | +| [RS_Normalize](Map-Algebra-Operators/RS_Normalize.md) | `Array<Double>` | Normalize the value in the array to [0, 255]. Uniform arrays are set to 0 after normalization. | v1.1.0 | +| [RS_NormalizedDifference](Map-Algebra-Operators/RS_NormalizedDifference.md) | `Array<Double>` | Returns Normalized Difference between two bands(band2 and band1) in a Geotiff image(example: NDVI, NDBI) | v1.1.0 | +| [RS_SquareRoot](Map-Algebra-Operators/RS_SquareRoot.md) | `Array<Double>` | Find Square root of band values in a geotiff image | v1.1.0 | +| [RS_Subtract](Map-Algebra-Operators/RS_Subtract.md) | `Array<Double>` | Subtract two spectral bands in a Geotiff image(band2 - band1) | v1.1.0 | ## Raster Aggregate Functions
