h3-pg: Uber's H3 Hexagonal Hierarchical Geospatial Indexing System in PostgreSQL
Developed in collaboration with Scandinavian Highlands.
- PostgreSQL 11+ (including server headers). It might work with earlier versions, we have not tested them.
- C compiler (e.g.,
- GNU Make
If the prerequisites are met you can use the PGXN Client to download, build, and install, e.g.:
$ pgxn install h3 $ pgxn load h3 $ psql =# SELECT h3_lat_lng_to_cell(POINT('37.3615593,-122.0553238'), 5); h3_lat_lng_to_cell ----------------- 85e35e73fffffff (1 row)
(You can install a specific version using
pgxn install 'h3=3.7.2' and
pgxn load 'h3=3.7.2' for example)
See Advanced Install for other installation methods.
🎉Note: The following usage docs apply to H3 v4, which was released on August 23, 2022.
Generally, all functions have been renamed from camelCase in H3 to snake_case in SQL.
See API reference for all provided functions.
# Generate native build system cmake -B build -DCMAKE_BUILD_TYPE=Release # Build extension(s) cmake --build build # Install extensions (might require sudo) cmake --install build --component h3-pg
Pull requests and GitHub issues are welcome. Please include tests for new work. Please note that the purpose of this extension is to expose the API of the H3 Core library, so we will rarely accept new features that are not part of that API. New proposed feature work is more appropriate in the core C library or in a new extension that depends on h3-pg.
This project is released under the Apache 2.0 License.