Skip to content

zachasme/h3-pg

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
h3
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

h3-pg: Uber's H3 Hexagonal Hierarchical Geospatial Indexing System in PostgreSQL

test-linux test-macos test-windows License

This library provides PostgreSQL bindings for the H3 Core Library. For API reference, please see the H3 Documentation.

Developed in collaboration with Scandinavian Highlands.

Prerequisites

  • PostgreSQL 11+ (including server headers). It might work with earlier versions, we have not tested them.
  • C compiler (e.g., gcc)
  • CMake
  • GNU Make

Quick Overview

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.

Usage

🎉 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.

Building

# 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

Contributing

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.

See Development.

License

This project is released under the Apache 2.0 License.

About

PostgreSQL bindings for H3, a hierarchical hexagonal geospatial indexing system

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published