-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Preview PR pingcap/docs#19412 and this preview is triggered from commit
- Loading branch information
Docsite Preview Bot
committed
Nov 22, 2024
1 parent
82e8877
commit 6015ea0
Showing
35 changed files
with
10,710 additions
and
0 deletions.
There are no files selected for viewing
190 changes: 190 additions & 0 deletions
190
markdown-pages/en/tidb/master/develop/dev-guide-gui-datagrip.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| --- | ||
| title: Connect to TiDB with JetBrains DataGrip | ||
| summary: Learn how to connect to TiDB using JetBrains DataGrip. This tutorial also applies to the Database Tools and SQL plugin available in other JetBrains IDEs, such as IntelliJ, PhpStorm, and PyCharm. | ||
| --- | ||
|
|
||
| # Connect to TiDB with JetBrains DataGrip | ||
|
|
||
| TiDB is a MySQL-compatible database, and [JetBrains DataGrip](https://www.jetbrains.com/help/datagrip/getting-started.html) is a powerful integrated development environment (IDE) for database and SQL. This tutorial walks you through the process of connecting to your TiDB cluster using DataGrip. | ||
|
|
||
| > **Note:** | ||
| > | ||
| > This tutorial is compatible with TiDB Cloud Serverless, TiDB Cloud Dedicated, and TiDB Self-Managed. | ||
| You can use DataGrip in two ways: | ||
|
|
||
| - As the [DataGrip IDE](https://www.jetbrains.com/datagrip/download) standalone tool. | ||
| - As the [Database Tools and SQL plugin](https://www.jetbrains.com/help/idea/relational-databases.html) in JetBrains IDEs, such as IntelliJ, PhpStorm, and PyCharm. | ||
|
|
||
| This tutorial mainly focuses on the standalone DataGrip IDE. The steps of connecting to TiDB using the JetBrains Database Tools and SQL plugin in JetBrains IDEs are similar. You can also follow the steps in this document for reference when connecting to TiDB from any JetBrains IDE. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| To complete this tutorial, you need: | ||
|
|
||
| - [DataGrip **2023.2.1** or later](https://www.jetbrains.com/datagrip/download/) or a non-community edition [JetBrains](https://www.jetbrains.com/) IDE. | ||
| - 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 Cloud 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) 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 Cloud 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've selected. | ||
|
|
||
| <SimpleTab> | ||
| <div label="TiDB Cloud 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. | ||
|
|
||
| - **Connection Type** is set to `Public` | ||
| - **Branch** is set to `main` | ||
| - **Connect With** is set to `DataGrip` | ||
| - **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 DataGrip and create a project to manage your connections. | ||
|
|
||
|  | ||
|
|
||
| 6. In the newly created project, click **+** in the upper-left corner of the **Database Explorer** panel, and select **Data Source** > **Other** > **TiDB**. | ||
|
|
||
|  | ||
|
|
||
| 7. Copy the connection string from the TiDB Cloud connection dialog. Then, paste it into the **URL** field, and the remaining parameters will be auto-populated. An example result is as follows: | ||
|
|
||
|  | ||
|
|
||
| If a **Download missing driver files** warning displays, click **Download** to acquire the driver files. | ||
|
|
||
| 8. Click **Test Connection** to validate the connection to the TiDB Cloud Serverless cluster. | ||
|
|
||
|  | ||
|
|
||
| 9. Click **OK** to save the connection configuration. | ||
|
|
||
| </div> | ||
| <div label="TiDB Cloud 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. 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](https://docs.pingcap.com/tidbcloud/configure-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](https://docs.pingcap.com/tidbcloud/connect-to-tidb-cluster). | ||
|
|
||
| 4. Launch DataGrip and create a project to manage your connections. | ||
|
|
||
|  | ||
|
|
||
| 5. In the newly created project, click **+** in the upper-left corner of the **Database Explorer** panel, and select **Data Source** > **Other** > **TiDB**. | ||
|
|
||
|  | ||
|
|
||
| 6. Copy and paste the appropriate connection string into the **Data Source and Drivers** window in DataGrip. The mappings between DataGrip fields and TiDB Cloud Dedicated connection string are as follows: | ||
|
|
||
| | DataGrip field | TiDB Cloud Dedicated connection string | | ||
| | -------------- | ------------------------------- | | ||
| | Host | `{host}` | | ||
| | Port | `{port}` | | ||
| | User | `{user}` | | ||
| | Password | `{password}` | | ||
|
|
||
| An example is as follows: | ||
|
|
||
|  | ||
|
|
||
| 7. Click the **SSH/SSL** tab, select the **Use SSL** checkbox, and input the CA certificate path into the **CA file** field. | ||
|
|
||
|  | ||
|
|
||
| If a **Download missing driver files** warning displays, click **Download** to acquire the driver files. | ||
|
|
||
| 8. Click the **Advanced** tab, scroll to find the **enabledTLSProtocols** parameter, and set its value to `TLSv1.2,TLSv1.3`. | ||
|
|
||
|  | ||
|
|
||
| 9. Click **Test Connection** to validate the connection to the TiDB Cloud Dedicated cluster. | ||
|
|
||
|  | ||
|
|
||
| 10. Click **OK** to save the connection configuration. | ||
|
|
||
| </div> | ||
| <div label="TiDB Self-Managed"> | ||
|
|
||
| 1. Launch DataGrip and create a project to manage your connections. | ||
|
|
||
|  | ||
|
|
||
| 2. In the newly created project, click **+** in the upper-left corner of the **Database Explorer** panel, and select **Data Source** > **Other** > **TiDB**. | ||
|
|
||
|  | ||
|
|
||
| 3. Configure the following connection parameters: | ||
|
|
||
| - **Host**: The IP address or domain name of your TiDB Self-Managed cluster. | ||
| - **Port**: The port number of your TiDB Self-Managed cluster. | ||
| - **User**: The username to use to connect to your TiDB Self-Managed cluster. | ||
| - **Password**: The password of the username. | ||
|
|
||
| An example is as follows: | ||
|
|
||
|  | ||
|
|
||
| If a **Download missing driver files** warning displays, click **Download** to acquire the driver files. | ||
|
|
||
| 4. Click **Test Connection** to validate the connection to the TiDB Self-Managed cluster. | ||
|
|
||
|  | ||
|
|
||
| 5. Click **OK** to save the connection configuration. | ||
|
|
||
| </div> | ||
| </SimpleTab> | ||
|
|
||
| ## Next steps | ||
|
|
||
| - Learn more usage of DataGrip from [the documentation of DataGrip](https://www.jetbrains.com/help/datagrip/getting-started.html). | ||
| - 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 [TiDB Community](https://ask.pingcap.com/), or [create a support ticket](/support.md). | ||
|
|
||
| </CustomContent> | ||
|
|
||
| <CustomContent platform="tidb-cloud"> | ||
|
|
||
| Ask questions on [TiDB Community](https://ask.pingcap.com/), or [create a support ticket](https://support.pingcap.com/). | ||
|
|
||
| </CustomContent> |
179 changes: 179 additions & 0 deletions
179
markdown-pages/en/tidb/master/develop/dev-guide-gui-dbeaver.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| --- | ||
| title: Connect to TiDB with DBeaver | ||
| summary: Learn how to connect to TiDB using DBeaver Community. | ||
| --- | ||
|
|
||
| # Connect to TiDB with DBeaver | ||
|
|
||
| TiDB is a MySQL-compatible database, and [DBeaver Community](https://dbeaver.io/download/) 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: | ||
|
|
||
| - [DBeaver Community **23.0.3** or higher](https://dbeaver.io/download/). | ||
| - 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 Cloud 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) 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 Cloud 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've selected. | ||
|
|
||
| <SimpleTab> | ||
| <div label="TiDB Cloud 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. | ||
|
|
||
| - **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**. | ||
|
|
||
|  | ||
|
|
||
| 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: | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| If the connection test is successful, the **Connection test** dialog is displayed as follows. Click **OK** to close it. | ||
|
|
||
|  | ||
|
|
||
| 9. Click **Finish** to save the connection configuration. | ||
|
|
||
| </div> | ||
| <div label="TiDB Cloud 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. 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](https://docs.pingcap.com/tidbcloud/configure-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](https://docs.pingcap.com/tidbcloud/connect-to-tidb-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**. | ||
|
|
||
|  | ||
|
|
||
| 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: | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| If the connection test is successful, the **Connection test** dialog is displayed as follows. Click **OK** to close it. | ||
|
|
||
|  | ||
|
|
||
| 7. Click **Finish** to save the connection configuration. | ||
|
|
||
| </div> | ||
| <div label="TiDB Self-Managed"> | ||
|
|
||
| 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**. | ||
|
|
||
|  | ||
|
|
||
| 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: | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| If the connection test is successful, the **Connection test** dialog is displayed as follows. Click **OK** to close it. | ||
|
|
||
|  | ||
|
|
||
| 4. Click **Finish** to save the connection configuration. | ||
|
|
||
| </div> | ||
| </SimpleTab> | ||
|
|
||
| ## Next steps | ||
|
|
||
| - Learn more usage of DBeaver from [the documentation of DBeaver](https://github.com/dbeaver/dbeaver/wiki). | ||
| - 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 [TiDB Community](https://ask.pingcap.com/), or [create a support ticket](/support.md). | ||
|
|
||
| </CustomContent> | ||
|
|
||
| <CustomContent platform="tidb-cloud"> | ||
|
|
||
| Ask questions on [TiDB Community](https://ask.pingcap.com/), or [create a support ticket](https://support.pingcap.com/). | ||
|
|
||
| </CustomContent> |
Oops, something went wrong.