Skip to content

ST_Relate

Returns the DE-9IM intersection matrix string for two geometries, or tests whether two geometries satisfy a given intersection matrix pattern.

Usage

string ST_Relate(geomA: geometry, geomB: geometry)
boolean ST_Relate(geomA: geometry, geomB: geometry, intersectionMatrixPattern: string)

Arguments

  • geomA (geometry): Input geometry
  • geomB (geometry): Input geometry
  • intersectionMatrixPattern (string): A 9-character DE-9IM pattern string. Each character can be 0-2, T, F, or * (wildcard).

Description

When called with two geometry arguments, returns the DE-9IM (Dimensionally Extended 9-Intersection Model) intersection matrix as a 9-character string describing the spatial relationship between two geometries.

When called with a third string argument, returns true if the two geometries satisfy the given DE-9IM intersection matrix pattern, false otherwise. The pattern can use wildcards (*) and T (any non-empty intersection) in addition to exact dimension values (0, 1, 2, F).

Examples

SELECT ST_Relate(
    ST_GeomFromText('POINT (0.5 0.5)'),
    ST_GeomFromText('POLYGON ((0 0, 1 0, 1 1, 0 1, 0 0))')
);

┌──────────────────────────────────────────────────────────────────────────────┐
│ st_relate(st_geomfromtext(Utf8("POINT (0.5 0.5)")),st_geomfromtext(Utf8("POL │
│                     YGON ((0 0, 1 0, 1 1, 0 1, 0 0))")))…                    │
╞══════════════════════════════════════════════════════════════════════════════╡
│ 0FFFFF212                                                                    │
└──────────────────────────────────────────────────────────────────────────────┘

SELECT ST_Relate(
    ST_GeomFromText('POINT (0.5 0.5)'),
    ST_GeomFromText('POLYGON ((0 0, 1 0, 1 1, 0 1, 0 0))'),
    '0FFFFF212'
);

┌──────────────────────────────────────────────────────────────────────────────┐
│ st_relate(st_geomfromtext(Utf8("POINT (0.5 0.5)")),st_geomfromtext(Utf8("POL │
│            YGON ((0 0, 1 0, 1 1, 0 1, 0 0))")),Utf8("0FFFFF212"))…           │
╞══════════════════════════════════════════════════════════════════════════════╡
│ true                                                                         │
└──────────────────────────────────────────────────────────────────────────────┘