Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Add example outputs to all Sedona functions #916

Merged
merged 9 commits into from
Jul 25, 2023
Merged

[DOCS] Add example outputs to all Sedona functions #916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f7ef6e3
Added inputs and outputs to ST_3DDistance and ST_Area
furqaankhan Jul 24, 2023
725bdbf
Fixed ST_AreaSpheroid output format
furqaankhan Jul 24, 2023
3408a27
Added input and output of ST_AsBinary
furqaankhan Jul 24, 2023
8d79b5e
Added input and output of ST_AsEWKB
furqaankhan Jul 24, 2023
ac97935
Added input and output of ST_AsEWKT
furqaankhan Jul 24, 2023
c0d79e5
Added input and output of ST_AsGeoJSON
furqaankhan Jul 24, 2023
8b349ca
Added input and output of ST_AsGML
furqaankhan Jul 24, 2023
08d69ca
Added input and output of ST_AsKML
furqaankhan Jul 24, 2023
2ea77ba
Added input and output of ST_AsText
furqaankhan Jul 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 79 additions & 20 deletions docs/api/flink/Function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,13 @@ Since: `v1.3.0`
Example:

```sql
SELECT ST_3DDistance(polygondf.countyshape, polygondf.countyshape)
FROM polygondf
SELECT ST_3DDistance(ST_GeomFromText("POINT Z (0 0 -5)"),
ST_GeomFromText("POINT Z(1 1 -6"))
```

Output:
```
1.7320508075688772
```

## ST_AddPoint
Expand Down Expand Up @@ -210,8 +215,12 @@ Since: `v1.3.0`
Example:

```sql
SELECT ST_Area(polygondf.countyshape)
FROM polygondf
SELECT ST_Area(ST_GeomFromText("POLYGON(0 0, 0 10, 10 10, 0 10, 0 0)"))
```

Output:
```
10
```

