This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sedona.git
The following commit(s) were added to refs/heads/master by this push:
new 746a2dc3 [DOCS] Add example outputs to all Sedona functions - 5 (#921)
746a2dc3 is described below
commit 746a2dc3bc7f7c9e1a02383168522cac91349f2d
Author: Furqaanahmed Khan <[email protected]>
AuthorDate: Wed Jul 26 00:30:20 2023 -0400
[DOCS] Add example outputs to all Sedona functions - 5 (#921)
---
docs/api/flink/Function.md | 125 ++++++++++++++++++++++++++----------------
docs/api/sql/Function.md | 134 ++++++++++++++++++++++++++++-----------------
2 files changed, 161 insertions(+), 98 deletions(-)
diff --git a/docs/api/flink/Function.md b/docs/api/flink/Function.md
index 36def857..49d33c59 100644
--- a/docs/api/flink/Function.md
+++ b/docs/api/flink/Function.md
@@ -1459,8 +1459,13 @@ Since: `v1.5.0`
Example:
```sql
-SELECT ST_LineMerge(geometry)
-FROM df
+SELECT ST_LineMerge(ST_GeomFromWKT('MULTILINESTRING ((-29 -27, -30 -29.7, -45
-33), (-45 -33, -46 -32))'))
+```
+
+Output:
+
+```
+LINESTRING (-29 -27, -30 -29.7, -45 -33, -46 -32)
```
## ST_LineSubstring
@@ -1472,17 +1477,15 @@ Format: `ST_LineSubstring (geom: geometry,
startfraction: Double, endfraction: D
Since: `v1.5.0`
Example:
+
```sql
-SELECT ST_LineSubstring(ST_GeomFromWKT('LINESTRING(25 50, 100 125, 150 190)'),
0.333, 0.666) as Substring
+SELECT ST_LineSubstring(ST_GeomFromWKT('LINESTRING(25 50, 100 125, 150 190)'),
0.333, 0.666)
```
Output:
+
```
-+------------------------------------------------------------------------------------------------+
-|Substring
|
-+------------------------------------------------------------------------------------------------+
-|LINESTRING (69.28469348539744 94.28469348539744, 100 125, 111.70035626068274
140.21046313888758)|
-+------------------------------------------------------------------------------------------------+
+LINESTRING (69.28469348539744 94.28469348539744, 100 125, 111.70035626068274
140.21046313888758)
```
## ST_MakePolygon
@@ -1495,24 +1498,17 @@ Since: `v1.5.0`
Example:
-Query:
```sql
-SELECT
- ST_MakePolygon(
+SELECT ST_MakePolygon(
ST_GeomFromText('LINESTRING(7 -1, 7 6, 9 6, 9 1, 7 -1)'),
ARRAY(ST_GeomFromText('LINESTRING(6 2, 8 2, 8 1, 6 1, 6 2)'))
- ) AS polygon
+ )
```
-Result:
+Output:
```
-+----------------------------------------------------------------+
-|polygon |
-+----------------------------------------------------------------+
-|POLYGON ((7 -1, 7 6, 9 6, 9 1, 7 -1), (6 2, 8 2, 8 1, 6 1, 6 2))|
-+----------------------------------------------------------------+
-
+POLYGON ((7 -1, 7 6, 9 6, 9 1, 7 -1), (6 2, 8 2, 8 1, 6 1, 6 2))
```
## ST_MakeValid
@@ -1554,8 +1550,16 @@ Format: `ST_MinimumBoundingCircle(geom: geometry,
[Optional] quadrantSegments:in
Since: `v1.5.0`
Example:
+
```sql
-SELECT ST_MinimumBoundingCircle(ST_GeomFromText('POLYGON((1 1,0 0, -1 1, 1
1))'))
+SELECT ST_MinimumBoundingCircle(ST_GeomFromWKT('LINESTRING(0 0, 0 1)'))
+```
+
+Output:
+
+```
+POLYGON ((0.5 0.5, 0.4997322937381828 0.4836404585891119, 0.4989294616193017
0.4672984353849285, 0.4975923633360985 0.4509914298352197, 0.4957224306869052
0.4347369038899742, 0.4933216660424395 0.4185522633027057, 0.4903926402016152
0.4024548389919359, 0.4869384896386668 0.3864618684828134, 0.4829629131445342
0.3705904774487396, 0.4784701678661044 0.3548576613727689, 0.4734650647475528
0.3392802673484192, 0.4679529633786629 0.3238749760393833, 0.4619397662556434
0.3086582838174551, 0.455 [...]
+```
## ST_MinimumBoundingRadius
@@ -1566,10 +1570,17 @@ Format: `ST_MinimumBoundingRadius(geom: geometry)`
Since: `v1.5.0`
Example:
+
```sql
SELECT ST_MinimumBoundingRadius(ST_GeomFromText('POLYGON((1 1,0 0, -1 1, 1
1))'))
```
+Output:
+
+```
+{POINT (0 1), 1.0}
+```
+
## ST_Multi
Introduction: Returns a MultiGeometry object based on the geometry input.
@@ -1584,19 +1595,13 @@ Since: `v1.5.0`
Example:
```sql
-SELECT ST_Multi(
- ST_GeomFromText('POINT(1 1)')
-) AS geom
+SELECT ST_Multi(ST_GeomFromText('POINT(1 1)'))
```
-Result:
+Output:
```
-+---------------------------------------------------------------+
-|geom |
-+---------------------------------------------------------------+
-|MULTIPOINT (1 1) |
-+---------------------------------------------------------------+
+MULTIPOINT (1 1)
```
@@ -1613,31 +1618,33 @@ Since: `v1.3.0`
Example:
```sql
-SELECT ST_AsEWKT(ST_Normalize(ST_GeomFromWKT('POLYGON((0 1, 1 1, 1 0, 0 0, 0
1))'))) AS geom
+SELECT ST_AsEWKT(ST_Normalize(ST_GeomFromWKT('POLYGON((0 1, 1 1, 1 0, 0 0, 0
1))')))
```
Result:
```
-+-----------------------------------+
-|geom |
-+-----------------------------------+
-|POLYGON ((0 0, 0 1, 1 1, 1 0, 0 0))|
-+-----------------------------------+
+POLYGON ((0 0, 0 1, 1 1, 1 0, 0 0))
```
## ST_NPoints
Introduction: Returns the number of points of the geometry
-Since: `v1.3.0`
-
Format: `ST_NPoints (A:geometry)`
+Since: `v1.3.0`
+
Example:
+
```sql
-SELECT ST_NPoints(polygondf.countyshape)
-FROM polygondf
+SELECT ST_NPoints(ST_GeomFromText('LINESTRING(77.29 29.07,77.42 29.26,77.27
29.31,77.29 29.07)'))
+```
+
+Output:
+
+```
+4
```
## ST_NDims
@@ -1648,13 +1655,17 @@ Format: `ST_NDims(geom: geometry)`
Since: `v1.3.1`
-Spark SQL example with z co-rodinate:
+Example with z coordinate:
```sql
SELECT ST_NDims(ST_GeomFromEWKT('POINT(1 1 2)'))
```
-Output: `3`
+Output:
+
+```
+3
+```
Example with x,y coordinate:
@@ -1662,7 +1673,11 @@ Example with x,y coordinate:
SELECT ST_NDims(ST_GeomFromText('POINT(1 1)'))
```
-Output: `2`
+Output:
+
+```
+2
+```
## ST_NRings
@@ -1705,10 +1720,16 @@ Format: `ST_NumGeometries (A:geometry)`
Since: `v1.3.0`
-Example:
+Example
+
```sql
-SELECT ST_NumGeometries(df.geometry)
-FROM df
+SELECT ST_NumGeometries(ST_GeomFromWKT('LINESTRING (-29 -27, -30 -29.7, -45
-33)'))
+```
+
+Output:
+
+```
+1
```
## ST_NumInteriorRings
@@ -1720,11 +1741,16 @@ Format: `ST_NumInteriorRings(geom: geometry)`
Since: `v1.3.0`
Example:
+
```sql
SELECT ST_NumInteriorRings(ST_GeomFromText('POLYGON ((0 0, 0 5, 5 5, 5 0, 0
0), (1 1, 2 1, 2 2, 1 2, 1 1))'))
```
-Output: `1`
+Output:
+
+```
+1
+```
## ST_NumPoints
@@ -1742,11 +1768,16 @@ Format: `ST_NumPoints(geom: geometry)`
Since: `v1.4.1`
Example:
+
```sql
SELECT ST_NumPoints(ST_GeomFromText('LINESTRING(1 2, 1 3)'))
```
-Output: `2`
+Output:
+
+```
+2
+```
## ST_PointN
diff --git a/docs/api/sql/Function.md b/docs/api/sql/Function.md
index f24cd8c3..9a91f018 100644
--- a/docs/api/sql/Function.md
+++ b/docs/api/sql/Function.md
@@ -1462,9 +1462,16 @@ Format: `ST_LineMerge (A:geometry)`
Since: `v1.0.0`
+Spark SQL example:
+
```sql
-SELECT ST_LineMerge(geometry)
-FROM df
+SELECT ST_LineMerge(ST_GeomFromWKT('MULTILINESTRING ((-29 -27, -30 -29.7, -45
-33), (-45 -33, -46 -32))'))
+```
+
+Output:
+
+```
+LINESTRING (-29 -27, -30 -29.7, -45 -33, -46 -32)
```
## ST_LineSubstring
@@ -1476,17 +1483,15 @@ Format: `ST_LineSubstring (geom: geometry,
startfraction: Double, endfraction: D
Since: `v1.0.1`
Spark SQL example:
+
```sql
-SELECT ST_LineSubstring(ST_GeomFromWKT('LINESTRING(25 50, 100 125, 150 190)'),
0.333, 0.666) as Substring
+SELECT ST_LineSubstring(ST_GeomFromWKT('LINESTRING(25 50, 100 125, 150 190)'),
0.333, 0.666)
```
Output:
+
```
-+------------------------------------------------------------------------------------------------+
-|Substring
|
-+------------------------------------------------------------------------------------------------+
-|LINESTRING (69.28469348539744 94.28469348539744, 100 125, 111.70035626068274
140.21046313888758)|
-+------------------------------------------------------------------------------------------------+
+LINESTRING (69.28469348539744 94.28469348539744, 100 125, 111.70035626068274
140.21046313888758)
```
## ST_MakePolygon
@@ -1499,24 +1504,17 @@ Since: `v1.1.0`
Example:
-Query:
```sql
-SELECT
- ST_MakePolygon(
+SELECT ST_MakePolygon(
ST_GeomFromText('LINESTRING(7 -1, 7 6, 9 6, 9 1, 7 -1)'),
ARRAY(ST_GeomFromText('LINESTRING(6 2, 8 2, 8 1, 6 1, 6 2)'))
- ) AS polygon
+ )
```
-Result:
+Output:
```
-+----------------------------------------------------------------+
-|polygon |
-+----------------------------------------------------------------+
-|POLYGON ((7 -1, 7 6, 9 6, 9 1, 7 -1), (6 2, 8 2, 8 1, 6 1, 6 2))|
-+----------------------------------------------------------------+
-
+POLYGON ((7 -1, 7 6, 9 6, 9 1, 7 -1), (6 2, 8 2, 8 1, 6 1, 6 2))
```
## ST_MakeValid
@@ -1563,8 +1561,15 @@ Format: `ST_MinimumBoundingCircle(geom: geometry,
[Optional] quadrantSegments:in
Since: `v1.0.1`
Spark SQL example:
+
```sql
-SELECT ST_MinimumBoundingCircle(ST_GeomFromText('POLYGON((1 1,0 0, -1 1, 1
1))'))
+SELECT ST_MinimumBoundingCircle(ST_GeomFromWKT('LINESTRING(0 0, 0 1)'))
+```
+
+Output:
+
+```
+POLYGON ((0.5 0.5, 0.4997322937381828 0.4836404585891119, 0.4989294616193017
0.4672984353849285, 0.4975923633360985 0.4509914298352197, 0.4957224306869052
0.4347369038899742, 0.4933216660424395 0.4185522633027057, 0.4903926402016152
0.4024548389919359, 0.4869384896386668 0.3864618684828134, 0.4829629131445342
0.3705904774487396, 0.4784701678661044 0.3548576613727689, 0.4734650647475528
0.3392802673484192, 0.4679529633786629 0.3238749760393833, 0.4619397662556434
0.3086582838174551, 0.455 [...]
```
## ST_MinimumBoundingRadius
@@ -1576,10 +1581,17 @@ Format: `ST_MinimumBoundingRadius(geom: geometry)`
Since: `v1.0.1`
Spark SQL example:
+
```sql
SELECT ST_MinimumBoundingRadius(ST_GeomFromText('POLYGON((1 1,0 0, -1 1, 1
1))'))
```
+Output:
+
+```
+{POINT (0 1), 1.0}
+```
+
## ST_Multi
Introduction: Returns a MultiGeometry object based on the geometry input.
@@ -1594,20 +1606,15 @@ Since: `v1.2.0`
Example:
```sql
-SELECT ST_Multi(
- ST_GeomFromText('POINT(1 1)')
-) AS geom
+SELECT ST_Multi(ST_GeomFromText('POINT(1 1)'))
```
-Result:
+Output:
```
-+---------------------------------------------------------------+
-|geom |
-+---------------------------------------------------------------+
-|MULTIPOINT (1 1) |
-+---------------------------------------------------------------+
+MULTIPOINT (1 1)
```
+
## ST_NDims
Introduction: Returns the coordinate dimension of the geometry.
@@ -1616,13 +1623,17 @@ Format: `ST_NDims(geom: geometry)`
Since: `v1.3.1`
-Spark SQL example with z co-rodinate:
+Spark SQL example with z coordinate:
```sql
SELECT ST_NDims(ST_GeomFromEWKT('POINT(1 1 2)'))
```
-Output: `3`
+Output:
+
+```
+3
+```
Spark SQL example with x,y coordinate:
@@ -1630,7 +1641,11 @@ Spark SQL example with x,y coordinate:
SELECT ST_NDims(ST_GeomFromText('POINT(1 1)'))
```
-Output: `2`
+Output:
+
+```
+2
+```
## ST_Normalize
@@ -1645,30 +1660,33 @@ Since: `v1.3.0`
Example:
```sql
-SELECT ST_AsEWKT(ST_Normalize(ST_GeomFromWKT('POLYGON((0 1, 1 1, 1 0, 0 0, 0
1))'))) AS geom
+SELECT ST_AsEWKT(ST_Normalize(ST_GeomFromWKT('POLYGON((0 1, 1 1, 1 0, 0 0, 0
1))')))
```
Result:
```
-+-----------------------------------+
-|geom |
-+-----------------------------------+
-|POLYGON ((0 0, 0 1, 1 1, 1 0, 0 0))|
-+-----------------------------------+
+POLYGON ((0 0, 0 1, 1 1, 1 0, 0 0))
```
## ST_NPoints
Introduction: Return points of the geometry
+Format: `ST_NPoints (A:geometry)`
+
Since: `v1.0.0`
-Format: `ST_NPoints (A:geometry)`
+Example:
```sql
-SELECT ST_NPoints(polygondf.countyshape)
-FROM polygondf
+SELECT ST_NPoints(ST_GeomFromText('LINESTRING(77.29 29.07,77.42 29.26,77.27
29.31,77.29 29.07)'))
+```
+
+Output:
+
+```
+4
```
## ST_NRings
@@ -1710,9 +1728,16 @@ Format: `ST_NumGeometries (A:geometry)`
Since: `v1.0.0`
+Example
+
```sql
-SELECT ST_NumGeometries(df.geometry)
-FROM df
+SELECT ST_NumGeometries(ST_GeomFromWKT('LINESTRING (-29 -27, -30 -29.7, -45
-33)'))
+```
+
+Output:
+
+```
+1
```
## ST_NumInteriorRings
@@ -1724,11 +1749,16 @@ Format: `ST_NumInteriorRings(geom: geometry)`
Since: `v1.0.0`
Spark SQL example:
+
```sql
SELECT ST_NumInteriorRings(ST_GeomFromText('POLYGON ((0 0, 0 5, 5 5, 5 0, 0
0), (1 1, 2 1, 2 2, 1 2, 1 1))'))
```
-Output: `1`
+Output:
+
+```
+1
+```
## ST_NumPoints
Introduction: Returns number of points in a LineString
@@ -1739,16 +1769,22 @@ Introduction: Returns number of points in a LineString
`SELECT ST_NumPoints(ST_GeomFromWKT('MULTIPOINT ((0 0), (1 1), (0 1), (2
2))'))`
Output: `IllegalArgumentException: Unsupported geometry type: MultiPoint,
only LineString geometry is supported.`
+
Format: `ST_NumPoints(geom: geometry)`
Since: `v1.4.1`
Spark SQL example:
+
```sql
SELECT ST_NumPoints(ST_GeomFromText('LINESTRING(0 1, 1 0, 2 0)'))
```
-Output: `3`
+Output:
+
+```
+3
+```
## ST_PointN
@@ -1760,17 +1796,13 @@ Since: `v1.2.1`
Spark SQL example:
```sql
-SELECT ST_PointN(ST_GeomFromText("LINESTRING(0 0, 1 2, 2 4, 3 6)"), 2) AS geom
+SELECT ST_PointN(ST_GeomFromText("LINESTRING(0 0, 1 2, 2 4, 3 6)"), 2)
```
Result:
```
-+---------------------------------------------------------------+
-|geom |
-+---------------------------------------------------------------+
-|POINT (1 2) |
-+---------------------------------------------------------------+
+POINT (1 2)
```
## ST_PointOnSurface
