You need to enable JavaScript to run this app.
文档中心
云数据库 TiDB 版

云数据库 TiDB 版

请输入
  • 文档首页
    • 云数据库 TiDB 版用户指南连接管理连接方式
复制全文
下载 pdf
我的收藏
连接管理
连接方式
复制全文
下载 pdf
我的收藏
连接方式
本文介绍连接到云数据库 TiDB 版集群的连接方式。您可使用任何兼容 MySQL 协议的连接工具或代码连接到云数据库 TiDB 版集群。​
背景信息​
云数据库 TiDB 版支持通过以下方式连接集群：​
前提条件​
  • 已完成网络准备，不同场景操作如下：​
  • ​
    网络场景​
    操作说明​
    同 VPC 连接​
    无需手动创建终端节点，云数据库 TiDB 版在创建集群时，会自动创建终端节点并添加至集群 default 端点白名单中。​
    跨 VPC 连接​
    需在业务 VPC 创建接口终端节点，并启用私有 DNS 名称，再将该终端节点添加至 TiDB 集群端点白名单中。 ​
    ​
  • 已获取集群连接参数。如何获取云数据库 TiDB 版集群的连接参数（主机地址、端口号、用户名、密码）和连接字符串，详情请参见连接集群。​
注意事项​
跨 VPC 连接 TiDB 集群时，请确保您的私有终端节点已启用私有 DNS 名称。如何启用，详情请参见启用/关闭私有 DNS 名称。​
通过命令行连接集群​
您可使用任何兼容 MySQL 协议的连接工具连接到云数据库 TiDB 版集群。以下以 MySQL client 为例。​
  1. 登录到需要连接云数据库 TiDB 版集群的云服务器 ECS。​
说明​
关于如何登录云服务器 ECS ，详情请参见登录 ECS 实例。​
  1. 安装 MySQL 命令行客户端。以 Linux 系统为例，可以通过包管理器进行安装：​
  • ​
    基于 Debian 的发行版
    基于 RPM 的发行版
    macOS
    ​
    ​
    sudo apt-get install mysql-client​
    ​
    ​
  1. 执行以下命令行连接。​
  • ​
    mysql -h<host> -u<user> -P<port> -p​
    ​
  • 参数说明：​
  • ​
    选项​
    参数​
    如何获取​
    -h​
    ​
    请输入云数据库 TiDB 版集群的主机地址。​
    如何获取主机地址、端口号、用户名以及密码，详情请参见连接集群。​
    -P​
    请输入云数据库 TiDB 版集群的端口号。​
    ​
    -u​
    请输入云数据库 TiDB 版集群的用户名。​
    ​
    -p​
    为保障密码安全，请勿直接在 -p 后输入密码。执行整行命令后，按终端提示输入密码，输入过程无字符显示，完成后回车即可登录。​
    ​
    ​
  • 示例如下：​
  • ​
    mysql -hgateway01-privatelink.cn-beijing.tidb.ivolces.com -u2Xcpqpbyx******.root -P4000 -p​
    ​
通过代码连接集群​
您可通过 Java、Python 或 Go 代码进行连接：​
​
Java
Python
Go
​
依赖 Maven​
​
<dependency>​
<groupId>com.mysql</groupId>​
<artifactId>mysql-connector-j</artifactId>​
<version>8.0.33</version>​
</dependency>​
​
连接代码示例​
​
import java.sql.Connection;​
import java.sql.DriverManager;​
​
public class TiDBTest {​
public static void main(String[] args) throws Exception {​
String url = "jdbc:mysql://<host>:4000/<数据库>?useSSL=false&serverTimezone=Asia/Shanghai&characterEncoding=utf8mb4";​
String user = "<用户名>";​
String pwd = "<密码>";​
​
Connection conn = DriverManager.getConnection(url, user, pwd);​
System.out.println("连接成功");​
conn.close();​
}​
}​
​
​
通过客户端连接集群​
  1. 客户端部署在火山引擎云服务器 ECS 上，且 ESC 实例与云数据库 TiDB 版集群在同一地域。​
  1. 在您使用的客户端程序中完成相应的连接配置，以连接云数据库 TiDB 版集群。以下以 MySQL Workbench 为例：​
  • ​
    MySQL Workbench
    ​
    1. 启动 MySQL Workbench，并点击 MySQL Connections 标题旁边的 +。​
    ​​​
    1. 在 Setup New Connection 对话框中，配置以下连接参数：​
    • Connection Name：为该连接指定一个名称。​
    • Hostname：输入从云数据库 TiDB 版连接对话框中的得到的 <主机> 参数。​
    • Port：输入从云数据库 TiDB 版连接对话框中的得到的 <端口> 参数。​
    • Username：输入从云数据库 TiDB 版连接对话框中的得到的 <用户名> 参数。​
    • Password：单击 Store in Keychain ... 或 Store in Vault，输入从云数据库 TiDB 版生成的 <密码>，然后单击 OK 保存密码。​
    说明​
    如何获取主机地址、端口号、用户名以及密码，详情请参见连接集群。​
    下图显示了连接参数的示例：​
    ​​​
    1. 单击 Test Connection 以验证与您目标 TiDB 集群的连接。​
    1. 如果连接测试成功，你可以看到 Successfully made the MySQL connection 信息。​
    1. 单击 OK 保存连接配置。​
    ​
  • ​
最近更新时间：2026.09.24 11:41:02
这个页面对您有帮助吗？
有用
有用
无用
无用