Share via

st_asbinary 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.

Returns the input GEOGRAPHY or GEOMETRY value in WKB format using the specified endianness, if provided. If the endianness is not specified, the returned value is little-endian encoded.

Syntax

st_asbinary ( geoExpr[, endiannessExpr] )

Arguments

  • geoExpr: A GEOGRAPHY or GEOMETRY value.
  • endiannessExpr: An optional STRING value, representing the endianness of the output WKB, 'NDR' for little-endian (default) or 'XDR' for big-endian.

Returns

A value of type BINARY. The returned value is the WKB description of the input GEOGRAPHY or GEOMETRY value using the specified endianness, if provided. If the endianness is not specified, the returned value is little-endian encoded.

The function returns NULL if any of the inputs is NULL.

Examples

-- Export a 3DZ Cartesian point in WKB format (default endianness).
> SELECT hex(st_asbinary(st_geomfromtext('POINT Z (1 2 100)')));
  01E9030000000000000000F03F00000000000000400000000000005940

-- Export a 3DZ geographic point in big -endianness WKB format.
> SELECT hex(st_asbinary(st_geogfromtext('POINT Z (1 2 100)'), 'XDR'));
  00000003E93FF000000000000040000000000000004059000000000000