diff --git a/develop/dev-guide-gui-datagrip.md b/develop/dev-guide-gui-datagrip.md index 639a9ec9df37e..4561689dece34 100644 --- a/develop/dev-guide-gui-datagrip.md +++ b/develop/dev-guide-gui-datagrip.md @@ -78,46 +78,44 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-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 171d1f65d11cb..b0a40e917f4fe 100644 --- a/develop/dev-guide-gui-dbeaver.md +++ b/develop/dev-guide-gui-dbeaver.md @@ -89,42 +89,41 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-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 4835104da1b55..d792d6b50defc 100644 --- a/develop/dev-guide-gui-mysql-workbench.md +++ b/develop/dev-guide-gui-mysql-workbench.md @@ -80,41 +80,38 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se
-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 46d52804588a4..caf82fed32414 100644 --- a/develop/dev-guide-gui-navicat.md +++ b/develop/dev-guide-gui-navicat.md @@ -76,43 +76,40 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se
-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 d9319f5fc39d0..cd5e9d4241029 100644 --- a/develop/dev-guide-gui-vscode-sqltools.md +++ b/develop/dev-guide-gui-vscode-sqltools.md @@ -96,48 +96,45 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se
-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 7a4ae1274f297..98344b13a9334 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 7f6c32671790a..3a27330b33789 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 691c3d4782f47..d5154a671892a 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 9f4f9c88a7f85..cbc0db62a86a1 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 4f91a46b5ad76..d3cac50277921 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 f5b314441abdf..5aba468b46120 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 279703e16dbab..f1dfd2efad520 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 f406c617d2560..a8a5e8c88e37f 100644 --- a/develop/dev-guide-sample-application-nextjs.md +++ b/develop/dev-guide-sample-application-nextjs.md @@ -116,29 +116,26 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 your TiDB cluster depending on the TiDB deployment option you've sele 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 d4509f884efd2..b0e6b7f747897 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 bd1be74d6bd42..12844c1298c8a 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 5b5e75de20b74..51629a25262e2 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 16a022623bf25..0459d72c4ce43 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 e681cab0b8dd9..b3cc9d06edaf2 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 469edb6a43c0a..ad8731c5b582d 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 baff77afffa76..b74b86294deb1 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 63dd6bdbf77c4..a486142af31c0 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 6735f0370d40f..83e6764921d4c 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 4d4bc592a2902..cddc4b8f13303 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 40a65c497442b..ec175f3df5085 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 217a744c17bb9..e4e9f13a60771 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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 your TiDB cluster depending on the TiDB deployment option you've sele 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 1c60e30493c6c..9d9a672b7e954 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 your TiDB cluster depending on the TiDB deployment option you've sele
-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.