Skip to main content

to_geography

Preview

This feature is in Public Preview.

Parses the input BINARY or string value and returns the corresponding Geography value. An error is thrown for invalid input.

For the corresponding Databricks SQL function, see to_geography function.

Syntax

Python
from pyspark.databricks.sql import functions as dbf

dbf.to_geography(col=<col>)

Parameters

Parameter

Type

Description

col

pyspark.sql.Column or str

A string value in WKT or GeoJSON format, or a BINARY value in WKB format representing a Geography value.

Examples

Python
from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([('POINT Z (3 4 5)',)], ['wkt'])
df.select(dbf.st_asewkt(dbf.to_geography('wkt')).alias('result')).collect()
Output
[Row(result='SRID=4326;POINT Z (3 4 5)')]
Python
from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([('{"type":"MultiPoint","coordinates":[[3,4,5]]}',)], ['geojson'])
df.select(dbf.st_asewkt(dbf.to_geography('geojson')).alias('result')).collect()
Output
[Row(result='SRID=4326;MULTIPOINT Z ((3 4 5))')]
Python
from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([(bytes.fromhex('01ef0300000100000001e9030000000000000000084000000000000010400000000000001440'),)], ['wkb'])
df.select(dbf.st_asewkt(dbf.to_geography('wkb')).alias('result')).collect()
Output
[Row(result='SRID=4326;GEOMETRYCOLLECTION Z (POINT Z (3 4 5))')]