Skip to content

develop: revise TiDB Cloud Premium connection steps #22619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Oreoxmt merged 1 commit into from
Mar 25, 2026
Merged

develop: revise TiDB Cloud Premium connection steps #22619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 23 additions & 25 deletions develop/dev-guide-gui-datagrip.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,46 +78,44 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
</div>
<div label="{{{ .premium }}}">

1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target instance to go to its overview page.
1. Navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page, and then click the name of your target instance to go to its overview page.

2. In the left panel, click **Settings**, and then click **Networking**.
2. In the left navigation pane, click **Settings** > **Networking**.

3. In the **Public Endpoint** section, click **Enable**. Wait a few minutes until the public endpoint is enabled.

4. Click **Overview** in the left panel to return to the overview page.

5. Click **Connect** in the upper-right corner. A connection dialog is displayed. In the connection dialog, select `Public` from the **Connection Type** drop-down list.

If you see a message indicating that the public endpoint is still being enabled, wait until it is enabled.

6. Click **Configure IP Access List** to configure an IP access list.
3. On the **Networking** page, click **Enable** for **Public Endpoint**, and then click **Add IP Address**.

Ensure that your client IP address is in the access list.

7. (Optional) If you need to verify the server certificate or if the connection fails and you are prompted for a CA certificate, click **CA cert** to download the CA certificate.
4. In the left navigation pane, click **Overview** to return to the instance overview page.

If you have not set the password yet, click **Set Root Password** in the dialog.
5. Click **Connect** in the upper-right corner. A connection dialog is displayed.

In addition to the **Public** connection type, {{{ .premium }}} supports **Private Endpoint** connection types. For more information, see [Connect to {{{ .premium }}} via AWS PrivateLink](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md).
6. In the connection dialog, select **Public** from the **Connection Type** drop-down list.

8. Launch DataGrip and create a project to manage your connections.
- If a message indicates that the public endpoint is still being enabled, wait until the process completes.
- If you have not set a password yet, click **Set Root Password** in the dialog.
- If you need to verify the server certificate or if the connection fails and a CA certificate is required, click **CA cert** to download it.
- In addition to the **Public** connection type, {{{ .premium }}} supports **Private Endpoint** connections. For more information, see [Connect to {{{ .premium }}} via AWS PrivateLink](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md).

9. In the newly created project, click **+** in the upper-left corner of the **Database Explorer** panel, and select **Data Source** > **Other** > **TiDB**.
7. Launch DataGrip and create a project to manage your connections.

10. Configure the following connection parameters based on the connection dialog:
8. In the newly created project, click **+** in the upper-left corner of the **Database Explorer** panel, and select **Data Source** > **Other** > **TiDB**.

- **Host**: `{host}`
- **Port**: `{port}`
- **User**: `{user}`
- **Password**: `{password}`
9. Copy and paste the appropriate connection string into the **Data Source and Drivers** window in DataGrip. The mappings between DataGrip fields and {{{ .premium }}} connection string are as follows:

Keep **Use SSL** cleared.
| DataGrip field | {{{ .premium }}} connection string |
| -------------- | ------------------------------- |
| Host | `{host}` |
| Port | `{port}` |
| User | `{user}` |
| Password | `{password}` |

If a **Download missing driver files** warning displays, click **Download** to acquire the driver files.
- On the **SSH/SSL** tab, clear the **Use SSL** checkbox.
- If a **Download missing driver files** warning displays, click **Download** to acquire the driver files.

11. Click **Test Connection** to validate the connection to the {{{ .premium }}} instance.
10. Click **Test Connection** to validate the connection to the {{{ .premium }}} instance.

12. Click **OK** to save the connection configuration.
11. Click **OK** to save the connection configuration.

</div>
<div label="TiDB Cloud Dedicated">
Expand Down
43 changes: 21 additions & 22 deletions develop/dev-guide-gui-dbeaver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,42 +89,41 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
</div>
<div label="{{{ .premium }}}">

1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target instance to go to its overview page.
1. Navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page, and then click the name of your target instance to go to its overview page.

2. In the left panel, click **Settings**, and then click **Networking**.
2. In the left navigation pane, click **Settings** > **Networking**.

3. In the **Public Endpoint** section, click **Enable**. Wait a few minutes until the public endpoint is enabled.

4. Click **Overview** in the left panel to return to the overview page.

