POLYGON constructors use geospatial data to create a POLYGON object.Documentation Index
Fetch the complete documentation index at: https://docs.ocient.com/llms.txt
Use this file to discover all available pages before exploring further.
ST_FORCECCW
Creates a standardized polygon from an existing one. defines standardized as the exterior being counterclockwise (CCW) and all holes being clockwise (CW) oriented. SyntaxSQL
| Argument | Data Type | Description |
|---|---|---|
polygon | POLYGON | A POLYGON to be converted on its exterior counterclockwise and clockwise for any interior holes. |
SQL
POLYGON((0 0,1 0,1 1,0 1,0 0))
ST_MAKEPOLYGON
Alias for ST_POLYGON.ST_POLYGON
Creates aPOLYGON.
ST_POLYGON(geo)
Creates aPOLYGON from the specified POINT, POINT array, LINESTRING, or POLYGON geography.
Syntax
SQL
| Argument | Data Type | Description |
|---|---|---|
geo | POLYGON | A POINT, POINT array, LINESTRING, or POLYGON value to be converted to a POLYGON object. |
SQL
POLYGON((1 2,1 3,1 4,1 2))
ST_POLYGON(char) [#st_polygon-char]
Alias for ST_MAKEPOLYGON(char). Creates aPOLYGON from the specified CHAR representing a POLYGON in WKT format.
Syntax
SQL
| Argument | Data Type | Description |
|---|---|---|
char | CHAR that represents a POLYGON in WKT format. | The CHAR argument must represent a POLYGON in WKT format. |
SQL
POLYGON((1 2,1 3,1 4,1 2))
ST_POLYGON(binary) [#st_polygon-binary]
Alias for ST_POLYGONFROMWKB(binary). Creates aPOLYGON from the specified BINARY. The BINARY value must represent a POLYGON in WKB format.
Syntax
SQL
| Argument | Data Type | Description |
|---|---|---|
binary | BINARY that represents a POLYGON in WKB format. | A BINARY argument to be converted to a POLYGON. The BINARY value must represent a POLYGON in WKB format. |
SQL
POLYGON((0 0,0 1,1 1,1 0,0 0))
ST_POLYGON(outer_ring, inner_rings)
Alias for ST_MAKEPOLYGON(outerRing, innerRings). Creates aPOLYGON from the specified outer ring (that must be either a POINT, POINT array, or LINESTRING) and the array of interior rings (closed lines).
The interior of the POLYGON is on the left when traveling around the exterior ring. The interior of a hole is on the right when traveling around a hole.
Syntax
SQL
| Argument | Data Type | Description |
|---|---|---|
outer_ring | POINT, POINT array, or LINESTRING | A POINT, POINT array, or LINESTRING that represents the outer ring of the POLYGON object. |
inner_rings | ARRAY of POINT arrays, or ARRAY of LINESTRING values | An ARRAY of POINT arrays or LINESTRING values that represents the inner rings or holes in the POLYGON object. |
SQL
POLYGON((1.000000 2.000000), (1.000000 2.000000))
ST_POLYGONFROMWKB
Alias for ST_POLYGON(binary).ST_POLYGONFROMEWKT
Alias for the ST_POLYGON constructor. Creates aPOLYGON using an EWKT-formatted CHAR as an input argument.
Syntax
SQL
| Argument | Data Type | Description |
|---|---|---|
char | CHAR | A string that includes an SRID value and an EWKT-formatted value that represents a POLYGON.Separate the values in the string by a semicolon in this format: 'SRID = value; polygon_value'The input string must include the SRID = value; component. However, the database ignores this component as all Ocient geography types are SRID = 4326. |
SQL
POLYGON((1 2,1 3,1 4,1 2))
ST_POLYGONFROMGEOJSON
Creates aPOLYGON represented by the specified GeoJSON value as an input argument.
Syntax
SQL
| Argument | Data Type | Description |
|---|---|---|
geo_json | STRING | A string of a GeoJSON. Valid GeoJSON formats follow standards, which you can generate using the ST_ASGEOJSON function. If you specify an invalid GeoJSON, the behavior of the function is undefined. The function returns NULL if any argument is a NULL value. |
geodesic | BOOLEAN | Optional. If you specify geodesic as TRUE, the function adds points to the resulting POLYGON such that it remains within 10 meters of the original planar polygon.If you do not specify this argument, the value defaults to FALSE. |
POLYGON value from the GeoJSON representation.
SQL
POLYGON EMPTY
In this example, the function produces a POLYGON value from the GeoJSON representation.
SQL
POLYGON((1 1, 1 5, 5 5, 5 1))
ST_POLYGONFROMTEXT
Alias for ST_POLYGON(char).ST_WHOLEEARTH
Returns the database internal representation of the whole earth polygon. The ST_ENVELOPE function returns thisPOLYGON value, with the envelope set as the entire earth.
GIS specifications do not describe a canonical polygon for the whole earth, but this value serves as the Ocient-canonical polygon. The whole earth polygon is also equivalent to ST_POLYGON('POLYGON((0 0,0 0,0 0,0 0'))), which can have a separate meaning in other GIS implementations.
Syntax
SQL
SQL
POLYGON((0.0 0.0, 0.0 0.0, 0.0 0.0, 0.0 0.0))

