h3_centeraswkb 函数

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

返回输入 H3 单元格的中心(表示为 WKB 格式的点)。

语法

h3_centeraswkb ( h3CellIdExpr )

参数

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

返回

BINARY 类型的值,它将输入 H3 单元格的中心表示为 WKB 格式的点。

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

错误条件

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

示例

-- Input a BIGINT representing a hexagonal cell.
> SELECT hex(h3_centeraswkb(599686042433355775))
  0101000000F5ACA5F17C7E5EC0833013F542AC4240

-- Input a STRING representing a pentagonal cell.
> SELECT hex(h3_centeraswkb('8009fffffffffff'))
  01010000009D8F6AAF881225404E2B56CDCC2C5040

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