h3_h3tostring function

Converts the input H3 cell ID to its equivalent hexadecimal string representation.

Since: Databricks Runtime 11.2

Syntax

h3_h3tostring ( h3CellIdExpr )

Arguments

  • h3CellIdExpr: A BIGINT expression representing an H3 cell ID.

Returns

A value of type STRING. The returned result is the big-endian hexadecimal representation of the input BIGINT with any leading zeros stripped.

The function returns NULL if the input is NULL. The function converts the BIGINT to its corresponding hexadecimal string. 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 h3CellIdExpr of is smaller than 0x08001fffffffffff or larger than 0x08ff3b6db6db6db6, the function returns H3_INVALID_CELL_ID.

Examples

-- Simple example
> SELECT h3_h3tostring(599686042433355775)
  85283473fffffff

-- Input is an invalid H3 cell ID.
> SELECT h3_h3tostring(0)
  [H3_INVALID_CELL_ID] 0 is not a valid H3 cell ID