Share via

h3_ispentagon 函数

  • 项目

适用于：check marked yes Databricks SQL check marked yes Databricks Runtime 11.2 及更高版本

如果输入 BIGINT 或十六进制 STRING 对应于五边形 H3 单元格，则返回 true。

语法

h3_ispentagon ( h3CellIdExpr )

参数

  • h3CellIdExpr：表示 H3 单元格 ID 的 BIGINT 表达式或十六进制 STRING 表达式。

返回

一个 BOOLEAN 值，指示输入 BIGINT 或十六进制 STRING 是否对应于五边形 H3 单元格。

如果输入为 NULL，则该函数返回 NULL。 该函数对输入参数是否为有效的 H3 单元格 ID 进行部分验证。 有效 H3 ID 的必要不充分条件是其值介于 0x08001fffffffffff 和 0x08ff3b6db6db6db6 之间。 如果输入单元格 ID 不是有效的单元格 ID，则表示该函数的行为未定义。

错误条件

  • 如果 h3CellIdExpr 是无法转换为 BIGINT 的 STRING 或对应于小于 0x08001fffffffffff 或大于 0x08ff3b6db6db6db6 的 BIGINT 值，则该函数返回 H3_INVALID_CELL_ID。

示例

-- 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