Skip to content

Commit 00bd7be

Browse files
docs: install the DuckDB extension from the community repository
1 parent 5538cae commit 00bd7be

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A postcode has 11 characters in five segments, written `EK-01-A03-FK-01`: state,
2323
| `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) |
2424
| `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) |
2525
| `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) |
26-
| `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) |
26+
| `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) |
2727
| `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) |
2828

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

133-
[ng-postcode-duckdb](https://github.com/Adeniyikayodee/ng-postcode-duckdb) provides them as a compiled extension.
133+
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`.
134134

135135
**Polars**
136136

‎docs/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Open-source tools for Nigeria's National Digital Alphanumeric Postcode System (N
1515
| [`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 |
1616
| [`ng-postcode-polars`](https://pypi.org/project/ng-postcode-polars/) | `pip install ng-postcode-polars` | Parse, check and group a Polars column of codes |
1717
| [`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 |
18-
| [`ng_postcode` for DuckDB](https://github.com/Adeniyikayodee/ng-postcode-duckdb) | Build from the repository | Parse, format and group codes in DuckDB |
18+
| [`ng_postcode` for DuckDB](https://github.com/Adeniyikayodee/ng-postcode-duckdb) | `INSTALL ng_postcode FROM community` | Parse, format and group codes in DuckDB |
1919
| [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 |
2020
| [`ng-address-resolver`](https://pypi.org/project/ng-address-resolver/) | `pip install ng-address-resolver` | Turn a described address into a postcode (pre-release) |
2121

‎docs/llms-full.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ A postcode has 11 characters in five segments, written `EK-01-A03-FK-01`: state,
7878
| `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) |
7979
| `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) |
8080
| `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) |
81-
| `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) |
81+
| `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) |
8282
| `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) |
8383

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

188-
[ng-postcode-duckdb](https://github.com/Adeniyikayodee/ng-postcode-duckdb) provides them as a compiled extension.
188+
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`.
189189

190190
**Polars**
191191

0 commit comments

Comments
 (0)