connector
TiDB logo

TiDB

MySQL-compatible distributed SQL database.

Connection fields

FieldRequiredDescription
hostYesHostname or IP address of the TiDB cluster's SQL endpoint.
portNoDefaults to 3306.
userYesUsername to authenticate with.
passwordNoNot enforced by the connector, but almost every real deployment requires one — leave it blank only against a server configured to allow passwordless auth.
dbYesDatabase name to connect to.

TiDB speaks the MySQL wire protocol, so it runs on the same connector code as MySQL/MariaDB — only the stored type name differs.

Example configuration

{
  "host": "tidb-cluster.internal.example.com",
  "port": 4000,
  "user": "arcodash_reader",
  "password": "••••••••",
  "db": "analytics"
}

Caveats

  • TiDB's default SQL port is 4000, not MySQL's 3306 — the connector's own default is still 3306, so set port explicitly for a standard TiDB deployment.