h3_toparent
-Funktion
Gilt für: Databricks SQL Databricks Runtime 11.3 LTS und höher
Gibt die ID der übergeordneten H3-Zelle der eingegebenen H3-Zellen-ID mit der angegebenen Auflösung zurück.
Syntax
h3_toparent ( h3cellIdExpr, resolutionExpr )
Argumente
h3CellIdExpr
: Ein BIGINT-Ausdruck oder ein hexadezimaler STRING-Ausdruck, der eine H3-Zellen-ID darstellt.resolutionExpr
: Ein INT-Ausdruck, für den ein Wert zwischen0
undh3_resolution(h3CellIdExpr)
erwartet wird, der die Auflösung der übergeordneten H3-Zellen-ID angibt.
Gibt zurück
Ein Wert des gleichen Typs wie der Typ des Ausdrucks h3CellIdExpr
, der der übergeordneten H3-Zellen-ID der Eingabe-H3-Zelle bei der angegebenen Auflösung entspricht.
Die Funktion gibt NULL zurück, wenn einer der beiden Eingabeausdrücke NULL ist.
Die Funktion überprüft teilweise, ob das Eingabeargument eine gültige H3-Zellen-ID ist. Eine notwendige, aber nicht hinreichende Bedingung für eine gültige H3-ID ist, dass ihr Wert zwischen 0x08001fffffffffff
und 0x08ff3b6db6db6db6
liegt.
Das Verhalten der Funktion ist undefiniert, wenn die Eingabezellen-ID keine gültige Zellen-ID ist.
Wenn der Wert der resolutionExpr
der Auflösung der Eingabe-H3-Zellen-ID entspricht, wird die Eingabe-H3-Zellen-ID zurückgegeben.
Fehlerbedingungen
- Wenn
h3CellIdExpr
ein STRING ist, der nicht in BIGINT konvertiert werden kann oder einem BIGINT-Wert entspricht, der kleiner als0x08001fffffffffff
oder größer als0x08ff3b6db6db6db6
ist, gibt die Funktion H3_INVALID_CELL_ID zurück. - Wenn
resolutionExpr
kleiner als0
oder größer alsh3_resolution(h3CellIdExpr)
ist, gibt die Funktion H3_INVALID_RESOLUTION_VALUE zurück.
Beispiele
-- Simple example taking a long as input.
> SELECT h3_toparent(599686042433355775, 0)
577199624117288959
-- Simple example taking a valid hexadecimal string as input.
> SELECT h3_toparent('85283473fffffff', 0)
8029fffffffffff
-- First input is an invalid H3 cell ID.
> SELECT h3_toparent(0, 0)
[H3_INVALID_CELL_ID] 0 is not a valid H3 cell ID
-- Second input is an invalid resolution value.
> SELECT h3_toparent('85283473fffffff', -1)
[H3_INVALID_RESOLUTION_VALUE] H3 resolution -1 must be between 0 and 5, inclusive