snowflake.snowpark.functions.st_geographyfromwkt

snowflake.snowpark.functions.st_geographyfromwkt(varchar_expression: Union[snowflake.snowpark.column.Column, str], allow_invalid: Union[snowflake.snowpark.column.Column, str] = None) → Column[source]

Parses a WKT (well-known text) or EWKT (extended well-known text) expression and returns a GEOGRAPHY object.

Parameters:

  • varchar_expression (ColumnOrName) – The WKT or EWKT representation of a geography object.

  • allow_invalid (ColumnOrName, optional) – A boolean expression that specifies whether to allow invalid geometries. If True, invalid geometries are returned as NULL instead of raising an error.

Returns:

A GEOGRAPHY object parsed from the input WKT string.

Return type:

Column

Examples::
>>> from snowflake.snowpark.functions import col, lit
>>> df = session.create_dataframe([['POINT(-122.35 37.55)'], ['POINTZ(-122.35 37.55 30)']], schema=["wkt"])
>>> df.select(st_geographyfromwkt(col("wkt")).alias("geography")).collect()
[Row(GEOGRAPHY='{\n  "coordinates": [\n    -122.35,\n    37.55\n  ],\n  "type": "Point"\n}'), Row(GEOGRAPHY='{\n  "coordinates": [\n    -122.35,\n    37.55,\n    30\n  ],\n  "type": "Point"\n}')]

>>> df.select(st_geographyfromwkt(col("wkt"), lit(True)).alias("geography")).collect()
[Row(GEOGRAPHY='{\n  "coordinates": [\n    -122.35,\n    37.55\n  ],\n  "type": "Point"\n}'), Row(GEOGRAPHY='{\n  "coordinates": [\n    -122.35,\n    37.55,\n    30\n  ],\n  "type": "Point"\n}')]