st_envelope_agg

Preview

This feature is in Public Preview. You can confirm preview enrollment on the Previews page. See Manage Databricks previews.

Returns the envelope of all the geometries in the column, or None if the column has zero rows, or contains only None values.

For the corresponding Databricks SQL function, see st_envelope_agg function.

Syntax

Python

from pyspark.databricks.sql import functions as dbf

dbf.st_envelope_agg(col=<col>)

Parameters

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

Examples

Python

from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([('MULTIPOINT(EMPTY,4 3,5 6,-1 8)',), ('POLYGON((0 0,10 0,0 10,0 0))',)], ['wkt'])
df.select(dbf.st_asewkt(dbf.st_envelope_agg(dbf.st_geomfromtext('wkt', 4326))).alias('result')).collect()

Output

[Row(result='SRID=4326;POLYGON((-1 0,-1 10,10 10,10 0,-1 0))')]