feat: Developer Guide - GUI - MySQL Workbench (#15366)

TOC-tidb-cloud.md

@@ -23,6 +23,7 @@
  - [JetBrains DataGrip](/develop/dev-guide-gui-datagrip.md)
  - [DBeaver](/develop/dev-guide-gui-dbeaver.md)
  - [VS Code](/develop/dev-guide-gui-vscode-sqltools.md)
+ - [MySQL Workbench](/develop/dev-guide-gui-mysql-workbench.md)
  - [Navicat](/develop/dev-guide-gui-navicat.md)
  - [Choose Driver or ORM](/develop/dev-guide-choose-driver-or-orm.md)
  - Java

TOC.md

@@ -53,6 +53,7 @@
  - [JetBrains DataGrip](/develop/dev-guide-gui-datagrip.md)
  - [DBeaver](/develop/dev-guide-gui-dbeaver.md)
  - [VS Code](/develop/dev-guide-gui-vscode-sqltools.md)
+ - [MySQL Workbench](/develop/dev-guide-gui-mysql-workbench.md)
  - [Navicat](/develop/dev-guide-gui-navicat.md)
  - [Choose Driver or ORM](/develop/dev-guide-choose-driver-or-orm.md)
  - [Connect to TiDB](/develop/dev-guide-connect-to-tidb.md)

develop/dev-guide-gui-mysql-workbench.md

@@ -0,0 +1,169 @@
+---
+title: Connect to TiDB with MySQL Workbench
+summary: Learn how to connect to TiDB using MySQL Workbench.
+---
+
+# Connect to TiDB with MySQL Workbench
+
+TiDB is a MySQL-compatible database, and [MySQL Workbench](https://www.mysql.com/products/workbench/) is a GUI tool set for MySQL database users.
+
+> **Warning:**
+>
+> - Although you can use MySQL Workbench to connect to TiDB due to its MySQL compatibility, MySQL Workbench does not fully support TiDB. You might encounter some issues during usage as it treats TiDB as MySQL.
+> - It is recommended to use other GUI tools that officially support TiDB, such as [DataGrip](/develop/dev-guide-gui-datagrip.md), [DBeaver](/develop/dev-guide-gui-dbeaver.md), and [VS Code SQLTools](/develop/dev-guide-gui-vscode-sqltools.md). For a complete list of GUI tools that fully supported by TiDB, see [Third-party tools supported by TiDB](/develop/dev-guide-third-party-support.md#gui).
+
+In this tutorial, you can learn how to connect to your TiDB cluster using MySQL Workbench.
+
+> **Note:**
+>
+> This tutorial is compatible with TiDB Serverless, TiDB Dedicated, and TiDB Self-Hosted.
+
+## Prerequisites
+
+To complete this tutorial, you need:
+
+- [MySQL Workbench](https://dev.mysql.com/downloads/workbench/) **8.0.31** or later versions.
+- A TiDB cluster.
+
+<CustomContent platform="tidb">
+
+**If you don't have a TiDB cluster, you can create one as follows:**
+
+- (Recommended) Follow [Creating a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster.
+- Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster.
+
+</CustomContent>
+<CustomContent platform="tidb-cloud">
+
+**If you don't have a TiDB cluster, you can create one as follows:**
+
+- (Recommended) Follow [Creating a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster.
+- Follow [Deploy a local test TiDB cluster](https://docs.pingcap.com/tidb/stable/quick-start-with-tidb#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](https://docs.pingcap.com/tidb/stable/production-deployment-using-tiup) to create a local cluster.
+
+</CustomContent>
+
+## Connect to TiDB
+
+Connect to your TiDB cluster depending on the TiDB deployment option you have selected.
+
+<SimpleTab>
+<div label="TiDB Serverless">
+
+1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page.
+
+2. Click **Connect** in the upper-right corner. A connection dialog is displayed.
+
+3. Ensure the configurations in the connection dialog match your operating environment.
+
+ - **Endpoint Type** is set to `Public`.
+ - **Connect With** is set to `General`.
+ - **Operating System** matches your environment.
+
+4. Click **Create password** to create a random password.
+
+ > **Tip:**
+ >
+ > If you have created a password before, you can either use the original password or click **Reset password** to generate a new one.
+
+5. Launch MySQL Workbench and click **+** near the **MySQL Connections** title.
+
+ ![MySQL Workbench: add new connection](/media/develop/navicat-add-new-connection.png)
+
+6. In the **Setup New Connection** dialog, configure the following connection parameters:
+
+ - **Connection Name**: give this connection a meaningful name.
+ - **Hostname**: enter the `host` parameter from the TiDB Cloud connection dialog.
+ - **Port**: enter the `port` parameter from the TiDB Cloud connection dialog.
+ - **Username**: enter the `user` parameter from the TiDB Cloud connection dialog.
+ - **Password**: click **Store in Keychain ...**, enter the password of the TiDB Serverless cluster, and then click **OK** to store the password.
+
+ ![MySQL Workbench: store the password of TiDB Serverless in keychain](/media/develop/mysql-workbench-store-password-in-keychain.png)
+
+ The following figure shows an example of the connection parameters:
+
+ ![MySQL Workbench: configure connection settings for TiDB Serverless](/media/develop/mysql-workbench-connection-config-serverless-parameters.png)
+
+7. Click **Test Connection** to validate the connection to the TiDB Serverless cluster.
+
+8. If the connection test is successful, you can see the **Successfully made the MySQL connection** message. Click **OK** to save the connection configuration.
+
+</div>
+<div label="TiDB Dedicated">
+
+1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page.
+
+2. Click **Connect** in the upper-right corner. A connection dialog is displayed.
+
+3. Click **Allow Access from Anywhere**.
+
+ For more details about how to obtain the connection string, refer to [TiDB Dedicated standard connection](https://docs.pingcap.com/tidbcloud/connect-via-standard-connection).
+
+4. Launch MySQL Workbench and click **+** near the **MySQL Connections** title.
+
+ ![MySQL Workbench: add new connection](/media/develop/navicat-add-new-connection.png)
+
+5. In the **Setup New Connection** dialog, configure the following connection parameters:
+
+ - **Connection Name**: give this connection a meaningful name.
+ - **Hostname**: enter the `host` parameter from the TiDB Cloud connection dialog.
+ - **Port**: enter the `port` parameter from the TiDB Cloud connection dialog.
+ - **Username**: enter the `user` parameter from the TiDB Cloud connection dialog.
+ - **Password**: click **Store in Keychain ...**, enter the password of the TiDB Dedicated cluster, and then click **OK** to store the password.
+
+ ![MySQL Workbench: store the password of TiDB Dedicated in keychain](/media/develop/mysql-workbench-store-dedicated-password-in-keychain.png)
+
+ The following figure shows an example of the connection parameters:
+
+ ![MySQL Workbench: configure connection settings for TiDB Dedicated](/media/develop/mysql-workbench-connection-config-dedicated-parameters.png)
+
+6. Click **Test Connection** to validate the connection to the TiDB Dedicated cluster.
+
+7. If the connection test is successful, you can see the **Successfully made the MySQL connection** message. Click **OK** to save the connection configuration.
+
+</div>
+<div label="TiDB Self-Hosted">
+
+1. Launch MySQL Workbench and click **+** near the **MySQL Connections** title.
+
+ ![MySQL Workbench: add new connection](/media/develop/navicat-add-new-connection.png)
+
+2. In the **Setup New Connection** dialog, configure the following connection parameters:
+
+ - **Connection Name**: give this connection a meaningful name.
+ - **Hostname**: enter the IP address or domain name of your TiDB Self-Hosted cluster.
+ - **Port**: enter the port number of your TiDB Self-Hosted cluster.
+ - **Username**: enter the username to use to connect to your TiDB.
+ - **Password**: click **Store in Keychain ...**, enter the password to use to connect to your TiDB cluster, and then click **OK** to store the password.
+
+ ![MySQL Workbench: store the password of TiDB Self-Hosted in keychain](/media/develop/mysql-workbench-store-self-hosted-password-in-keychain.png)
+
+ The following figure shows an example of the connection parameters:
+
+ ![MySQL Workbench: configure connection settings for TiDB Self-Hosted](/media/develop/mysql-workbench-connection-config-self-hosted-parameters.png)
+
+3. Click **Test Connection** to validate the connection to the TiDB Self-Hosted cluster.
+
+4. If the connection test is successful, you can see the **Successfully made the MySQL connection** message. Click **OK** to save the connection configuration.
+
+</div>
+</SimpleTab>
+
+## Next steps
+
+- Learn more usage of MySQL Workbench from [the documentation of MySQL Workbench](https://dev.mysql.com/doc/workbench/en/).
+- Learn the best practices for TiDB application development with the chapters in the [Developer guide](/develop/dev-guide-overview.md), such as [Insert data](/develop/dev-guide-insert-data.md), [Update data](/develop/dev-guide-update-data.md), [Delete data](/develop/dev-guide-delete-data.md), [Single table reading](/develop/dev-guide-get-data-from-single-table.md), [Transactions](/develop/dev-guide-transaction-overview.md), and [SQL performance optimization](/develop/dev-guide-optimize-sql-overview.md).
+- Learn through the professional [TiDB developer courses](https://www.pingcap.com/education/) and earn [TiDB certifications](https://www.pingcap.com/education/certification/) after passing the exam.
+
+## Need help?
+
+<CustomContent platform="tidb">
+
+Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/support.md).
+
+</CustomContent>
+
+<CustomContent platform="tidb-cloud">
+
+Ask questions on the [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc), or [create a support ticket](/tidb-cloud/tidb-cloud-support.md).
+
+</CustomContent>