Skip to main content
Version: Next

TiDB

Connect a TiDB database to Lakehousecat using a connection URI. TiDB is a distributed, MySQL-compatible HTAP database developed by PingCAP.

Connection Fields​

FieldRequiredDescription
Connection URIYesFull connection string including credentials, host, port, and database name. Example: tidb://user:password@host:4000/mydb
Use SSHNoEnable if the database is behind an SSH bastion host. When enabled, SSH settings fields appear. See SSH Tunneling.

Prerequisites​

  • Admin or Builder role in Lakehousecat
  • A TiDB user with SELECT access to the schemas and tables you want to expose
  • Network connectivity from the Lakehousecat backend to the database (direct or via SSH)
  • TiDB default port: 4000

Notes​

  • TiDB is MySQL-wire-compatible — the connection uses the MySQL protocol internally.
  • The connection URI scheme tidb:// is automatically translated to mysql+pymysql:// for DLT loading.
  • Use a read-only database user to follow the principle of least privilege.
  • Incremental Load is supported; use a timestamp column (e.g., updated_at) as the incremental column.
  • TiDB does not support empty passwords — create a dedicated user with a password.

Next Steps​

After creating the datasource, go to the Operations tab to trigger semantic extraction.