
Spatial Extension for BigQuery
Unlock Spatial Analytics on BigQuery
h3
H3 is Uber’s Hexagonal Hierarchical Spatial Index. Full documentation of the project can be found at h3geo. You can also learn more about H3 in the Overview section of this documentation.
ST_ASH3
Description
Returns the H3 cell index that the point belongs to in the required resolution
. It will return null
on error (invalid geography type or resolution out of bounds).
point
:GEOGRAPHY
point to get the H3 cell from.resolution
:INT64
number between 0 and 15 with the H3 resolution.
Return type
STRING
Example
|
|
LONGLAT_ASH3
Description
Returns the H3 cell index that the point belongs to in the required resolution
. It will return null
on error (resolution out of bounds).
longitude
:FLOAT64
horizontal coordinate of the map.latitude
:FLOAT64
vertical coordinate of the map.resolution
:INT64
number between 0 and 15 with the H3 resolution.
Return type
STRING
Example
|
|
ST_ASH3_POLYFILL
Description
Returns an array with all the H3 cell indexes with centers contained in a given polygon. It will return null
on error (invalid geography type or resolution out of bounds).
geography
:GEOGRAPHY
polygon or multipolygon representing the area to cover.resolution
:INT64
number between 0 and 15 with the H3 resolution.
Return type
ARRAY<STRING>
Example
|
|
ST_BOUNDARY
Description
Returns a geography representing the H3 cell. It will return null
on error (invalid input).
index
:STRING
The H3 cell index.
Return type
GEOGRAPHY
Example
|
|
ISVALID
Description
Returns true
when the given index is valid, false
otherwise.
index
:STRING
The H3 cell index.
Return type
BOOLEAN
Examples
|
|
|
|
COMPACT
Description
Returns an array with the indexes of a set of hexagons across multiple resolutions that represent the same area as the input set of hexagons.
indexArray
:ARRAY<STRING>
of H3 cell indices of the same resolution.
Return type
ARRAY<STRING>
Example
|
|
UNCOMPACT
Description
Returns an array with the indexes of a set of hexagons of the same resolution
that represent the same area as the compacted input hexagons.
indexArray
:ARRAY<STRING>
of H3 cell indices.resolution
:INT64
number between 0 and 15 with the H3 resolution.
Return type
ARRAY<STRING>
Example
|
|
TOPARENT
Description
Returns the H3 cell index of the parent of the given hexagon at the given resolution.
index
:STRING
The H3 cell index.resolution
:INT64
number between 0 and 15 with the H3 resolution.
Return type
STRING
Example
|
|
TOCHILDREN
Description
Returns an array with the indexes of the children/descendents of the given hexagon at the given resolution.
index
:STRING
The H3 cell index.resolution
:INT64
number between 0 and 15 with the H3 resolution.
Return type
ARRAY<STRING>
Example
|
|
ISPENTAGON
Description
Returns true
if given H3 index is a pentagon. Returns false
otherwise, even on invalid input.
index
:STRING
The H3 cell index.
Return type
BOOLEAN
Example
|
|
DISTANCE
Description
Returns the grid distance between two hexagon indexes. This function may fail to find the distance between two indexes if they are very far apart or on opposite sides of a pentagon. Returns null
on failure or invalid input.
origin
:STRING
origin H3 cell index.destination
:STRING
destination H3 cell index.
Return type
INT64
Example
|
|
KRING
Description
Returns an array with the indexes of all hexagons within distance
of the given input hexagon. The order of the hexagons is undefined. Returns null
on invalid input.
index
:STRING
The H3 cell index.distance
:INT64
distance (in number of cells) to the source.
Return type
ARRAY<STRING>
Example
|
|
HEXRING
Description
Get all hexagons in a hollow hexagonal ring centered at origin with sides of a given length. Unlike KRING, this function will return null
if there is a pentagon anywhere in the ring.
index
:STRING
The H3 cell index.distance
:INT64
distance (in cells) to the source.
Return type
ARRAY<STRING>
Example
|
|
VERSION
Description
Returns the current version of the H3 module.
Return type
STRING
Example
|
|