Skip to content

Commit

Permalink
cloud: rename Endpoint Type to Connection Type for TiDB Serverless (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-chi-bot authored Sep 4, 2024
1 parent 4c37e25 commit 5317bb6
Show file tree
Hide file tree
Showing 38 changed files with 42 additions and 42 deletions.
2 changes: 1 addition & 1 deletion develop/dev-guide-gui-datagrip.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `DataGrip`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-gui-dbeaver.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `DBeaver`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-gui-mysql-workbench.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `MySQL Workbench`.
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-gui-navicat.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `Navicat`.
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-gui-vscode-sqltools.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `VS Code`.
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-aws-lambda.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-golang-gorm.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-golang-sql-driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-java-hibernate.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-java-mybatis.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-java-spring-boot.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-nextjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-nodejs-mysql2.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `General`.
- **Operating System** matches the operating system where you run the application.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-nodejs-mysqljs.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `General`.
- **Operating System** matches the operating system where you run the application.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-nodejs-prisma.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `Prisma`.
- **Operating System** matches the operating system where you run the application.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-nodejs-sequelize.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-nodejs-typeorm.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `General`.
- **Operating System** matches the operating system where you run the application.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-python-django.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-python-mysqlclient.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-python-peewee.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-python-pymysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-python-sqlalchemy.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-ruby-mysql2.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `General`.
- **Operating System** matches the operating system where you run the application.
Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-sample-application-ruby-rails.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele

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

3. In the connection dialog, select `Rails` from the **Connect With** drop-down list and keep the default setting of the **Endpoint Type** as `Public`.
3. In the connection dialog, select `Rails` from the **Connect With** drop-down list and keep the default setting of the **Connection Type** as `Public`.

4. If you have not set a password yet, click **Generate Password** to generate a random password.

Expand Down
8 changes: 4 additions & 4 deletions tidb-cloud/connect-via-standard-connection-serverless.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ To connect to a TiDB Serverless cluster via public endpoint, take the following

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

3. In the dialog, keep the default setting of the endpoint type as `Public`, and select your preferred connection method and operating system to get the corresponding connection string.
3. In the dialog, keep the default setting of the connection type as `Public`, and select your preferred connection method and operating system to get the corresponding connection string.

> **Note:**
>
> - Keeping the endpoint type as `Public` means the connection is via standard TLS connection. For more information, see [TLS Connection to TiDB Serverless](/tidb-cloud/secure-connections-to-serverless-clusters.md).
> - If you choose **Private** in the **Endpoint Type** drop-down list, it means that the connection is via private endpoint. For more information, see [Connect to TiDB Serverless via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md).
> - Keeping the connection type as `Public` means the connection is via standard TLS connection. For more information, see [TLS Connection to TiDB Serverless](/tidb-cloud/secure-connections-to-serverless-clusters.md).
> - If you choose **Private Endpoint** in the **Connection Type** drop-down list, it means that the connection is via private endpoint. For more information, see [Connect to TiDB Serverless via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md).
4. TiDB Serverless lets you create [branches](/tidb-cloud/branch-overview.md) for your cluster. After a branch is created, you can choose to connect to the branch via the **Branch** drop-down list. `main` represents the cluster itself.

Expand All @@ -46,7 +46,7 @@ If you do not need to use a public endpoint of a TiDB Serverless cluster, you ca

3. Click **Disable** in the confirmation dialog.

After disabling the public endpoint, the `Public` entry in the **Endpoint Type** drop-down list of the connect dialog is disabled. If users are still trying to access the cluster from the public endpoint, they will get an error.
After disabling the public endpoint, the `Public` entry in the **Connection Type** drop-down list of the connect dialog is disabled. If users are still trying to access the cluster from the public endpoint, they will get an error.

> **Note:**
>
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/dev-guide-wordpress.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Configure the WordPress database connection to TiDB Serverless.

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Connect With** is set to `WordPress`.
- **Operating System** is set to `Debian/Ubuntu/Arch`.
- **Database** is set to the database you want to use—for example, `test`.
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/import-with-mysql-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Connect With** is set to `MySQL CLI`.
- **Operating System** matches your environment.

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/secure-connections-to-serverless-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of dif

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

3. In the dialog, keep the default setting of the endpoint type as `Public`, and select your preferred connection method and operating system.
3. In the dialog, keep the default setting of the connection type as `Public`, and select your preferred connection method and operating system.

4. If you have not set a password yet, click **Generate Password** to generate a random password for your TiDB Serverless cluster. The password will be automatically embedded in the sample connection string for connecting to your cluster easily.

Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/set-up-private-endpoint-connections-serverless.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To connect to your TiDB Serverless cluster via a private endpoint, follow these

1. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click the name of your target TiDB Serverless cluster to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed.
3. In the **Endpoint Type** drop-down list, select **Private**.
3. In the **Connection Type** drop-down list, select **Private Endpoint**.
4. Take a note of **Service Name**, **Availability Zone ID**, and **Region ID**.

> **Note:**
Expand Down Expand Up @@ -103,7 +103,7 @@ After you have created the interface endpoint, go back to the TiDB Cloud console

1. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click the name of your target cluster to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed.
3. In the **Endpoint Type** drop-down list, select **Private**.
3. In the **Connection Type** drop-down list, select **Private Endpoint**.
4. In the **Connect With** drop-down list, select your preferred connection method. The corresponding connection string is displayed at the bottom of the dialog.
5. Connect to your cluster with the connection string.

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/vector-search-get-started-using-python.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ pip install sqlalchemy pymysql sentence-transformers tidb-vector python-dotenv

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `SQLAlchemy`.
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/vector-search-get-started-using-sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To complete this tutorial, you need:

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

3. In the connection dialog, select **MySQL CLI** from the **Connect With** drop-down list and keep the default setting of the **Endpoint Type** as **Public**.
3. In the connection dialog, select **MySQL CLI** from the **Connect With** drop-down list and keep the default setting of the **Connection Type** as **Public**.

4. If you have not set a password yet, click **Generate Password** to generate a random password.

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/vector-search-integrate-with-django-orm.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ For more information, refer to [django-tidb repository](https://github.com/pingc

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `General`
- **Operating System** matches your environment.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Get the Jina AI API key from the [Jina AI Embeddings API](https://jina.ai/embedd

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`
- **Connection Type** is set to `Public`
- **Branch** is set to `main`
- **Connect With** is set to `SQLAlchemy`
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/vector-search-integrate-with-langchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ from langchain_text_splitters import CharacterTextSplitter

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `SQLAlchemy`.
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/vector-search-integrate-with-llamaindex.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ from llama_index.vector_stores.tidbvector import TiDBVectorStore

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `SQLAlchemy`.
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/vector-search-integrate-with-peewee.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ pip install peewee pymysql python-dotenv tidb-vector

3. Ensure the configurations in the connection dialog match your operating environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `General`.
- **Operating System** matches your environment.
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/vector-search-integrate-with-sqlalchemy.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ pip install pymysql python-dotenv sqlalchemy tidb-vector

3. Ensure the configurations in the connection dialog match your environment.

- **Endpoint Type** is set to `Public`.
- **Connection Type** is set to `Public`.
- **Branch** is set to `main`.
- **Connect With** is set to `SQLAlchemy`.
- **Operating System** matches your environment.
Expand Down

0 comments on commit 5317bb6

Please sign in to comment.