Skip to main content

The duckdb adpter plugin for dbt (data build tool)

Project description

dbt-duckdb

Installation

This project is hosted on PyPI, so you should be able to install it and the necessary dependencies via:

pip3 install dbt-duckdb

The latest supported version targets dbt-core 1.0.0 and duckdb 0.3.1.

Configuring your profile

DuckDB is an embedded database, similar to SQLite, but designed for OLAP-style analytics instead of OLTP. The only configuration parameter that is required in your profile (in addition to type: duckdb) is the path field, which should refer to a path on your local filesystem where you would like the DuckDB database file (and it's associated write-ahead log) to be written. You can also specify the schema parameter if you would like to use a schema besides the default (which is called main).

There is also a database field defined in the DuckDBCredentials class for consistency with the parent Credentials class, but it defaults to main and setting it to be something else will likely cause strange things to happen that I cannot fully predict, so, ya know, don't do that.

Developer Workflow

If you find that you need to add a feature to DuckDB in order to implement some functionality in dbt-duckdb, here is the workflow you can use for doing local development. First, you need to clone and build DuckDB from source:

$ git clone https://github.com/cwida/duckdb.git
$ cd duckdb
$ pip3 install -e tools/pythonpkg

in order to do a local install off of the main branch, and then run:

$ git clone https://github.com/jwills/dbt-duckdb.git
$ cd dbt-duckdb
$ pip3 install .

to install dbt-duckdb, at which point you will be able to run:

$ pip3 install pytest-dbt-adapter
$ pytest test/duckdb.dbtspec

to exercise the dbt-adapter-tests locally against your build of DuckDB (note that you also need to update setup.py in this directory to ensure that you are using your local version of duckdb, and not the released duckdb version 0.3.1)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dbt-duckdb-1.0.1.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

dbt_duckdb-1.0.1-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file dbt-duckdb-1.0.1.tar.gz.

File metadata

  • Download URL: dbt-duckdb-1.0.1.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/3.7.0 pkginfo/1.8.2 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.0

File hashes

Hashes for dbt-duckdb-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b1008846727bba6a39996b4a16a2a241b0c729e2fe31572faac57c0d8a25b567
MD5 a4ef8a3dcd9288bdb4732c671a65486a
BLAKE2b-256 394e97be69f43db5b13541c6db0d3a6a4e72dbfa9ed8295e3ceed919a4afe807

See more details on using hashes here.

File details

Details for the file dbt_duckdb-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: dbt_duckdb-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/3.7.0 pkginfo/1.8.2 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.0

File hashes

Hashes for dbt_duckdb-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 457cd1daba85b6f031ce2fc7091c5a678aaf16197b35647ffdcb0fc7d370f5fa
MD5 3e2bf4758b73fe93911e648dcb09759d
BLAKE2b-256 b545313da253c8595dbff9ec1418f56e9dd37f36843c97609f5e13f86140b526

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page