Categories:

Geospatial functions

H3_LATLNG_TO_CELL¶

Returns the INTEGER value of the H3 cell ID for a given latitude, longitude, and resolution.

See also:

H3_LATLNG_TO_CELL_STRING

Syntax¶

H3_LATLNG_TO_CELL( <latitude> , <longitude> , <target_resolution> )
Copy

Arguments¶

latitude

A FLOAT that represents the latitude.

Values outside the standard latitude range are wrapped to the range [-90, 90].

longitude

A FLOAT that represents the longitude.

Values outside the standard longitude range are wrapped to the range [-180, 180].

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 that corresponds to the H3 cell ID for the given location and resolution.

Usage notes¶

  • Specifying NaN or Inf values for any input argument results in an error.

Examples¶

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

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

The following example specifies a longitude value (373.377704) that is outside of the traditional longitude range (-180 to 180). The function interprets this value as 13.377704 (373.377704 modulo 180).

SELECT H3_LATLNG_TO_CELL(52.516262, 373.377704, 8);
Copy
+---------------------------------------------+
| H3_LATLNG_TO_CELL(52.516262, 373.377704, 8) |
|---------------------------------------------|
|                          613036919424548863 |
+---------------------------------------------+

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

SELECT H3_LATLNG_TO_CELL(52.516262, 373.377704, 18);
Copy
100410 (P0000): Invalid H3 resolution value: 18. Resolution must be between 0 (coarsest) and 15 (finest).
Language: English