st_contains

Preview

This feature is in Public Preview.

Returns True if the first geometry contains the second geometry. Geometry collections are not supported.

For the corresponding Databricks SQL function, see st_contains function.

Syntax

Python

from pyspark.databricks.sql import functions as dbf

dbf.st_contains(col1=<col1>, col2=<col2>)

Parameters

Parameter	Type	Description
col1	pyspark.sql.Column or str	The first Geometry value.
col2	pyspark.sql.Column or str	The second Geometry value.

Notes

The two geometries are expected to have the same SRID value, otherwise an error is returned.

Examples

Python

from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([('POLYGON((0 0,10 0,0 10,0 0))','POINT(1 1)',)], ['wkt1', 'wkt2'])
df.select(dbf.st_contains(dbf.st_geomfromtext('wkt1'), dbf.st_geomfromtext('wkt2')).alias('result')).collect()

Output

[Row(result=True)]

Python

from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([('POLYGON((0 0,10 0,0 10,0 0))','POINT(5 6)',)], ['wkt1', 'wkt2'])
df.select(dbf.st_contains(dbf.st_geomfromtext('wkt1'), dbf.st_geomfromtext('wkt2')).alias('result')).collect()

Output

[Row(result=False)]