a pipe for quackheads

:baby_chick: quackpipe

QuackPipe is a serverless OLAP API built on top of DuckDB emulating and aliasing the ClickHouse HTTP API

Play with DuckDB SQL and Cloud storage though a familiar API, without giving up old habits and integrations.

:hatched_chick: Demos

:hatched_chick: try a sample s3/parquet query in our miniature playground (fly.io free tier, 1x-shared-vcpu, 256Mb)
:hatched_chick: launch your own free instance on fly.io

:seedling: Get Started

Download a binary release, use docker or build from source

🐋 Using Docker

docker pull ghcr.io/metrico/quackpipe:latest
docker run -ti --rm -p 8123:8123 ghcr.io/metrico/quackpipe:latest

📦 Download Binary

curl -fsSL github.com/metrico/quackpipe/releases/latest/download/quackpipe-amd64 --output quackpipe \
&& chmod +x quackpipe

🔌 Start Server w/ parameters

./quackpipe --port 8123

🔌 Start Server w/ file database, READ-ONLY access

./quackpipe --port 8123 --params "/tmp/test.db?access_mode=READ_ONLY"

Run with -h for a full list of parameters

Parameters

:point_right: Playground

Execute queries using the embedded playground

:point_right: API

Execute queries using the POST API

curl -X POST https://quackpipe.fly.dev 
   -H "Content-Type: application/json"
   -d 'SELECT version()'  

:point_right: STDIN

Execute queries using STDIN

# echo "SELECT 'hello', version() as version FORMAT CSV" | ./quackpipe --stdin
hello,v0.7.1

:fist_right: Extensions

Several extensions are pre-installed by default in Docker images, including parquet, json, httpfs
When using HTTP API, httpfs, parquet, json extensions are automatically pre-loaded by the wrapper.

Users can pre-install extensions and execute quackpipe using a custom parameters:

echo "INSTALL httpfs;" | ./quackpipe --stdin --params "?extension_directory=/tmp/"
./quackpipe --port 8123 --host 0.0.0.0 --params "?extension_directory=/tmp/"

ClickHouse UDF

Quackpipe can be used as executable UDF to get DuckDB data IN/OUT of ClickHouse queries:

SELECT *
FROM executable('quackpipe -stdin -format TSV', TSV, 'id UInt32, num UInt32', (
    SELECT 'SELECT 1, 2'
))
Query id: dd878948-bec8-4abe-9e06-2f5813653c3a
┌─id─┬─num─┐
│  1 │   2 │
└────┴─────┘
1 rows in set. Elapsed: 0.155 sec.

🃏 What is this? Think of it as a SELECT within a SELECT with a different syntax.
🃏 Format confusion? Make DuckDB SQL feel like ClickHouse with the included ClickHouse Macro Aliases

:construction: Feature Status

• [x] DuckDB Core [^1]
  • [x] cgo binding
  • [x] Extension preloading
  • [ ] Aliases Extension
• [x] REST API [^3]
  • [x] CH FORMAT Emulation
    • [x] CSV, CSVWithNames
    • [x] TSV, TSVWithNames
    • [x] JSONCompact
    • [ ] Native
  • [x] Web Playground (from ClickkHouse, Apache2 Licensed) [^2]
• [x] STDIN Fast Query Execution
• [x] ClickHouse Executable UDF
• [x] :memory: mode Cloud Storage (s3/r2/minio, httpfs, etc)
• [x] :file: mode using optional parameters

Contributors

Community

:black_joker: Disclaimers

[^1]: DuckDB ® is a trademark of DuckDB Foundation. All rights reserved by their respective owners. [^2]: ClickHouse ® is a trademark of ClickHouse Inc. No direct affiliation or endorsement. [^3]: Released under the MIT license. See LICENSE for details. All rights reserved by their respective owners.