h3_stringtoh3
function
Applies to: Databricks SQL Databricks Runtime 11.3 LTS and above
Converts the input string, which is expected to be a hexadecimal string representing an H3 cell, to the corresponding BIGINT representation of the H3 cell.
Arguments
h3CellIdStringExpr
: A well-formed hexadecimal STRING expression representing a valid H3 cell ID.
Returns
A value of type BIGINT. The returned value is the BIGINT representation of the input hexadecimal string.
The function returns NULL if the input is NULL.
The function converts the hexadecimal string to the corresponding BIGINT number.
The function does partial validation regarding whether the input argument is a valid H3 cell ID. A necessary, but not sufficient condition for a valid H3 ID is that its value is between 0x08001fffffffffff
and 0x08ff3b6db6db6db6
.
The behavior of the function is undefined if the input cell ID is not a valid cell ID.
Error conditions
If the value of
h3CellIdStringExpr
cannot be converted to a BIGINT or if the value corresponds to a BIGINT value that is smaller than0x08001fffffffffff
or larger than0x08ff3b6db6db6db6
, the function returns H3_INVALID_CELL_ID.