st_envelope_agg

Important

This feature is in Public Preview.

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

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

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()

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