https://github.com/vortex-data/duckdb-vortex
DuckDB extension allowing reading/writing of vortex files
https://github.com/vortex-data/duckdb-vortex
Last synced: 6 months ago
JSON representation
DuckDB extension allowing reading/writing of vortex files
- Host: GitHub
- URL: https://github.com/vortex-data/duckdb-vortex
- Owner: vortex-data
- License: mit
- Created: 2025-04-17T10:30:34.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-08-05T13:43:31.000Z (6 months ago)
- Last Synced: 2025-08-05T15:31:31.421Z (6 months ago)
- Language: Shell
- Size: 68.4 KB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VortexDuckdb
This repository is based on https://github.com/duckdb/extension-template, check it out if you want to build and ship
your own DuckDB extension.
---
This extension, VortexDuckdb, allow you to ... .
## Building
### Install required system dependencies
#### MacOS
```shell
brew install pkg-config
```
### Managing dependencies
DuckDB extensions uses VCPKG for dependency management. Enabling VCPKG is very simple: follow
the [installation instructions](https://vcpkg.io/en/getting-started) or just run the following:
```shell
git clone https://github.com/Microsoft/vcpkg.git
./vcpkg/bootstrap-vcpkg.sh
export VCPKG_TOOLCHAIN_PATH=`pwd`/vcpkg/scripts/buildsystems/vcpkg.cmake
```
Note: VCPKG is only required for extensions that want to rely on it for dependency management. If you want to develop an
extension without dependencies, or want to do your own dependency management, just skip this step. Note that the example
extension uses VCPKG to build with a dependency for instructive purposes, so when skipping this step the build may not
work without removing the dependency.
### Build steps
Now to build the extension, run:
```sh
make
```
The main binaries that will be built are:
```sh
./build/release/duckdb
./build/release/test/unittest
./build/release/extension/vortex_duckdb/vortex_duckdb.duckdb_extension
```
- `duckdb` is the binary for the duckdb shell with the extension code automatically loaded.
- `unittest` is the test runner of duckdb. Again, the extension is already linked into the binary.
- `vortex_duckdb.duckdb_extension` is the loadable binary as it would be distributed.
## Running the extension
To run the extension code, simply start the shell with `./build/release/duckdb`.
### Writing a file
To write a table to a vortex file use `COPY .. TO '...' (FORMAT VORTEX)`:
```sql
COPY (SELECT * from generate_series(0, 4)) TO 'FILENAME.vortex' (FORMAT VORTEX);
```
This will create a compressed vortex file from the sql table.
### Reading a file
To read a table from a vortex file:
```sql
select * from read_vortex('FILENAME.vortex');
```
This command also supports glob syntax e.g. `read_vortex('FILE_WITH_GLOB*.vortex')`.
## Running the tests
Different tests can be created for DuckDB extensions. The primary way of testing DuckDB extensions should be the SQL
tests in `./test/sql`. These SQL tests can be run using:
```sh
make test
```
### Installing the deployed binaries
To install your extension binaries from S3, you will need to do two things. Firstly, DuckDB should be launched with the
`allow_unsigned_extensions` option set to true. How to set this will depend on the client you're using. Some examples:
CLI:
```shell
duckdb -unsigned
```
Python:
```python
con = duckdb.connect(':memory:', config={'allow_unsigned_extensions': 'true'})
```
NodeJS:
```js
db = new duckdb.Database(':memory:', {"allow_unsigned_extensions": "true"});
```
Secondly, you will need to set the repository endpoint in DuckDB to the HTTP url of your bucket + version of the
extension
you want to install. To do this run the following SQL query in DuckDB:
```sql
SET
custom_extension_repository='bucket.s3.eu-west-1.amazonaws.com//latest';
```
Note that the `/latest` path will allow you to install the latest extension version available for your current version
of
DuckDB. To specify a specific version, you can pass the version instead.
After running these steps, you can install and load your extension using the regular INSTALL/LOAD commands in DuckDB:
```sql
INSTALL
vortex_duckdb
LOAD vortex_duckdb
```