Skip to content

Commit

Permalink
[DOCS] Arrange items in the API reference in alphabetical order (#659)
Browse files Browse the repository at this point in the history
  • Loading branch information
sekikn committed Aug 16, 2022
1 parent da7bbbc commit 36af55a
Show file tree
Hide file tree
Showing 11 changed files with 1,193 additions and 1,208 deletions.
74 changes: 37 additions & 37 deletions docs/api/flink/Constructor.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,28 @@
## ST_Point
## ST_GeomFromGeoHash

Introduction: Construct a Point from X and Y
Introduction: Create Geometry from geohash string and optional precision

Format: `ST_Point (X:decimal, Y:decimal)`
Format: `ST_GeomFromGeoHash(geohash: string, precision: int)`

Since: `v1.2.1`

SQL example:
```SQL
SELECT ST_Point(x, y) AS pointshape
FROM pointtable
SELECT ST_GeomFromGeoHash('s00twy01mt', 4) AS geom
```

## ST_GeomFromWKT
## ST_GeomFromGeoJSON

Introduction: Construct a Geometry from Wkt
Introduction: Construct a Geometry from GeoJson

Format:
`ST_GeomFromWKT (Wkt:string)`
Format: `ST_GeomFromGeoJSON (GeoJson:string)`

Since: `v1.2.0`

SQL example:
```SQL
SELECT ST_GeomFromWKT('POINT(40.7128 -74.0060)') AS geometry
SELECT ST_GeomFromGeoJSON(polygontable._c0) AS polygonshape
FROM polygontable
```

## ST_GeomFromText
Expand Down Expand Up @@ -67,31 +66,18 @@ SELECT ST_GeomFromWKB(polygontable._c0) AS polygonshape
FROM polygontable
```

## ST_GeomFromGeoJSON

Introduction: Construct a Geometry from GeoJson

Format: `ST_GeomFromGeoJSON (GeoJson:string)`

Since: `v1.2.0`

SQL example:
```SQL
SELECT ST_GeomFromGeoJSON(polygontable._c0) AS polygonshape
FROM polygontable
```

## ST_PointFromText
## ST_GeomFromWKT

Introduction: Construct a Point from Text, delimited by Delimiter
Introduction: Construct a Geometry from Wkt

Format: `ST_PointFromText (Text:string, Delimiter:char)`
Format:
`ST_GeomFromWKT (Wkt:string)`

Since: `v1.2.0`

SQL example:
```SQL
SELECT ST_PointFromText('40.7128,-74.0060', ',') AS pointshape
SELECT ST_GeomFromWKT('POINT(40.7128 -74.0060)') AS geometry
```

## ST_LineFromText
Expand Down Expand Up @@ -120,17 +106,31 @@ Spark SQL example:
SELECT ST_LineStringFromText('Linestring(1 2, 3 4)') AS line
```

## ST_PolygonFromText
## ST_Point

Introduction: Construct a Polygon from Text, delimited by Delimiter. Path must be closed
Introduction: Construct a Point from X and Y

Format: `ST_PolygonFromText (Text:string, Delimiter:char)`
Format: `ST_Point (X:decimal, Y:decimal)`

Since: `v1.2.1`

SQL example:
```SQL
SELECT ST_Point(x, y) AS pointshape
FROM pointtable
```

## ST_PointFromText

Introduction: Construct a Point from Text, delimited by Delimiter

Format: `ST_PointFromText (Text:string, Delimiter:char)`

Since: `v1.2.0`

SQL example:
```SQL
SELECT ST_PolygonFromText('-74.0428197,40.6867969,-74.0421975,40.6921336,-74.0508020,40.6912794,-74.0428197,40.6867969', ',') AS polygonshape
SELECT ST_PointFromText('40.7128,-74.0060', ',') AS pointshape
```

## ST_PolygonFromEnvelope
Expand All @@ -148,15 +148,15 @@ FROM pointdf
WHERE ST_Contains(ST_PolygonFromEnvelope(1.0,100.0,1000.0,1100.0), pointdf.pointshape)
```

## ST_GeomFromGeoHash
## ST_PolygonFromText

Introduction: Create Geometry from geohash string and optional precision
Introduction: Construct a Polygon from Text, delimited by Delimiter. Path must be closed

Format: `ST_GeomFromGeoHash(geohash: string, precision: int)`
Format: `ST_PolygonFromText (Text:string, Delimiter:char)`

Since: `v1.2.1`
Since: `v1.2.0`

SQL example:
```SQL
SELECT ST_GeomFromGeoHash('s00twy01mt', 4) AS geom
SELECT ST_PolygonFromText('-74.0428197,40.6867969,-74.0421975,40.6921336,-74.0508020,40.6912794,-74.0428197,40.6867969', ',') AS polygonshape
```
Loading

0 comments on commit 36af55a

Please sign in to comment.