Categories:

Geospatial Functions

H3_COMPACT_CELLS

Returns an array of VARIANT values that contain the INTEGER IDs of fewer, larger H3 cells that cover the same area as the H3 cells in the input. For information about compacted cells, see Indexing.

Syntax

H3_COMPACT_CELLS( <array_of_cell_ids> )
Copy

Arguments

array_of_cell_ids

An array of VARIANT values that contain the INTEGER values that represent H3 cell IDs (indexes).

Returns

Returns a value of the ARRAY data type or NULL.

  • If the input is an array of INTEGER values, returns an array that consists of VARIANT values that represent a compacted set of H3 cells. The VARIANT values contain the INTEGER values that represent H3 cell IDs.

  • If the input is NULL, returns NULL without reporting an error.

Usage notes

  • All of the INTEGER values in the input must represent valid H3 cells.

  • All of the H3 cells in the input must have the same resolution.

  • The H3 cells in the input must cover unique areas without overlapping. Duplicate H3 cells are not allowed.

Examples

The following example compacts a set of H3 cells, returning cells at a lower resolution that represent the same area.

SELECT H3_COMPACT_CELLS(
  [
    622236750562230271,
    622236750562263039,
    622236750562295807,
    622236750562328575,
    622236750562361343,
    622236750562394111,
    622236750562426879,
    622236750558396415
  ]
) AS compacted;
Copy
+-----------------------+
| COMPACTED             |
|-----------------------|
| [                     |
|   622236750558396415, |
|   617733150935089151  |
| ]                     |
+-----------------------+