TiDB Source

TiDB is a distributed SQL database that combines the best of traditional RDBMS and NoSQL databases.

  2 minute read  

About

TiDB is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL-compatible and features horizontal scalability, strong consistency, and high availability.

Available Tools

TiDB Source Tools

Tool NameDescription
tidb-execute-sql ToolA "tidb-execute-sql" tool executes a SQL statement against a TiDB database.
tidb-sql ToolA "tidb-sql" tool executes a pre-defined SQL statement against a TiDB database.

Requirements

Database User

This source uses standard MySQL protocol authentication. You will need to create a TiDB user to login to the database with.

For TiDB Cloud users, you can create database users through the TiDB Cloud console.

Example

  • TiDB Cloud

    kind: sources
name: my-tidb-cloud-source
type: tidb
host: gateway01.us-west-2.prod.aws.tidbcloud.com
port: 4000
database: my_db
user: ${TIDB_USERNAME}
password: ${TIDB_PASSWORD}
# SSL is automatically enabled for TiDB Cloud

  • Self-Hosted TiDB

    kind: sources
name: my-tidb-source
type: tidb
host: 127.0.0.1
port: 4000
database: my_db
user: ${TIDB_USERNAME}
password: ${TIDB_PASSWORD}
# ssl: true  # Optional: enable SSL for secure connections

Tip

Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file.

Reference

fieldtyperequireddescription
typestringtrueMust be “tidb”.
hoststringtrueIP address or hostname to connect to (e.g. “127.0.0.1” or “gateway01.*.tidbcloud.com”).
portstringtruePort to connect to (typically “4000” for TiDB).
databasestringtrueName of the TiDB database to connect to (e.g. “my_db”).
userstringtrueName of the TiDB user to connect as (e.g. “my-tidb-user”).
passwordstringtruePassword of the TiDB user (e.g. “my-password”).
sslbooleanfalseWhether to use SSL/TLS encryption. Automatically enabled for TiDB Cloud instances.

Advanced Usage

SSL Configuration

  • TiDB Cloud

    For TiDB Cloud instances, SSL is automatically enabled when the hostname matches the TiDB Cloud pattern (gateway*.*.*.tidbcloud.com). You don’t need to explicitly set ssl: true for TiDB Cloud connections.

  • Self-Hosted TiDB

    For self-hosted TiDB instances, you can optionally enable SSL by setting ssl: true in your configuration.



Last modified March 12, 2026: docs: Add page standardization to external source integrations (#2666) (b4f910bc603)