DbSchema connects to PingCAP's TiDB through the MySQL Connector/J driver — TiDB speaks the MySQL protocol — and turns the schema of your HTAP cluster into ER diagrams, SQL tooling, and documentation, self-hosted or on TiDB Cloud.
Trusted by teams at
TiDB splits storage into regions, keeps TiKV rows and TiFlash columns consistent over Raft, and hides all of it behind a MySQL-compatible endpoint. That transparency is the point — but it means the logical schema is the one thing your team still has to understand, document, and evolve deliberately.
DbSchema works at exactly that layer: the tables, keys, and relationships your applications see, diagrammed and versioned like the code around them.
Everything rides the MySQL protocol — including your existing habits.
The bundled MySQL Connector/J reads the TiDB catalog and produces the full ER diagram — no cluster-specific setup, just the right port.
Author MySQL-compatible SQL, add hints like READ_FROM_STORAGE(TIFLASH[...]) for columnar execution, and study EXPLAIN ANALYZE output to see which operators ran where.
Region splitting stays invisible, so the diagram reads like a single-node schema — split it into per-domain layouts and color-code the areas each team owns.
Keep the TiDB schema as a model file in your repository: branch it with the feature, diff it in the pull request, and apply the reviewed change to development, staging, and production clusters in the order you choose.
TiDB is compatible with the MySQL 5.7 and 8.0 protocol and listens on port
4000 — not MySQL's 3306, and the wrong port is the most common
first-connection mistake. Select MySQL as the database type; DbSchema ships MySQL Connector/J
(com.mysql.cj.jdbc.Driver), so the URL is simply
jdbc:mysql://tidb-host:4000/mydb.
For TiDB Cloud, copy the connection string from the console: it carries the cluster hostname,
port 4000, and mandatory SSL — append ?useSSL=true&requireSSL=true or set SSL
in the connection dialog's advanced settings. The root password is defined at cluster creation;
there is no default empty password. Details on the
TiDB JDBC driver page.
Grab the free installer — Community Edition with a 15-day Architect trial, signup-free.
Teams working with TiDB often use these engines too. Explore dedicated guides and JDBC setup for each.