Compartir vía

Función h3_kring

  • Artículo

Se aplica a: casilla marcada como sí Databricks SQL casilla marcada como Sí Databricks Runtime 11.3 LTS y versiones posteriores

Devuelve las celdas H3 que están dentro de una distancia (de cuadrícula) k de la celda de origen. El conjunto de estas celdas H3 se denomina el anillo k de la celda de origen.

Sintaxis

h3_kring ( h3CellIdExpr, kExpr )

Argumentos

  • h3CellIdExpr: expresión BIGINT o expresión STRING hexadecimal que representa un identificador de celda H3.
  • kExpr: expresión INTEGER que representa la distancia de la cuadrícula. kExpr no puede ser negativo.

Devoluciones

Se devuelve una elemento ARRAY donde se incluyen valores del mismo tipo que el de la expresión h3CellIdExpr. Estos se corresponden con los id. de la celda H3 que tienen la misma resolución que la celda H3 de entrada y que se ubican a una distancia de cuadrícula k con respecto a la celda H3 de entrada, donde el elemento k se corresponde con el valor de kExpr.

La función devuelve NULL si alguna de las expresiones de entrada es NULL. La función realiza una validación parcial con respecto a si el argumento de entrada es un identificador de celda H3 válido. Una condición necesaria, pero no suficiente para un identificador H3 válido es que su valor está entre 0x08001fffffffffff y 0x08ff3b6db6db6db6. El comportamiento de la función no está definido si el identificador de celda de entrada no es un identificador de celda válido. Si el valor de la distancia de la cuadrícula es cero, la matriz devuelta contiene un valor único igual al id. de la celda H3 de entrada.

Condiciones de error

  • Si h3CellIdExpr es una cadena que no se puede convertir en BIGINT o corresponde a un valor BIGINT menor que 0x08001fffffffffff o mayor que 0x08ff3b6db6db6db6, la función devuelve H3_INVALID_CELL_ID.
  • Si kExpr es negativo, la función devuelve H3_INVALID_GRID_DISTANCE_VALUE.

Ejemplos

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