Skip to content

docs: install the DuckDB extension from the community repository #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Adeniyikayodee merged 1 commit into from
Oct 14, 2026
Merged

docs: install the DuckDB extension from the community repository #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ A postcode has 11 characters in five segments, written `EK-01-A03-FK-01`: state,
| `ng-postcode-mcp` (npm) | The same server for Node, without address resolution | `npx ng-postcode-mcp` | [`js/packages/ng-postcode-mcp`](js/packages/ng-postcode-mcp) |
| `ng-postcode-polars` | Polars expressions that parse, format and group codes by place, compiled from the Rust core | `pip install ng-postcode-polars` | [`native/polars`](native/polars) |
| `ng_postcode` (PostgreSQL) | The postcode as native 8-byte types with index support, compiled from the Rust core | Package from [Releases](https://github.com/Adeniyikayodee/ng-postcode/releases), then `CREATE EXTENSION ng_postcode` | [`native/pg`](native/pg) |
| `ng_postcode` (DuckDB) | The same functions as a DuckDB extension, compiled from the Rust core | Build from [ng-postcode-duckdb](https://github.com/Adeniyikayodee/ng-postcode-duckdb) | [ng-postcode-duckdb](https://github.com/Adeniyikayodee/ng-postcode-duckdb) |
| `ng_postcode` (DuckDB) | The same functions as a DuckDB extension, compiled from the Rust core | `INSTALL ng_postcode FROM community` | [ng-postcode-duckdb](https://github.com/Adeniyikayodee/ng-postcode-duckdb) |
| `ng-address-resolver` | Resolve free-text addresses to postcodes, only as precisely as the evidence allows (pre-alpha) | `pip install ng-address-resolver` | [`agent/`](agent) |

Each package has its own README with full usage.
Expand Down Expand Up @@ -130,7 +130,7 @@ SELECT ng_postcode_parse('ek 01 a03 fk 01');
-- EK01A03FK01
```

[ng-postcode-duckdb](https://github.com/Adeniyikayodee/ng-postcode-duckdb) provides them as a compiled extension.
The compiled extension, [ng-postcode-duckdb](https://github.com/Adeniyikayodee/ng-postcode-duckdb), has the same functions: run `INSTALL ng_postcode FROM community`, then `LOAD ng_postcode`.

**Polars**

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Open-source tools for Nigeria's National Digital Alphanumeric Postcode System (N
| [`ng-postcode-mcp`](https://pypi.org/project/ng-postcode-mcp/) | `uvx ng-postcode-mcp` or `npx ng-postcode-mcp` | Give an AI assistant postcode tools |
| [`ng-postcode-polars`](https://pypi.org/project/ng-postcode-polars/) | `pip install ng-postcode-polars` | Parse, check and group a Polars column of codes |
| [`ng_postcode` for PostgreSQL](https://github.com/Adeniyikayodee/ng-postcode/tree/main/native/pg) | Package from [Releases](https://github.com/Adeniyikayodee/ng-postcode/releases), then `CREATE EXTENSION ng_postcode` | Store codes as a native 8-byte type with index support |
| [`ng_postcode` for DuckDB](https://github.com/Adeniyikayodee/ng-postcode-duckdb) | Build from the repository | Parse, format and group codes in DuckDB |
| [`ng_postcode` for DuckDB](https://github.com/Adeniyikayodee/ng-postcode-duckdb) | `INSTALL ng_postcode FROM community` | Parse, format and group codes in DuckDB |
| [SQL files](https://github.com/Adeniyikayodee/ng-postcode/tree/main/sql) | Run one file in PostgreSQL or DuckDB | The same functions where no extension can be installed |
| [`ng-address-resolver`](https://pypi.org/project/ng-address-resolver/) | `pip install ng-address-resolver` | Turn a described address into a postcode (pre-release) |

Expand Down
4 changes: 2 additions & 2 deletions docs/llms-full.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ A postcode has 11 characters in five segments, written `EK-01-A03-FK-01`: state,
| `ng-postcode-mcp` (npm) | The same server for Node, without address resolution | `npx ng-postcode-mcp` | [`js/packages/ng-postcode-mcp`](js/packages/ng-postcode-mcp) |
| `ng-postcode-polars` | Polars expressions that parse, format and group codes by place, compiled from the Rust core | `pip install ng-postcode-polars` | [`native/polars`](native/polars) |
| `ng_postcode` (PostgreSQL) | The postcode as native 8-byte types with index support, compiled from the Rust core | Package from [Releases](https://github.com/Adeniyikayodee/ng-postcode/releases), then `CREATE EXTENSION ng_postcode` | [`native/pg`](native/pg) |
| `ng_postcode` (DuckDB) | The same functions as a DuckDB extension, compiled from the Rust core | Build from [ng-postcode-duckdb](https://github.com/Adeniyikayodee/ng-postcode-duckdb) | [ng-postcode-duckdb](https://github.com/Adeniyikayodee/ng-postcode-duckdb) |
| `ng_postcode` (DuckDB) | The same functions as a DuckDB extension, compiled from the Rust core | `INSTALL ng_postcode FROM community` | [ng-postcode-duckdb](https://github.com/Adeniyikayodee/ng-postcode-duckdb) |
| `ng-address-resolver` | Resolve free-text addresses to postcodes, only as precisely as the evidence allows (pre-alpha) | `pip install ng-address-resolver` | [`agent/`](agent) |

Each package has its own README with full usage.
Expand Down Expand Up @@ -185,7 +185,7 @@ SELECT ng_postcode_parse('ek 01 a03 fk 01');
-- EK01A03FK01
```

[ng-postcode-duckdb](https://github.com/Adeniyikayodee/ng-postcode-duckdb) provides them as a compiled extension.
The compiled extension, [ng-postcode-duckdb](https://github.com/Adeniyikayodee/ng-postcode-duckdb), has the same functions: run `INSTALL ng_postcode FROM community`, then `LOAD ng_postcode`.

**Polars**

Expand Down
Loading