https://github.com/databendcloud/dbt-databend
dbt-databend adapter plugin
https://github.com/databendcloud/dbt-databend
Last synced: 4 months ago
JSON representation
dbt-databend adapter plugin
- Host: GitHub
- URL: https://github.com/databendcloud/dbt-databend
- Owner: databendcloud
- License: apache-2.0
- Created: 2022-11-24T06:55:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-30T09:01:05.000Z (about 2 years ago)
- Last Synced: 2026-01-08T17:12:13.472Z (5 months ago)
- Language: Python
- Size: 103 KB
- Stars: 10
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# dbt-databend-cloud
The `dbt-databend-cloud` package contains all of the code enabling [dbt](https://getdbt.com) to work with
[Databend Cloud](https://databend.rs/doc/cloud/).
## Table of Contents
* [Installation](#installation)
* [Supported features](#supported-features)
* [Profile Configuration](#profile-configuration)
* [Database User Privileges](#database-user-privileges)
* [Running Tests](#running-tests)
* [Example](#example)
* [Contributing](#contributing)
## Installation
Compile by source code.
```bash
$ git clone https://github.com/databendcloud/dbt-databend.git
$ cd dbt-databend
$ pip install .
```
Also, you can get it from pypi.
```bash
$ pip install dbt-databend-cloud
```
## Supported features
| ok | Feature |
|:--:|:---------------------------:|
| ✅ | Table materialization |
| ✅ | View materialization |
| ✅ | Incremental materialization |
| ❌ | Ephemeral materialization |
| ✅ | Seeds |
| ✅ | Sources |
| ✅ | Custom data tests |
| ✅ | Docs generate |
| ✅ | Snapshots |
| ✅ | Connection retry |
Note:
* Databend does not support `Ephemeral` and `SnapShot`. You can find more detail [here](https://github.com/datafuselabs/databend/issues/8685)
## Profile Configuration
Databend Cloud targets should be set up using the following configuration in your `profiles.yml` file.
**Example entry for profiles.yml:**
```
Your_Profile_Name:
target: dev
outputs:
dev:
type: databend
host: [host]
port: [port]
schema: [schema(Your database)]
user: [username]
pass: [password]
secure: [SSL]
```
| Option | Description | Required? | Example |
|--------|------------------------------------------------------|-----------|--------------------------------|
| type | The specific adapter to use | Required | `databend` |
| host | The server (hostname) to connect to | Required | `yourorg.databend.com` |
| port | The port to use | Required | `443` |
| schema | Specify the schema (database) to build models into | Required | `analytics` |
| user | The username to use to connect to the server | Required | `dbt_admin` |
| pass | The password to use for authenticating to the server | Required | `correct-horse-battery-staple` |
| secure | The SSL of host (default as True) | Optional | `True` |
Note:
* You can find your host, user, pass information in this [docs](https://docs.databend.com/using-databend-cloud/warehouses/connecting-a-warehouse)
## Running Tests
See [tests/README.md](tests/README.md) for details on running the integration tests.
## Example
Click [here](https://github.com/databendcloud/dbt-databend/wiki/How-to-use-dbt-with-Databend-Cloud) to see a simple example about using dbt with dbt-databend-cloud.
## Contributing
Welcome to contribute for dbt-databend-cloud. See [Contributing Guide](CONTRIBUTING.md) for more information.