MySQL 8.0 Reference Manual Including MySQL NDB Cluster 8.0

The OpenGIS specification defines the following functions to
test the relationship between two geometry values
`g1`

and `g2`

, using precise
object shapes. The return values 1 and 0 indicate true and
false, respectively, except for
`ST_Distance()`

, which returns
distance values.

Functions in this section detect arguments in either Cartesian or geographic spatial reference systems (SRSs), and return results appropriate to the SRS.

Unless otherwise specified, functions in this section handle their arguments as follows:

If any argument is

`NULL`

or any geometry argument is an empty geometry, the return value is`NULL`

.If any geometry argument is not a syntactically well-formed geometry, an

`ER_GIS_INVALID_DATA`

error occurs.If any geometry argument refers to an undefined spatial reference system (SRS), an

`ER_SRS_NOT_FOUND`

error occurs.For functions that take multiple geometry arguments, if those arguments do not have the same SRID, an

`ER_GIS_DIFFERENT_SRIDS`

error occurs.If any geometry argument is geometrically invalid, either the result is true or false (it is undefined which), or an error occurs.

For geographic SRS geometry arguments, if any argument has a longitude or latitude that is out of range, an error occurs:

If a longitude value is not in the range (−180, 180], an

`ER_LONGITUDE_OUT_OF_RANGE`

error occurs.If a latitude value is not in the range [−90, 90], an

`ER_LATITUDE_OUT_OF_RANGE`

error occurs.

Ranges shown are in degrees. If an SRS uses another unit, the range uses the corresponding values in its unit. The exact range limits deviate slightly due to floating-point arithmetic.

Otherwise, the return value is non-

`NULL`

.

These object-shape functions are available for testing geometry relationships:

Returns 1 or 0 to indicate whether

completely contains`g1`

. This tests the opposite relationship as`g2`

`ST_Within()`

.`ST_Contains()`

handles its arguments as described in the introduction to this section.Two geometries

*spatially cross*if their spatial relation has the following properties:Unless

`g1`

and`g2`

are both of dimension 1:`g1`

crosses`g2`

if the interior of`g2`

has points in common with the interior of`g1`

, but`g2`

does not cover the entire interior of`g1`

.If both

`g1`

and`g2`

are of dimension 1: If the lines cross each other in a finite number of points (that is, no common line segments, only single points in common).

This function returns 1 or 0 to indicate whether

spatially crosses`g1`

.`g2`

`ST_Crosses()`

handles its arguments as described in the introduction to this section except that the return value is`NULL`

for these additional conditions:`g1`

is of dimension 2 (`Polygon`

or`MultiPolygon`

).is of dimension 1 (`g2`

`Point`

or`MultiPoint`

).

Returns 1 or 0 to indicate whether

is spatially disjoint from (does not intersect)`g1`

.`g2`

`ST_Disjoint()`

handles its arguments as described in the introduction to this section.Returns the distance between

and`g1`

, measured in the length unit of the spatial reference system (SRS) of the geometry arguments, or in the unit of the optional`g2`

argument if that is specified.`unit`

This function processes geometry collections by returning the shortest distance among all combinations of the components of the two geometry arguments.

`ST_Distance()`

handles its geometry arguments as described in the introduction to this section, with these exceptions:`ST_Distance()`

detects arguments in a geographic (ellipsoidal) spatial reference system and returns the geodetic distance on the ellipsoid. As of MySQL 8.0.18,`ST_Distance()`

supports distance calculations for geographic SRS arguments of all geometry types. Prior to MySQL 8.0.18, the only permitted geographic argument types are`Point`

and`Point`

, or`Point`

and`MultiPoint`

(in any argument order). If called with other geometry type argument combinations in a geographic SRS, an`ER_NOT_IMPLEMENTED_FOR_GEOGRAPHIC_SRS`

error occurs.If any argument is geometrically invalid, either the result is an undefined distance (that is, it can be any number), or an error occurs.

If an intermediate or final result produces

