Função h3_toparent
Aplica-se a: Databricks SQL Databricks Runtime 11.3 LTS e superior
Retorna a célula H3 pai da célula H3 de entrada na resolução especificada.
Sintaxe
h3_toparent ( h3cellIdExpr, resolutionExpr )
Argumentos
h3CellIdExpr
: Uma expressão BIGINT ou uma expressão STRING hexadecimal que representa um ID de célula H3.resolutionExpr
: Uma expressão INT, cujo valor deve ser entre0
eh3_resolution(h3CellIdExpr)
inclusivo, especificando a resolução do ID da célula H3 pai.
Devoluções
Um valor do mesmo tipo que o tipo da h3CellIdExpr
expressão, correspondente ao ID da célula H3 pai da célula H3 de entrada na resolução especificada.
A função retorna NULL se qualquer uma das duas expressões de entrada for NULL.
A função faz validação parcial em relação a se o argumento de entrada é um ID de célula H3 válido. Uma condição necessária, mas não suficiente, para um ID H3 válido é que seu valor esteja entre 0x08001fffffffffff
e 0x08ff3b6db6db6db6
.
O comportamento da função é indefinido se o ID da célula de entrada não for um ID de célula válido.
Se o valor do for igual à resolução do ID da célula H3 de entrada, o ID da célula H3 de resolutionExpr
entrada será retornado.
Condições de erro
- Se
h3CellIdExpr
for um STRING que não pode ser convertido em um BIGINT ou corresponder a um valor BIGINT menor0x08001fffffffffff
ou maior que0x08ff3b6db6db6db6
, a função retornará H3_INVALID_CELL_ID. - Se
resolutionExpr
for menor0
ou maior queh3_resolution(h3CellIdExpr)
, a função retornará H3_INVALID_RESOLUTION_VALUE.
Exemplos
-- 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