Skip to content

Commit b1c3769

Browse files
committed
lake: publish dbt integration docs
1 parent dd3daa5 commit b1c3769

2 files changed

Lines changed: 16 additions & 12 deletions

File tree

TOC-tidb-cloud-lake.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@
6464
- [Load from Bucket](/tidb-cloud-lake/guides/load-from-bucket.md)
6565
- [Load from Local File](/tidb-cloud-lake/guides/load-from-local-file.md)
6666
- [Load from Remote File](/tidb-cloud-lake/guides/load-from-remote-file.md)
67+
- Load with Platforms
68+
- [Load with dbt](/tidb-cloud-lake/guides/load-with-dbt.md)
6769
- Load Semi-structured Data
6870
- [Overview](/tidb-cloud-lake/guides/load-semi-structured-data.md)
6971
- [Load Parquet](/tidb-cloud-lake/guides/load-parquet.md)

tidb-cloud-lake/guides/load-with-dbt.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ summary: dbt is a transformation workflow that helps you get more work done whil
77

88
[dbt](https://www.getdbt.com/) is a transformation workflow that helps you get more work done while producing higher quality results. You can use dbt to modularize and centralize your analytics code, while also providing your data team with guardrails typically found in software engineering workflows. Collaborate on data models, version them, and test and document your queries before safely deploying them to production, with monitoring and visibility.
99

10-
[dbt-databend-cloud](https://github.com/databendcloud/dbt-databend) is a plugin developed by {{{ .lake }}} with the primary goal of enabling smooth integration between dbt and {{{ .lake }}}. By utilizing this plugin, you can seamlessly perform data modeling, transformation, and cleansing tasks using dbt and conveniently load the output into {{{ .lake }}}. The table below illustrates the level of support that the dbt-databend-cloud plugin offers for commonly used features in dbt:
10+
[tidbcloudlake-dbt](https://github.com/tidbcloud/lake-dbt) is a plugin developed by {{{ .lake }}} with the primary goal of enabling smooth integration between dbt and {{{ .lake }}}. By utilizing this plugin, you can seamlessly perform data modeling, transformation, and cleansing tasks using dbt and conveniently load the output into {{{ .lake }}}. The table below illustrates the level of support that the tidbcloudlake-dbt plugin offers for commonly used features in dbt:
1111

1212
| Feature | Supported ? |
1313
|----------------------------- |----------- |
@@ -19,36 +19,38 @@ summary: dbt is a transformation workflow that helps you get more work done whil
1919
| Sources | Yes |
2020
| Custom Data Tests | Yes |
2121
| Docs Generate | Yes |
22-
| Snapshots | No |
22+
| Snapshots | Yes |
2323
| Connection Retry | Yes |
2424

25-
## Installing dbt-databend-cloud
25+
## Installing tidbcloudlake-dbt
2626

27-
Installing the dbt-databend-cloud plugin has been streamlined for your convenience, as it now includes dbt as a required dependency. To effortlessly set up both dbt and the dbt-databend-cloud plugin, run the following command:
27+
Installing the tidbcloudlake-dbt plugin has been streamlined for your convenience, as it now includes dbt as a required dependency. To effortlessly set up both dbt and the tidbcloudlake-dbt plugin, run the following command:
2828

2929
```shell
30-
pip3 install dbt-databend-cloud
30+
pip3 install tidbcloudlake-dbt
3131
```
3232

3333
However, if you prefer to install dbt separately, you can refer to the official dbt installation guide for detailed instructions.
3434

3535
## Tutorial: Run dbt Project jaffle_shop
3636

37-
If you're new to dbt, {{{ .lake }}} recommends completing the official dbt tutorial available at <https://github.com/dbt-labs/jaffle_shop>. Before you start, follow [Installing dbt-databend-cloud](#installing-dbt-databend-cloud) to install dbt and dbt-databend-cloud.
37+
If you're new to dbt, {{{ .lake }}} recommends completing the official dbt tutorial available at <https://github.com/dbt-labs/jaffle_shop>. Before you start, follow [Installing tidbcloudlake-dbt](#installing-tidbcloudlake-dbt) to install dbt and tidbcloudlake-dbt.
3838

3939
This tutorial provides a sample dbt project called "jaffle_shop," offering hands-on experience with the dbt tool. By configuring the default global profile (~/.dbt/profiles.yml) with the necessary information to connect to your {{{ .lake }}} instance, the project will generate tables and views defined in the dbt models directly in your {{{ .lake }}} database. Here's an example of the file profiles.yml that connects to a {{{ .lake }}} instance:
4040

4141
```yml title="~/.dbt/profiles.yml"
42-
jaffle_shop_databend:
42+
jaffle_shop_lake:
4343
target: dev
4444
outputs:
4545
dev:
46-
type: databend
47-
host: 127.0.0.1
48-
port: 8000
46+
type: tidbcloudlake
47+
host: tnxxxx.gw.aws-us-east-2.default.tidbcloud.com
48+
port: 443
4949
schema: sjh_dbt
50-
user: databend
50+
user: <username>
5151
pass: ********
52+
warehouse: default
53+
secure: true
5254
```
5355
54-
If you're using {{{ .lake }}}, you can refer to this [Wiki page](https://github.com/databendcloud/dbt-databend/wiki/How-to-use-dbt-with-Databend-Cloud) for step-by-step instructions on how to run the jaffle_shop dbt project.
56+
For more information about configuring and using the adapter, see the [lake-dbt repository](https://github.com/tidbcloud/lake-dbt).

0 commit comments

Comments
 (0)