Categories:

Geospatial Functions

H3_POINT_TO_CELL

Returns the INTEGER value of an H3 cell ID for a Point (specified by a GEOGRAPHY object) at a given resolution.

See also:

H3_POINT_TO_CELL_STRING , H3_CELL_TO_POINT

Syntax

H3_POINT_TO_CELL( <geography_point> , <target_resolution> )
Copy

Arguments

geography_point

A GEOGRAPHY object that represents a Point.

target_resolution

An INTEGER between 0 and 15 (inclusive) specifying the H3 resolution that you want to use for the returned H3 cell.

Specifying any other INTEGER value results in an error.

Returns

Returns an INTEGER value corresponding to the H3 cell ID for the given location and resolution.

Examples

The following example returns the H3 cell ID for the Brandenburg Gate at resolution 8.

SELECT H3_POINT_TO_CELL(ST_POINT(13.377704, 52.516262), 8);
Copy
+-----------------------------------------------------+
| H3_POINT_TO_CELL(ST_POINT(13.377704, 52.516262), 8) |
|-----------------------------------------------------|
|                                  613036919424548863 |
+-----------------------------------------------------+

The following example demonstrates that you cannot specify a resolution outside of 0 through 15.

SELECT H3_POINT_TO_CELL(ST_POINT(13.377704, 52.516262), 18);
Copy
100410 (P0000): Invalid H3 resolution value: 18. Resolution must be between 0 (coarsest) and 15 (finest).