Funkce h3_kring
Platí pro: Databricks SQL Databricks Runtime 11.3 LTS a vyšší
Vrátí buňky H3, které jsou ve vzdálenosti k
(mřížky) buňky původu. Sada těchto buněk H3 se nazývá k
-ring původní buňky.
Syntaxe
h3_kring ( h3CellIdExpr, kExpr )
Argumenty
h3CellIdExpr
: Výraz BIGINT nebo šestnáctkový výraz STRING představující ID buňky H3.kExpr
: Výraz INTEGER představující vzdálenost mřížky.kExpr
musí být nezáporná.
Návraty
POLE hodnot stejného typu jako typ h3CellIdExpr
výrazu, které odpovídají ID buněk H3, které mají stejné rozlišení jako vstupní buňka H3, a jsou ve vzdálenosti k
mřížky vstupní buňky H3, kde k
je hodnota kExpr
buňky .
Funkce vrátí hodnotu NULL, pokud některý ze vstupních výrazů má hodnotu NULL.
Funkce provádí částečné ověření týkající se toho, jestli je vstupním argumentem platné ID buňky H3. Nezbytným, ale ne dostatečným předpokladem platného ID H3 je, že jeho hodnota je mezi 0x08001fffffffffff
a 0x08ff3b6db6db6db6
.
Chování funkce není definováno, pokud id vstupní buňky není platné ID buňky.
Pokud je hodnota vzdálenosti mřížky nula, vrácená matice obsahuje jednu hodnotu, která se rovná vstupnímu ID buňky H3.
Chybové podmínky
- Pokud
h3CellIdExpr
je řetězec, který nelze převést na BIGINT nebo odpovídá hodnotě BIGINT, která je menší nebo větší než0x08001fffffffffff
0x08ff3b6db6db6db6
, vrátí funkce H3_INVALID_CELL_ID. - Pokud
kExpr
je záporná, vrátí funkce H3_INVALID_GRID_DISTANCE_VALUE.
Příklady
-- Simple example where the first argument is a BIGINT.
> SELECT h3_kring(599686042433355775, 1)
[599686042433355775,599686030622195711,599686044580839423,599686038138388479,599686043507097599,599686015589810175,599686014516068351]
-- Simple example where the first argument is a STRING.
> SELECT h3_kring('85283473fffffff', 1)
[85283473fffffff,85283447fffffff,8528347bfffffff,85283463fffffff,85283477fffffff,8528340ffffffff,8528340bfffffff]
-- First input is an invalid H3 cell ID.
> SELECT h3_kring(0, 0)
[H3_INVALID_CELL_ID] 0 is not a valid H3 cell ID
-- Second input is an invalid grid distance value.
> SELECT h3_kring('85283473fffffff', -1)
[H3_INVALID_GRID_DISTANCE_VALUE] H3 grid distance -1 must be non-negative