Skip to content

Commit

Permalink
docs: add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yyy1000 committed Jul 11, 2023
1 parent a556641 commit 54644c9
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 1 deletion.
14 changes: 14 additions & 0 deletions docs/api/flink/Constructor.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,20 @@ SELECT ST_Point(x, y) AS pointshape
FROM pointtable
```

## ST_PointZ

Introduction: Construct a Point from X, Y and Z and an optional srid. If srid is not set, it defaults to 0 (unknown).

Format: `ST_PointZ (X:decimal, Y:decimal, Z:decimal)`
Format: `ST_PointZ (X:decimal, Y:decimal, Z:decimal, srid:integer)`

Since: `v1.5.0`

SQL example:
```sql
SELECT ST_PointZ(1.0, 2.0, 3.0) AS pointshape
```

## ST_PointFromText

Introduction: Construct a Point from Text, delimited by Delimiter
Expand Down
62 changes: 61 additions & 1 deletion docs/api/flink/Predicate.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,21 @@ FROM pointdf
WHERE ST_Contains(ST_PolygonFromEnvelope(1.0,100.0,1000.0,1100.0), pointdf.arealandmark)
```

## ST_Crosses

Introduction: Return true if A crosses B

Format: `ST_Crosses (A:geometry, B:geometry)`

Since: `v1.5.0`

SQL example:
```sql
SELECT *
FROM pointdf
WHERE ST_Crosses(pointdf.arealandmark, ST_PolygonFromEnvelope(1.0,100.0,1000.0,1100.0))
```

## ST_Disjoint

Introduction: Return true if A and B are disjoint
Expand All @@ -21,13 +36,28 @@ Format: `ST_Disjoint (A:geometry, B:geometry)`

Since: `v1.2.1`

Spark SQL example:
SQL example:
```sql
SELECT *
FROM pointdf
WHERE ST_Disjoinnt(ST_PolygonFromEnvelope(1.0,100.0,1000.0,1100.0), pointdf.arealandmark)
```

## ST_Equals

Introduction: Return true if A equals to B

Format: `ST_Equals (A:geometry, B:geometry)`

Since: `v1.5.0`

SQL example:
```sql
SELECT *
FROM pointdf
WHERE ST_Equals(pointdf.arealandmark, ST_PolygonFromEnvelope(1.0,100.0,1000.0,1100.0))
```

## ST_Intersects

Introduction: Return true if A intersects B
Expand All @@ -43,6 +73,36 @@ FROM pointdf
WHERE ST_Intersects(ST_PolygonFromEnvelope(1.0,100.0,1000.0,1100.0), pointdf.arealandmark)
```

## ST_Overlaps

Introduction: Return true if A overlaps B

Format: `ST_Overlaps (A:geometry, B:geometry)`

Since: `v1.5.0`

SQL example:
```sql
SELECT *
FROM geom
WHERE ST_Overlaps(geom.geom_a, geom.geom_b)
```

## ST_Touches

Introduction: Return true if A touches B

Format: `ST_Touches (A:geometry, B:geometry)`

Since: `v1.5.0`

SQL example:
```sql
SELECT *
FROM pointdf
WHERE ST_Touches(pointdf.arealandmark, ST_PolygonFromEnvelope(1.0,100.0,1000.0,1100.0))
```

## ST_Within

Introduction: Return true if A is within B
Expand Down

0 comments on commit 54644c9

Please sign in to comment.