From 11edf2d08ef1d940cc50c9222d33989373fd48fc Mon Sep 17 00:00:00 2001 From: Cheese Date: Thu, 5 Mar 2026 16:31:20 +0800 Subject: [PATCH 1/5] feat: develop document for tidb cloud premium --- develop/dev-guide-gui-datagrip.md | 46 +++++++++++++- develop/dev-guide-gui-dbeaver.md | 42 ++++++++++++- develop/dev-guide-gui-mysql-workbench.md | 41 ++++++++++++- develop/dev-guide-gui-navicat.md | 43 ++++++++++++- develop/dev-guide-gui-vscode-sqltools.md | 48 ++++++++++++++- ...dev-guide-sample-application-aws-lambda.md | 54 ++++++++++++++-- ...ev-guide-sample-application-golang-gorm.md | 48 ++++++++++++++- ...de-sample-application-golang-sql-driver.md | 48 ++++++++++++++- ...guide-sample-application-java-hibernate.md | 48 ++++++++++++++- .../dev-guide-sample-application-java-jdbc.md | 50 ++++++++++++++- ...v-guide-sample-application-java-mybatis.md | 48 ++++++++++++++- ...ide-sample-application-java-spring-boot.md | 48 ++++++++++++++- .../dev-guide-sample-application-nextjs.md | 61 ++++++++++++++++++- ...-guide-sample-application-nodejs-mysql2.md | 46 +++++++++++++- ...guide-sample-application-nodejs-mysqljs.md | 46 +++++++++++++- ...-guide-sample-application-nodejs-prisma.md | 50 ++++++++++++++- ...ide-sample-application-nodejs-sequelize.md | 47 +++++++++++++- ...guide-sample-application-nodejs-typeorm.md | 46 +++++++++++++- ...-guide-sample-application-python-django.md | 47 +++++++++++++- ...mple-application-python-mysql-connector.md | 47 +++++++++++++- ...e-sample-application-python-mysqlclient.md | 48 ++++++++++++++- ...-guide-sample-application-python-peewee.md | 47 +++++++++++++- ...guide-sample-application-python-pymysql.md | 47 +++++++++++++- ...de-sample-application-python-sqlalchemy.md | 47 +++++++++++++- ...ev-guide-sample-application-ruby-mysql2.md | 46 +++++++++++++- ...dev-guide-sample-application-ruby-rails.md | 41 ++++++++++++- 26 files changed, 1198 insertions(+), 32 deletions(-) diff --git a/develop/dev-guide-gui-datagrip.md b/develop/dev-guide-gui-datagrip.md index cab767e4b3dbd..523619197f155 100644 --- a/develop/dev-guide-gui-datagrip.md +++ b/develop/dev-guide-gui-datagrip.md @@ -10,7 +10,7 @@ TiDB is a MySQL-compatible database, and [JetBrains DataGrip](https://www.jetbra > **Note:** > -> This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. You can use DataGrip in two ways: @@ -75,6 +75,50 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 9. Click **OK** to save the connection configuration. + +
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Launch DataGrip and create a project to manage your connections. + +9. In the newly created project, click **+** in the upper-left corner of the **Database Explorer** panel, and select **Data Source** > **Other** > **TiDB**. + +10. Configure the following connection parameters based on the connection dialog: + + - **Host**: `{host}` + - **Port**: `{port}` + - **User**: `{user}` + - **Password**: `{password}` + + Keep **Use SSL** cleared. + + 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. + +12. Click **OK** to save the connection configuration. +
diff --git a/develop/dev-guide-gui-dbeaver.md b/develop/dev-guide-gui-dbeaver.md index f0bfe56720eda..7234bfda2010e 100644 --- a/develop/dev-guide-gui-dbeaver.md +++ b/develop/dev-guide-gui-dbeaver.md @@ -12,7 +12,7 @@ In this tutorial, you can learn how to connect to TiDB using DBeaver Community. > **Note:** > -> This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -86,6 +86,46 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 9. Click **Finish** to save the connection configuration. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +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**. + +9. Configure the following connection parameters based on the connection dialog: + + - **Server Host**: `{host}` + - **Port**: `{port}` + - **Username**: `{user}` + - **Password**: `{password}` + + Keep the SSL settings disabled. + +10. Click **Test Connection** to validate the connection. + +11. Click **Finish** to save the connection configuration. +
diff --git a/develop/dev-guide-gui-mysql-workbench.md b/develop/dev-guide-gui-mysql-workbench.md index ea93a8f5d0116..44e69e41c3461 100644 --- a/develop/dev-guide-gui-mysql-workbench.md +++ b/develop/dev-guide-gui-mysql-workbench.md @@ -17,7 +17,7 @@ In this tutorial, you can learn how to connect to TiDB using MySQL Workbench. > **Note:** > -> This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -77,6 +77,45 @@ Connect to TiDB depending on the TiDB deployment option you have selected. 8. If the connection test is successful, you can see the **Successfully made the MySQL connection** message. Click **OK** to save the connection configuration. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Launch MySQL Workbench and click **+** near the **MySQL Connections** title. + +9. 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. + - **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. + +11. If the connection test is successful, you can see the **Successfully made the MySQL connection** message. Click **OK** to save the connection configuration. +
diff --git a/develop/dev-guide-gui-navicat.md b/develop/dev-guide-gui-navicat.md index 20701071e3ac1..3e9e1ec161f4c 100644 --- a/develop/dev-guide-gui-navicat.md +++ b/develop/dev-guide-gui-navicat.md @@ -12,7 +12,7 @@ In this tutorial, you can learn how to connect to TiDB using Navicat. > **Note:** > -> This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -73,6 +73,47 @@ Connect to TiDB depending on the TiDB deployment option you have selected. 9. If the connection test is successful, you can see the **Connection Successful** message. Click **OK** to finish the connection configuration. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +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. + +9. 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. + - **Password**: enter the password of the {{{ .premium }}} instance. + +10. Click the **SSL** tab and ensure **Use SSL** is cleared. + +11. Click **Test Connection** to validate the connection. + +12. If the connection test is successful, you can see the **Connection Successful** message. Click **OK** to finish the connection configuration. +
diff --git a/develop/dev-guide-gui-vscode-sqltools.md b/develop/dev-guide-gui-vscode-sqltools.md index 0e1a459fa770a..dda0b661d3f5f 100644 --- a/develop/dev-guide-gui-vscode-sqltools.md +++ b/develop/dev-guide-gui-vscode-sqltools.md @@ -12,7 +12,7 @@ In this tutorial, you can learn how to connect to TiDB using Visual Studio Code. > **Note:** > -> - This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> - This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. > - This tutorial also works with Visual Studio Code Remote Development environments, such as [GitHub Codespaces](https://github.com/features/codespaces), [Visual Studio Code Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers), and [Visual Studio Code WSL](https://code.visualstudio.com/docs/remote/wsl). ## Prerequisites @@ -93,6 +93,52 @@ Connect to TiDB depending on the TiDB deployment option you have selected. 8. If the connection test is successful, you can see the **Successfully connected!** message. Click **SAVE CONNECTION** to save the connection configuration. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Launch VS Code and select the **SQLTools** extension on the navigation pane. Under the **CONNECTIONS** section, click **Add New Connection** and select **TiDB** as the database driver. + +9. In the setting pane, configure the following connection parameters based on the connection dialog: + + - **Connect using**: select **Server and Port**. + - **Server Address**: `{host}` + - **Port**: `{port}` + - **Database**: the database that you want to connect to. + - **Username**: `{user}` + - **Password mode**: select **SQLTools Driver Credentials**. + - In the **MySQL driver specific options** area, configure the following parameters: + + - **Authentication Protocol**: select **default**. + - **SSL**: select **Disabled**. + +10. Click **TEST CONNECTION** to validate the connection. + +11. In the **SQLTools Driver Credentials** dialog, enter the password. + +12. If the connection test is successful, click **SAVE CONNECTION** to save the connection configuration. +
diff --git a/develop/dev-guide-sample-application-aws-lambda.md b/develop/dev-guide-sample-application-aws-lambda.md index a7652332d4138..86b1d925c3791 100644 --- a/develop/dev-guide-sample-application-aws-lambda.md +++ b/develop/dev-guide-sample-application-aws-lambda.md @@ -17,7 +17,7 @@ In this tutorial, you can learn how to use TiDB and mysql2 in AWS Lambda Functio > **Note** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, and TiDB Self-Managed. ## Prerequisites @@ -99,7 +99,50 @@ Connect to TiDB depending on the TiDB deployment option you've selected. "TIDB_HOST": "{gateway-region}.aws.tidbcloud.com", "TIDB_PORT": "4000", "TIDB_USER": "{prefix}.root", - "TIDB_PASSWORD": "{password}" + "TIDB_PASSWORD": "{password}", + "TIDB_ENABLE_SSL": "true" + } + } + ``` + + Replace the placeholders in `{}` with the values obtained in the connection dialog. + +
+ +
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Copy and paste the corresponding connection string into `env.json`. The following is an example: + + ```json + { + "Parameters": { + "TIDB_HOST": "{host}", + "TIDB_PORT": "4000", + "TIDB_USER": "root", + "TIDB_PASSWORD": "{password}", + "TIDB_ENABLE_SSL": "false" } } ``` @@ -118,7 +161,8 @@ Copy and paste the corresponding connection string into `env.json`. The followin "TIDB_HOST": "{tidb_server_host}", "TIDB_PORT": "4000", "TIDB_USER": "root", - "TIDB_PASSWORD": "{password}" + "TIDB_PASSWORD": "{password}", + "TIDB_ENABLE_SSL": "false" } } ``` @@ -273,10 +317,10 @@ function connect() { user: process.env.TIDB_USER, // TiDB user, for example: {prefix}.root password: process.env.TIDB_PASSWORD, // TiDB password database: process.env.TIDB_DATABASE || 'test', // TiDB database name, default: test - ssl: { + ssl: process.env.TIDB_ENABLE_SSL === 'true' ? { minVersion: 'TLSv1.2', rejectUnauthorized: true, - }, + } : null, connectionLimit: 1, // Setting connectionLimit to "1" in a serverless function environment optimizes resource usage, reduces costs, ensures connection stability, and enables seamless scalability. maxIdle: 1, // max idle connections, the default value is the same as `connectionLimit` enableKeepAlive: true, diff --git a/develop/dev-guide-sample-application-golang-gorm.md b/develop/dev-guide-sample-application-golang-gorm.md index db36328af1fa7..aa6f2a5ee287a 100644 --- a/develop/dev-guide-sample-application-golang-gorm.md +++ b/develop/dev-guide-sample-application-golang-gorm.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and GORM to accomplish the follo > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -95,6 +95,52 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + USE_SSL='false' + ``` + + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. + +10. Save the `.env` file. +
diff --git a/develop/dev-guide-sample-application-golang-sql-driver.md b/develop/dev-guide-sample-application-golang-sql-driver.md index fe5b55ef56fb2..cb8971a6fd653 100644 --- a/develop/dev-guide-sample-application-golang-sql-driver.md +++ b/develop/dev-guide-sample-application-golang-sql-driver.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and Go-MySQL-Driver to accomplis > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -95,6 +95,52 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + USE_SSL='false' + ``` + + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. + +10. Save the `.env` file. +
diff --git a/develop/dev-guide-sample-application-java-hibernate.md b/develop/dev-guide-sample-application-java-hibernate.md index d92dbc46b1e45..eae6f6f7f6956 100644 --- a/develop/dev-guide-sample-application-java-hibernate.md +++ b/develop/dev-guide-sample-application-java-hibernate.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and Hibernate to accomplish the > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -96,6 +96,52 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `env.sh` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `env.sh.example` and rename it to `env.sh`: + + ```shell + cp env.sh.example env.sh + ``` + +9. Copy and paste the corresponding connection string into the `env.sh` file. The example result is as follows: + + ```shell + export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + export TIDB_PORT='4000' + export TIDB_USER='{user}' # e.g. root + export TIDB_PASSWORD='{password}' + export TIDB_DB_NAME='test' + export USE_SSL='false' + ``` + + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. + +10. Save the `env.sh` file. +
diff --git a/develop/dev-guide-sample-application-java-jdbc.md b/develop/dev-guide-sample-application-java-jdbc.md index fd29e4c7b50fc..04243aad7edcf 100644 --- a/develop/dev-guide-sample-application-java-jdbc.md +++ b/develop/dev-guide-sample-application-java-jdbc.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and JDBC to accomplish the follo > **Note:** > -> - This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> - This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. > - Starting from TiDB v7.4, if `connectionCollation` is not configured, and `characterEncoding` is either not configured or set to `UTF-8` in the JDBC URL, the collation used in a JDBC connection depends on the JDBC driver version. For more information, see [Collation used in JDBC connections](/faq/sql-faq.md#collation-used-in-jdbc-connections). ## Prerequisites @@ -98,6 +98,54 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `env.sh` file.
+ +
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `env.sh.example` and rename it to `env.sh`: + + ```shell + cp env.sh.example env.sh + ``` + +9. Copy and paste the corresponding connection string into the `env.sh` file. The example result is as follows: + + ```shell + export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + export TIDB_PORT='4000' + export TIDB_USER='{user}' # e.g. root + export TIDB_PASSWORD='{password}' + export TIDB_DB_NAME='test' + export USE_SSL='false' + ``` + + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. + +10. Save the `env.sh` file. + +
+
1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-java-mybatis.md b/develop/dev-guide-sample-application-java-mybatis.md index b4c5d4d0f02b0..c051a6fdd150c 100644 --- a/develop/dev-guide-sample-application-java-mybatis.md +++ b/develop/dev-guide-sample-application-java-mybatis.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and MyBatis to accomplish the fo > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -96,6 +96,52 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `env.sh` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `env.sh.example` and rename it to `env.sh`: + + ```shell + cp env.sh.example env.sh + ``` + +9. Copy and paste the corresponding connection string into the `env.sh` file. The example result is as follows: + + ```shell + export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + export TIDB_PORT='4000' + export TIDB_USER='{user}' # e.g. root + export TIDB_PASSWORD='{password}' + export TIDB_DB_NAME='test' + export USE_SSL='false' + ``` + + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. + +10. Save the `env.sh` file. +
diff --git a/develop/dev-guide-sample-application-java-spring-boot.md b/develop/dev-guide-sample-application-java-spring-boot.md index 66e969fe95b6d..b9cf75658c744 100644 --- a/develop/dev-guide-sample-application-java-spring-boot.md +++ b/develop/dev-guide-sample-application-java-spring-boot.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB along with [Spring Data JPA](htt > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -96,6 +96,52 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `env.sh` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `env.sh.example` and rename it to `env.sh`: + + ```shell + cp env.sh.example env.sh + ``` + +9. Copy and paste the corresponding connection string into the `env.sh` file. The example result is as follows: + + ```shell + export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + export TIDB_PORT='4000' + export TIDB_USER='{user}' # e.g. root + export TIDB_PASSWORD='{password}' + export TIDB_DB_NAME='test' + export USE_SSL='false' + ``` + + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. + +10. Save the `env.sh` file. +
diff --git a/develop/dev-guide-sample-application-nextjs.md b/develop/dev-guide-sample-application-nextjs.md index 11281058e62cd..68cb5fac48b79 100644 --- a/develop/dev-guide-sample-application-nextjs.md +++ b/develop/dev-guide-sample-application-nextjs.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and mysql2 in Next.js to accompl > **Note** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, and TiDB Self-Managed. ## Prerequisites @@ -105,6 +105,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. TIDB_USER='{prefix}.root' TIDB_PASSWORD='{password}' TIDB_DB_NAME='test' + TIDB_ENABLE_SSL='true' ``` Replace the placeholders in `{}` with the values obtained in the connection dialog. @@ -113,6 +114,59 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```bash + # Linux + cp .env.example .env + ``` + + ```powershell + # Windows + Copy-Item ".env.example" -Destination ".env" + ``` + +9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: + + ```bash + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + TIDB_ENABLE_SSL='false' + ``` + + Replace the placeholders in `{}` with the values obtained in the connection dialog. + +10. Save the `.env` file. + +
+
1. Run the following command to copy `.env.example` and rename it to `.env`: @@ -135,6 +189,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. TIDB_USER='root' TIDB_PASSWORD='{password}' TIDB_DB_NAME='test' + TIDB_ENABLE_SSL='false' ``` Replace the placeholders in `{}` with the values obtained in the **Connect** window. If you are running TiDB locally, the default host address is `127.0.0.1`, and the password is empty. @@ -192,10 +247,10 @@ export function connect() { user: process.env.TIDB_USER, // TiDB user, for example: {prefix}.root password: process.env.TIDB_PASSWORD, // The password of TiDB user. database: process.env.TIDB_DATABASE || 'test', // TiDB database name, default: test - ssl: { + ssl: process.env.TIDB_ENABLE_SSL === 'true' ? { minVersion: 'TLSv1.2', rejectUnauthorized: true, - }, + } : null, connectionLimit: 1, // Setting connectionLimit to "1" in a serverless function environment optimizes resource usage, reduces costs, ensures connection stability, and enables seamless scalability. maxIdle: 1, // max idle connections, the default value is the same as `connectionLimit` enableKeepAlive: true, diff --git a/develop/dev-guide-sample-application-nodejs-mysql2.md b/develop/dev-guide-sample-application-nodejs-mysql2.md index a3bec1e6f3f46..6f67f1cd62416 100644 --- a/develop/dev-guide-sample-application-nodejs-mysql2.md +++ b/develop/dev-guide-sample-application-nodejs-mysql2.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and node-mysql2 to accomplish th > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -106,6 +106,50 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: + + ```dotenv + TIDB_HOST={host} + TIDB_PORT=4000 + TIDB_USER={user} + TIDB_PASSWORD={password} + TIDB_DATABASE=test + TIDB_ENABLE_SSL=false + ``` + +10. Save the `.env` file. +
diff --git a/develop/dev-guide-sample-application-nodejs-mysqljs.md b/develop/dev-guide-sample-application-nodejs-mysqljs.md index 804e5b60a8995..d300969252ffb 100644 --- a/develop/dev-guide-sample-application-nodejs-mysqljs.md +++ b/develop/dev-guide-sample-application-nodejs-mysqljs.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and mysql.js driver to accomplis > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -106,6 +106,50 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: + + ```dotenv + TIDB_HOST={host} + TIDB_PORT=4000 + TIDB_USER={user} + TIDB_PASSWORD={password} + TIDB_DATABASE=test + TIDB_ENABLE_SSL=false + ``` + +10. Save the `.env` file. +
diff --git a/develop/dev-guide-sample-application-nodejs-prisma.md b/develop/dev-guide-sample-application-nodejs-prisma.md index 5ffcdd9af295f..f0f141236d183 100644 --- a/develop/dev-guide-sample-application-nodejs-prisma.md +++ b/develop/dev-guide-sample-application-nodejs-prisma.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and Prisma to accomplish the fol > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -109,6 +109,54 @@ Connect to TiDB depending on the TiDB deployment option you've selected. } ``` +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Edit the `.env` file, set up the environment variable `DATABASE_URL` as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: + + ```dotenv + DATABASE_URL='mysql://{user}:{password}@{host}:4000/test' + ``` + +10. Save the `.env` file. + +11. In the `prisma/schema.prisma`, set up `mysql` as the connection provider and `env("DATABASE_URL")` as the connection URL: + + ```prisma + datasource db { + provider = "mysql" + url = env("DATABASE_URL") + } + ``` +
diff --git a/develop/dev-guide-sample-application-nodejs-sequelize.md b/develop/dev-guide-sample-application-nodejs-sequelize.md index e2bff8202e02f..99f7b5c9ab245 100644 --- a/develop/dev-guide-sample-application-nodejs-sequelize.md +++ b/develop/dev-guide-sample-application-nodejs-sequelize.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and Sequelize to accomplish the > **Note** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -106,6 +106,51 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: + + ```dotenv + TIDB_HOST='{host}' + TIDB_PORT='4000' + TIDB_USER='{user}' + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + TIDB_ENABLE_SSL='false' + ``` + +10. Save the `.env` file. + +
+
1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-nodejs-typeorm.md b/develop/dev-guide-sample-application-nodejs-typeorm.md index f030081a9f546..ddad8f428d221 100644 --- a/develop/dev-guide-sample-application-nodejs-typeorm.md +++ b/develop/dev-guide-sample-application-nodejs-typeorm.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and TypeORM to accomplish the fo > **Note** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -114,6 +114,50 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: + + ```dotenv + TIDB_HOST={host} + TIDB_PORT=4000 + TIDB_USER={user} + TIDB_PASSWORD={password} + TIDB_DATABASE=test + TIDB_ENABLE_SSL=false + ``` + +10. Save the `.env` file. +
diff --git a/develop/dev-guide-sample-application-python-django.md b/develop/dev-guide-sample-application-python-django.md index 8b2a9859d0f53..ea17dd46a5cbd 100644 --- a/develop/dev-guide-sample-application-python-django.md +++ b/develop/dev-guide-sample-application-python-django.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and Django to accomplish the fol > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -113,6 +113,51 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + ``` + + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. + +10. Save the `.env` file. +
diff --git a/develop/dev-guide-sample-application-python-mysql-connector.md b/develop/dev-guide-sample-application-python-mysql-connector.md index 3e80a5dfdef9c..3a0eaa5bfd989 100644 --- a/develop/dev-guide-sample-application-python-mysql-connector.md +++ b/develop/dev-guide-sample-application-python-mysql-connector.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and MySQL Connector/Python to ac > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -101,6 +101,51 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + ``` + + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. + +10. Save the `.env` file. +
diff --git a/develop/dev-guide-sample-application-python-mysqlclient.md b/develop/dev-guide-sample-application-python-mysqlclient.md index 5b838effdf0c7..ebe233e8214fc 100644 --- a/develop/dev-guide-sample-application-python-mysqlclient.md +++ b/develop/dev-guide-sample-application-python-mysqlclient.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and mysqlclient to accomplish th > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -105,6 +105,52 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + CA_PATH='' + ``` + + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. + +10. Save the `.env` file. +
diff --git a/develop/dev-guide-sample-application-python-peewee.md b/develop/dev-guide-sample-application-python-peewee.md index 9980a0d889bee..bfa2deb1e8881 100644 --- a/develop/dev-guide-sample-application-python-peewee.md +++ b/develop/dev-guide-sample-application-python-peewee.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and peewee to accomplish the fol > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -105,6 +105,51 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + ``` + + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. + +10. Save the `.env` file. +
diff --git a/develop/dev-guide-sample-application-python-pymysql.md b/develop/dev-guide-sample-application-python-pymysql.md index 557573019af08..69c17ad24a0ef 100644 --- a/develop/dev-guide-sample-application-python-pymysql.md +++ b/develop/dev-guide-sample-application-python-pymysql.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and PyMySQL to accomplish the fo > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -101,6 +101,51 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + ``` + + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. + +10. Save the `.env` file. +
diff --git a/develop/dev-guide-sample-application-python-sqlalchemy.md b/develop/dev-guide-sample-application-python-sqlalchemy.md index 38c219e02ff98..f178e8db20e22 100644 --- a/develop/dev-guide-sample-application-python-sqlalchemy.md +++ b/develop/dev-guide-sample-application-python-sqlalchemy.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and SQLAlchemy to accomplish the > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -111,6 +111,51 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: + + ```dotenv + TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com + TIDB_PORT='4000' + TIDB_USER='{user}' # e.g. root + TIDB_PASSWORD='{password}' + TIDB_DB_NAME='test' + ``` + + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. + +10. Save the `.env` file. +
diff --git a/develop/dev-guide-sample-application-ruby-mysql2.md b/develop/dev-guide-sample-application-ruby-mysql2.md index b4a9f0bbf31d9..7d7c9f093483b 100644 --- a/develop/dev-guide-sample-application-ruby-mysql2.md +++ b/develop/dev-guide-sample-application-ruby-mysql2.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and mysql2 to accomplish the fol > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -107,6 +107,50 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: + + ```dotenv + DATABASE_HOST={host} + DATABASE_PORT=4000 + DATABASE_USER={user} + DATABASE_PASSWORD={password} + DATABASE_NAME=test + DATABASE_ENABLE_SSL=false + ``` + +10. Save the `.env` file. +
diff --git a/develop/dev-guide-sample-application-ruby-rails.md b/develop/dev-guide-sample-application-ruby-rails.md index 4ea0afcc3e7c9..334a18157e580 100644 --- a/develop/dev-guide-sample-application-ruby-rails.md +++ b/develop/dev-guide-sample-application-ruby-rails.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and Rails to accomplish the foll > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, {{{ .premium }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -97,6 +97,45 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 7. Save the `.env` file. +
+
+ +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. + +2. In the left panel, click **Settings**, and then click **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. + + 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. + + If you have not set the password yet, click **Set Root Password** in the dialog. + + 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). + +8. Run the following command to copy `.env.example` and rename it to `.env`: + + ```shell + cp .env.example .env + ``` + +9. Edit the `.env` file, set up the `DATABASE_URL` environment variable as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: + + ```dotenv + DATABASE_URL='mysql2://{user}:{password}@{host}:{port}/{database_name}' + ``` + +10. Save the `.env` file. +
From f4722734b95359d24bf7bcd98b5f2a90285a6839 Mon Sep 17 00:00:00 2001 From: Aolin Date: Wed, 25 Mar 2026 10:10:44 +0800 Subject: [PATCH 2/5] develop: revise TiDB Cloud Premium connection steps (#22619) --- develop/dev-guide-gui-datagrip.md | 48 +++++++++---------- develop/dev-guide-gui-dbeaver.md | 43 ++++++++--------- develop/dev-guide-gui-mysql-workbench.md | 39 +++++++-------- develop/dev-guide-gui-navicat.md | 41 ++++++++-------- develop/dev-guide-gui-vscode-sqltools.md | 43 ++++++++--------- ...dev-guide-sample-application-aws-lambda.md | 27 +++++------ ...ev-guide-sample-application-golang-gorm.md | 31 ++++++------ ...de-sample-application-golang-sql-driver.md | 31 ++++++------ ...guide-sample-application-java-hibernate.md | 31 ++++++------ .../dev-guide-sample-application-java-jdbc.md | 31 ++++++------ ...v-guide-sample-application-java-mybatis.md | 31 ++++++------ ...ide-sample-application-java-spring-boot.md | 31 ++++++------ .../dev-guide-sample-application-nextjs.md | 31 ++++++------ ...-guide-sample-application-nodejs-mysql2.md | 31 ++++++------ ...guide-sample-application-nodejs-mysqljs.md | 31 ++++++------ ...-guide-sample-application-nodejs-prisma.md | 33 ++++++------- ...ide-sample-application-nodejs-sequelize.md | 31 ++++++------ ...guide-sample-application-nodejs-typeorm.md | 31 ++++++------ ...-guide-sample-application-python-django.md | 31 ++++++------ ...mple-application-python-mysql-connector.md | 31 ++++++------ ...e-sample-application-python-mysqlclient.md | 31 ++++++------ ...-guide-sample-application-python-peewee.md | 31 ++++++------ ...guide-sample-application-python-pymysql.md | 31 ++++++------ ...de-sample-application-python-sqlalchemy.md | 31 ++++++------ ...ev-guide-sample-application-ruby-mysql2.md | 31 ++++++------ ...dev-guide-sample-application-ruby-rails.md | 31 ++++++------ 26 files changed, 394 insertions(+), 469 deletions(-) diff --git a/develop/dev-guide-gui-datagrip.md b/develop/dev-guide-gui-datagrip.md index 523619197f155..e379b9ba13cf6 100644 --- a/develop/dev-guide-gui-datagrip.md +++ b/develop/dev-guide-gui-datagrip.md @@ -78,46 +78,44 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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.
diff --git a/develop/dev-guide-gui-dbeaver.md b/develop/dev-guide-gui-dbeaver.md index 7234bfda2010e..0b2e4152eaf38 100644 --- a/develop/dev-guide-gui-dbeaver.md +++ b/develop/dev-guide-gui-dbeaver.md @@ -89,42 +89,41 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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.
diff --git a/develop/dev-guide-gui-mysql-workbench.md b/develop/dev-guide-gui-mysql-workbench.md index 44e69e41c3461..f4186b53814ea 100644 --- a/develop/dev-guide-gui-mysql-workbench.md +++ b/develop/dev-guide-gui-mysql-workbench.md @@ -80,41 +80,38 @@ Connect to TiDB depending on the TiDB deployment option you have selected.
-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.
diff --git a/develop/dev-guide-gui-navicat.md b/develop/dev-guide-gui-navicat.md index 3e9e1ec161f4c..41b722cee80fb 100644 --- a/develop/dev-guide-gui-navicat.md +++ b/develop/dev-guide-gui-navicat.md @@ -76,43 +76,40 @@ Connect to TiDB depending on the TiDB deployment option you have selected.
-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.
diff --git a/develop/dev-guide-gui-vscode-sqltools.md b/develop/dev-guide-gui-vscode-sqltools.md index dda0b661d3f5f..59864174a8381 100644 --- a/develop/dev-guide-gui-vscode-sqltools.md +++ b/develop/dev-guide-gui-vscode-sqltools.md @@ -96,48 +96,45 @@ Connect to TiDB depending on the TiDB deployment option you have selected.
-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 VS Code and select the **SQLTools** extension on the navigation pane. Under the **CONNECTIONS** section, click **Add New Connection** and select **TiDB** as the database driver. +7. Launch VS Code and select the **SQLTools** extension on the navigation pane. Under the **CONNECTIONS** section, click **Add New Connection** and select **TiDB** as the database driver. -9. In the setting pane, configure the following connection parameters based on the connection dialog: +8. In the setting pane, configure the following connection parameters: - **Connect using**: select **Server and Port**. - - **Server Address**: `{host}` - - **Port**: `{port}` - - **Database**: the database that you want to connect to. - - **Username**: `{user}` + - **Server Address**: enter the `host` parameter from the TiDB Cloud connection dialog. + - **Port**: enter the `port` parameter from the TiDB Cloud connection dialog. + - **Database**: enter the database that you want to connect to. + - **Username**: enter the `user` parameter from the TiDB Cloud connection dialog. - **Password mode**: select **SQLTools Driver Credentials**. - In the **MySQL driver specific options** area, configure the following parameters: - **Authentication Protocol**: select **default**. - **SSL**: select **Disabled**. -10. Click **TEST CONNECTION** to validate the connection. +9. Click **TEST CONNECTION** to validate the connection to the {{{ .premium }}} instance. -11. In the **SQLTools Driver Credentials** dialog, enter the password. +10. In the **SQLTools Driver Credentials** dialog, enter the password. -12. If the connection test is successful, click **SAVE CONNECTION** to save the connection configuration. +11. If the connection test is successful, click **SAVE CONNECTION** to save the connection configuration.
diff --git a/develop/dev-guide-sample-application-aws-lambda.md b/develop/dev-guide-sample-application-aws-lambda.md index 86b1d925c3791..18d1948dcf47a 100644 --- a/develop/dev-guide-sample-application-aws-lambda.md +++ b/develop/dev-guide-sample-application-aws-lambda.md @@ -111,29 +111,26 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Copy and paste the corresponding connection string into `env.json`. The following is an example: +7. Copy and paste the corresponding connection string into `env.json`. The following is an example: ```json { diff --git a/develop/dev-guide-sample-application-golang-gorm.md b/develop/dev-guide-sample-application-golang-gorm.md index aa6f2a5ee287a..819e580241644 100644 --- a/develop/dev-guide-sample-application-golang-gorm.md +++ b/develop/dev-guide-sample-application-golang-gorm.md @@ -98,35 +98,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: ```dotenv TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -139,7 +136,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-golang-sql-driver.md b/develop/dev-guide-sample-application-golang-sql-driver.md index cb8971a6fd653..5a6548dd4662d 100644 --- a/develop/dev-guide-sample-application-golang-sql-driver.md +++ b/develop/dev-guide-sample-application-golang-sql-driver.md @@ -98,35 +98,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: ```dotenv TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -139,7 +136,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-java-hibernate.md b/develop/dev-guide-sample-application-java-hibernate.md index eae6f6f7f6956..bc8688c3f38e8 100644 --- a/develop/dev-guide-sample-application-java-hibernate.md +++ b/develop/dev-guide-sample-application-java-hibernate.md @@ -99,35 +99,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `env.sh.example` and rename it to `env.sh`: +7. Run the following command to copy `env.sh.example` and rename it to `env.sh`: ```shell cp env.sh.example env.sh ``` -9. Copy and paste the corresponding connection string into the `env.sh` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `env.sh` file. The example result is as follows: ```shell export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -140,7 +137,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. -10. Save the `env.sh` file. +9. Save the `env.sh` file.
diff --git a/develop/dev-guide-sample-application-java-jdbc.md b/develop/dev-guide-sample-application-java-jdbc.md index 04243aad7edcf..c894efd6378bb 100644 --- a/develop/dev-guide-sample-application-java-jdbc.md +++ b/develop/dev-guide-sample-application-java-jdbc.md @@ -101,35 +101,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `env.sh.example` and rename it to `env.sh`: +7. Run the following command to copy `env.sh.example` and rename it to `env.sh`: ```shell cp env.sh.example env.sh ``` -9. Copy and paste the corresponding connection string into the `env.sh` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `env.sh` file. The example result is as follows: ```shell export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -142,7 +139,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. -10. Save the `env.sh` file. +9. Save the `env.sh` file.
diff --git a/develop/dev-guide-sample-application-java-mybatis.md b/develop/dev-guide-sample-application-java-mybatis.md index c051a6fdd150c..96bfcab3cf1e7 100644 --- a/develop/dev-guide-sample-application-java-mybatis.md +++ b/develop/dev-guide-sample-application-java-mybatis.md @@ -99,35 +99,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `env.sh.example` and rename it to `env.sh`: +7. Run the following command to copy `env.sh.example` and rename it to `env.sh`: ```shell cp env.sh.example env.sh ``` -9. Copy and paste the corresponding connection string into the `env.sh` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `env.sh` file. The example result is as follows: ```shell export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -140,7 +137,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. -10. Save the `env.sh` file. +9. Save the `env.sh` file.
diff --git a/develop/dev-guide-sample-application-java-spring-boot.md b/develop/dev-guide-sample-application-java-spring-boot.md index b9cf75658c744..9d5e80d4190fb 100644 --- a/develop/dev-guide-sample-application-java-spring-boot.md +++ b/develop/dev-guide-sample-application-java-spring-boot.md @@ -99,35 +99,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `env.sh.example` and rename it to `env.sh`: +7. Run the following command to copy `env.sh.example` and rename it to `env.sh`: ```shell cp env.sh.example env.sh ``` -9. Copy and paste the corresponding connection string into the `env.sh` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `env.sh` file. The example result is as follows: ```shell export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -140,7 +137,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. -10. Save the `env.sh` file. +9. Save the `env.sh` file.
diff --git a/develop/dev-guide-sample-application-nextjs.md b/develop/dev-guide-sample-application-nextjs.md index 68cb5fac48b79..6b29b839d648c 100644 --- a/develop/dev-guide-sample-application-nextjs.md +++ b/develop/dev-guide-sample-application-nextjs.md @@ -116,29 +116,26 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```bash # Linux @@ -150,7 +147,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Copy-Item ".env.example" -Destination ".env" ``` -9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: ```bash TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -163,7 +160,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Replace the placeholders in `{}` with the values obtained in the connection dialog. -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-nodejs-mysql2.md b/develop/dev-guide-sample-application-nodejs-mysql2.md index 6f67f1cd62416..722ad67be129b 100644 --- a/develop/dev-guide-sample-application-nodejs-mysql2.md +++ b/develop/dev-guide-sample-application-nodejs-mysql2.md @@ -109,35 +109,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: +8. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: ```dotenv TIDB_HOST={host} @@ -148,7 +145,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. TIDB_ENABLE_SSL=false ``` -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-nodejs-mysqljs.md b/develop/dev-guide-sample-application-nodejs-mysqljs.md index d300969252ffb..33bcb48dbe0c4 100644 --- a/develop/dev-guide-sample-application-nodejs-mysqljs.md +++ b/develop/dev-guide-sample-application-nodejs-mysqljs.md @@ -109,35 +109,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: +8. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: ```dotenv TIDB_HOST={host} @@ -148,7 +145,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. TIDB_ENABLE_SSL=false ``` -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-nodejs-prisma.md b/develop/dev-guide-sample-application-nodejs-prisma.md index f0f141236d183..9b044b00ab3b5 100644 --- a/develop/dev-guide-sample-application-nodejs-prisma.md +++ b/develop/dev-guide-sample-application-nodejs-prisma.md @@ -112,43 +112,40 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Edit the `.env` file, set up the environment variable `DATABASE_URL` as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: +8. Edit the `.env` file, set up the environment variable `DATABASE_URL` as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: ```dotenv DATABASE_URL='mysql://{user}:{password}@{host}:4000/test' ``` -10. Save the `.env` file. +9. Save the `.env` file. -11. In the `prisma/schema.prisma`, set up `mysql` as the connection provider and `env("DATABASE_URL")` as the connection URL: +10. In the `prisma/schema.prisma`, set up `mysql` as the connection provider and `env("DATABASE_URL")` as the connection URL: ```prisma datasource db { diff --git a/develop/dev-guide-sample-application-nodejs-sequelize.md b/develop/dev-guide-sample-application-nodejs-sequelize.md index 99f7b5c9ab245..a2f3944659785 100644 --- a/develop/dev-guide-sample-application-nodejs-sequelize.md +++ b/develop/dev-guide-sample-application-nodejs-sequelize.md @@ -108,35 +108,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: +8. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: ```dotenv TIDB_HOST='{host}' @@ -147,7 +144,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. TIDB_ENABLE_SSL='false' ``` -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-nodejs-typeorm.md b/develop/dev-guide-sample-application-nodejs-typeorm.md index ddad8f428d221..90d2893930c50 100644 --- a/develop/dev-guide-sample-application-nodejs-typeorm.md +++ b/develop/dev-guide-sample-application-nodejs-typeorm.md @@ -117,35 +117,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: +8. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: ```dotenv TIDB_HOST={host} @@ -156,7 +153,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. TIDB_ENABLE_SSL=false ``` -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-python-django.md b/develop/dev-guide-sample-application-python-django.md index ea17dd46a5cbd..de2925478b39d 100644 --- a/develop/dev-guide-sample-application-python-django.md +++ b/develop/dev-guide-sample-application-python-django.md @@ -116,35 +116,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: ```dotenv TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -156,7 +153,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-python-mysql-connector.md b/develop/dev-guide-sample-application-python-mysql-connector.md index 3a0eaa5bfd989..85e340f9f490a 100644 --- a/develop/dev-guide-sample-application-python-mysql-connector.md +++ b/develop/dev-guide-sample-application-python-mysql-connector.md @@ -104,35 +104,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: ```dotenv TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -144,7 +141,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-python-mysqlclient.md b/develop/dev-guide-sample-application-python-mysqlclient.md index ebe233e8214fc..2d4bc03c50b83 100644 --- a/develop/dev-guide-sample-application-python-mysqlclient.md +++ b/develop/dev-guide-sample-application-python-mysqlclient.md @@ -108,35 +108,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: ```dotenv TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -149,7 +146,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-python-peewee.md b/develop/dev-guide-sample-application-python-peewee.md index bfa2deb1e8881..a6deaca062e4c 100644 --- a/develop/dev-guide-sample-application-python-peewee.md +++ b/develop/dev-guide-sample-application-python-peewee.md @@ -108,35 +108,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: ```dotenv TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -148,7 +145,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-python-pymysql.md b/develop/dev-guide-sample-application-python-pymysql.md index 69c17ad24a0ef..85d988541d511 100644 --- a/develop/dev-guide-sample-application-python-pymysql.md +++ b/develop/dev-guide-sample-application-python-pymysql.md @@ -104,35 +104,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: ```dotenv TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -144,7 +141,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-python-sqlalchemy.md b/develop/dev-guide-sample-application-python-sqlalchemy.md index f178e8db20e22..0101797579070 100644 --- a/develop/dev-guide-sample-application-python-sqlalchemy.md +++ b/develop/dev-guide-sample-application-python-sqlalchemy.md @@ -114,35 +114,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: +8. Copy and paste the corresponding connection string into the `.env` file. The example result is as follows: ```dotenv TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com @@ -154,7 +151,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-ruby-mysql2.md b/develop/dev-guide-sample-application-ruby-mysql2.md index 7d7c9f093483b..f4bc64ed001c8 100644 --- a/develop/dev-guide-sample-application-ruby-mysql2.md +++ b/develop/dev-guide-sample-application-ruby-mysql2.md @@ -110,35 +110,32 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: +8. Edit the `.env` file, set up the environment variables as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: ```dotenv DATABASE_HOST={host} @@ -149,7 +146,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. DATABASE_ENABLE_SSL=false ``` -10. Save the `.env` file. +9. Save the `.env` file.
diff --git a/develop/dev-guide-sample-application-ruby-rails.md b/develop/dev-guide-sample-application-ruby-rails.md index 334a18157e580..25c34c0fb544e 100644 --- a/develop/dev-guide-sample-application-ruby-rails.md +++ b/develop/dev-guide-sample-application-ruby-rails.md @@ -100,41 +100,38 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. Run the following command to copy `.env.example` and rename it to `.env`: +7. Run the following command to copy `.env.example` and rename it to `.env`: ```shell cp .env.example .env ``` -9. Edit the `.env` file, set up the `DATABASE_URL` environment variable as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: +8. Edit the `.env` file, set up the `DATABASE_URL` environment variable as follows, and replace the corresponding placeholders `{}` with connection parameters in the connection dialog: ```dotenv DATABASE_URL='mysql2://{user}:{password}@{host}:{port}/{database_name}' ``` -10. Save the `.env` file. +9. Save the `.env` file.
From 4dad7c295585600a5a970490ea98841591684ae7 Mon Sep 17 00:00:00 2001 From: Aolin Date: Wed, 25 Mar 2026 15:18:56 +0800 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: Grace Cai --- develop/dev-guide-gui-datagrip.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/develop/dev-guide-gui-datagrip.md b/develop/dev-guide-gui-datagrip.md index e379b9ba13cf6..c3c70b111b9bf 100644 --- a/develop/dev-guide-gui-datagrip.md +++ b/develop/dev-guide-gui-datagrip.md @@ -84,7 +84,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -94,7 +94,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Launch DataGrip and create a project to manage your connections. @@ -111,7 +111,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. | Password | `{password}` | - 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. + - If a **Download missing driver files** warning is displayed, click **Download** to acquire the driver files. 10. Click **Test Connection** to validate the connection to the {{{ .premium }}} instance. From 862f9b92e5de975d217d959b61426690ba62fdef Mon Sep 17 00:00:00 2001 From: Aolin Date: Wed, 25 Mar 2026 15:25:02 +0800 Subject: [PATCH 4/5] update --- develop/dev-guide-gui-dbeaver.md | 4 ++-- develop/dev-guide-gui-mysql-workbench.md | 4 ++-- develop/dev-guide-gui-navicat.md | 4 ++-- develop/dev-guide-gui-vscode-sqltools.md | 4 ++-- develop/dev-guide-sample-application-aws-lambda.md | 4 ++-- develop/dev-guide-sample-application-golang-gorm.md | 4 ++-- develop/dev-guide-sample-application-golang-sql-driver.md | 4 ++-- develop/dev-guide-sample-application-java-hibernate.md | 4 ++-- develop/dev-guide-sample-application-java-jdbc.md | 4 ++-- develop/dev-guide-sample-application-java-mybatis.md | 4 ++-- develop/dev-guide-sample-application-java-spring-boot.md | 4 ++-- develop/dev-guide-sample-application-nextjs.md | 4 ++-- develop/dev-guide-sample-application-nodejs-mysql2.md | 4 ++-- develop/dev-guide-sample-application-nodejs-mysqljs.md | 4 ++-- develop/dev-guide-sample-application-nodejs-prisma.md | 4 ++-- develop/dev-guide-sample-application-nodejs-sequelize.md | 4 ++-- develop/dev-guide-sample-application-nodejs-typeorm.md | 4 ++-- develop/dev-guide-sample-application-python-django.md | 4 ++-- .../dev-guide-sample-application-python-mysql-connector.md | 4 ++-- develop/dev-guide-sample-application-python-mysqlclient.md | 4 ++-- develop/dev-guide-sample-application-python-peewee.md | 4 ++-- develop/dev-guide-sample-application-python-pymysql.md | 4 ++-- develop/dev-guide-sample-application-python-sqlalchemy.md | 4 ++-- develop/dev-guide-sample-application-ruby-mysql2.md | 4 ++-- develop/dev-guide-sample-application-ruby-rails.md | 4 ++-- 25 files changed, 50 insertions(+), 50 deletions(-) diff --git a/develop/dev-guide-gui-dbeaver.md b/develop/dev-guide-gui-dbeaver.md index 0b2e4152eaf38..8b426359df711 100644 --- a/develop/dev-guide-gui-dbeaver.md +++ b/develop/dev-guide-gui-dbeaver.md @@ -95,7 +95,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -105,7 +105,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 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**. diff --git a/develop/dev-guide-gui-mysql-workbench.md b/develop/dev-guide-gui-mysql-workbench.md index f4186b53814ea..2727c36350d4a 100644 --- a/develop/dev-guide-gui-mysql-workbench.md +++ b/develop/dev-guide-gui-mysql-workbench.md @@ -86,7 +86,7 @@ Connect to TiDB depending on the TiDB deployment option you have selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -96,7 +96,7 @@ Connect to TiDB depending on the TiDB deployment option you have selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Launch MySQL Workbench and click **+** near the **MySQL Connections** title. diff --git a/develop/dev-guide-gui-navicat.md b/develop/dev-guide-gui-navicat.md index 41b722cee80fb..e95a1c5bf38e5 100644 --- a/develop/dev-guide-gui-navicat.md +++ b/develop/dev-guide-gui-navicat.md @@ -82,7 +82,7 @@ Connect to TiDB depending on the TiDB deployment option you have selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -92,7 +92,7 @@ Connect to TiDB depending on the TiDB deployment option you have selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 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. diff --git a/develop/dev-guide-gui-vscode-sqltools.md b/develop/dev-guide-gui-vscode-sqltools.md index 59864174a8381..e22bb5fa76975 100644 --- a/develop/dev-guide-gui-vscode-sqltools.md +++ b/develop/dev-guide-gui-vscode-sqltools.md @@ -102,7 +102,7 @@ Connect to TiDB depending on the TiDB deployment option you have selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -112,7 +112,7 @@ Connect to TiDB depending on the TiDB deployment option you have selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Launch VS Code and select the **SQLTools** extension on the navigation pane. Under the **CONNECTIONS** section, click **Add New Connection** and select **TiDB** as the database driver. diff --git a/develop/dev-guide-sample-application-aws-lambda.md b/develop/dev-guide-sample-application-aws-lambda.md index 18d1948dcf47a..c5f4649444062 100644 --- a/develop/dev-guide-sample-application-aws-lambda.md +++ b/develop/dev-guide-sample-application-aws-lambda.md @@ -117,7 +117,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -127,7 +127,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Copy and paste the corresponding connection string into `env.json`. The following is an example: diff --git a/develop/dev-guide-sample-application-golang-gorm.md b/develop/dev-guide-sample-application-golang-gorm.md index 819e580241644..6fe16ca8600db 100644 --- a/develop/dev-guide-sample-application-golang-gorm.md +++ b/develop/dev-guide-sample-application-golang-gorm.md @@ -104,7 +104,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -114,7 +114,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-golang-sql-driver.md b/develop/dev-guide-sample-application-golang-sql-driver.md index 5a6548dd4662d..938cd0b585f19 100644 --- a/develop/dev-guide-sample-application-golang-sql-driver.md +++ b/develop/dev-guide-sample-application-golang-sql-driver.md @@ -104,7 +104,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -114,7 +114,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-java-hibernate.md b/develop/dev-guide-sample-application-java-hibernate.md index bc8688c3f38e8..44d7483710a5e 100644 --- a/develop/dev-guide-sample-application-java-hibernate.md +++ b/develop/dev-guide-sample-application-java-hibernate.md @@ -105,7 +105,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -115,7 +115,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `env.sh.example` and rename it to `env.sh`: diff --git a/develop/dev-guide-sample-application-java-jdbc.md b/develop/dev-guide-sample-application-java-jdbc.md index c894efd6378bb..b5e0b94e7fb16 100644 --- a/develop/dev-guide-sample-application-java-jdbc.md +++ b/develop/dev-guide-sample-application-java-jdbc.md @@ -107,7 +107,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -117,7 +117,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `env.sh.example` and rename it to `env.sh`: diff --git a/develop/dev-guide-sample-application-java-mybatis.md b/develop/dev-guide-sample-application-java-mybatis.md index 96bfcab3cf1e7..2ef9fbb914f66 100644 --- a/develop/dev-guide-sample-application-java-mybatis.md +++ b/develop/dev-guide-sample-application-java-mybatis.md @@ -105,7 +105,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -115,7 +115,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `env.sh.example` and rename it to `env.sh`: diff --git a/develop/dev-guide-sample-application-java-spring-boot.md b/develop/dev-guide-sample-application-java-spring-boot.md index 9d5e80d4190fb..ec355165eb36d 100644 --- a/develop/dev-guide-sample-application-java-spring-boot.md +++ b/develop/dev-guide-sample-application-java-spring-boot.md @@ -105,7 +105,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -115,7 +115,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `env.sh.example` and rename it to `env.sh`: diff --git a/develop/dev-guide-sample-application-nextjs.md b/develop/dev-guide-sample-application-nextjs.md index 6b29b839d648c..efb4f6949bdf3 100644 --- a/develop/dev-guide-sample-application-nextjs.md +++ b/develop/dev-guide-sample-application-nextjs.md @@ -122,7 +122,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -132,7 +132,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-nodejs-mysql2.md b/develop/dev-guide-sample-application-nodejs-mysql2.md index 722ad67be129b..5e3b5aa483e9b 100644 --- a/develop/dev-guide-sample-application-nodejs-mysql2.md +++ b/develop/dev-guide-sample-application-nodejs-mysql2.md @@ -115,7 +115,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -125,7 +125,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-nodejs-mysqljs.md b/develop/dev-guide-sample-application-nodejs-mysqljs.md index 33bcb48dbe0c4..86b6187c19188 100644 --- a/develop/dev-guide-sample-application-nodejs-mysqljs.md +++ b/develop/dev-guide-sample-application-nodejs-mysqljs.md @@ -115,7 +115,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -125,7 +125,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-nodejs-prisma.md b/develop/dev-guide-sample-application-nodejs-prisma.md index 9b044b00ab3b5..c8e27b4d3d8f7 100644 --- a/develop/dev-guide-sample-application-nodejs-prisma.md +++ b/develop/dev-guide-sample-application-nodejs-prisma.md @@ -118,7 +118,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -128,7 +128,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-nodejs-sequelize.md b/develop/dev-guide-sample-application-nodejs-sequelize.md index a2f3944659785..48d852f9d5493 100644 --- a/develop/dev-guide-sample-application-nodejs-sequelize.md +++ b/develop/dev-guide-sample-application-nodejs-sequelize.md @@ -114,7 +114,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -124,7 +124,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-nodejs-typeorm.md b/develop/dev-guide-sample-application-nodejs-typeorm.md index 90d2893930c50..d6f8b92b926f8 100644 --- a/develop/dev-guide-sample-application-nodejs-typeorm.md +++ b/develop/dev-guide-sample-application-nodejs-typeorm.md @@ -123,7 +123,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -133,7 +133,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-python-django.md b/develop/dev-guide-sample-application-python-django.md index de2925478b39d..eec70fdd7545c 100644 --- a/develop/dev-guide-sample-application-python-django.md +++ b/develop/dev-guide-sample-application-python-django.md @@ -122,7 +122,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -132,7 +132,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-python-mysql-connector.md b/develop/dev-guide-sample-application-python-mysql-connector.md index 85e340f9f490a..2368f454b7bd7 100644 --- a/develop/dev-guide-sample-application-python-mysql-connector.md +++ b/develop/dev-guide-sample-application-python-mysql-connector.md @@ -110,7 +110,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -120,7 +120,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-python-mysqlclient.md b/develop/dev-guide-sample-application-python-mysqlclient.md index 2d4bc03c50b83..bb60d7a695ecb 100644 --- a/develop/dev-guide-sample-application-python-mysqlclient.md +++ b/develop/dev-guide-sample-application-python-mysqlclient.md @@ -114,7 +114,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -124,7 +124,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-python-peewee.md b/develop/dev-guide-sample-application-python-peewee.md index a6deaca062e4c..01556b4b882db 100644 --- a/develop/dev-guide-sample-application-python-peewee.md +++ b/develop/dev-guide-sample-application-python-peewee.md @@ -114,7 +114,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -124,7 +124,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-python-pymysql.md b/develop/dev-guide-sample-application-python-pymysql.md index 85d988541d511..d3d3309b5505f 100644 --- a/develop/dev-guide-sample-application-python-pymysql.md +++ b/develop/dev-guide-sample-application-python-pymysql.md @@ -110,7 +110,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -120,7 +120,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-python-sqlalchemy.md b/develop/dev-guide-sample-application-python-sqlalchemy.md index 0101797579070..71ed5be798fd0 100644 --- a/develop/dev-guide-sample-application-python-sqlalchemy.md +++ b/develop/dev-guide-sample-application-python-sqlalchemy.md @@ -120,7 +120,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -130,7 +130,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-ruby-mysql2.md b/develop/dev-guide-sample-application-ruby-mysql2.md index f4bc64ed001c8..45c1625f0acb2 100644 --- a/develop/dev-guide-sample-application-ruby-mysql2.md +++ b/develop/dev-guide-sample-application-ruby-mysql2.md @@ -116,7 +116,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -126,7 +126,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: diff --git a/develop/dev-guide-sample-application-ruby-rails.md b/develop/dev-guide-sample-application-ruby-rails.md index 25c34c0fb544e..5b3339f16fcaa 100644 --- a/develop/dev-guide-sample-application-ruby-rails.md +++ b/develop/dev-guide-sample-application-ruby-rails.md @@ -106,7 +106,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. 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. + Ensure that your client IP address is added to the access list. 4. In the left navigation pane, click **Overview** to return to the instance overview page. @@ -116,7 +116,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected. - 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. + - If you need to verify the server certificate or if the connection fails and requires a CA certificate, 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). 7. Run the following command to copy `.env.example` and rename it to `.env`: From d2e5addddd1d169a010d1717e52b51aa8b1c12a4 Mon Sep 17 00:00:00 2001 From: Aolin Date: Tue, 7 Apr 2026 10:42:32 +0800 Subject: [PATCH 5/5] update "TiDB Instances" to "My TiDB" --- develop/dev-guide-gui-datagrip.md | 2 +- develop/dev-guide-gui-dbeaver.md | 2 +- develop/dev-guide-gui-mysql-workbench.md | 2 +- develop/dev-guide-gui-navicat.md | 2 +- develop/dev-guide-gui-vscode-sqltools.md | 2 +- develop/dev-guide-sample-application-aws-lambda.md | 2 +- develop/dev-guide-sample-application-golang-gorm.md | 2 +- develop/dev-guide-sample-application-golang-sql-driver.md | 2 +- develop/dev-guide-sample-application-java-hibernate.md | 2 +- develop/dev-guide-sample-application-java-jdbc.md | 2 +- develop/dev-guide-sample-application-java-mybatis.md | 2 +- develop/dev-guide-sample-application-java-spring-boot.md | 2 +- develop/dev-guide-sample-application-nextjs.md | 2 +- develop/dev-guide-sample-application-nodejs-mysql2.md | 2 +- develop/dev-guide-sample-application-nodejs-mysqljs.md | 2 +- develop/dev-guide-sample-application-nodejs-prisma.md | 2 +- develop/dev-guide-sample-application-nodejs-sequelize.md | 2 +- develop/dev-guide-sample-application-nodejs-typeorm.md | 2 +- develop/dev-guide-sample-application-python-django.md | 2 +- develop/dev-guide-sample-application-python-mysql-connector.md | 2 +- develop/dev-guide-sample-application-python-mysqlclient.md | 2 +- develop/dev-guide-sample-application-python-peewee.md | 2 +- develop/dev-guide-sample-application-python-pymysql.md | 2 +- develop/dev-guide-sample-application-python-sqlalchemy.md | 2 +- develop/dev-guide-sample-application-ruby-mysql2.md | 2 +- develop/dev-guide-sample-application-ruby-rails.md | 2 +- 26 files changed, 26 insertions(+), 26 deletions(-) diff --git a/develop/dev-guide-gui-datagrip.md b/develop/dev-guide-gui-datagrip.md index c3c70b111b9bf..ac66c9916fb9a 100644 --- a/develop/dev-guide-gui-datagrip.md +++ b/develop/dev-guide-gui-datagrip.md @@ -78,7 +78,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-gui-dbeaver.md b/develop/dev-guide-gui-dbeaver.md index 8b426359df711..d1d03d866c143 100644 --- a/develop/dev-guide-gui-dbeaver.md +++ b/develop/dev-guide-gui-dbeaver.md @@ -89,7 +89,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-gui-mysql-workbench.md b/develop/dev-guide-gui-mysql-workbench.md index 2727c36350d4a..283d4b59560f0 100644 --- a/develop/dev-guide-gui-mysql-workbench.md +++ b/develop/dev-guide-gui-mysql-workbench.md @@ -80,7 +80,7 @@ Connect to TiDB depending on the TiDB deployment option you have selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-gui-navicat.md b/develop/dev-guide-gui-navicat.md index e95a1c5bf38e5..5444e3d8f7e52 100644 --- a/develop/dev-guide-gui-navicat.md +++ b/develop/dev-guide-gui-navicat.md @@ -76,7 +76,7 @@ Connect to TiDB depending on the TiDB deployment option you have selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-gui-vscode-sqltools.md b/develop/dev-guide-gui-vscode-sqltools.md index e22bb5fa76975..f55aacc7606d1 100644 --- a/develop/dev-guide-gui-vscode-sqltools.md +++ b/develop/dev-guide-gui-vscode-sqltools.md @@ -96,7 +96,7 @@ Connect to TiDB depending on the TiDB deployment option you have selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-aws-lambda.md b/develop/dev-guide-sample-application-aws-lambda.md index c5f4649444062..1ec0faa7df8b8 100644 --- a/develop/dev-guide-sample-application-aws-lambda.md +++ b/develop/dev-guide-sample-application-aws-lambda.md @@ -111,7 +111,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-golang-gorm.md b/develop/dev-guide-sample-application-golang-gorm.md index 6fe16ca8600db..ddc20d200a293 100644 --- a/develop/dev-guide-sample-application-golang-gorm.md +++ b/develop/dev-guide-sample-application-golang-gorm.md @@ -98,7 +98,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-golang-sql-driver.md b/develop/dev-guide-sample-application-golang-sql-driver.md index 938cd0b585f19..fb1701fecb7ba 100644 --- a/develop/dev-guide-sample-application-golang-sql-driver.md +++ b/develop/dev-guide-sample-application-golang-sql-driver.md @@ -98,7 +98,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-java-hibernate.md b/develop/dev-guide-sample-application-java-hibernate.md index 44d7483710a5e..c0c3ee048a4d1 100644 --- a/develop/dev-guide-sample-application-java-hibernate.md +++ b/develop/dev-guide-sample-application-java-hibernate.md @@ -99,7 +99,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-java-jdbc.md b/develop/dev-guide-sample-application-java-jdbc.md index b5e0b94e7fb16..59a9802a2576c 100644 --- a/develop/dev-guide-sample-application-java-jdbc.md +++ b/develop/dev-guide-sample-application-java-jdbc.md @@ -101,7 +101,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-java-mybatis.md b/develop/dev-guide-sample-application-java-mybatis.md index 2ef9fbb914f66..07014801af272 100644 --- a/develop/dev-guide-sample-application-java-mybatis.md +++ b/develop/dev-guide-sample-application-java-mybatis.md @@ -99,7 +99,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-java-spring-boot.md b/develop/dev-guide-sample-application-java-spring-boot.md index ec355165eb36d..290a5f86870b2 100644 --- a/develop/dev-guide-sample-application-java-spring-boot.md +++ b/develop/dev-guide-sample-application-java-spring-boot.md @@ -99,7 +99,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-nextjs.md b/develop/dev-guide-sample-application-nextjs.md index efb4f6949bdf3..4a5a73abeeabc 100644 --- a/develop/dev-guide-sample-application-nextjs.md +++ b/develop/dev-guide-sample-application-nextjs.md @@ -116,7 +116,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-nodejs-mysql2.md b/develop/dev-guide-sample-application-nodejs-mysql2.md index 5e3b5aa483e9b..533c01de3cfd9 100644 --- a/develop/dev-guide-sample-application-nodejs-mysql2.md +++ b/develop/dev-guide-sample-application-nodejs-mysql2.md @@ -109,7 +109,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-nodejs-mysqljs.md b/develop/dev-guide-sample-application-nodejs-mysqljs.md index 86b6187c19188..a077508d606d4 100644 --- a/develop/dev-guide-sample-application-nodejs-mysqljs.md +++ b/develop/dev-guide-sample-application-nodejs-mysqljs.md @@ -109,7 +109,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-nodejs-prisma.md b/develop/dev-guide-sample-application-nodejs-prisma.md index c8e27b4d3d8f7..7230423c24386 100644 --- a/develop/dev-guide-sample-application-nodejs-prisma.md +++ b/develop/dev-guide-sample-application-nodejs-prisma.md @@ -112,7 +112,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-nodejs-sequelize.md b/develop/dev-guide-sample-application-nodejs-sequelize.md index 48d852f9d5493..57abaffc61460 100644 --- a/develop/dev-guide-sample-application-nodejs-sequelize.md +++ b/develop/dev-guide-sample-application-nodejs-sequelize.md @@ -108,7 +108,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-nodejs-typeorm.md b/develop/dev-guide-sample-application-nodejs-typeorm.md index d6f8b92b926f8..d8d9264408370 100644 --- a/develop/dev-guide-sample-application-nodejs-typeorm.md +++ b/develop/dev-guide-sample-application-nodejs-typeorm.md @@ -117,7 +117,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-python-django.md b/develop/dev-guide-sample-application-python-django.md index eec70fdd7545c..b995e0a42d6b1 100644 --- a/develop/dev-guide-sample-application-python-django.md +++ b/develop/dev-guide-sample-application-python-django.md @@ -116,7 +116,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-python-mysql-connector.md b/develop/dev-guide-sample-application-python-mysql-connector.md index 2368f454b7bd7..875715956b38e 100644 --- a/develop/dev-guide-sample-application-python-mysql-connector.md +++ b/develop/dev-guide-sample-application-python-mysql-connector.md @@ -104,7 +104,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-python-mysqlclient.md b/develop/dev-guide-sample-application-python-mysqlclient.md index bb60d7a695ecb..9fc0f575d3577 100644 --- a/develop/dev-guide-sample-application-python-mysqlclient.md +++ b/develop/dev-guide-sample-application-python-mysqlclient.md @@ -108,7 +108,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-python-peewee.md b/develop/dev-guide-sample-application-python-peewee.md index 01556b4b882db..d855c79c2feaa 100644 --- a/develop/dev-guide-sample-application-python-peewee.md +++ b/develop/dev-guide-sample-application-python-peewee.md @@ -108,7 +108,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-python-pymysql.md b/develop/dev-guide-sample-application-python-pymysql.md index d3d3309b5505f..95b683c9204ac 100644 --- a/develop/dev-guide-sample-application-python-pymysql.md +++ b/develop/dev-guide-sample-application-python-pymysql.md @@ -104,7 +104,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-python-sqlalchemy.md b/develop/dev-guide-sample-application-python-sqlalchemy.md index 71ed5be798fd0..c39c9166c9444 100644 --- a/develop/dev-guide-sample-application-python-sqlalchemy.md +++ b/develop/dev-guide-sample-application-python-sqlalchemy.md @@ -114,7 +114,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-ruby-mysql2.md b/develop/dev-guide-sample-application-ruby-mysql2.md index 45c1625f0acb2..a9192362b9826 100644 --- a/develop/dev-guide-sample-application-ruby-mysql2.md +++ b/develop/dev-guide-sample-application-ruby-mysql2.md @@ -110,7 +110,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/develop/dev-guide-sample-application-ruby-rails.md b/develop/dev-guide-sample-application-ruby-rails.md index 5b3339f16fcaa..0b5e7b6353515 100644 --- a/develop/dev-guide-sample-application-ruby-rails.md +++ b/develop/dev-guide-sample-application-ruby-rails.md @@ -100,7 +100,7 @@ Connect to TiDB depending on the TiDB deployment option you've selected.
-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. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .premium }}} instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**.