Mosaic DuckDB Server
A Python-based server that runs a local DuckDB instance and support queries over Web Sockets or HTTP, returning data in either Apache Arrow or JSON format.
Note: This package provides a local DuckDB server. To instead use DuckDB-WASM in the browser, use the wasmConnector in the mosaic-core package.
Installation and usage
We recommend running the server in an isolated environment with uvx. For example, to directly run the server, use:
uvx duckdb-server
Alternatively, you can install the server with pip install duckdb-server. Then you can start the server with duckdb-server.
Developer Setup
We use uv to manage our development setup.
Start the server with uv run duckdb-server. The server will not restart when the code changes.
Start the server in development with pnpm dev. The server restarts when you change the code.
Run uv run ruff check --fix and uv run ruff format to lint the code.
To run the tests, use uv run pytest.
To set up a local certificate for SSL, use https://github.com/FiloSottile/mkcert.
API
The server supports queries via HTTP GET and POST, and WebSockets. The GET endpoint is useful for debugging. For example, you can query it with this url.
Each endpoint takes a JSON object with a command in the type. The server supports the following commands.
exec
Executes the SQL query in the sql field.
arrow
Executes the SQL query in the sql field and returns the result in Apache Arrow format.
json
Executes the SQL query in the sql field and returns the result in JSON format.
Publishing
Run the build with uv build. Then publish with uvx twine upload --skip-existing ../../dist/*. We publish using tokens so when asked, set the username to __token__ and then use your token as the password. Alternatively, create a .pypirc file.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file duckdb_server-0.30.0.tar.gz.
File metadata
- Download URL: duckdb_server-0.30.0.tar.gz
- Upload date:
- Size: 13.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dcd1b877d50ef790cd241295dcba67a1399b7868d8d9dbb76ccfb2fcf4c91c23
|
|
| MD5 |
1b17cd41398777c7806fdbc52298845a
|
|
| BLAKE2b-256 |
051fe9816182615e64ca383e88670021eeab58ddcdf8abc7ad57d6b58cc700ba
|
Provenance
The following attestation bundles were made for duckdb_server-0.30.0.tar.gz:
Publisher:
release.yml on uwdata/mosaic
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
duckdb_server-0.30.0.tar.gz -
Subject digest:
dcd1b877d50ef790cd241295dcba67a1399b7868d8d9dbb76ccfb2fcf4c91c23 - Sigstore transparency entry: 2400026626
- Sigstore integration time:
-
Permalink:
uwdata/mosaic@73a7c742e48f38b48ba2b8a379f902c7be49c293 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/uwdata
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@73a7c742e48f38b48ba2b8a379f902c7be49c293 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file duckdb_server-0.30.0-py3-none-any.whl.
File metadata
- Download URL: duckdb_server-0.30.0-py3-none-any.whl
- Upload date:
- Size: 5.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
833001ddd492a204d214cd340c4a2222ed84b41472d40fc6cdae45b42b67fbb5
|
|
| MD5 |
7a2490459ec476ea83b94d480e2f4ae8
|
|
| BLAKE2b-256 |
86bd4dc1a33faaf240160083bec315150ef4a848a6b4aea74733e7b1e8a35ab8
|
Provenance
The following attestation bundles were made for duckdb_server-0.30.0-py3-none-any.whl:
Publisher:
release.yml on uwdata/mosaic
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
duckdb_server-0.30.0-py3-none-any.whl -
Subject digest:
833001ddd492a204d214cd340c4a2222ed84b41472d40fc6cdae45b42b67fbb5 - Sigstore transparency entry: 2400026775
- Sigstore integration time:
-
Permalink:
uwdata/mosaic@73a7c742e48f38b48ba2b8a379f902c7be49c293 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/uwdata
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@73a7c742e48f38b48ba2b8a379f902c7be49c293 -
Trigger Event:
workflow_dispatch
-
Statement type:
