h3_ischildof
関数
適用対象: Databricks SQL Databricks Runtime 11.3 LTS 以降
最初の H3 セルが 2 番目の H3 セルと同じ、または子である場合に true を返します。
構文
h3_ischildof ( h3CellId1Expr, h3cellId2Expr )
引数
h3CellId1Expr
: H3 セル ID を表す BIGINT 式または 16 進数の STRING 式。h3CellId2Expr
: H3 セル ID を表す BIGINT 式または 16 進数の STRING 式。
戻り値
最初の H3 セルが 2 番目の H3 セルと同じか、子であることを示す BOOLEAN 型の値。
いずれかの入力が NULL の場合、この関数は NULL を返します。
この関数は、2 つの入力引数のいずれかが有効な H3 セル ID であるかに関する部分的な検証を行います。 有効な H3 ID の必要条件 (十分条件ではない) は、その値が 0x08001fffffffffff
と 0x08ff3b6db6db6db6
の間にあることです。
2 つの入力セル ID のいずれかが有効なセル ID でない場合、関数の動作は未定義です。
エラー条件
h3CellId1Expr
またはh3CellId2Expr
が BIGINT に変換できない STRING の場合、または、0x08001fffffffffff
より小さいか0x08ff3b6db6db6db6
より大きい BIGINT 値に対応する STRING の場合、関数は H3_INVALID_CELL_ID を返します。
例
-- Simple example taking two longs as input.
> SELECT h3_ischildof(608693241318998015, 599686042433355775)
true
-- Simple example taking two strings as input.
> SELECT h3_ischildof('88283471b9fffff', '85283473fffffff')
true
-- Simple example taking a long integer and a string as input.
> SELECT h3_ischildof(580260664489017343, '85283473fffffff')
false
-- First input is an invalid H3 cell ID.
> SELECT h3_ischildof(0, 599686042433355775)
[H3_INVALID_CELL_ID] 0 is not a valid H3 cell ID
-- Second input is an invalid H3 cell ID.
> SELECT h3_ischildof(608693241318998015, 'xyz')
[H3_INVALID_CELL_ID] 'xyz' is not a valid H3 cell ID