5. Click **Connect** in the upper-right corner. A connection dialog is displayed. In the connection dialog, select `Public` from the **Connection Type** drop-down list.

If you see a message indicating that the public endpoint is still being enabled, wait until it is enabled.

6. Click **Configure IP Access List** to configure an IP access list.
3. On the **Networking** page, click **Enable** for **Public Endpoint**, and then click **Add IP Address**.

Ensure that your client IP address is in the access list.

7. (Optional) If you need to verify the server certificate or if the connection fails and you are prompted for a CA certificate, click **CA cert** to download the CA certificate.
4. In the left navigation pane, click **Overview** to return to the instance overview page.

5. Click **Connect** in the upper-right corner. A connection dialog is displayed.

If you have not set the password yet, click **Set Root Password** in the dialog.
6. In the connection dialog, select **Public** from the **Connection Type** drop-down list.

In addition to the **Public** connection type, {{{ .premium }}} supports **Private Endpoint** connection types. For more information, see [Connect to {{{ .premium }}} via AWS PrivateLink](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md).
- If a message indicates that the public endpoint is still being enabled, wait until the process completes.
- If you have not set a password yet, click **Set Root Password** in the dialog.
- If you need to verify the server certificate or if the connection fails and a CA certificate is required, click **CA cert** to download it.
- In addition to the **Public** connection type, {{{ .premium }}} supports **Private Endpoint** connections. For more information, see [Connect to {{{ .premium }}} via AWS PrivateLink](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md).

8. 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**.
7. 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**.

9. Configure the following connection parameters based on the connection dialog:
8. Copy and paste the appropriate connection string into the DBeaver connection panel. The mappings between DBeaver fields and {{{ .premium }}} connection string are as follows:

- **Server Host**: `{host}`
- **Port**: `{port}`
- **Username**: `{user}`
- **Password**: `{password}`
| DBeaver field | {{{ .premium }}} connection string |
|---------------| ------------------------------- |
| Server Host | `{host}` |
| Port | `{port}` |
| Username | `{user}` |
| Password | `{password}` |

Keep the SSL settings disabled.

10. Click **Test Connection** to validate the connection.
9. Click **Test Connection** to validate the connection to the {{{ .premium }}} instance.

11. Click **Finish** to save the connection configuration.
10. Click **Finish** to save the connection configuration.

</div>
<div label="TiDB Cloud Dedicated">
Expand Down
39 changes: 18 additions & 21 deletions develop/dev-guide-gui-mysql-workbench.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,41 +80,38 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se
</div>
<div label="{{{ .premium }}}">

1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target instance to go to its overview page.
1. Navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page, and then click the name of your target instance to go to its overview page.

2. In the left panel, click **Settings**, and then click **Networking**.
2. In the left navigation pane, click **Settings** > **Networking**.

3. In the **Public Endpoint** section, click **Enable**. Wait a few minutes until the public endpoint is enabled.

4. Click **Overview** in the left panel to return to the overview page.

5. Click **Connect** in the upper-right corner. A connection dialog is displayed. In the connection dialog, select `Public` from the **Connection Type** drop-down list.

If you see a message indicating that the public endpoint is still being enabled, wait until it is enabled.

6. Click **Configure IP Access List** to configure an IP access list.
3. On the **Networking** page, click **Enable** for **Public Endpoint**, and then click **Add IP Address**.

Ensure that your client IP address is in the access list.

7. (Optional) If you need to verify the server certificate or if the connection fails and you are prompted for a CA certificate, click **CA cert** to download the CA certificate.
4. In the left navigation pane, click **Overview** to return to the instance overview page.

If you have not set the password yet, click **Set Root Password** in the dialog.
5. Click **Connect** in the upper-right corner. A connection dialog is displayed.

In addition to the **Public** connection type, {{{ .premium }}} supports **Private Endpoint** connection types. For more information, see [Connect to {{{ .premium }}} via AWS PrivateLink](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md).
6. In the connection dialog, select **Public** from the **Connection Type** drop-down list.

8. Launch MySQL Workbench and click **+** near the **MySQL Connections** title.
- If a message indicates that the public endpoint is still being enabled, wait until the process completes.
- If you have not set a password yet, click **Set Root Password** in the dialog.
- If you need to verify the server certificate or if the connection fails and a CA certificate is required, click **CA cert** to download it.
- In addition to the **Public** connection type, {{{ .premium }}} supports **Private Endpoint** connections. For more information, see [Connect to {{{ .premium }}} via AWS PrivateLink](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md).

