Skip to content

Latest commit

 

History

History
115 lines (69 loc) · 6.59 KB

dev-guide-gui-mysql-workbench.md

File metadata and controls

115 lines (69 loc) · 6.59 KB
title summary
Connect to TiDB with MySQL Workbench
Learn how to connect to TiDB using MySQL Workbench.

Connect to TiDB with MySQL Workbench

TiDB is a MySQL-compatible database, and MySQL 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, DBeaver, and VS Code SQLTools. For a complete list of GUI tools that fully supported by TiDB, see Third-party tools supported by TiDB.

In this tutorial, you can learn how to connect to your TiDB cluster using MySQL Workbench.

Prerequisites

To complete this tutorial, you need:

If you don't have a TiDB cluster, you can create one as follows:

If you don't have a TiDB cluster, you can create one as follows:

Connect to TiDB

Connect to your TiDB cluster depending on the TiDB deployment option you have selected.

  1. Navigate to the 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.

    • Connection Type is set to Public.
    • Branch is set to main.
    • Connect With is set to MySQL Workbench.
    • Operating System matches your environment.

  4. Click Generate 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

  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 USERNAME parameter from the TiDB Cloud connection dialog.

    • Password: click Store in Keychain ... or Store in Vault, enter the password of the TiDB Cloud Starter cluster, and then click OK to store the password.

      MySQL Workbench: store the password of TiDB Cloud Starter in keychain

    The following figure shows an example of the connection parameters:

    MySQL Workbench: configure connection settings for TiDB Cloud Starter

  7. Click Test Connection to validate the connection to the TiDB Cloud Starter 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.

FAQs

How to handle the connection timeout error "Error Code: 2013. Lost connection to MySQL server during query"?

This error indicates that the query execution time exceeds the timeout limit. To resolve this issue, you can adjust the timeout settings by the following steps:

  1. Launch MySQL Workbench and navigate to the Workbench Preferences page.

  2. In the SQL Editor > MySQL Session section, configure the DBMS connection read timeout interval (in seconds) option. This sets the maximum amount of time (in seconds) that a query can take before MySQL Workbench disconnects from the server.

    MySQL Workbench: adjust timeout option in SQL Editor settings

For more information, see MySQL Workbench frequently asked questions.

Next steps

Need help?

Ask the community on Discord or Slack, or submit a support ticket.

Ask the community on Discord or Slack, or submit a support ticket.