Comment on page
predicates

CORE
This module contains functions that return a boolean based on the relation between 2 geometries or its properties.
ST_CONTAINS
ST_CONTAINS(geomA, geomB)
Description
Returns true if and only if no points of b lie in the exterior of a, and at least one Point of the interior of b lies in the interior of a.
geomA: Geometry input geom A.
geomB: Geometry input geom B.
Return type
Boolean
Example
1
WITH t AS (
2
  SELECT carto.ST_MAKEBBOX(0, 0, 2, 2) AS geom,
3
  carto.ST_MAKEPOINT(1, 1) as Point
4
)
5
SELECT carto.ST_CONTAINS(geom, point) FROM t;
6
-- true
ST_COVERS
ST_COVERS(geomA, geomB)
Description
Returns true if no Point in Geometry b is outside Geometry a.
geomA: Geometry input geom A.
geomB: Geometry input geom B.
Return type
Boolean
Example
1
WITH t AS (
2
  SELECT carto.ST_MAKEBBOX(0, 0, 3, 3) AS geomA,
3
  carto.ST_MAKEBBOX(1, 1, 2, 2) as geomB
4
)
5
SELECT carto.ST_COVERS(geomA, geomB) FROM t;
6
-- true
ST_CROSSES
ST_CROSSES(geomA, geomB)
Description
Returns true if the supplied geometries have some, but not all, interior points in common.
geomA: Geometry input geom A.
geomB: Geometry input geom B.
Return type
Boolean
Example
1
WITH t AS (
2
  SELECT carto.ST_GEOMFROMWKT("LINESTRING (1 0, 1 2)") AS lineA,
3
  carto.ST_GEOMFROMWKT("LINESTRING (0 1, 2 1)") AS lineB
4
)
5
SELECT carto.ST_CROSSES(lineA, lineB) FROM t;
6
-- true
ST_DISJOINT
ST_DISJOINT(geomA, geomB)
Description
Returns true if the geometries do not “spatially intersect”; i.e., they do not share any space together. Equivalent to NOT st_intersects(a, b).
geomA: Geometry input geom A.
geomB: Geometry input geom B.
Return type
Boolean
Example
1
WITH t AS (
2
  SELECT carto.ST_GEOMFROMWKT("LINESTRING (1 0, 1 2)") AS lineA,
3
  carto.ST_GEOMFROMWKT("LINESTRING (0 1, 2 1)") AS lineB
4
)
5
SELECT carto.ST_DISJOINT(lineA, lineB) AS disjoint FROM t;
6
-- false
ST_EQUALS
ST_EQUALS(geomA, geomB)
Description
Returns true if the given Geometries represent the same logical Geometry. Directionality is ignored.
geomA: Geometry input geom A.
geomB: Geometry input geom B.
Return type
Boolean
Example
1
WITH t AS (
2
  SELECT carto.ST_GEOMFROMWKT("LINESTRING (0 0, 2 2)") AS lineA,
3
  carto.ST_GEOMFROMWKT("LINESTRING (0 0, 1 1, 2 2)") AS lineB
4
)
5
SELECT carto.ST_EQUALS(lineA, lineB) FROM t;
6
-- true
ST_INTERSECTS
ST_INTERSECTS(geomA, geomB)
Description
Returns true if the geometries spatially intersect in 2D (i.e. share any portion of space). Equivalent to NOT st_disjoint(a, b).
geomA: Geometry input geom A.
geomB: Geometry input geom B.
Return type
Boolean
Example
1
WITH t AS (
2
  SELECT carto.ST_GEOMFROMWKT("LINESTRING (1 0, 1 2)") AS lineA,
3
  carto.ST_GEOMFROMWKT("LINESTRING (0 1, 2 1)") AS lineB
4
)
5
SELECT carto.ST_INTERSECTS(lineA, lineB) FROM t;
6
-- true
ST_OVERLAPS
ST_OVERLAPS(geomA, geomB)
Description
Returns true if the Geometries have some but not all points in common, are of the same dimension, and the intersection of the interiors of the two geometries has the same dimension as the geometries themselves.
geomA: Geometry input geom A.
geomB: Geometry input geom B.
Return type
Boolean
Example
1
WITH t AS (
2
  SELECT carto.ST_MAKEBBOX(0, 0, 2, 2) AS geomA,
3
  carto.ST_MAKEBBOX(1, 1, 3, 3) AS geomB
4
)
5
SELECT carto.ST_OVERLAPS(geomA, geomB) FROM t;
6
-- true
ST_RELATE
ST_RELATE(geomA, geomB)
Description
Returns the DE-9IM 3x3 interaction matrix pattern describing the dimensionality of the intersections between the interior, boundary and exterior of the two geometries.
geomA: Geometry input geom A.
geomB: Geometry input geom B.
Return type
String
Example
1
WITH t AS (
2
  SELECT carto.ST_MAKEBBOX(0, 0, 2, 2) AS geomA,
3
  carto.ST_MAKEBBOX(1, 1, 3, 3) AS geomB
4
)
5
SELECT carto.ST_RELATE(geomA, geomB) FROM t;
6
-- 212101212
ST_RELATEBOOL
ST_RELATEBOOL(geomA, geomB, mask)
Description
Returns true if the DE-9IM interaction matrix mask matches the interaction matrix pattern obtained from st_relate(a, b).
geomA: Geometry input geom A.
geomB: Geometry input geom B.
mask: String DE-9IM interaction matrix mask.
Return type
Boolean
Example
1
WITH t AS (
2
  SELECT carto.ST_MAKEBBOX(0, 0, 2, 2) AS geomA,
3
  carto.ST_MAKEBBOX(1, 1, 3, 3) AS geomB
4
)
5
SELECT carto.ST_RELATEBOOL(geomA, geomB, "212101212") FROM t;
6
-- true
ST_TOUCHES
ST_TOUCHES(geomA, geomB)
Description
Returns true if the geometries have at least one Point in common, but their interiors do not intersect.
geomA: Geometry input geom A.
geomB: Geometry input geom B.
Return type
Boolean
Example
1
WITH t AS (
2
  SELECT carto.ST_MAKEBBOX(0, 0, 2, 2) AS geomA,
3
  carto.ST_GEOMFROMWKT("LINESTRING (3 1, 1 3)") AS geomB
4
)
5
SELECT carto.ST_TOUCHES(geomA, geomB) FROM t;
6
-- true
ST_WITHIN
ST_WITHIN(geomA, geomB)
Description
Returns true if geometry a is completely inside geometry b.
geomA: Geometry input geom A.
geomB: Geometry input geom B.
Return type
Boolean
Example
1
WITH t AS (
2
  SELECT carto.ST_POINT(1, 1) AS geomA,
3
  carto.ST_MAKEBBOX(0, 0, 2, 2) AS geomB
4
)
5
SELECT carto.ST_WITHIN(geomA, geomB) FROM t;
6
-- true
parsers
tiler
Last modified 4mo ago