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.1 and duckdb 0.3.2.

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/duckdb/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.2)

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.1.0.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

dbt_duckdb-1.1.0-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dbt-duckdb-1.1.0.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.10

File hashes

Hashes for dbt-duckdb-1.1.0.tar.gz
Algorithm Hash digest
SHA256 fc6c7c3158528760af9ce2211b6bb92b1ae0d2721769aff2a2c676ba8889578f
MD5 a827868308791af1ef45c24cdca8895e
BLAKE2b-256 04f5df4fb7c20b78a6d843e8f8eab2d1a3cb344cd00240cc960e25487c9aced4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dbt_duckdb-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.10

File hashes

Hashes for dbt_duckdb-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ecc2eb9134e5cd5ae66b6453f213efd05c33870963bc2c8acae87a6837cea991
MD5 14f1e53a4a130aa27459c75a5464004e
BLAKE2b-256 6fbf8661d12c81487fae363639e42988428c9864f5ea35deb99e6545c2c816ee

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