h3_ispentagon function (Databricks SQL)

Returns true if the input BIGINT or hexadecimal STRING corresponds to a pentagonal H3 cell or not.

Requires: SQL warehouse version 2022.35 or higher. This version is available in the Preview channel.

Syntax

h3_ispentagon ( h3CellIdExpr )

Arguments

  • h3CellIdExpr: A BIGINT expression, or a hexadecimal STRING expression representing an H3 cell ID.

Returns

A BOOLEAN value indicating whether the input BIGINT or hexadecimal STRING corresponds to a pentagonal H3 cell.

The function returns NULL if the input is NULL. 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 h3CellIdExpr is a STRING that cannot be converted to a BIGINT or corresponds to a BIGINT value that is smaller than 0x08001fffffffffff or larger than 0x08ff3b6db6db6db6, the function returns H3_INVALID_CELL_ID.

Examples

-- Simple example taking a long as input.
> SELECT h3_ispentagon(590112357393367039)
  true

-- Simple example taking a hexadecimal string as input.
> SELECT h3_ispentagon('85283473fffffff')
  false

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