`NaN`

or a negative number, an`ER_GIS_INVALID_DATA`

error occurs.

As of MySQL 8.0.14,

`ST_Distance()`

permits an optionalargument that specifies the linear unit for the returned distance value. These rules apply:`unit`

If a unit is specified but not supported by MySQL, an

`ER_UNIT_NOT_FOUND`

error occurs.If a supported linear unit is specified and the SRID is 0, an

`ER_GEOMETRY_IN_UNKNOWN_LENGTH_UNIT`

error occurs.If a supported linear unit is specified and the SRID is not 0, the result is in that unit.

If a unit is not specified, the result is in the unit of the SRS of the geometries, whether Cartesian or geographic. Currently, all MySQL SRSs are expressed in meters.

A unit is supported if it is found in the

`INFORMATION_SCHEMA`

`ST_UNITS_OF_MEASURE`

table. See Section 25.35, “The INFORMATION_SCHEMA ST_UNITS_OF_MEASURE Table”.mysql>

mysql>`SET @g1 = Point(1,1);`

mysql>`SET @g2 = Point(2,2);`

+-----------------------+ | ST_Distance(@g1, @g2) | +-----------------------+ | 1.4142135623730951 | +-----------------------+ mysql>`SELECT ST_Distance(@g1, @g2);`

mysql>`SET @g1 = ST_GeomFromText('POINT(1 1)', 4326);`

mysql>`SET @g2 = ST_GeomFromText('POINT(2 2)', 4326);`

+-----------------------+ | ST_Distance(@g1, @g2) | +-----------------------+ | 156874.3859490455 | +-----------------------+ mysql>`SELECT ST_Distance(@g1, @g2);`

+--------------------------------+ | ST_Distance(@g1, @g2, 'metre') | +--------------------------------+ | 156874.3859490455 | +--------------------------------+ mysql>`SELECT ST_Distance(@g1, @g2, 'metre');`

+-------------------------------+ | ST_Distance(@g1, @g2, 'foot') | +-------------------------------+ | 514679.7439273146 | +-------------------------------+`SELECT ST_Distance(@g1, @g2, 'foot');`

For the special case of distance calculations on a sphere, see the

`ST_Distance_Sphere()`

function.Returns 1 or 0 to indicate whether

is spatially equal to`g1`

.`g2`

`ST_Equals()`

handles its arguments as described in the introduction to this section, except that it does not return`NULL`

for empty geometry arguments.mysql>

mysql>`SET @g1 = Point(1,1), @g2 = Point(2,2);`

+---------------------+---------------------+ | ST_Equals(@g1, @g1) | ST_Equals(@g1, @g2) | +---------------------+---------------------+ | 1 | 0 | +---------------------+---------------------+`SELECT ST_Equals(@g1, @g1), ST_Equals(@g1, @g2);`

Returns 1 or 0 to indicate whether

spatially intersects`g1`

.`g2`

`ST_Intersects()`

handles its arguments as described in the introduction to this section.Two geometries

*spatially overlap*if they intersect and their intersection results in a geometry of the same dimension but not equal to either of the given geometries.This function returns 1 or 0 to indicate whether

spatially overlaps`g1`

.`g2`

`ST_Overlaps()`

handles its arguments as described in the introduction to this section except that the return value is`NULL`

for the additional condition that the dimensions of the two geometries are not equal.Two geometries

*spatially touch*if their interiors do not intersect, but the boundary of one of the geometries intersects either the boundary or the interior of the other.This function returns 1 or 0 to indicate whether

spatially touches`g1`

.`g2`

`ST_Touches()`

handles its arguments as described in the introduction to this section except that the return value is`NULL`

for the additional condition that both geometries are of dimension 0 (`Point`

or`MultiPoint`

).Returns 1 or 0 to indicate whether

is spatially within`g1`

. This tests the opposite relationship as`g2`

`ST_Contains()`

.`ST_Within()`

handles its arguments as described in the introduction to this section.