9. In the **Setup New Connection** dialog, configure the following connection parameters:
7. Launch MySQL Workbench and click **+** near the **MySQL Connections** title.

8. 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 connection dialog.
- **Port**: enter the `PORT` parameter from the connection dialog.
- **Username**: enter the `USERNAME` parameter from the connection dialog.
- **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 {{{ .premium }}} instance, and then click **OK** to store the password.

10. Click **Test Connection** to validate the connection.
9. Click **Test Connection** to validate the connection to the {{{ .premium }}} instance.

11. If the connection test is successful, you can see the **Successfully made the MySQL connection** message. Click **OK** to save the connection configuration.
10. 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 Cloud Dedicated">
Expand Down
41 changes: 19 additions & 22 deletions develop/dev-guide-gui-navicat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,43 +76,40 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se
</div>
<div label="{{{ .premium }}}">

1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target instance to go to its overview page.
1. Navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page, and then click the name of your target instance to go to its overview page.

2. In the left panel, click **Settings**, and then click **Networking**.
2. In the left navigation pane, click **Settings** > **Networking**.

3. In the **Public Endpoint** section, click **Enable**. Wait a few minutes until the public endpoint is enabled.

4. Click **Overview** in the left panel to return to the overview page.

5. Click **Connect** in the upper-right corner. A connection dialog is displayed. In the connection dialog, select `Public` from the **Connection Type** drop-down list.

If you see a message indicating that the public endpoint is still being enabled, wait until it is enabled.

6. Click **Configure IP Access List** to configure an IP access list.
3. On the **Networking** page, click **Enable** for **Public Endpoint**, and then click **Add IP Address**.

Ensure that your client IP address is in the access list.

7. (Optional) If you need to verify the server certificate or if the connection fails and you are prompted for a CA certificate, click **CA cert** to download the CA certificate.
4. In the left navigation pane, click **Overview** to return to the instance overview page.

If you have not set the password yet, click **Set Root Password** in the dialog.
5. Click **Connect** in the upper-right corner. A connection dialog is displayed.

In addition to the **Public** connection type, {{{ .premium }}} supports **Private Endpoint** connection types. For more information, see [Connect to {{{ .premium }}} via AWS PrivateLink](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md).
6. In the connection dialog, select **Public** from the **Connection Type** drop-down list.

8. Launch Navicat Premium, click **Connection** in the upper-left corner, select **PingCAP** from the **Vendor Filter** list, and double-click **TiDB** in the right panel.
- If a message indicates that the public endpoint is still being enabled, wait until the process completes.
- If you have not set a password yet, click **Set Root Password** in the dialog.
- If you need to verify the server certificate or if the connection fails and a CA certificate is required, click **CA cert** to download it.
- In addition to the **Public** connection type, {{{ .premium }}} supports **Private Endpoint** connections. For more information, see [Connect to {{{ .premium }}} via AWS PrivateLink](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md).

9. In the **New Connection (TiDB)** dialog, configure the following connection parameters:
7. Launch Navicat Premium, click **Connection** in the upper-left corner, select **PingCAP** from the **Vendor Filter** list, and double-click **TiDB** in the right panel.

8. In the **New Connection (TiDB)** dialog, configure the following connection parameters:

- **Connection Name**: give this connection a meaningful name.
- **Host**: enter the `HOST` parameter from the connection dialog.
- **Port**: enter the `PORT` parameter from the connection dialog.
- **User Name**: enter the `USERNAME` parameter from the connection dialog.
- **Host**: enter the `HOST` parameter from the TiDB Cloud connection dialog.
- **Port**: enter the `PORT` parameter from the TiDB Cloud connection dialog.
- **User Name**: enter the `USERNAME` parameter from the TiDB Cloud connection dialog.
- **Password**: enter the password of the {{{ .premium }}} instance.

10. Click the **SSL** tab and ensure **Use SSL** is cleared.
9. Click the **SSL** tab and clear the **Use SSL** checkbox.

11. Click **Test Connection** to validate the connection.
10. Click **Test Connection** to validate the connection to the {{{ .premium }}} instance.

12. If the connection test is successful, you can see the **Connection Successful** message. Click **OK** to finish the connection configuration.
11. If the connection test is successful, you can see the **Connection Successful** message. Click **OK** to finish the connection configuration.

</div>
<div label="TiDB Cloud Dedicated">
Expand Down
Loading
Loading