st_ndims

Preview

Support for GEOGRAPHY values is in Public Preview. Support for GEOMETRY values is generally available.

Returns the coordinate dimension of the input Geography or Geometry value.

For the corresponding Databricks SQL function, see st_ndims function.

Syntax

Python

from pyspark.databricks.sql import functions as dbf

dbf.st_ndims(col=<col>)

Parameters

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

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

Examples

Python

from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([('POINT ZM (10 34 48 -24)',)], ['wkt'])
df.select(dbf.st_ndims(dbf.st_geomfromtext('wkt')).alias('result')).collect()

Output

[Row(result=4)]