Skip to content

Commit

Permalink
Preview PR pingcap/docs-cn#16164 and this preview is triggered from c…
Browse files Browse the repository at this point in the history
  • Loading branch information
Docsite Preview Bot committed Jan 29, 2024
1 parent 99fd2fb commit 3fe34b8
Show file tree
Hide file tree
Showing 9 changed files with 154 additions and 14 deletions.
20 changes: 6 additions & 14 deletions markdown-pages/zh/tidb/master/TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- [文档中心](https://docs.pingcap.com/zh)
- 关于 TiDB
- [TiDB 简介](/overview.md)
- [TiDB 7.6 Release Notes](/releases/release-7.6.0.md)
- [TiDB 7.5 Release Notes](/releases/release-7.5.0.md)
- [功能概览](/basic-features.md)
- [与 MySQL 的兼容性](/mysql-compatibility.md)
- [使用限制](/tidb-limitations.md)
Expand Down Expand Up @@ -45,6 +45,8 @@
- [mysql2](/develop/dev-guide-sample-application-ruby-mysql2.md)
- [Rails](/develop/dev-guide-sample-application-ruby-rails.md)
- 连接到 TiDB
- GUI 数据库工具
- [MySQL Workbench](/develop/dev-guide-gui-mysql-workbench.md)
- [选择驱动或 ORM 框架](/develop/dev-guide-choose-driver-or-orm.md)
- [连接到 TiDB](/develop/dev-guide-connect-to-tidb.md)
- [连接池与连接参数](/develop/dev-guide-connection-parameters.md)
Expand Down Expand Up @@ -105,7 +107,6 @@
- 规划集群拓扑
- [最小部署拓扑结构](/minimal-deployment-topology.md)
- [TiFlash 部署拓扑](/tiflash-deployment-topology.md)
- [TiProxy 部署拓扑](/tiproxy/tiproxy-deployment-topology.md)
- [TiCDC 部署拓扑](/ticdc-deployment-topology.md)
- [TiDB Binlog 部署拓扑](/tidb-binlog-deployment-topology.md)
- [TiSpark 部署拓扑](/tispark-deployment-topology.md)
Expand Down Expand Up @@ -614,13 +615,6 @@
- [不同库名或表名的数据校验](/sync-diff-inspector/route-diff.md)
- [分库分表场景下的数据校验](/sync-diff-inspector/shard-diff.md)
- [基于 DM 同步场景下的数据校验](/sync-diff-inspector/dm-diff.md)
- TiProxy
- [概述](/tiproxy/tiproxy-overview.md)
- [配置文件](/tiproxy/tiproxy-configuration.md)
- [命令行参数](/tiproxy/tiproxy-command-line-flags.md)
- [监控指标](/tiproxy/tiproxy-grafana.md)
- [故障诊断](/tiproxy/troubleshoot-tiproxy.md)
- [性能测试报告](/tiproxy/tiproxy-performance-test.md)
- 参考指南
- 架构
- [概述](/tidb-architecture.md)
Expand Down Expand Up @@ -715,7 +709,6 @@
- [`ADMIN PAUSE DDL`](/sql-statements/sql-statement-admin-pause-ddl.md)
- [`ADMIN RECOVER INDEX`](/sql-statements/sql-statement-admin-recover.md)
- [`ADMIN RESUME DDL`](/sql-statements/sql-statement-admin-resume-ddl.md)
- [`ADMIN [SET|SHOW|UNSET] BDR ROLE`](/sql-statements/sql-statement-admin-bdr-role.md)
- [`ADMIN SHOW DDL [JOBS|QUERIES]`](/sql-statements/sql-statement-admin-show-ddl.md)
- [`ADMIN SHOW TELEMETRY`](/sql-statements/sql-statement-admin-show-telemetry.md)
- [`ALTER DATABASE`](/sql-statements/sql-statement-alter-database.md)
Expand Down Expand Up @@ -768,7 +761,7 @@
- [`EXECUTE`](/sql-statements/sql-statement-execute.md)
- [`EXPLAIN ANALYZE`](/sql-statements/sql-statement-explain-analyze.md)
- [`EXPLAIN`](/sql-statements/sql-statement-explain.md)
- [`FLASHBACK CLUSTER`](/sql-statements/sql-statement-flashback-cluster.md)
- [`FLASHBACK CLUSTER TO TIMESTAMP`](/sql-statements/sql-statement-flashback-to-timestamp.md)
- [`FLASHBACK DATABASE`](/sql-statements/sql-statement-flashback-database.md)
- [`FLASHBACK TABLE`](/sql-statements/sql-statement-flashback-table.md)
- [`FLUSH PRIVILEGES`](/sql-statements/sql-statement-flush-privileges.md)
Expand Down Expand Up @@ -825,7 +818,9 @@
- [`SHOW FIELDS FROM`](/sql-statements/sql-statement-show-fields-from.md)
- [`SHOW GRANTS`](/sql-statements/sql-statement-show-grants.md)
- [`SHOW IMPORT JOB`](/sql-statements/sql-statement-show-import-job.md)
- [`SHOW INDEX`](/sql-statements/sql-statement-show-index.md)
- [`SHOW INDEXES`](/sql-statements/sql-statement-show-indexes.md)
- [`SHOW KEYS`](/sql-statements/sql-statement-show-keys.md)
- [`SHOW MASTER STATUS`](/sql-statements/sql-statement-show-master-status.md)
- [`SHOW PLACEMENT`](/sql-statements/sql-statement-show-placement.md)
- [`SHOW PLACEMENT FOR`](/sql-statements/sql-statement-show-placement-for.md)
Expand Down Expand Up @@ -973,7 +968,6 @@
- [概述](/performance-schema/performance-schema.md)
- [`SESSION_CONNECT_ATTRS`](/performance-schema/performance-schema-session-connect-attrs.md)
- [元数据锁](/metadata-lock.md)
- [TiDB DDL V2](/ddl-v2.md)
- UI
- TiDB Dashboard
- [简介](/dashboard/dashboard-intro.md)
Expand Down Expand Up @@ -1027,8 +1021,6 @@
- [版本发布时间线](/releases/release-timeline.md)
- [TiDB 版本规则](/releases/versioning.md)
- [TiDB 离线包](/binary-package.md)
- v7.6
- [7.6.0-DMR](/releases/release-7.6.0.md)
- v7.5
- [7.5.0](/releases/release-7.5.0.md)
- v7.4
Expand Down
148 changes: 148 additions & 0 deletions markdown-pages/zh/tidb/master/develop/dev-guide-gui-mysql-workbench.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
---
title: 使用 MySQL Workbench 连接 TiDB
summary: 了解如何使用 MySQL Workbench 连接到 TiDB。
---

# 使用 MySQL Workbench 连接 TiDB

TiDB 是一个兼容 MySQL 的数据库。[MySQL Workbench](https://www.mysql.com/products/workbench/) 是为 MySQL 数据库用户提供的 GUI 工具集。

> **警告**
>
> - 尽管由于 MySQL Workbench 兼容 MySQL,你可以使用 MySQL Workbench 连接到 TiDB,但 MySQL Workbench 并不完全支持 TiDB。由于 MySQL Workbench 将 TiDB 视为 MySQL,因此在使用过程中可能会遇到一些问题。
> - 推荐使用其他官方支持 TiDB 的 GUI 工具,例如 DataGrip,DBeaver 以及 VS Code SQLTools。TiDB 完全支持的 GUI 工具的完整列表,参考 [TiDB 支持的第三方工具](/develop/dev-guide-third-party-support.md#gui)
在本文档中,你可以学习如何使用 MySQL Workbench 连接到 TiDB 集群。

> **注意**
>
> 本文档适用于 TiDB Serverless、TiDB Dedicated 和本地部署的 TiDB。
## 前置需求

为了能够顺利完成本文中的操作,你需要:

- [MySQL Workbench](https://dev.mysql.com/downloads/workbench/) **8.0.31** 或以上版本。
- 准备一个 TiDB 集群。

**如果你未有 TiDB 集群,可以按如下方式创建一个:**

- (推荐) 参考 [使用 TiDB Serverless 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md) 来创建一个 TiDB Cloud 集群。
- 参考 [部署本地测试集群](/quick-start-with-tidb.md#部署本地测试集群)[部署生产 TiDB 集群](/production-deployment-using-tiup.md) 来创建一个本地集群。

## 连接到 TiDB

根据你选择的 TiDB 部署选项连接到 TiDB 集群。

<SimpleTab>
<div label="TiDB Serverless">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,点击你目标集群的名字,并进入集群的 Overview 页面。

2. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。

3. 确认对话框中的配置和你的运行环境一致。

- **Endpoint Type** 选择 `Public`
- **Branch** 选择 `main`
- **Connect With** 选择 `MySQL Workbench`
- **Operating System** 为你的运行环境。

4. 点击 **Generate Password** 生成一个随机密码。

> **小贴士**
>
> 如果你之前已经生成过密码,可以直接使用原密码,或点击 **Reset Password** 重新生成密码。
5. 启动 MySQL Workbench,并点击 **MySQL Connections** 标题附近的 **+**

![MySQL Workbench: add new connection](/media/develop/mysql-workbench-add-new-connection.png)

6.**Setup New Connection** 对话框中,配置以下连接参数:

- **Connection Name**:为该连接指定一个有意义的名称。
- **Hostname**:输入从 TiDB Cloud 连接对话框中的得到的 `HOST` 参数。
- **Port**:输入从 TiDB Cloud 连接对话框中的得到的 `PORT` 参数。
- **Username**:输入从 TiDB Cloud 连接对话框中的得到的 `USERNAME` 参数。
- **Password**:点击 **Store in Keychain ...**,输入 TiDB Serverless 集群的密码,然后点击 **OK** 保存密码。

![MySQL Workbench: store the password of TiDB Serverless in keychain](/media/develop/mysql-workbench-store-password-in-keychain.png)

下图显示了连接参数的示例:

![MySQL Workbench: configure connection settings for TiDB Serverless](/media/develop/mysql-workbench-connection-config-serverless-parameters.png)

7. 点击 **Test Connection** 以验证与 TiDB Serverless 集群的连接。

8. 如果连接测试成功,你可以看到 **Successfully made the MySQL connection** 信息。点击 **OK** 保存连接配置。

</div>
<div label="TiDB Dedicated">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,点击你目标集群的名字,并进入集群的 Overview 页面。

2. 点击右上角的 **Connect** 按钮,将会弹出连接对话框。

3. 点击 **Allow Access from Anywhere**

有关如何获取连接字符串的更多详细信息,参考 [TiDB Dedicated 标准连接](https://docs.pingcap.com/tidbcloud/connect-via-standard-connection)

4. 启动 MySQL Workbench,并点击 **MySQL Connections** 标题附近的 **+**

![MySQL Workbench: add new connection](/media/develop/mysql-workbench-add-new-connection.png)

5.**Setup New Connection** 对话框中,配置以下连接参数:

- **Connection Name**:为该连接指定一个有意义的名称。
- **Hostname**: 输入从 TiDB Cloud 连接对话框中的得到的 `HOST` 参数。
- **Port**:输入从 TiDB Cloud 连接对话框中的得到的 `PORT` 参数。
- **Username**:输入从 TiDB Cloud 连接对话框中的得到的 `USERNAME` 参数。
- **Password**:点击 **Store in Keychain ...**,输入 TiDB Dedicated 集群的密码,然后点击 **OK** 保存密码。

![MySQL Workbench: store the password of TiDB Dedicated in keychain](/media/develop/mysql-workbench-store-dedicated-password-in-keychain.png)

下图显示了连接参数的示例:

![MySQL Workbench: configure connection settings for TiDB Dedicated](/media/develop/mysql-workbench-connection-config-dedicated-parameters.png)

6. 点击 **Test Connection** 以验证与 TiDB Dedicated 集群的连接。

7. 如果连接测试成功,你可以看到 **Successfully made the MySQL connection** 信息。点击 **OK** 保存连接配置。

</div>
<div label="TiDB Self-Hosted">

1. 启动 MySQL Workbench,并点击 **MySQL Connections** 标题附近的 **+**

![MySQL Workbench: add new connection](/media/develop/mysql-workbench-add-new-connection.png)

2.**Setup New Connection** 对话框中,配置以下连接参数:

- **Connection Name**:为该连接指定一个有意义的名称。
- **Hostname**:输入本地部署 TiDB 集群的 IP 地址或域名。
- **Port**:输入本地部署 TiDB 集群的端口号。
- **Username**:输入用于连接到 TiDB 的用户名。
- **Password**:点击 **Store in Keychain ...**,输入用于连接 TiDB 集群的密码,然后点击 **OK** 保存密码。

![MySQL Workbench: store the password of TiDB Self-Hosted in keychain](/media/develop/mysql-workbench-store-self-hosted-password-in-keychain.png)

下图显示了连接参数的示例:

![MySQL Workbench: configure connection settings for TiDB Self-Hosted](/media/develop/mysql-workbench-connection-config-self-hosted-parameters.png)

3. 点击 **Test Connection** 以验证与本地部署 TiDB 集群的连接。

4. 如果连接测试成功,你可以看到 **Successfully made the MySQL connection** 信息。点击 **OK** 保存连接配置。

</div>
</SimpleTab>

## 下一步

- 关于 MySQL Workbench 的更多使用方法,可以参考 [MySQL Workbench 官方文档](https://dev.mysql.com/doc/workbench/en/)
- 你可以继续阅读 [开发者文档](/develop/dev-guide-overview.md),以获取更多关于 TiDB 应用开发的最佳实践。例如:[插入数据](/develop/dev-guide-insert-data.md)[更新数据](/develop/dev-guide-update-data.md)[删除数据](/develop/dev-guide-delete-data.md)[单表读取](/develop/dev-guide-get-data-from-single-table.md)[事务](/develop/dev-guide-transaction-overview.md)[SQL 性能优化](/develop/dev-guide-optimize-sql-overview.md)等。
- 如果你更倾向于参与课程进行学习,我们也提供专业的 [TiDB 开发者课程](https://cn.pingcap.com/courses-catalog/category/back-end-developer/?utm_source=docs-cn-dev-guide) 支持,并在考试后提供相应的 [资格认证](https://learn.pingcap.com/learner/certification-center)

## 需要帮助?

如果在开发的过程中遇到问题,可以在 [AskTUG](https://asktug.com/?utm_source=docs-cn-dev-guide) 上进行提问,或从 PingCAP 官方或 TiDB 社区[获取支持](/support.md)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3fe34b8

Please sign in to comment.