snowflake.snowpark.functions.st_geographyfromwkb

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

Parses a WKB (well-known binary) or EWKB (extended well-known binary) input and returns a GEOGRAPHY object.

Parameters:

  • varchar_or_binary_expression (ColumnOrName) – The WKB or EWKB representation as a VARCHAR or BINARY value.

  • allow_invalid (ColumnOrName, optional) – A boolean column that specifies whether to allow invalid geometries. If True, invalid geometries are accepted; if False or not specified, invalid geometries cause an error.

Returns:

A GEOGRAPHY object parsed from the WKB input.

Return type:

Column

Examples::
>>> from snowflake.snowpark.functions import col, lit
>>> df = session.create_dataframe([['01010000006666666666965EC06666666666C64240']], schema=["wkb_data"])
>>> df.select(st_geographyfromwkb(col("wkb_data")).alias("geography")).collect()
[Row(GEOGRAPHY='{\n  "coordinates": [\n    -1.223500000000000e+02,\n    3.755000000000000e+01\n  ],\n  "type": "Point"\n}')]

>>> df.select(st_geographyfromwkb(col("wkb_data"), lit(True)).alias("geography")).collect()
[Row(GEOGRAPHY='{\n  "coordinates": [\n    -1.223500000000000e+02,\n    3.755000000000000e+01\n  ],\n  "type": "Point"\n}')]