h3
Last updated
Was this helpful?
Last updated
Was this helpful?
is Uber’s Hexagonal Hierarchical Spatial Index. Full documentation of the project can be found at . You can also learn more about H3 in the of this documentation.
Description
Returns a geography representing the H3 cell. It will return null
on error (invalid input).
index
: VARCHAR(16)
The H3 cell index as hexadecimal.
Return type
GEOMETRY
Example
Description
Returns the center of the H3 cell as a GEOMETRY point. It will return null
on error (invalid input).
index
: VARCHAR(16)
The H3 cell index.
Return type
GEOMETRY
Example
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
: VARCHAR(16)[]
of H3 cell indices of the same resolution as hexadecimal.
Return type
VARCHAR(16)[]
Example
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
: VARCHAR(16)
The H3 cell index as hexadecimal.
destination
: VARCHAR(16)
The H3 cell index as hexadecimal.
Return type
BIGINT
Example
Description
Returns the H3 cell index that the point belongs to in the requested resolution
. It will return null
on error (invalid geography type or resolution out of bounds). This function is an alias for H3_FROMGEOPOINT
.
point
: GEOMETRY
point to get the H3 cell from.
Return type
VARCHAR(16)
Example
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
: DOUBLE PRECISION
horizontal coordinate of the map.
latitude
: DOUBLE PRECISION
vertical coordinate of the map.
Return type
VARCHAR(16)
Example
Description
origin
: VARCHAR(16)
H3 cell index of the origin.
size
: INT
size of the ring (distance from the origin).
Return type
VARCHAR(16)[]
Example
Description
Converts the integer representation of the H3 index to the string representation.
index
: INT
The H3 cell index.
Return type
VARCHAR(16)
Example
Description
Returns true
if given H3 index is a pentagon. Returns false
otherwise, even on invalid input.
index
: VARCHAR(16)
The H3 cell index as hexadecimal.
Return type
BOOLEAN
Example
Description
Returns true
when the given index is valid, false
otherwise.
index
: VARCHAR(16)
The H3 cell index as hexadecimal.
Return type
BOOLEAN
Examples
Description
Returns all cell indexes in a filled hexagonal k-ring centered at the origin in no particular order.
origin
: VARCHAR(16)
H3 cell index of the origin.
size
: INT
size of the ring (distance from the origin).
Return type
VARCHAR(16)[]
Example
Description
Returns all cell indexes and their distances in a filled hexagonal k-ring centered at the origin in no particular order.
origin
: VARCHAR(16)
H3 cell index of the origin.
size
: INT
size of the ring (distance from the origin).
Return type
JSON[]
Example
Description
Returns an array of H3 cell indexes contained in the given geometry at a requested resolution. Containment is determined by the mode: center, intersects, contains.
geom
: GEOMETRY
representing the shape to cover.
mode
(optional): VARCHAR
center
(default) returns the indexes of the H3 cells which centers intersect the input geometry (polygon). The resulting H3 set does not fully cover the input geometry, however, this is significantly faster that the other modes. This mode is not compatible with points or lines.
intersects
returns the indexes of the H3 cells that intersect the input geometry. The resulting H3 set will completely cover the input geometry (point, line, polygon).
contains
returns the indexes of the H3 cells that are entirely contained inside the input geometry (polygon). This mode is not compatible with points or lines.
Mode center
:
Mode intersects
:
Mode contains
:
Return type
VARCHAR(16)[]
Examples
Description
Converts the string representation of the H3 index to the integer representation.
index
: VARCHAR(16)
The H3 cell index.
Return type
INT
Example
Description
Returns an array with the indexes of the children/descendents of the given hexagon at the given resolution.
index
: VARCHAR(16)
The H3 cell index as hexadecimal.
Return type
VARCHAR(16)[]
Example
Description
Returns the H3 cell index of the parent of the given hexagon at the given resolution.
index
: VARCHAR(16)
The H3 cell index as hexadecimal.
Return type
VARCHAR
Example
Description
indexArray
: VARCHAR(16)
of H3 cell indices as hexadecimal.
Return type
VARCHAR(16)[]
Example
If you want the distance in meters use between the cells () or their centroid.
resolution
: INT
number between 0 and 15 with the .
If you want the cells covered by a POLYGON see .
resolution
: INT
number between 0 and 15 with the .
Returns all cell indexes in a hollow hexagonal ring centered at the origin in no particular order. Unlike , this function will throw an exception if there is a pentagon anywhere in the ring.
resolution
: INT
level of detail. The value must be between 0 and 15 ().
resolution
: INT
number between 0 and 15 with the .
resolution
: INT
number between 0 and 15 with the .
Returns an array with the indexes of a set of hexagons of the same resolution
that represent the same area as the input hexagons.
resolution
: INT
number between 0 and 15 with the .