h3_stringtoh3 函数

适用于: Databricks SQL 勾选标记为“是” Databricks Runtime 11.3 LTS 及更高版本check marked yes

将输入字符串(预期为表示 H3 单元格的十六进制字符串)转换为 H3 单元格的对应 BIGINT 表示形式。

语法

h3_stringtoh3 ( h3CellIdExpr )

参数

  • h3CellIdStringExpr:表示有效 H3 单元格 ID 的标准格式十六进制 STRING 表达式。

返回

BIGINT 类型的值。 返回值是输入十六进制字符串的 BIGINT 表示形式。

如果输入为 NULL,则该函数返回 NULL。 该函数将十六进制字符串转换为对应的 BIGINT 数字。 该函数对输入参数是否为有效的 H3 单元格 ID 进行部分验证。 有效 H3 ID 的必要不充分条件是其值介于 0x08001fffffffffff0x08ff3b6db6db6db6 之间。 如果输入单元格 ID 不是有效的单元格 ID,则表示该函数的行为未定义。

错误条件

  • h3CellIdStringExpr如果无法转换为 BIGINT 的值,或者该值对应于小于0x08001fffffffffff或大于0x08ff3b6db6db6db6的 BIGINT 值,则函数将返回H3_INVALID_CELL_ID

示例

-- Simple example
> SELECT h3_stringtoh3('85283473fffffff');
  599686042433355775

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