snowflake.snowpark.functions.h3_is_valid_cell¶

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

Checks if the given H3 cell ID is valid.

Parameters:

cell_id (ColumnOrName) – The H3 cell IDs to validate.

Returns:

Whether each H3 cell ID is valid, returns True for valid H3 cell IDs, False for invalid ones, and None for None inputs.

Return type:

Column

Example:

>>> df = session.create_dataframe([613036919424548863, 123456789, None], schema=["cell_id"])
>>> df.select(h3_is_valid_cell(df["cell_id"]).alias("is_valid")).collect()
[Row(IS_VALID=True), Row(IS_VALID=False), Row(IS_VALID=None)]

Copy