https://github.com/query-farm/airport
The Airport extension for DuckDB, enables the use of Arrow Flight with DuckDB
https://github.com/query-farm/airport
arrow arrow-flight duckdb duckdb-extension
Last synced: 8 months ago
JSON representation
The Airport extension for DuckDB, enables the use of Arrow Flight with DuckDB
- Host: GitHub
- URL: https://github.com/query-farm/airport
- Owner: Query-farm
- License: mit
- Created: 2024-07-06T15:04:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-08-22T01:11:43.000Z (8 months ago)
- Last Synced: 2025-08-30T00:53:28.702Z (8 months ago)
- Topics: arrow, arrow-flight, duckdb, duckdb-extension
- Language: C++
- Homepage: https://airport.query.farm
- Size: 1.24 MB
- Stars: 293
- Watchers: 8
- Forks: 16
- Open Issues: 7
-
Metadata Files:
- Readme: docs/README.md
- License: LICENSE
Awesome Lists containing this project
README
# Airport Extension for DuckDB
The **Airport** extension brings [Arrow Flight](https://arrow.apache.org/docs/format/Flight.html) support to [DuckDB](https://duckdb.org), enabling DuckDB to query, modify, and store data via Arrow Flight servers. A DuckDB extension is a plugin that expands DuckDB's core functionality by adding new capabilities.
To understand the rationale behind the development of this extension, check out the [motivation for creating the extension](https://airport.query.farm/motivation.html).
# Documentation
Visit the [documentation for this extension](https://airport.query.farm).
# Building the extension
```sh
# Clone this repo with submodules.
# duckdb and extension-ci-tools are submodules.
git clone --recursive git@github.com:Query-farm/duckdb-airport-extension
# Clone the vcpkg repo
git clone https://github.com/Microsoft/vcpkg.git
# Bootstrap vcpkg
./vcpkg/bootstrap-vcpkg.sh
export VCPKG_TOOLCHAIN_PATH=`pwd`/vcpkg/scripts/buildsystems/vcpkg.cmake
# Build the extension
make
# If you have ninja installed, you can use it to speed up the build
# GEN=ninja make
```
The main binaries that will be built are:
```sh
./build/release/duckdb
./build/release/test/unittest
./build/release/extension/airport/airport.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.
- `airport.duckdb_extension` is the loadable binary as it would be distributed.
## Building on MacOS
If you have difficulties building with the clang provided by the Xcode Command Line Tools, you may want to try installing llvm and using the included clang. Also, some of the dependencies built by `vcpkg` require GNU bison to be installed:
```sh
brew install bison cmake llvm
export CXX=/opt/homebrew/opt/llvm/bin/clang++
```
If you are building against the `main` branch of DuckDB you need to be aware that. Airport now relies on the `httpfs` extension for HTTPS support. Although it builds `httpfs`, it doesn’t link it automatically. As a result, during development, you’ll need to manually copy the built `httpfs` extension into your local DuckDB extension directory—usually `~/.duckdb/extensions/`.
The following script will copy the necessary extensions to the correct location:
```sh
#!/bin/sh
platform=$(duckdb -noheader -csv -c "pragma platform")
snapshot=$(basename ./build/debug/repository/*)
mkdir -p ~/.duckdb/extensions/$snapshot/$platform/
cp -r ./build/debug/repository/$snapshot ~/.duckdb/extensions/$snapshot
```
## Running the extension
To run the extension code, simply start the shell with `./build/release/duckdb`. This duckdb shell will have the extension pre-loaded.
Now we can use the features from the extension directly in DuckDB.
## 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
```