snowflake.snowpark.functions.h3_is_pentagon¶

snowflake.snowpark.functions.h3_is_pentagon(cell_id: Union[snowflake.snowpark.column.Column, str]) → Column[source]¶

Returns true if the given H3 cell ID is a pentagon.

Parameters:

cell_id (ColumnOrName) – The H3 cell IDs.

Returns:

Whether each H3 cell ID is a pentagon.

Return type:

Column

Example::
>>> df = session.create_dataframe([613036919424548863], schema=["cell_id"])
>>> df.select(h3_is_pentagon(df["cell_id"]).alias("is_pentagon")).collect()
[Row(IS_PENTAGON=False)]
>>> df = session.create_dataframe(['804dfffffffffff'], schema=["cell_id"])
>>> df.select(h3_is_pentagon(df["cell_id"]).alias("is_pentagon")).collect()
[Row(IS_PENTAGON=True)]
Copy