Skip to content

Latest commit

 

History

History
179 lines (104 loc) · 8.59 KB

dev-guide-gui-dbeaver.md

File metadata and controls

179 lines (104 loc) · 8.59 KB
title summary
Connect to TiDB with DBeaver
Learn how to connect to TiDB using DBeaver Community.

Connect to TiDB with DBeaver

TiDB is a MySQL-compatible database, and DBeaver Community is a free cross-platform database tool for developers, database administrators, analysts, and everyone working with data.

In this tutorial, you can learn how to connect to your TiDB cluster using DBeaver Community.

Note:

This tutorial is compatible with TiDB Cloud Serverless, TiDB Cloud Dedicated, and TiDB Self-Managed.

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've 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 DBeaver
    • 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 DBeaver and click New Database Connection in the upper-left corner. In the Connect to a database dialog, select TiDB from the list, and then click Next.

    Select TiDB as the database in DBeaver

  6. Copy the connection string from the TiDB Cloud connection dialog. In DBeaver, select URL for Connect by and paste the connection string into the URL field.

  7. In the Authentication (Database Native) section, enter your Username and Password. An example is as follows:

    Configure connection settings for TiDB Cloud Serverless

  8. Click Test Connection to validate the connection to the TiDB Cloud Serverless cluster.

    If the Download driver files dialog is displayed, click Download to get the driver files.

    Download driver files

    If the connection test is successful, the Connection test dialog is displayed as follows. Click OK to close it.

    Connection test result

  9. Click Finish to save the connection configuration.

  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. In the connection dialog, select Public from the Connection Type drop-down list, and then click CA cert to download the CA certificate.

    If you have not configured the IP access list, click Configure IP Access List or follow the steps in Configure an IP Access List to configure it before your first connection.

    In addition to the Public connection type, TiDB Dedicated supports Private Endpoint and VPC Peering connection types. For more information, see Connect to Your TiDB Dedicated Cluster.

  4. Launch DBeaver and click New Database Connection in the upper-left corner. In the Connect to a database dialog, select TiDB from the list, and then click Next.

    Select TiDB as the database in DBeaver

  5. Copy and paste the appropriate connection string into the DBeaver connection panel. The mappings between DBeaver fields and TiDB Cloud Dedicated connection string are as follows:

    DBeaver field TiDB Cloud Dedicated connection string
    Server Host {host}
    Port {port}
    Username {user}
    Password {password}

    An example is as follows:

    Configure connection settings for TiDB Cloud Dedicated

  6. Click Test Connection to validate the connection to the TiDB Cloud Dedicated cluster.

    If the Download driver files dialog is displayed, click Download to get the driver files.

    Download driver files

    If the connection test is successful, the Connection test dialog is displayed as follows. Click OK to close it.

    Connection test result

  7. Click Finish to save the connection configuration.

  1. Launch DBeaver and click New Database Connection in the upper-left corner. In the Connect to a database dialog, select TiDB from the list, and then click Next.

    Select TiDB as the database in DBeaver

  2. Configure the following connection parameters:

    • Server Host: The IP address or domain name of your TiDB Self-Managed cluster.
    • Port: The port number of your TiDB Self-Managed cluster.
    • Username: The username to use to connect to your TiDB Self-Managed cluster.
    • Password: The password of the username.

    An example is as follows:

    Configure connection settings for TiDB Self-Managed

  3. Click Test Connection to validate the connection to the TiDB Self-Managed cluster.

    If the Download driver files dialog is displayed, click Download to get the driver files.

    Download driver files

    If the connection test is successful, the Connection test dialog is displayed as follows. Click OK to close it.

    Connection test result

  4. Click Finish to save the connection configuration.

Next steps

Need help?

Ask questions on TiDB Community, or create a support ticket.

Ask questions on TiDB Community, or create a support ticket.