tidbcloudlake-dbt
The tidbcloudlake-dbt package contains all of the code enabling dbt to work with
TiDB Cloud Lake. It talks to the server through
tidbcloudlake-driver.
Table of Contents
Installation
From PyPI:
$ pip install tidbcloudlake-dbt
Or from source:
$ git clone https://github.com/tidbcloud/lake-dbt.git
$ cd lake-dbt
$ pip install .
Supported features
| ok | Feature |
|---|---|
| ✅ | Table materialization |
| ✅ | View materialization |
| ✅ | Incremental materialization |
| ❌ | Ephemeral materialization |
| ✅ | Seeds |
| ✅ | Sources |
| ✅ | Custom data tests |
| ✅ | Docs generate |
| ✅ | Snapshots |
| ✅ | Connection retry |
Note:
Ephemeralmaterialization is not supported.- In
dbt docs generate, views have no owner -- the server records one when a table is created but not when a view is.
Profile Configuration
TiDB Cloud Lake 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: tidbcloudlake
host: [host]
port: [port]
schema: [schema(Your database)]
user: [username]
pass: [password]
warehouse: [warehouse]
secure: [SSL]
| Option | Description | Required? | Example |
|---|---|---|---|
| type | The specific adapter to use | Required | tidbcloudlake |
| host | The server (hostname) to connect to | Required | tnxxxx.gw.aws-us-east-2.default.tidbcloud.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 |
| warehouse | The warehouse to run queries in | Optional | default |
| secure | Whether to connect over TLS (default as True) | Optional | True |
These options are assembled into a lakesql DSN of the form
lake://user:pass@host:port/schema?sslmode=require. See the
DSN reference for the full list of
supported arguments.
Running Tests
See tests/README.md for details on running the integration tests.
Contributing
Welcome to contribute for tidbcloudlake-dbt. See Contributing Guide for more information.
1 maintainer
Metadata
1 maintainer
Release files for tidbcloudlake-dbt 1.8.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| tidbcloudlake_dbt-1.8.1.tar.gz | 24.0 kB | With provenance | Details for tidbcloudlake_dbt-1.8.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| tidbcloudlake_dbt-1.8.1-py3-none-any.whl | Python 3 | none | any | Details for tidbcloudlake_dbt-1.8.1-py3-none-any.whl |
Total release size: 52.0 kB
Release files / tidbcloudlake_dbt-1.8.1.tar.gz
| Download URL | tidbcloudlake_dbt-1.8.1.tar.gz |
|---|---|
| Size | 24.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ed4d82018382f0e804c6855b5181161015c5084c610423a8613d21f4f6c2375f
|
|
BLAKE2b-256 checksum How to use checksums |
fa9d9047506d630f7d420506d065f1ca04c318274fd4f3d36b2a057f19e3b63d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 11, 2026.
Transparency logRelease files / tidbcloudlake_dbt-1.8.1-py3-none-any.whl
| Download URL | tidbcloudlake_dbt-1.8.1-py3-none-any.whl |
|---|---|
| Size | 28.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
edf1d73be00c2e52a3d0216be4fc4fe9c519bb9938530ee2571e803e235dc7b1
|
|
BLAKE2b-256 checksum How to use checksums |
a74834e912b921839e80f6d722136e9624ab89fe899aa3aef6c781ec56c99a2e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 11, 2026.
Transparency logSecurity for tidbcloudlake-dbt 1.8.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for tidbcloudlake_dbt-1.8.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 11, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
