12.16.4 Functions That Create Geometry Values from WKB Values

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.

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.

These functions also accept geometry objects as returned by the functions in Section 12.16.5, “MySQL-Specific Functions That Create Geometry Values”. Thus, those functions may be used to provide the first argument to the functions in this section. However, as of MySQL 5.7.19, use of geometry arguments is deprecated and generates a warning. Geometry arguments are not accepted in MySQL 8.0. To migrate calls from using geometry arguments to using WKB arguments, follow these guidelines:

For a description of WKB format, see Well-Known Binary (WKB) Format.

• Rewrite constructs such as ST_GeomFromWKB(Point(0, 0)) as Point(0, 0).

• Rewrite constructs such as ST_GeomFromWKB(Point(0, 0), 4326) as ST_GeomFromWKB(ST_AsWKB(Point(0, 0)), 4326). (Alternatively, in MySQL 8.0, you can use ST_SRID(Point(0, 0), 4326).)

• GeomCollFromWKB(wkb [, srid]), GeometryCollectionFromWKB(wkb [, srid])

  ST_GeomCollFromWKB(), ST_GeometryCollectionFromWKB(), GeomCollFromWKB(), and GeometryCollectionFromWKB() are synonyms. For more information, see the description of ST_GeomCollFromWKB().

  GeomCollFromWKB() and GeometryCollectionFromWKB() are deprecated; expect them to be removed in a future MySQL release. Use ST_GeomCollFromWKB() and ST_GeometryCollectionFromWKB() instead.

• GeomFromWKB(wkb [, srid]), GeometryFromWKB(wkb [, srid])

  ST_GeomFromWKB(), ST_GeometryFromWKB(), GeomFromWKB(), and GeometryFromWKB() are synonyms. For more information, see the description of ST_GeomFromWKB().

  GeomFromWKB() and GeometryFromWKB() are deprecated; expect them to be removed in a future MySQL release. Use ST_GeomFromWKB() and ST_GeometryFromWKB() instead.

• LineFromWKB(wkb [, srid]), LineStringFromWKB(wkb [, srid])

  ST_LineFromWKB(), ST_LineStringFromWKB(), LineFromWKB(), and LineStringFromWKB() are synonyms. For more information, see the description of ST_LineFromWKB().

  LineFromWKB() and LineStringFromWKB() are deprecated; expect them to be removed in a future MySQL release. Use ST_LineFromWKB() and ST_LineStringFromWKB() instead.

• MLineFromWKB(wkb [, srid]), MultiLineStringFromWKB(wkb [, srid])

  ST_MLineFromWKB(), ST_MultiLineStringFromWKB(), MLineFromWKB(), and MultiLineStringFromWKB() are synonyms. For more information, see the description of ST_MLineFromWKB().

  MLineFromWKB() and MultiLineStringFromWKB() are deprecated; expect them to be removed in a future MySQL release. Use ST_MLineFromWKB() and ST_MultiLineStringFromWKB() instead.

• MPointFromWKB(wkb [, srid]), MultiPointFromWKB(wkb [, srid])

  ST_MPointFromWKB(), ST_MultiPointFromWKB(), MPointFromWKB(), and MultiPointFromWKB() are synonyms. For more information, see the description of ST_MPointFromWKB().

  MPointFromWKB() and MultiPointFromWKB() are deprecated; expect them to be removed in a future MySQL release. Use ST_MPointFromWKB() and ST_MultiPointFromWKB() instead.

• MPolyFromWKB(wkb [, srid]), MultiPolygonFromWKB(wkb [, srid])

  ST_MPolyFromWKB(), ST_MultiPolygonFromWKB(), MPolyFromWKB(), and MultiPolygonFromWKB() are synonyms. For more information, see the description of ST_MPolyFromWKB().

  MPolyFromWKB() and MultiPolygonFromWKB() are deprecated; expect them to be removed in a future MySQL release. Use ST_MPolyFromWKB() and ST_MultiPolygonFromWKB() instead.

• PointFromWKB(wkb [, srid])

  ST_PointFromWKB() and PointFromWKB() are synonyms. For more information, see the description of ST_PointFromWKB().

  PointFromWKB() is deprecated; expect it to be removed in a future MySQL release. Use ST_PointFromWKB() instead.

• PolyFromWKB(wkb [, srid]), PolygonFromWKB(wkb [, srid])

  ST_PolyFromWKB(), ST_PolygonFromWKB(), PolyFromWKB(), and PolygonFromWKB() are synonyms. For more information, see the description of ST_PolyFromWKB().

  PolyFromWKB() and PolygonFromWKB() are deprecated; expect them to be removed in a future MySQL release. Use ST_PolyFromWKB() and ST_PolygonFromWKB() instead.

• ST_GeomCollFromWKB(wkb [, srid]), ST_GeometryCollectionFromWKB(wkb [, srid])

  Constructs a GeometryCollection value using its WKB representation and SRID.

  The result is NULL if the WKB or SRID argument is NULL.

  ST_GeomCollFromWKB(), ST_GeometryCollectionFromWKB(), GeomCollFromWKB(), and GeometryCollectionFromWKB() are synonyms.

• ST_GeomFromWKB(wkb [, srid]), ST_GeometryFromWKB(wkb [, srid])

  Constructs a geometry value of any type using its WKB representation and SRID.

  The result is NULL if the WKB or SRID argument is NULL.

  ST_GeomFromWKB(), ST_GeometryFromWKB(), GeomFromWKB(), and GeometryFromWKB() are synonyms.

• ST_LineFromWKB(wkb [, srid]), ST_LineStringFromWKB(wkb [, srid])

  Constructs a LineString value using its WKB representation and SRID.

  The result is NULL if the WKB or SRID argument is NULL.

  ST_LineFromWKB(), ST_LineStringFromWKB(), LineFromWKB(), and LineStringFromWKB() are synonyms.

• ST_MLineFromWKB(wkb [, srid]), ST_MultiLineStringFromWKB(wkb [, srid])

  Constructs a MultiLineString value using its WKB representation and SRID.

  The result is NULL if the WKB or SRID argument is NULL.

  ST_MLineFromWKB(), ST_MultiLineStringFromWKB(), MLineFromWKB(), and MultiLineStringFromWKB() are synonyms.

• ST_MPointFromWKB(wkb [, srid]), ST_MultiPointFromWKB(wkb [, srid])

  Constructs a MultiPoint value using its WKB representation and SRID.

  The result is NULL if the WKB or SRID argument is NULL.

  ST_MPointFromWKB(), ST_MultiPointFromWKB(), MPointFromWKB(), and MultiPointFromWKB() are synonyms.

• ST_MPolyFromWKB(wkb [, srid]), ST_MultiPolygonFromWKB(wkb [, srid])

  Constructs a MultiPolygon value using its WKB representation and SRID.

  The result is NULL if the WKB or SRID argument is NULL.

  ST_MPolyFromWKB(), ST_MultiPolygonFromWKB(), MPolyFromWKB(), and MultiPolygonFromWKB() are synonyms.

• ST_PointFromWKB(wkb [, srid])

  Constructs a Point value using its WKB representation and SRID.

  The result is NULL if the WKB or SRID argument is NULL.

  ST_PointFromWKB() and PointFromWKB() are synonyms.

• ST_PolyFromWKB(wkb [, srid]), ST_PolygonFromWKB(wkb [, srid])

  Constructs a Polygon value using its WKB representation and SRID.

  The result is NULL if the WKB or SRID argument is NULL.

  ST_PolyFromWKB(), ST_PolygonFromWKB(), PolyFromWKB(), and PolygonFromWKB() are synonyms.