Skip to main content

st_difference

Preview

This feature is in Public Preview.

Returns the point-set different of the two input geometries as a 2D geometry.

For the corresponding Databricks SQL function, see st_difference function.

Syntax

Python
from pyspark.databricks.sql import functions as dbf

dbf.st_difference(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([('MULTIPOINT(EMPTY,4 3,5 6,-1 8)','POLYGON((0 0,10 0,0 10,0 0))',)], ['wkt1', 'wkt2'])
df.select(dbf.st_asewkt(dbf.st_difference(dbf.st_geomfromtext('wkt1', 4326), dbf.st_geomfromtext('wkt2', 4326))).alias('result')).collect()
Output
[Row(result='SRID=4326;MULTIPOINT((-1 8),(5 6))')]