Share via


st_m

Important

This feature is in Public Preview.

Returns the M coordinate of the input point geometry, or None if the input point geometry is empty or if it does not have an M coordinate.

For the corresponding Databricks SQL function, see st_m function.

Syntax

from pyspark.databricks.sql import functions as dbf

dbf.st_m(col=<col>)

Parameters

Parameter Type Description
col pyspark.sql.Column or str A Geometry value.

Examples

from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([('POINT M (1 2 4)',)], ['wkt'])
df.select(dbf.st_m(dbf.st_geomfromtext('wkt')).alias('result')).collect()
[Row(result=4.0)]
from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([('POINT ZM (1 2 3 4)',)], ['wkt'])
df.select(dbf.st_m(dbf.st_geomfromtext('wkt')).alias('result')).collect()
[Row(result=4.0)]