h3_toparent
-functie
Van toepassing op: Databricks SQL
Databricks Runtime 11.3 LTS en hoger
Retourneert de bovenliggende H3-cel van de ingevoerde H3-cel met de opgegeven resolutie.
Syntaxis
h3_toparent ( h3cellIdExpr, resolutionExpr )
Argumenten
h3CellIdExpr
: Een BIGINT-expressie of een hexadecimale TEKENREEKS-expressie die een H3-cel-id vertegenwoordigt.resolutionExpr
: Een INT-expressie, waarvan de waarde naar verwachting tussen0
enh3_resolution(h3CellIdExpr)
inclusief is, waarbij de resolutie van de bovenliggende H3-cel-id wordt opgegeven.
Retouren
Een waarde van hetzelfde type als het type expressie h3CellIdExpr
dat overeenkomt met de bovenliggende H3-cel-id van de ingevoerde H3-cel met de opgegeven resolutie.
De functie retourneert NULL als een van de twee invoerexpressies NULL is.
De functie voert gedeeltelijke validatie uit met betrekking tot of het invoerargument een geldige H3-cel-id is. Een noodzakelijke, maar niet voldoende voorwaarde voor een geldige H3-id is dat de waarde tussen 0x08001fffffffffff
en 0x08ff3b6db6db6db6
.
Het gedrag van de functie is niet gedefinieerd als de invoercel-id geen geldige cel-id is.
Als de waarde van de resolutionExpr
waarde gelijk is aan de resolutie van de H3-cel-id van de invoer, wordt de H3-cel-id voor invoer geretourneerd.
Foutvoorwaarden
- Als
h3CellIdExpr
dit een TEKENREEKS is die niet kan worden geconverteerd naar een BIGINT of overeenkomt met een BIGINT-waarde die kleiner is dan0x08001fffffffffff
of groter0x08ff3b6db6db6db6
is, retourneert de functie H3_INVALID_CELL_ID. - Als
resolutionExpr
deze kleiner is dan0
of groterh3_resolution(h3CellIdExpr)
is, retourneert de functie H3_INVALID_RESOLUTION_VALUE.
Voorbeelden
-- 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