ST_GeomFromText(text [, srid])
Spatial functions
Spatial functions provide functionality for working with geospatial data. Teiid Spring Boot relies on the JTS Topology Suite to provide partial compatibility with the OpenGIS Simple Features Specification For SQL Revision 1.1. For more information about particular functions, see the Open GIS specification or the PostGIS manual.
Most Geometry capabilities is limited to two dimensions due to the WKB and WKT formats.
Note

There might be minor differences between Teiid Spring Boot and pushdown results that will need to be further refined. 
Returns a geometry from a Clob in WKT format.
text
is a CLOB, srid
is an optional integer that represents a spatial reference identifier (SRID).
Return value is a geometry.
Returns a geography from a Clob in (E)WKT format.
ST_GeogFromText(text)
text
is a CLOB, srid
is an optional integer.
Return value is a geography.
Returns a geometry from a BLOB in WKB format.
ST_GeomFromWKB(bin [, srid])
bin
is a BLOB, srid
is an optional integer.
Return value is a geometry.
Returns a geometry from a BLOB in EWKB format.
ST_GeomFromEWKB(bin)
bin
is a BLOB.
Return value is a geometry.
This version of the translator works with two dimensions only.
Returns a geography from a BLOB in (E)WKB format.
ST_GeomFromEWKB(bin)
bin
is a BLOB.
Return value is a geography.
This version of the translator works with two dimensions only.
Returns a geometry from a character large object (CLOB) in EWKT format.
ST_GeomFromEWKT(text)
text
is a CLOB.
Return value is a geometry.
This version of the translator works with two dimensions only.
Returns a geometry from a CLOB in GeoJSON format.
ST_GeomFromGeoJson(`text` [, srid])
text
is a CLOB, srid
is an optional integer.
Return value is a geometry.
Returns a geometry from a CLOB in GML2 format.
ST_GeomFromGML(text [, srid])
text
is a CLOB, srid
is an optional integer.
Return value is a geometry.
ST_AsText(geom)
geom
is a geometry.
Return value is CLOB in WKT format.
ST_AsBinary(geo)
geo is a geometry or geography. Return value is a binary large object (BLOB) in WKB format.
ST_AsEWKB(geom)
geom
is a geometry.
Return value is BLOB in EWKB format.
ST_AsGeoJSON(geom)
geom
is a geometry.
Return value is a CLOB with the GeoJSON value.
ST_AsGML(geom)
geom
is a geometry.
Return value is a CLOB with the GML2 value.
ST_AsEWKT(geo)
geo
is a geometry or geography.
Return value is a CLOB with the EWKT value.
The EWKT value is the WKT value with the SRID prefix.
ST_AsKML(geom)
geom
is a geometry.
Return value is a CLOB with the KML value.
The KML value is effectively a simplified GML value and projected into SRID 4326.
Returns true if the bounding boxes of geom1
and geom2
intersect.
geom1 && geom2
geom1
, geom2
are geometries.
Return value is a Boolean.
Returns true if geom1
contains geom2
.
ST_Contains(geom1, geom2)
geom1
, geom2
are geometries.
Return value is a Boolean.
Returns true if the geometries cross.
ST_Crosses(geom1, geom2)
geom1
, geom2
are geometries.
Return value is a Boolean.
Returns true if the geometries are disjoint.
ST_Disjoint(geom1, geom2)
geom1
, geom2
are geometries.
Return value is a Boolean.
Returns the distance between two geometries.
ST_Distance(geo1, geo2)
geo1
, geo2
are both geometries or geographies.
Return value is a double.
The geography variant must be pushed down for evaluation.
Returns true if the geometries are within a given distance of one another.
ST_DWithin(geom1, geom2, dist)
geom1
, geom2
are geometries.
dist
is a double.
Return value is a Boolean.
Returns true if the two geometries are spatially equal. The points and order can differ, but neither geometry lies outside of the other.
ST_Equals(geom1, geom2)
geom1
, geom2
are geometries.
Return value is a Boolean.
Returns true if the geometries intersect.
ST_Intersects(geo1, geo2)
geo1
, geo2
are both geometries or geographies.
Return value is a Boolean.
The geography variant must be pushed down for evaluation.
Returns true if geom1
and geom2
have the same structure and the same ordering of points.
ST_OrderingEquals(geom1, geom2)
geom1
, geom2
are geometries.
Return value is a Boolean.
Returns true if the geometries overlap.
ST_Overlaps(geom1, geom2)
geom1
, geom2
are geometries. Return value is a Boolean.
Test or return the intersection of geom1 and geom2.
ST_Relate(geom1, geom2, pattern)
geom1
, geom2
are geometries.
pattern
is a nine character DE9IM pattern string.
Return value is a Boolean.
ST_Relate(geom1, geom2)
geom1
, geom2
are geometries.
Return value is the nine character DE9IM intersection string.
Returns true if the geometries touch.
ST_Touches(geom1, geom2)
geom1
, geom2
are geometries. Return value is a Boolean.
Returns true if geom1
is completely inside geom2
.
ST_Within(geom1, geom2)
geom1
, geom2
are geometries.
Return value is a Boolean.
Returns the area of geom.
ST_Area(geom)
geom
is a geometry.
Return value is a double.
Returns the coordinate dimensions of geom.
ST_CoordDim(geom)
geom
is a geometry.
Return value is an integer between 0 and 3.
Returns the dimension of geom.
ST_Dimension(geom)
geom
is a geometry.
Return value is an integer between 0 and 3.
Returns the end Point of the LineString geom.
Returns null if geom
is not a LineString.
ST_EndPoint(geom)
geom
is a geometry.
Return value is a geometry.
Returns the exterior ring or shell LineString of the polygon geom.
Returns null if geom
is not a polygon.
ST_ExteriorRing(geom)
geom
is a geometry. Return value is a geometry.
Returns the nth geometry at the given 1based index in geom. Returns null if a geometry at the given index does not exist. Noncollection types return themselves at the first index.
ST_GeometryN(geom, index)
geom
is a geometry. index is an integer.
Return value is a geometry.
Returns the type name of geom
as ST_name.
Where name will be LineString, Polygon, Point etc.
ST_GeometryType(geom)
geom
is a geometry.
Return value is a string.
Tests if the geometry has a circular string.
Reports false
, because the translator does not work with curved geometry types.
ST_HasArc(geom)
geom
is a geometry.
Return value is a geometry.
Returns the nth interior ring LinearString geometry at the given 1based index in geom.
Returns null if a geometry at the given index does not exist, or if geom
is not a polygon.
ST_InteriorRingN(geom, index)
geom
is a geometry. index is an integer.
Return value is a geometry.
Returns true if LineString geom
is closed.
Returns false if geom
is not a LineString
ST_IsClosed(geom)
geom
is a geometry. Return value is a Boolean.
Returns true if the set of points is empty.
ST_IsEmpty(geom)
geom
is a geometry.
Return value is a Boolean.
Returns true if the LineString geom
is a ring.
Returns false if geom
is not a LineString.
ST_IsRing(geom)
geom
is a geometry.
Return value is a Boolean.
Returns true if the geom
is simple.
ST_IsSimple(geom)
geom
is a geometry.
Return value is a Boolean.
Returns true
if the geom
is valid.
ST_IsValid(geom)
geom
is a geometry.
Return value is a Boolean.
Returns the length of a (Multi)LineString, otherwise returns 0.
ST_Length(geo)
geo
is a geometry or a geography.
Return value is a double.
The geography variant must be pushed down for evaluation.
Returns the number of geometries in geom
.
Will return 1 if not a geometry collection.
ST_NumGeometries(geom)
geom
is a geometry.
Return value is an integer.
Returns the number of interior rings in the polygon geometry.
Returns null if geom
is not a polygon.
ST_NumInteriorRings(geom)
geom
is a geometry.
Return value is an integer.
Returns the number of points in geom
.
ST_NunPoints(geom)
geom
is a geometry.
Return value is an integer.
Returns a point that is guaranteed to be on the surface of geom.
ST_PointOnSurface(geom)
geom
is a geometry.
Return value is a point geometry.
Returns the perimeter of the (Multi)Polygon geom.
Will return 0 if geom
is not a (Multi)Polygon
ST_Perimeter(geom)
geom
is a geometry.
Return value is a double.
Returns the nth point at the given 1based index in geom.
Returns null if a point at the given index does not exist or if geom
is not a LineString.
ST_PointN(geom, index)
geom
is a geometry. index is an integer.
Return value is a geometry.
Returns the SRID for the geometry.
ST_SRID(geo)
geo
is a geometry or geography.
Return value is an integer.
A 0 value rather than null will be returned for an unknown SRID on a nonnull geometry.
Set the SRID for the given geometry.
ST_SetSRID(geo, srid)
geo
is a geometry or geography.
srid
is an integer.
Return value is the same as the value of geo
.
Only the SRID metadata of is modified.
No transformation is performed.
Returns the start Point of the LineString geom.
Returns null if geom
is not a LineString.
ST_StartPoint(geom)
geom
is a geometry.
Return value is a geometry.
Returns the X ordinate value, or null if the point is empty. Throws an exception if the geometry is not a point.
ST_X(geom)
geom
is a geometry.
Return value is a double.
Returns the Y ordinate value, or null if the point is empty. Throws an exception if the geometry is not a point.
ST_Y(geom)
geom
is a geometry.
Return value is a double.
Returns the Z ordinate value, or null if the point is empty.
Throws an exception if the geometry is not a point.
Typically returns null
because the translator does not work with more than two dimensions.
ST_Z(geom)
geom
is a geometry.
Return value is a double.
Computes the boundary of the given geometry.
ST_Boundary(geom)
geom
is a geometry.
Return value is a geometry.
Computes the geometry that has points within the given distance of geom
.
ST_Buffer(geom, distance)
geom
is a geometry. distance
is a double.
Return value is a geometry.
Computes the geometric center point of geom.
ST_Centroid(geom)
geom
is a geometry.
Return value is a geometry.
Return the smallest convex polygon that contains all of the points in geometry.
ST_ConvexHull(geom)
geom
is a geometry.
Return value is a geometry.
Converts a CircularString/CurvedPolygon to a LineString/Polygon. Not currently implemented in Teiid Spring Boot.
ST_CurveToLine(geom)
geom
is a geometry. Return value is a geometry.
Computes the closure of the point set of the points contained in geom1
that are not in geom2
.
ST_Difference(geom1, geom2)
geom1
, geom2
are geometries.
Return value is a geometry.
Computes the 2D bounding box of the given geometry.
ST_Envelope(geom)
geom
is a geometry.
Return value is a geometry.
Removes the z coordinate value if present.
ST_Force_2D(geom)
geom
is a geometry. Return value is a geometry.
Computes the point set intersection of the points contained in geom1
and in geom2
.
ST_Intersection(geom1, geom2)
geom1
, geom2
are geometries.
Return value is a geometry.
Simplifies a geometry using the DouglasPeucker algorithm, but may oversimplify to an invalid or empty geometry.
ST_Simplify(geom, distanceTolerance)
geom
is a geometry. distanceTolerance
is a double.
Return value is a geometry.
Simplifies a geometry using the DouglasPeucker algorithm. Will always return a valid geometry.
ST_SimplifyPreserveTopology(geom, distanceTolerance)
geom
is a geometry. distanceTolerance
is a double.
Return value is a geometry.
Snaps all points in the geometry to grid of given size.
ST_SnapToGrid(geom, size)
geom
is a geometry. size is a double. Return value is a geometry.
Return the part of geom1 that does not intersect with geom2 and vice versa.
ST_SymDifference(geom1, geom2)
geom1
, geom2
are geometry.
Return value is a geometry.
Transforms the geometry value from one coordinate system to another.
ST_Transform(geom, srid)
geom
is a geometry. srid
is an integer.
Return value is a geometry.
The srid
value and the SRID of the geometry value must exist in the SPATIAL_REF_SYS view.
Return a geometry that represents the point set containing all of geom1
and geom2
.
ST_Union(geom1, geom2)
geom1
, geom2
are geometries.
Return value is a geometry.
Computes the 2D bounding box around all of the geometry values. All values should have the same SRID.
ST_Extent(geom)
geom
is a geometry.
Return value is a geometry.
Retuns the Point for the given coordinates.
ST_Point(x, y)
x and y are doubles. Return value is a Point geometry.
Returns the Polygon with the given shell and SRID.
ST_Polygon(geom, srid)
geom
is a linear ring geometry and srid
is an integer.
Return value is a Polygon geometry.