MySQL 8.4 Release Notes
These functions take as arguments a
BLOB containing a Well-Known Binary
(WKB) representation and, optionally, a spatial reference system
identifier (SRID). They return the corresponding geometry. For a
description of WKB format, see Well-Known Binary (WKB) Format.
Functions in this section detect arguments in either Cartesian or geographic spatial reference systems (SRSs), and return results appropriate to the SRS.
ST_GeomFromWKB() accepts a WKB
value of any geometry type as its first argument. Other functions
provide type-specific construction functions for construction of
geometry values of each geometry type.
Prior to MySQL 8.4, these functions also accepted geometry objects as returned by the functions in Section 14.16.5, “MySQL-Specific Functions That Create Geometry Values”. Geometry arguments are no longer permitted and produce an error. To migrate calls from using geometry arguments to using WKB arguments, follow these guidelines:
Rewrite constructs such as
ST_GeomFromWKB(Point(0, 0))asPoint(0, 0).Rewrite constructs such as
ST_GeomFromWKB(Point(0, 0), 4326)asST_SRID(Point(0, 0), 4326)orST_GeomFromWKB(ST_AsWKB(Point(0, 0)), 4326).
Unless otherwise specified, functions in this section handle their geometry arguments as follows:
If the WKB or SRID argument is
NULL, the return value isNULL.By default, geographic coordinates (latitude, longitude) are interpreted as in the order specified by the spatial reference system of geometry arguments. An optional
optionsargument may be given to override the default axis order.optionsconsists of a list of comma-separatedkey=valuekeyvalue isaxis-order, with permitted values oflat-long,long-latandsrid-defined(the default).If the
optionsargument isNULL, the return value isNULL. If theoptionsargument is invalid, an error occurs to indicate why.If an SRID argument refers to an undefined spatial reference system (SRS), an
ER_SRS_NOT_FOUNDerror 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_RANGEerror occurs.If a latitude value is not in the range [−90, 90], an
ER_LATITUDE_OUT_OF_RANGEerror 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.
These functions are available for creating geometries from WKB values:
ST_GeomCollFromWKB(,wkb[,srid[,options]])ST_GeometryCollectionFromWKB(wkb[,srid[,options]])Constructs a
GeometryCollectionvalue using its WKB representation and SRID.These functions handle their arguments as described in the introduction to this section.
ST_GeomFromWKB(,wkb[,srid[,options]])ST_GeometryFromWKB(wkb[,srid[,options]])Constructs a geometry value of any type using its WKB representation and SRID.
These functions handle their arguments as described in the introduction to this section.
ST_LineFromWKB(,wkb[,srid[,options]])ST_LineStringFromWKB(wkb[,srid[,options]])Constructs a
LineStringvalue using its WKB representation and SRID.These functions handle their arguments as described in the introduction to this section.
ST_MLineFromWKB(,wkb[,srid[,options]])ST_MultiLineStringFromWKB(wkb[,srid[,options]])Constructs a
MultiLineStringvalue using its WKB representation and SRID.These functions handle their arguments as described in the introduction to this section.
ST_MPointFromWKB(,wkb[,srid[,options]])ST_MultiPointFromWKB(wkb[,srid[,options]])Constructs a
MultiPointvalue using its WKB representation and SRID.These functions handle their arguments as described in the introduction to this section.
ST_MPolyFromWKB(,wkb[,srid[,options]])ST_MultiPolygonFromWKB(wkb[,srid[,options]])Constructs a
MultiPolygonvalue using its WKB representation and SRID.These functions handle their arguments as described in the introduction to this section.
ST_PointFromWKB(wkb[,srid[,options]])Constructs a
Pointvalue using its WKB representation and SRID.ST_PointFromWKB()handles its arguments as described in the introduction to this section.ST_PolyFromWKB(,wkb[,srid[,options]])ST_PolygonFromWKB(wkb[,srid[,options]])Constructs a
Polygonvalue using its WKB representation and SRID.These functions handle their arguments as described in the introduction to this section.