---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: hex9
excerpt: |
  DuckDB Community Extensions
  Hex9 hierarchical hexagonal DGGS — point encoding, layer binning, cell geometry as WKB, labels, k-rings, Hamiltonian-curve ordering, and grid enumeration

extension:
  name: hex9
  description: Hex9 hierarchical hexagonal DGGS — point encoding, layer binning, cell geometry as WKB, labels, k-rings, Hamiltonian-curve ordering, and grid enumeration
  version: 2.1.0
  language: C++
  build: cmake
  license: Apache-2.0
  maintainers:
    - MrBenGriffin

repo:
  github: MrBenGriffin/duckdb-hex9
  ref: bf3b954b4d91bc6e2ff834dad494e409e0570ab3

docs:
  hello_world: |
    SELECT h9_encode(-3.19, 55.95) AS cell;
    SELECT h9_label(h9_encode(-3.19, 55.95), 8) AS label;
    SELECT h9_cell(h9_encode(-3.19, 55.95), 8) AS wkb;  -- pair with spatial's ST_GeomFromWKB
    SELECT h9_curve_index(h9_curve(h9_encode(-3.19, 55.95))) AS locality;
  extended_description: |
    Hex9 is an equal-area hierarchical hexagonal DGGS (discrete global grid
    system), backed by [libhex9](https://github.com/MrBenGriffin/libhex9) —
    the same core as its PostGIS extension. Cells are 16-byte UUIDs; every
    full address is reversible, and layer-scoped bins derived from it serve
    as join keys. Vectorized scalar functions (encode/decode/bin, lineage,
    k-rings, labels, Hamiltonian-curve locality ordering with HUGEINT
    indexes) plus table functions (h9_grid, h9_curve_cells, h9_owned_cells).
    Geometry is emitted as WKB, consumed directly by the spatial extension.
    Since libhex9 2.1.0 the encode chain is deterministic: the same lon/lat
    yields the bit-identical uuid on every platform, enforced by in-repo
    universality pin tests.

extension_star_count: 1
extension_star_count_pretty: 1
extension_download_count: 739
extension_download_count_pretty: 739
image: '/images/community_extensions/social_preview/preview_community_extension_hex9.png'
layout: community_extension_doc
---
### Compatibility Matrix

This table covers all DuckDB releases that have not reached [end-of-life](https://duckdb.org/release_calendar), including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.

<div class="extension_compatibility_table"></div>

| Platform | 1.4.4 | 1.4.5 | 1.5.5 | 1.5.6 | 2.0.0 |
| :--- | :---: | :---: | :---: | :---: | :---: |
| Linux AMD64 | ❌ | ❌ | ✅ | ❌ | ❌ |
| Linux ARM64 | ❌ | ❌ | ✅ | ❌ | ❌ |
| macOS AMD64 | ❌ | ❌ | ✅ | ❌ | ❌ |
| macOS ARM64 | ❌ | ❌ | ✅ | ❌ | ❌ |
| Windows AMD64 | ❌ | ❌ | ✅ | ❌ | ❌ |
| Windows ARM64 | ❌ | ❌ | ❌ | ❌ | ❌ |
| WebAssembly | ❌ | ❌ | ✅ | ❌ | ❌ |

### Installing and Loading
```sql
INSTALL {{ page.extension.name }} FROM community;
LOAD {{ page.extension.name }};
```

{% if page.docs.hello_world %}
### Example
```sql
{{ page.docs.hello_world }}```
{% endif %}

{% if page.docs.extended_description %}
### About {{ page.extension.name }}
{{ page.docs.extended_description }}
{% endif %}
### Added Functions

<div class="extension_functions_table"></div>

|    function_name    | function_type | description | comment | examples |
|---------------------|---------------|-------------|---------|----------|
| h9_bin              | scalar        | NULL        | NULL    |          |
| h9_cell             | scalar        | NULL        | NULL    |          |
| h9_cell_ancestor    | scalar        | NULL        | NULL    |          |
| h9_cell_children    | scalar        | NULL        | NULL    |          |
| h9_cell_parent      | scalar        | NULL        | NULL    |          |
| h9_common_ancestor  | scalar        | NULL        | NULL    |          |
| h9_curve            | scalar        | NULL        | NULL    |          |
| h9_curve_bin        | scalar        | NULL        | NULL    |          |
| h9_curve_cells      | table         | NULL        | NULL    |          |
| h9_curve_decode     | scalar        | NULL        | NULL    |          |
| h9_curve_from_label | scalar        | NULL        | NULL    |          |
| h9_curve_index      | scalar        | NULL        | NULL    |          |
| h9_curve_label      | scalar        | NULL        | NULL    |          |
| h9_curve_layer      | scalar        | NULL        | NULL    |          |
| h9_curve_pack       | scalar        | NULL        | NULL    |          |
| h9_decode           | scalar        | NULL        | NULL    |          |
| h9_decode_wkb       | scalar        | NULL        | NULL    |          |
| h9_encode           | scalar        | NULL        | NULL    |          |
| h9_grid             | table         | NULL        | NULL    |          |
| h9_id_from_int      | scalar        | NULL        | NULL    |          |
| h9_id_int           | scalar        | NULL        | NULL    |          |
| h9_is_curve         | scalar        | NULL        | NULL    |          |
| h9_kdisk            | scalar        | NULL        | NULL    |          |
| h9_kring            | scalar        | NULL        | NULL    |          |
| h9_label            | scalar        | NULL        | NULL    |          |
| h9_label_centroid   | scalar        | NULL        | NULL    |          |
| h9_label_key        | scalar        | NULL        | NULL    |          |
| h9_lmax             | scalar        | NULL        | NULL    |          |
| h9_neighbors        | scalar        | NULL        | NULL    |          |
| h9_owned_cells      | table         | NULL        | NULL    |          |
| h9_parse_label      | scalar        | NULL        | NULL    |          |
| h9_version          | scalar        | NULL        | NULL    |          |

### Overloaded Functions

<div class="extension_functions_table"></div>

This extension does not add any function overloads.

### Added Types

<div class="extension_types_table"></div>

This extension does not add any types.

### Added Settings

<div class="extension_settings_table"></div>

This extension does not add any settings.