# Connect Databend Cloud to dbt Core

Local development

Vendor-supported plugin

Some [core functionality](https://github.com/databendcloud/dbt-databend#supported-features) may be limited. If you're interested in contributing, check out the source code repository listed below.

* **Maintained by**: Databend Cloud
* **Authors**: Shanjie Han
* **GitHub repo**: [databendcloud/dbt-databend](https://github.com/databendcloud/dbt-databend) [![](https://img.shields.io/github/stars/databendcloud/dbt-databend?style=for-the-badge)](https://github.com/databendcloud/dbt-databend)
* **PyPI package**: `dbt-databend-cloud` [![](https://badge.fury.io/py/dbt-databend-cloud.svg)](https://badge.fury.io/py/dbt-databend-cloud)
* **Slack channel**:[]()
* **Supported dbt Core version**: v1.0.0 and newer
* **dbt support**: Not Supported
* **Minimum data platform version**: n/a

## Installing dbt-databend-cloud

Use `pip` to install the adapter. Use the following command for installation:

`python -m pip install dbt-databend-cloud`

## Configuring dbt-databend-cloud

For Databend Cloud-specific configuration, please refer to [Databend Cloud configs.](../../../reference/resource-configs/no-configs.md)

## Connecting to Databend Cloud with **dbt-databend-cloud**

### User / Password Authentication

Configure your dbt profile for using Databend Cloud:

#### Databend Cloud connection profile

profiles.yml

```yaml
dbt-databend-cloud:
  target: dev
  outputs:
    dev:
      type: databend
      host: databend-cloud-host
      port: 443
      schema: database_name
      user: username
      pass: password
```

#### Description of Profile Fields

| Option | Description                                        | Required? | Example                     |
| ------ | -------------------------------------------------- | --------- | --------------------------- |
| type   | The specific adapter to use                        | Required  | `databend`                  |
| host   | The host (hostname) to connect to                  | Required  | `yourorg.datafusecloud.com` |
| port   | The port to use                                    | Required  | `443`                       |
| schema | Specify the schema (database) to build models into | Required  | `default`                   |
| user   | The username to use to connect to the host         | Required  | `dbt_admin`                 |
| pass   | The password to use for authenticating to the host | Required  | `awesome_password`          |

## Database User Privileges

Your database user would be able to have some abilities to read or write, such as `SELECT`, `CREATE`, and so on. You can find some help [here](https://docs.databend.com/using-databend-cloud/warehouses/connecting-a-warehouse) with Databend Cloud privileges management.

| Required Privilege     |
| ---------------------- |
| SELECT                 |
| CREATE                 |
| CREATE TEMPORARY TABLE |
| CREATE VIEW            |
| INSERT                 |
| DROP                   |
| SHOW DATABASE          |
| SHOW VIEW              |
| SUPER                  |

## 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)

## Was this page helpful?

YesNo

[Privacy policy](https://www.getdbt.com/cloud/privacy-policy)[Create a GitHub issue](https://github.com/dbt-labs/docs.getdbt.com/issues)

This site is protected by reCAPTCHA and the Google [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms) apply.