Fonction h3_toparent

  • Article

S’applique à :coche marquée oui Databricks SQL oui coché Databricks Runtime 11.3 LTS et versions ultérieures

Retourne la cellule H3 parente de la cellule H3 d’entrée à la résolution spécifiée.

Syntaxe

h3_toparent ( h3cellIdExpr, resolutionExpr )

Arguments

  • h3CellIdExpr : expression BIGINT ou expression STRING hexadécimale représentant un ID de cellule H3.
  • resolutionExpr : expression INT dont la valeur doit être comprise entre 0 et h3_resolution(h3CellIdExpr) inclus, en spécifiant la résolution de l’ID de cellule H3 parent.

Retours

Valeur du même type que le type de l’expression h3CellIdExpr , correspondant à l’ID de cellule H3 parent de la cellule H3 d’entrée à la résolution spécifiée.

La fonction retourne NULL si l’une des deux expressions d’entrée est NULL. La fonction effectue une validation partielle pour déterminer si l’argument d’entrée est un ID de cellule H3 valide. Une valeur d’ID H3 comprise entre 0x08001fffffffffff et 0x08ff3b6db6db6db6 constitue une condition nécessaire mais pas suffisante. Le comportement de la fonction n’est pas défini si l’ID de cellule d’entrée ne correspond pas à un ID de cellule valide. Si la valeur de resolutionExpr est égale à la résolution de l’ID de cellule H3 d’entrée, l’ID de cellule H3 d’entrée est retourné.

Conditions d'erreur

  • Si h3CellIdExpr correspond à une STRING qui ne peut pas être convertie en BIGINT ou qui correspond à une valeur BIGINT inférieure à 0x08001fffffffffff ou supérieure à 0x08ff3b6db6db6db6, la fonction retourne H3_INVALID_CELL_ID.
  • Si resolutionExpr est inférieure à 0 ou supérieure à h3_resolution(h3CellIdExpr), la fonction retourne H3_INVALID_RESOLUTION_VALUE.

Exemples

-- 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