tidbcloudlake-dbt

PyPI PyPI - Python Version

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:

  • Ephemeral materialization 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.

Project links

Data verified by PyPI on Aug 11, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for ti-chi-bot from gravatar.com ti-chi-bot

Credits

Author: TiDB Cloud

GitHub Statistics

Data verified by PyPI on Aug 11, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

Apache Software License (Apache-2.0)

Requires

Python >=3.8

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tidbcloudlake_dbt-1.8.1.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tidbcloudlake_dbt-1.8.1-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

Details for the file tidbcloudlake_dbt-1.8.1.tar.gz.

File metadata

  • Download URL: tidbcloudlake_dbt-1.8.1.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for tidbcloudlake_dbt-1.8.1.tar.gz
Algorithm Hash digest
SHA256 ed4d82018382f0e804c6855b5181161015c5084c610423a8613d21f4f6c2375f
MD5 4003058951da1c5d9e62b5a96d96c49e
BLAKE2b-256 fa9d9047506d630f7d420506d065f1ca04c318274fd4f3d36b2a057f19e3b63d

See more details on using hashes here.

Provenance

The following attestation bundles were made for tidbcloudlake_dbt-1.8.1.tar.gz:

Publisher: release.yml on tidbcloud/lake-dbt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tidbcloudlake_dbt-1.8.1-py3-none-any.whl.

File metadata

File hashes

Hashes for tidbcloudlake_dbt-1.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 edf1d73be00c2e52a3d0216be4fc4fe9c519bb9938530ee2571e803e235dc7b1
MD5 ec338f007c29502b6208cb781c05a2e3
BLAKE2b-256 a74834e912b921839e80f6d722136e9624ab89fe899aa3aef6c781ec56c99a2e

See more details on using hashes here.

Provenance

The following attestation bundles were made for tidbcloudlake_dbt-1.8.1-py3-none-any.whl:

Publisher: release.yml on tidbcloud/lake-dbt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.8.1 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page