## ST_AreaSpheroid
Expand All @@ -230,7 +239,11 @@ Example:
SELECT ST_AreaSpheroid(ST_GeomFromWKT('Polygon ((35 34, 30 28, 34 25, 35 34))'))
```

Output: `201824850811.76245`
Output:

```
201824850811.76245
```

## ST_AsBinary

Expand All @@ -243,8 +256,13 @@ Since: `v1.3.0`
Example:

```sql
SELECT ST_AsBinary(polygondf.countyshape)
FROM polygondf
SELECT ST_AsBinary(ST_GeomFromWKT('POINT (1 1)'))
```

Output:

```
0101000000000000000000f87f000000000000f87f
```

## ST_AsEWKB
Expand All @@ -261,8 +279,13 @@ Since: `v1.3.0`
Example:

```sql
SELECT ST_AsEWKB(polygondf.countyshape)
FROM polygondf
SELECT ST_AsEWKB(ST_SetSrid(ST_GeomFromWKT('POINT (1 1)'), 3021))
```

Output:

```
0101000020cd0b0000000000000000f03f000000000000f03f
```

## ST_AsEWKT
Expand All @@ -279,8 +302,13 @@ Since: `v1.2.1`

Spark SQL example:
```sql
SELECT ST_AsEWKT(polygondf.countyshape)
FROM polygondf
SELECT ST_AsEWKT(ST_SetSrid(ST_GeomFromWKT('POLYGON((0 0,0 1,1 1,1 0,0 0))'), 4326))
```

Output:

```
SRID=4326;POLYGON ((0 0, 0 1, 1 1, 1 0, 0 0))
```

## ST_AsGeoJSON
Expand All @@ -293,8 +321,22 @@ Since: `v1.3.0`

Spark SQL example:
```sql
SELECT ST_AsGeoJSON(polygondf.countyshape)
FROM polygondf
SELECT ST_AsGeoJSON(ST_GeomFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'))
```

Output:

```json
{
"type":"Polygon",
"coordinates":[
[[1.0,1.0],
[8.0,1.0],
[8.0,8.0],
[1.0,8.0],
[1.0,1.0]]
]
}
```

## ST_AsGML
Expand All @@ -306,9 +348,15 @@ Format: `ST_AsGML (A:geometry)`
Since: `v1.3.0`

Spark SQL example:

```sql
SELECT ST_AsGML(polygondf.countyshape)
FROM polygondf
SELECT ST_AsGML(ST_GeomFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'))
```

Output:

```
1.0,1.0 8.0,1.0 8.0,8.0 1.0,8.0 1.0,1.0
```

## ST_AsKML
Expand All @@ -319,10 +367,16 @@ Format: `ST_AsKML (A:geometry)`

Since: `v1.3.0`

Spark SQL example:
Example:

```sql
SELECT ST_AsKML(polygondf.countyshape)
FROM polygondf
SELECT ST_AsKML(ST_GeomFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'))
```

Output:

```
1.0,1.0 8.0,1.0 8.0,8.0 1.0,8.0 1.0,1.0
```

## ST_AsText
Expand All @@ -336,8 +390,13 @@ Since: `v1.3.0`
Example:

```sql
SELECT ST_AsText(polygondf.countyshape)
FROM polygondf
SELECT ST_AsText(ST_SetSRID(ST_Point(1.0,1.0), 3021))
```

Output:

```
POINT (1 1)
```

## ST_Azimuth
Expand Down
101 changes: 82 additions & 19 deletions docs/api/sql/Function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,12 @@ Since: `v1.2.0`

Spark SQL example:
```sql
SELECT ST_3DDistance(polygondf.countyshape, polygondf.countyshape)
FROM polygondf
SELECT ST_3DDistance(ST_GeomFromText("POINT Z (0 0 -5)"),
ST_GeomFromText("POINT Z(1 1 -6"))
```
Output:
```
1.7320508075688772
```

## ST_AddPoint
Expand Down Expand Up @@ -205,8 +209,12 @@ Since: `v1.0.0`

Spark SQL example:
```sql
SELECT ST_Area(polygondf.countyshape)
FROM polygondf
SELECT ST_Area(ST_GeomFromText("POLYGON(0 0, 0 10, 10 10, 0 10, 0 0)"))
```

Output:
```
10
```

## ST_AreaSpheroid
Expand All @@ -225,7 +233,11 @@ Spark SQL example:
SELECT ST_AreaSpheroid(ST_GeomFromWKT('Polygon ((35 34, 30 28, 34 25, 35 34))'))
```

Output: `201824850811.76245`
Output:

```
201824850811.76245
```

## ST_AsBinary

Expand All @@ -236,9 +248,15 @@ Format: `ST_AsBinary (A:geometry)`
Since: `v1.1.1`

Spark SQL example:

```sql
SELECT ST_AsBinary(polygondf.countyshape)
FROM polygondf
SELECT ST_AsBinary(ST_GeomFromWKT('POINT (1 1)'))
```

Output:

```
0101000000000000000000f87f000000000000f87f
```

## ST_AsEWKB
Expand All @@ -254,9 +272,15 @@ Format: `ST_AsEWKB (A:geometry)`
Since: `v1.1.1`

Spark SQL example:

```sql
SELECT ST_AsEWKB(polygondf.countyshape)
FROM polygondf
SELECT ST_AsEWKB(ST_SetSrid(ST_GeomFromWKT('POINT (1 1)'), 3021))
```

Output:

```
0101000020cd0b0000000000000000f03f000000000000f03f
```

## ST_AsEWKT
Expand All @@ -272,9 +296,15 @@ Format: `ST_AsEWKT (A:geometry)`
Since: `v1.2.1`

Spark SQL example:

```sql
SELECT ST_AsEWKT(polygondf.countyshape)
FROM polygondf
SELECT ST_AsEWKT(ST_SetSrid(ST_GeomFromWKT('POLYGON((0 0,0 1,1 1,1 0,0 0))'), 4326))
```

Output:

```
SRID=4326;POLYGON ((0 0, 0 1, 1 1, 1 0, 0 0))
```

## ST_AsGeoJSON
Expand All @@ -286,9 +316,24 @@ Format: `ST_AsGeoJSON (A:geometry)`
Since: `v1.0.0`

Spark SQL example:

```sql
SELECT ST_AsGeoJSON(polygondf.countyshape)
FROM polygondf
SELECT ST_AsGeoJSON(ST_GeomFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'))
```

Output:

```json
{
"type":"Polygon",
"coordinates":[
[[1.0,1.0],
[8.0,1.0],
[8.0,8.0],
[1.0,8.0],
[1.0,1.0]]
]
}
```

## ST_AsGML
Expand All @@ -300,9 +345,15 @@ Format: `ST_AsGML (A:geometry)`
Since: `v1.3.0`

Spark SQL example:

```sql
SELECT ST_AsGML(polygondf.countyshape)
FROM polygondf
SELECT ST_AsGML(ST_GeomFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'))
```

Output:

```
1.0,1.0 8.0,1.0 8.0,8.0 1.0,8.0 1.0,1.0
```

## ST_AsKML
Expand All @@ -314,9 +365,15 @@ Format: `ST_AsKML (A:geometry)`
Since: `v1.3.0`

Spark SQL example:

```sql
SELECT ST_AsKML(polygondf.countyshape)
FROM polygondf
SELECT ST_AsKML(ST_GeomFromWKT('POLYGON((1 1, 8 1, 8 8, 1 8, 1 1))'))
```

Output:

```
1.0,1.0 8.0,1.0 8.0,8.0 1.0,8.0 1.0,1.0
```

## ST_AsText
Expand All @@ -328,9 +385,15 @@ Format: `ST_AsText (A:geometry)`
Since: `v1.0.0`

Spark SQL example:

```sql
SELECT ST_AsText(polygondf.countyshape)
FROM polygondf
SELECT ST_AsText(ST_SetSRID(ST_Point(1.0,1.0), 3021))
```

Output:

```
POINT (1 1)
```

## ST_Azimuth
Expand Down