Share via

to_geometry function

Applies to: check marked yes Databricks SQL check marked yes Databricks Runtime 17.1 and above

Important

This feature is in Public Preview.

Note

This feature is not available on Databricks SQL Classic warehouses. To learn more about Databricks SQL warehouses, see SQL warehouse types.

Parses the input description of a geometry and returns the corresponding GEOMETRY value. The SRID value of the returned GEOMETRY value depends on the input format.

Syntax

to_geometry ( geoRepExpr )

Arguments

  • geoRepExpr: A BINARY or STRING expression representing a geometry in WKB, WKT, GeoJSON, or Extended WKB (EWKB).

Returns

A value of type GEOMETRY(ANY), corresponding to the input geography description.

The function returns NULL if the input is NULL.

Error conditions

  • If geoRepExpr is of type BINARY and the value is an invalid EWKB, the function returns EWKB_PARSE_ERROR.
  • If geoRepExpr is of type BINARY and the value is an invalid WKB, the function returns WKB_PARSE_ERROR.
  • If geoRepExpr is of type STRING and the value is an invalid WKT, the function returns WKT_PARSE_ERROR.
  • If geoRepExpr is of type STRING and the value is an invalid GeoJSON, the function returns GEOJSON_PARSE_ERROR.

Examples

-- Input geometry is in WKT format.
> SELECT st_asgeojson(to_geometry('POINT Z (3 4 5)'));
  {"type":"Point","coordinates":[3,4,5]}

-- Input geometry is in GeoJSON format.
> SELECT st_astext(to_geometry('{"type":"Point","coordinates":[3,4,5]}'));
  POINT Z (3 4 5)

-- Input geometry is in WKB format.
> SELECT st_astext(to_geometry(X'0101000060110f0000000000000000084000000000000010400000000000001440'));
  POINT M (3 4 5)

-- Input geometry is in EWKB format.
> SELECT st_asewkt(to_geometry(X'01010000E0110F0000000000000000084000000000000010400000000000001440000000000000F0BF'));
  SRID=3857;POINT ZM (3 4 5 -1)