使用 mysqlclient 连接 TiDB

在 TiDB Cloud 控制台中，打开 Clusters 页面，选择你的 TiDB Serverless 集群，进入 Overview 页面，点击右上角的 Connect 按钮。

确认窗口中的配置和你的运行环境一致。

• Endpoint Type 为 Public
• Connect With 为 General
• Operating System 为你的运行环境

如果你在 Windows Subsystem for Linux (WSL) 中运行，请切换为对应的 Linux 发行版。

点击 Generate password 生成密码。

如果你之前已经生成过密码，可以直接使用原密码，或点击 Reset Password 重新生成密码。

运行以下命令，将 .env.example 复制并重命名为 .env：

cp .env.example .env

复制并粘贴对应连接字符串至 .env 中。示例结果如下：

 TIDB_HOST='{gateway-region}.aws.tidbcloud.com'
 TIDB_PORT='4000'
 TIDB_USER='{prefix}.root'
 TIDB_PASSWORD='{password}'
 TIDB_DB_NAME='test'
 CA_PATH=''

注意替换 {} 中的占位符为 Connect 窗口中获得的值。

TiDB Serverless 要求使用 secure connection，由于 mysqlclient 的 ssl_mode 默认为 PREFERRED，所以不需要你手动指定 CA_PATH，设置为空即可。但如果你有特殊原因需要手动指定 CA_PATH，可以参考 TiDB Cloud 文档获取不同操作系统下证书的路径。

保存文件。

在 TiDB Cloud Web Console 中，选择你的 TiDB Dedicated 集群，进入 Overview 页面，点击右上角的 Connect 按钮。点击 Allow Access from Anywhere 并点击 Download TiDB cluster CA 下载证书。

更多配置细节，可参考 TiDB Dedicated 标准连接教程.

运行以下命令，将 .env.example 复制并重命名为 .env：

cp .env.example .env

复制并粘贴对应的连接字符串至 .env 中。示例结果如下：

 TIDB_HOST='{host}.clusters.tidb-cloud.com'
 TIDB_PORT='4000'
 TIDB_USER='{username}'
 TIDB_PASSWORD='{password}'
 TIDB_DB_NAME='test'
 CA_PATH='{your-downloaded-ca-path}'

注意替换 {} 中的占位符为 Connect 窗口中获得的值，并配置前面步骤中下载好的证书路径。

保存文件。

运行以下命令，将 .env.example 复制并重命名为 .env：

cp .env.example .env

复制并粘贴对应 TiDB 的连接字符串至 .env 中。示例结果如下：

TIDB_HOST='{tidb_server_host}'
TIDB_PORT='4000'
TIDB_USER='root'
TIDB_PASSWORD='{password}'
TIDB_DB_NAME='test'

注意替换 {} 中的占位符为你的 TiDB 对应的值，并删除 CA_PATH 这行。如果你在本机运行 TiDB，默认 Host 地址为 127.0.0.1，密码为空。

保存文件。