st_y function

Applies to: Databricks SQL Databricks Runtime 17.1 and above

Returns the Y coordinate of the input point GEOMETRY value, or NULL if the point is empty.

Syntax

st_y ( geoExpr )

Arguments

• geoExpr: A GEOMETRY value.

Returns

A value of type DOUBLE, equal to the Y coordinate of the input point GEOMETRY value.

The function returns NULL if the input is NULL or if the point is empty.

Error conditions

• If the value of geoExpr is not a point, the function returns ST_INVALID_ARGUMENT.INVALID_TYPE.

Examples

-- Returns the Y coordinate of a non-empty point geometry.
> SELECT st_y(st_geomfromtext('POINT Z (2 3 4)'));
  3.0
-- Returns `NULL` for an empty point geometry.
> SELECT st_y(st_geomfromtext('POINT ZM EMPTY'));
  NULL

Related functions

• st_m function
• st_x function
• st_ymax function
• st_ymin function
• st_z function