tidb-gateway

tidb-gateway

Manage client connections to multiple TiDB instances.

mysql 客户端可以通过 gateway 连接不同的后端 TiDB 集群。

How

为了兼容尽可能多的 driver，我们修改了 UserName 字段（即 mysql 的 -U 参数）来指定后端集群。

规则是 username = {clusterid}.{username}。

sequenceDiagram
    client->>tidb-gateway: connect
    tidb-gateway->>client: InitialHandshake
    client->>tidb-gateway: HandshakeResponse
    Note over tidb-gateway: extract clusterID from UserName
    tidb-gateway->>tidb: connect
    tidb->>tidb-gateway: InitialHandshake
    tidb-gateway->>tidb: HandshakeResponse
    Note over client,tidb: Continue exchanging data

Example

# start tidb1 (localhost:4000)
> ./tidb-server
# start tidb2 (localhost:4001)
> ./tidb-server -P 4001 -status 10081 -path /tmp/tidb2

# start tidb-gateway (localhost:3306)
> ./tidb-gateway --addr :3306 --backend tidb1=localhost:4000 --backend tidb2=localhost:4001

# connect tidb1
> mysql -uroot -h 127.0.0.1 -u tidb1.root -D test

# connect tidb2
> mysql -uroot -h 127.0.0.1 -u tidb2.root -D test