snowflake.snowpark.functions.h3_grid_distance¶
- snowflake.snowpark.functions.h3_grid_distance(cell_id_1: Union[snowflake.snowpark.column.Column, str], cell_id_2: Union[snowflake.snowpark.column.Column, str]) Column[source] (https://github.com/snowflakedb/snowpark-python/blob/v1.40.0/src/snowflake/snowpark/_functions/scalar_functions.py#L744-L765)¶
Returns the grid distance between two H3 cell IDs.
- Parameters:
cell_id_1 (ColumnOrName) – The first H3 cell ID column or value.
cell_id_2 (ColumnOrName) – The second H3 cell ID column or value.
- Returns:
The grid distance between the two H3 cells.
- Return type:
- Example::
>>> df = session.create_dataframe([[617540519103561727, 617540519052967935]], schema=["cell_id_1", "cell_id_2"]) >>> df.select(h3_grid_distance(df["cell_id_1"], df["cell_id_2"]).alias("distance")).collect() [Row(DISTANCE=5)]