diff --git a/TOC-develop.md b/TOC-develop.md index 2666d25b2700b..77dab88ec51e5 100644 --- a/TOC-develop.md +++ b/TOC-develop.md @@ -5,7 +5,7 @@ ## QUICK START -- [Create a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md) +- [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md) - [TiDB Basics](/develop/dev-guide-tidb-basics.md) - [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md) diff --git a/TOC-tidb-cloud-starter.md b/TOC-tidb-cloud-starter.md index d8fa6020884bd..5c78a9747ac62 100644 --- a/TOC-tidb-cloud-starter.md +++ b/TOC-tidb-cloud-starter.md @@ -30,22 +30,21 @@ ## GUIDES -- Manage Cluster - - [Select Your Cluster Plan](/tidb-cloud/select-cluster-tier.md) - - Manage TiDB Cloud Clusters - - [Create a TiDB Cloud Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) - - Connect to Your TiDB Cloud Cluster - - [Network Connection Overview](/tidb-cloud/connect-to-tidb-cluster-serverless.md) - - [Connect via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) - - [Connect via Private Endpoint with AWS](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) - - [Connect via Private Endpoint with Alibaba Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) - - Branch ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) - - [Overview](/tidb-cloud/branch-overview.md) - - [Manage Branches](/tidb-cloud/branch-manage.md) - - [GitHub Integration](/tidb-cloud/branch-github-integration.md) - - [Manage Spending Limit](/tidb-cloud/manage-serverless-spend-limit.md) - - [Back Up and Restore TiDB Cloud Data](/tidb-cloud/backup-and-restore-serverless.md) - - [Export Data from TiDB Cloud](/tidb-cloud/serverless-export.md) +- Manage TiDB resources + - [Select a Plan](/tidb-cloud/select-cluster-tier.md) + - [Create a {{{ .starter }}} Instance](/tidb-cloud/create-tidb-cluster-serverless.md) + - Connect to Your {{{ .starter }}} Instance + - [Network Connection Overview](/tidb-cloud/connect-to-tidb-cluster-serverless.md) + - [Connect via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) + - [Connect via Private Endpoint with AWS](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) + - [Connect via Private Endpoint with Alibaba Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) + - Branch ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [Overview](/tidb-cloud/branch-overview.md) + - [Manage Branches](/tidb-cloud/branch-manage.md) + - [GitHub Integration](/tidb-cloud/branch-github-integration.md) + - [Manage Spending Limit](/tidb-cloud/manage-serverless-spend-limit.md) + - [Back Up and Restore TiDB Cloud Data](/tidb-cloud/backup-and-restore-serverless.md) + - [Export Data from TiDB Cloud](/tidb-cloud/serverless-export.md) - Use an HTAP Cluster with TiFlash - [TiFlash Overview](/tiflash/tiflash-overview.md) - [Create TiFlash Replicas](/tiflash/create-tiflash-replicas.md) @@ -133,7 +132,7 @@ - [Naming Conventions for Data Import](/tidb-cloud/naming-conventions-for-data-import.md) - [CSV Configurations for Importing Data](/tidb-cloud/csv-config-for-import-data.md) - [Troubleshoot Access Denied Errors during Data Import from Amazon S3](/tidb-cloud/troubleshoot-import-access-denied-error.md) - - [Connect AWS DMS to TiDB Cloud clusters](/tidb-cloud/tidb-cloud-connect-aws-dms.md) + - [Connect AWS DMS to TiDB Cloud Resources](/tidb-cloud/tidb-cloud-connect-aws-dms.md) - Explore Data - [Chat2Query in SQL Editor](/tidb-cloud/explore-data-with-chat2query.md) ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) - [SQL Proxy Account](/tidb-cloud/sql-proxy-account.md) diff --git a/ai/examples/auto-embedding-with-pytidb.md b/ai/examples/auto-embedding-with-pytidb.md index 3f963ff0eac4c..98b7cf49195b9 100644 --- a/ai/examples/auto-embedding-with-pytidb.md +++ b/ai/examples/auto-embedding-with-pytidb.md @@ -17,7 +17,7 @@ This example shows how to use the [Auto Embedding](/ai/integrations/vector-searc Before you begin, ensure you have the following: - **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). ## How to run @@ -38,7 +38,7 @@ pip install -r reqs.txt ### Step 3. Set environment variables -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed. 3. Set environment variables according to the connection parameters as follows: diff --git a/ai/examples/basic-with-pytidb.md b/ai/examples/basic-with-pytidb.md index 402a2a1c0fba2..5cea4e912d91c 100644 --- a/ai/examples/basic-with-pytidb.md +++ b/ai/examples/basic-with-pytidb.md @@ -16,7 +16,7 @@ This example demonstrates basic CRUD (Create, Read, Update, Delete) operations u Before you begin, ensure you have the following: - **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). ## How to run @@ -37,7 +37,7 @@ pip install -r reqs.txt ### Step 3. Set environment variables -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed. 3. Set environment variables according to the connection parameters as follows: diff --git a/ai/examples/fulltext-search-with-pytidb.md b/ai/examples/fulltext-search-with-pytidb.md index c3dd12bfabe36..6debe5b661eea 100644 --- a/ai/examples/fulltext-search-with-pytidb.md +++ b/ai/examples/fulltext-search-with-pytidb.md @@ -17,7 +17,7 @@ This example demonstrates how to build an e-commerce product search app using Ti Before you begin, ensure you have the following: - **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). ## How to run @@ -40,7 +40,7 @@ pip install -r reqs.txt ### Step 3. Set environment variables -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed. 3. Set environment variables according to the connection parameters as follows: diff --git a/ai/examples/hybrid-search-with-pytidb.md b/ai/examples/hybrid-search-with-pytidb.md index 166d5340ce894..6ce50fd3d77c2 100644 --- a/ai/examples/hybrid-search-with-pytidb.md +++ b/ai/examples/hybrid-search-with-pytidb.md @@ -17,7 +17,7 @@ This demo shows how to combine vector search and full-text search to improve the Before you begin, ensure you have the following: - **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). - **OpenAI API key**: Get an OpenAI API key from [OpenAI](https://platform.openai.com/api-keys). > **Note** @@ -47,7 +47,7 @@ pip install -r reqs.txt ### Step 3. Set environment variables -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed. 3. Set environment variables according to the connection parameters as follows: diff --git a/ai/examples/image-search-with-pytidb.md b/ai/examples/image-search-with-pytidb.md index 042b09fc95177..3080252eb2734 100644 --- a/ai/examples/image-search-with-pytidb.md +++ b/ai/examples/image-search-with-pytidb.md @@ -22,7 +22,7 @@ With just a few lines of code, you can create a search system that understands b Before you begin, ensure you have the following: - **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). - **Jina AI API key**: You can get a free API key from [Jina AI Embeddings](https://jina.ai/embeddings/). ## How to run @@ -46,7 +46,7 @@ pip install -r reqs.txt ### Step 3. Set environment variables -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed. 3. Set environment variables according to the connection parameters as follows: diff --git a/ai/examples/memory-with-pytidb.md b/ai/examples/memory-with-pytidb.md index 1263e7cc139a7..f9f52c0a97552 100644 --- a/ai/examples/memory-with-pytidb.md +++ b/ai/examples/memory-with-pytidb.md @@ -24,7 +24,7 @@ With just a few lines of code, you can create a conversational AI that remembers Before you begin, ensure you have the following: - **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). - **OpenAI API key**: Get an OpenAI API key from [OpenAI](https://platform.openai.com/api-keys). ## How to run @@ -48,7 +48,7 @@ pip install -r reqs.txt ### Step 3. Set environment variables -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed. 3. Set environment variables according to the connection parameters as follows: diff --git a/ai/examples/rag-with-pytidb.md b/ai/examples/rag-with-pytidb.md index be06bdbf493be..5e8aaa37f0158 100644 --- a/ai/examples/rag-with-pytidb.md +++ b/ai/examples/rag-with-pytidb.md @@ -19,7 +19,7 @@ The application uses [Ollama](https://ollama.com/download) for local embedding g Before you begin, ensure you have the following: - **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). - **Ollama**: Install from [Ollama](https://ollama.com/download). ## How to run @@ -67,7 +67,7 @@ pip install -r reqs.txt ### Step 4. Set environment variables -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed. 3. Set environment variables according to the connection parameters as follows: diff --git a/ai/examples/text2sql-with-pytidb.md b/ai/examples/text2sql-with-pytidb.md index 8f3b637d76923..764ed5b990b55 100644 --- a/ai/examples/text2sql-with-pytidb.md +++ b/ai/examples/text2sql-with-pytidb.md @@ -12,7 +12,7 @@ This demo shows how to build an AI-powered interface that converts natural-langu Before you begin, ensure you have the following: - **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). - **OpenAI API key**: Get an OpenAI API key from [OpenAI](https://platform.openai.com/api-keys). ## How to run diff --git a/ai/examples/vector-search-with-pytidb.md b/ai/examples/vector-search-with-pytidb.md index a9d76e2684fc6..1961282d7204f 100644 --- a/ai/examples/vector-search-with-pytidb.md +++ b/ai/examples/vector-search-with-pytidb.md @@ -19,7 +19,7 @@ The application uses [Ollama](https://ollama.com/download) for local embedding g Before you begin, ensure you have the following: - **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). - **Ollama**: Install from [Ollama](https://ollama.com/download). ## How to run @@ -58,7 +58,7 @@ pip install -r reqs.txt ### Step 4. Set environment variables -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed. 3. Set environment variables according to the connection parameters as follows: diff --git a/ai/guides/connect.md b/ai/guides/connect.md index 9d2e264f4ca16..e2701c39787ba 100644 --- a/ai/guides/connect.md +++ b/ai/guides/connect.md @@ -24,7 +24,7 @@ Choose the steps based on your TiDB deployment type:
-You can [create a TiDB Cloud Starter cluster](https://tidbcloud.com/free-trial/), and then get the connection parameters from the web console as follows: +You can [create a TiDB Cloud Starter instance](https://tidbcloud.com/free-trial/), and then get the connection parameters from the web console as follows: 1. Navigate to the [Clusters page](https://tidbcloud.com/clusters), and then click the name of your target cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed. @@ -46,7 +46,7 @@ db = TiDBClient.connect( > **Note:** > -> For TiDB Cloud Starter, [TLS connection to the database](https://docs.pingcap.com/tidbcloud/secure-connections-to-starter-clusters/) is required when using a public endpoint. The `pytidb` client **automatically** enables TLS for TiDB Cloud Starter clusters. +> For TiDB Cloud Starter, [TLS connection to the database](https://docs.pingcap.com/tidbcloud/secure-connections-to-starter-clusters/) is required when using a public endpoint. The `pytidb` client **automatically** enables TLS for TiDB Cloud Starter instances.
@@ -83,7 +83,7 @@ If you prefer to use a connection string (database URL), you can follow the form
-You can [create a TiDB Cloud Starter cluster](https://tidbcloud.com/free-trial/), and then get the connection parameters from the web console as follows: +You can [create a TiDB Cloud Starter instance](https://tidbcloud.com/free-trial/), and then get the connection parameters from the web console as follows: 1. Navigate to the [Clusters page](https://tidbcloud.com/clusters), and then click the name of your target cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with the connection parameters listed. diff --git a/ai/guides/vector-search-full-text-search-python.md b/ai/guides/vector-search-full-text-search-python.md index 38f38d6c191ca..567ae509accb3 100644 --- a/ai/guides/vector-search-full-text-search-python.md +++ b/ai/guides/vector-search-full-text-search-python.md @@ -30,7 +30,7 @@ Full-text search is still in the early stages, and we are continuously rolling i - AWS: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)` -To complete this tutorial, make sure you have a {{{ .starter }}} cluster in a supported region. If you don't have one, follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create it. +To complete this tutorial, make sure you have a {{{ .starter }}} instance in a supported region. If you don't have one, follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create it. ## Get started @@ -66,7 +66,7 @@ db = TiDBClient.connect( You can get these connection parameters from the [TiDB Cloud console](https://tidbcloud.com) as follows: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed. @@ -81,7 +81,7 @@ You can get these connection parameters from the [TiDB Cloud console](https://ti CA: /etc/ssl/cert.pem ``` - The corresponding Python code to connect to the {{{ .starter }}} cluster would be as follows: + The corresponding Python code to connect to the {{{ .starter }}} instance would be as follows: ```python db = TiDBClient.connect( diff --git a/ai/guides/vector-search-full-text-search-sql.md b/ai/guides/vector-search-full-text-search-sql.md index 88ec66f57b5e8..33170b8879087 100644 --- a/ai/guides/vector-search-full-text-search-sql.md +++ b/ai/guides/vector-search-full-text-search-sql.md @@ -30,7 +30,7 @@ Full-text search is still in the early stages, and we are continuously rolling i - AWS: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)` -Before using full-text search, make sure your {{{ .starter }}} cluster is created in a supported region. If you don't have one, follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create it. +Before using full-text search, make sure your {{{ .starter }}} instance is created in a supported region. If you don't have one, follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create it. To perform a full-text search, follow these steps: diff --git a/ai/guides/vector-search-hybrid-search.md b/ai/guides/vector-search-hybrid-search.md index 4058eec9ff56e..a522f219d5877 100644 --- a/ai/guides/vector-search-hybrid-search.md +++ b/ai/guides/vector-search-hybrid-search.md @@ -23,7 +23,7 @@ Full-text search is still in the early stages, and we are continuously rolling i - AWS: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)` -To complete this tutorial, make sure you have a {{{ .starter }}} cluster in a supported region. If you don't have one, follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create it. +To complete this tutorial, make sure you have a {{{ .starter }}} instance in a supported region. If you don't have one, follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create it. ## Get started @@ -55,7 +55,7 @@ db = TiDBClient.connect( You can get these connection parameters from the [TiDB Cloud console](https://tidbcloud.com) as follows: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed. @@ -70,7 +70,7 @@ You can get these connection parameters from the [TiDB Cloud console](https://ti CA: /etc/ssl/cert.pem ``` - The corresponding Python code to connect to the {{{ .starter }}} cluster would be as follows: + The corresponding Python code to connect to the {{{ .starter }}} instance would be as follows: ```python db = TiDBClient.connect( diff --git a/ai/integrations/embedding-openai-compatible.md b/ai/integrations/embedding-openai-compatible.md index d89e940586cf5..178f6a30f81fc 100644 --- a/ai/integrations/embedding-openai-compatible.md +++ b/ai/integrations/embedding-openai-compatible.md @@ -9,7 +9,7 @@ This tutorial demonstrates how to use OpenAI-compatible embedding services to ge > **Note:** > -> Currently, [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} clusters hosted on AWS. +> Currently, [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} instances hosted on AWS. ## OpenAI-compatible embedding services diff --git a/ai/integrations/tidb-mcp-claude-code.md b/ai/integrations/tidb-mcp-claude-code.md index 9db834959194c..fa011827caaa7 100644 --- a/ai/integrations/tidb-mcp-claude-code.md +++ b/ai/integrations/tidb-mcp-claude-code.md @@ -13,7 +13,7 @@ Before you begin, ensure you have the following: - **Claude Code**: Install it from [claude.com](https://claude.com/product/claude-code). - **Python (>=3.10) and uv**: Ensure Python (3.10 or later) and `uv` are installed. Follow the [installation guide](https://docs.astral.sh/uv/getting-started/installation/) to install `uv`. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). ## Connect to TiDB Cloud Starter (recommended) diff --git a/ai/integrations/tidb-mcp-claude-desktop.md b/ai/integrations/tidb-mcp-claude-desktop.md index 5845b7b67bd5b..207a04226756f 100644 --- a/ai/integrations/tidb-mcp-claude-desktop.md +++ b/ai/integrations/tidb-mcp-claude-desktop.md @@ -13,7 +13,7 @@ Before you begin, ensure you have the following: - **Claude Desktop**: Download and install Claude Desktop from [claude.ai](https://claude.ai/download). - **Python (>=3.10) and uv**: Ensure Python (3.10 or later) and `uv` are installed. Follow the [installation guide](https://docs.astral.sh/uv/getting-started/installation/) to install `uv`. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). ## Setup steps diff --git a/ai/integrations/tidb-mcp-cursor.md b/ai/integrations/tidb-mcp-cursor.md index ad27fe67ffb08..2d8e8948a24ab 100644 --- a/ai/integrations/tidb-mcp-cursor.md +++ b/ai/integrations/tidb-mcp-cursor.md @@ -17,7 +17,7 @@ Before you begin, ensure you have the following: - **Cursor**: Download and install Cursor from [cursor.com](https://cursor.com). - **Python (>=3.10) and uv**: Ensure Python (3.10 or later) and `uv` are installed. Follow the [installation guide](https://docs.astral.sh/uv/getting-started/installation/) to install `uv`. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). ## Connect to TiDB Cloud Starter (recommended) diff --git a/ai/integrations/tidb-mcp-server.md b/ai/integrations/tidb-mcp-server.md index 241d8b48aea7d..e43673cd740b1 100644 --- a/ai/integrations/tidb-mcp-server.md +++ b/ai/integrations/tidb-mcp-server.md @@ -27,7 +27,7 @@ Before you begin, ensure you have the following: - **An MCP-compatible client**: For example, [Cursor](/ai/integrations/tidb-mcp-cursor.md) or [Claude Desktop](/ai/integrations/tidb-mcp-claude-desktop.md). - **Python (>=3.10) and uv**: Ensure Python (3.10 or later) and `uv` are installed. Follow the [installation guide](https://docs.astral.sh/uv/getting-started/installation/) to install `uv`. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). ## Supported MCP Clients diff --git a/ai/integrations/tidb-mcp-vscode.md b/ai/integrations/tidb-mcp-vscode.md index eabf765d86a62..7ee78e3d158ca 100644 --- a/ai/integrations/tidb-mcp-vscode.md +++ b/ai/integrations/tidb-mcp-vscode.md @@ -13,7 +13,7 @@ Before you begin, ensure you have the following: - **Visual Studio Code**: Download and install VS Code from [code.visualstudio.com](https://code.visualstudio.com). - **Python (>=3.10) and uv**: Ensure Python (3.10 or later) and `uv` are installed. Follow the [installation guide](https://docs.astral.sh/uv/getting-started/installation/) to install `uv`. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). ## Connect to TiDB Cloud Starter (recommended) diff --git a/ai/integrations/tidb-mcp-windsurf.md b/ai/integrations/tidb-mcp-windsurf.md index d7eeaa8e713a3..afc4002cedd75 100644 --- a/ai/integrations/tidb-mcp-windsurf.md +++ b/ai/integrations/tidb-mcp-windsurf.md @@ -13,7 +13,7 @@ Before you begin, ensure you have the following: - **Windsurf**: Download and install Windsurf from [windsurf.com](https://windsurf.com). - **Python (>=3.10) and uv**: Ensure Python (3.10 or later) and `uv` are installed. Follow the [installation guide](https://docs.astral.sh/uv/getting-started/installation/) to install `uv`. -- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). +- **A TiDB Cloud Starter instance**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial). ## Connect to TiDB Cloud Starter (recommended) diff --git a/ai/integrations/vector-search-auto-embedding-amazon-titan.md b/ai/integrations/vector-search-auto-embedding-amazon-titan.md index 5c002dbe8960f..92fe6432efae3 100644 --- a/ai/integrations/vector-search-auto-embedding-amazon-titan.md +++ b/ai/integrations/vector-search-auto-embedding-amazon-titan.md @@ -10,7 +10,7 @@ This document describes how to use Amazon Titan embedding models with [Auto Embe > **Note:** > -> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} clusters hosted on AWS. +> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} instances hosted on AWS. ## Available models diff --git a/ai/integrations/vector-search-auto-embedding-cohere.md b/ai/integrations/vector-search-auto-embedding-cohere.md index e099fb5c5be5e..1b9b4bc2cc760 100644 --- a/ai/integrations/vector-search-auto-embedding-cohere.md +++ b/ai/integrations/vector-search-auto-embedding-cohere.md @@ -10,7 +10,7 @@ This document describes how to use Cohere embedding models with [Auto Embedding] > **Note:** > -> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} clusters hosted on AWS. +> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} instances hosted on AWS. ## Available models diff --git a/ai/integrations/vector-search-auto-embedding-gemini.md b/ai/integrations/vector-search-auto-embedding-gemini.md index bd451c18164f1..2ce4bfb5f77e6 100644 --- a/ai/integrations/vector-search-auto-embedding-gemini.md +++ b/ai/integrations/vector-search-auto-embedding-gemini.md @@ -10,7 +10,7 @@ This document describes how to use Gemini embedding models with [Auto Embedding] > **Note:** > -> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} clusters hosted on AWS. +> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} instances hosted on AWS. ## Available models diff --git a/ai/integrations/vector-search-auto-embedding-huggingface.md b/ai/integrations/vector-search-auto-embedding-huggingface.md index 3853c54c73522..f03c9cf24b60f 100644 --- a/ai/integrations/vector-search-auto-embedding-huggingface.md +++ b/ai/integrations/vector-search-auto-embedding-huggingface.md @@ -10,7 +10,7 @@ This document describes how to use Hugging Face embedding models with [Auto Embe > **Note:** > -> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} clusters hosted on AWS. +> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} instances hosted on AWS. ## Available models diff --git a/ai/integrations/vector-search-auto-embedding-jina-ai.md b/ai/integrations/vector-search-auto-embedding-jina-ai.md index c6a3602bf9faf..4611b6e417ea7 100644 --- a/ai/integrations/vector-search-auto-embedding-jina-ai.md +++ b/ai/integrations/vector-search-auto-embedding-jina-ai.md @@ -10,7 +10,7 @@ This document describes how to use [Jina AI embedding models](https://jina.ai/em > **Note:** > -> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} clusters hosted on AWS. +> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} instances hosted on AWS. ## Available models diff --git a/ai/integrations/vector-search-auto-embedding-nvidia-nim.md b/ai/integrations/vector-search-auto-embedding-nvidia-nim.md index 364bf76bbc7a2..7bf7d87b52256 100644 --- a/ai/integrations/vector-search-auto-embedding-nvidia-nim.md +++ b/ai/integrations/vector-search-auto-embedding-nvidia-nim.md @@ -10,7 +10,7 @@ This document describes how to use NVIDIA NIM embedding models with [Auto Embedd > **Note:** > -> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} clusters hosted on AWS. +> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} instances hosted on AWS. ## Available models diff --git a/ai/integrations/vector-search-auto-embedding-openai.md b/ai/integrations/vector-search-auto-embedding-openai.md index c2b2f2034a658..79a8748dcfd87 100644 --- a/ai/integrations/vector-search-auto-embedding-openai.md +++ b/ai/integrations/vector-search-auto-embedding-openai.md @@ -10,7 +10,7 @@ This document describes how to use OpenAI embedding models with [Auto Embedding] > **Note:** > -> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} clusters hosted on AWS. +> [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} instances hosted on AWS. ## Available models diff --git a/ai/integrations/vector-search-auto-embedding-overview.md b/ai/integrations/vector-search-auto-embedding-overview.md index ecbbb2a8bc7ca..bbc12a988dc90 100644 --- a/ai/integrations/vector-search-auto-embedding-overview.md +++ b/ai/integrations/vector-search-auto-embedding-overview.md @@ -16,7 +16,7 @@ To use Auto Embedding, the basic workflow is as follows: > **Note:** > -> Auto Embedding is only available on {{{ .starter }}} clusters hosted on AWS. +> Auto Embedding is only available on {{{ .starter }}} instances hosted on AWS. ## Quick start example diff --git a/ai/integrations/vector-search-integrate-with-amazon-bedrock.md b/ai/integrations/vector-search-integrate-with-amazon-bedrock.md index 9a013e92d46c9..19c1e77489461 100644 --- a/ai/integrations/vector-search-integrate-with-amazon-bedrock.md +++ b/ai/integrations/vector-search-integrate-with-amazon-bedrock.md @@ -35,9 +35,9 @@ To complete this tutorial, you need: aws configure set region ``` -- A {{{ .starter }}} cluster +- A {{{ .starter }}} instance - Follow [creating a {{{ .starter }}} cluster](/tidb-cloud/select-cluster-tier.md#starter) to create your own TiDB Cloud cluster if you don't have one. + Follow [creating a {{{ .starter }}} instance](/tidb-cloud/select-cluster-tier.md#starter) to create your own TiDB Cloud cluster if you don't have one. - An AWS account with the [required permissions for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html) and access to the following models: @@ -54,7 +54,7 @@ This section provides step-by-step instructions to integrate TiDB Vector Search Get the TiDB connection information from the [TiDB Cloud console](https://tidbcloud.com/) and set the environment variables in your development environment as follows: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -242,7 +242,7 @@ Base.metadata.create_all(engine) ### Step 7. Save the vector data to {{{ .starter }}} -In `demo.py`, add the following code to save the vector data to your {{{ .starter }}} cluster: +In `demo.py`, add the following code to save the vector data to your {{{ .starter }}} instance: ```python # ---- Saving Vectors to TiDB ---- diff --git a/ai/integrations/vector-search-integrate-with-django-orm.md b/ai/integrations/vector-search-integrate-with-django-orm.md index d81a46641c0d8..1dd486e4e8d9b 100644 --- a/ai/integrations/vector-search-integrate-with-django-orm.md +++ b/ai/integrations/vector-search-integrate-with-django-orm.md @@ -23,7 +23,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app @@ -79,9 +79,9 @@ Configure the environment variables depending on the TiDB deployment option you'
-For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: +For a {{{ .starter }}} or Essential instance, take the following steps to obtain the cluster connection string and configure environment variables: -1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/ai/integrations/vector-search-integrate-with-jinaai-embedding.md b/ai/integrations/vector-search-integrate-with-jinaai-embedding.md index 2dafff89ce87f..5a6b59f62f2c2 100644 --- a/ai/integrations/vector-search-integrate-with-jinaai-embedding.md +++ b/ai/integrations/vector-search-integrate-with-jinaai-embedding.md @@ -23,7 +23,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app @@ -63,9 +63,9 @@ Get the Jina AI API key from the [Jina AI Embeddings API](https://jina.ai/embedd
-For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: +For a {{{ .starter }}} or Essential instance, take the following steps to obtain the cluster connection string and configure environment variables: -1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/ai/integrations/vector-search-integrate-with-langchain.md b/ai/integrations/vector-search-integrate-with-langchain.md index 201904fb49fba..2f1e5f9bb4131 100644 --- a/ai/integrations/vector-search-integrate-with-langchain.md +++ b/ai/integrations/vector-search-integrate-with-langchain.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Get started @@ -70,9 +70,9 @@ Configure the environment variables depending on the TiDB deployment option you'
-For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: +For a {{{ .starter }}} or Essential instance, take the following steps to obtain the cluster connection string and configure environment variables: -1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/ai/integrations/vector-search-integrate-with-llamaindex.md b/ai/integrations/vector-search-integrate-with-llamaindex.md index b9a20381b6101..6b546516b54bf 100644 --- a/ai/integrations/vector-search-integrate-with-llamaindex.md +++ b/ai/integrations/vector-search-integrate-with-llamaindex.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Get started @@ -69,9 +69,9 @@ Configure the environment variables depending on the TiDB deployment option you'
-For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: +For a {{{ .starter }}} or Essential instance, take the following steps to obtain the cluster connection string and configure environment variables: -1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/ai/integrations/vector-search-integrate-with-peewee.md b/ai/integrations/vector-search-integrate-with-peewee.md index d30fa1effc5a8..53a09f664857d 100644 --- a/ai/integrations/vector-search-integrate-with-peewee.md +++ b/ai/integrations/vector-search-integrate-with-peewee.md @@ -23,7 +23,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app @@ -69,9 +69,9 @@ Configure the environment variables depending on the TiDB deployment option you'
-For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: +For a {{{ .starter }}} or Essential instance, take the following steps to obtain the cluster connection string and configure environment variables: -1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/ai/integrations/vector-search-integrate-with-sqlalchemy.md b/ai/integrations/vector-search-integrate-with-sqlalchemy.md index 0432a3d9b844b..64663f8f32897 100644 --- a/ai/integrations/vector-search-integrate-with-sqlalchemy.md +++ b/ai/integrations/vector-search-integrate-with-sqlalchemy.md @@ -23,7 +23,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app @@ -69,9 +69,9 @@ Configure the environment variables depending on the TiDB deployment option you'
-For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: +For a {{{ .starter }}} or Essential instance, take the following steps to obtain the cluster connection string and configure environment variables: -1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/ai/quickstart-via-python.md b/ai/quickstart-via-python.md index a6edc20cdca37..b711460cdcfd3 100644 --- a/ai/quickstart-via-python.md +++ b/ai/quickstart-via-python.md @@ -22,7 +22,7 @@ By following this document, you will learn how to: ## Prerequisites -- Go to [tidbcloud.com](https://tidbcloud.com/) to create a TiDB Cloud Starter cluster for free or using [tiup playground](https://docs.pingcap.com/tidb/stable/quick-start-with-tidb/#deploy-a-local-test-cluster) to deploy a TiDB Self-Managed cluster for local testing. +- Go to [tidbcloud.com](https://tidbcloud.com/) to create a TiDB Cloud Starter instance for free or using [tiup playground](https://docs.pingcap.com/tidb/stable/quick-start-with-tidb/#deploy-a-local-test-cluster) to deploy a TiDB Self-Managed cluster for local testing. ## Installation @@ -61,7 +61,7 @@ DATABASE: test CA: /etc/ssl/cert.pem ``` -The corresponding Python code to connect to the TiDB Cloud Starter cluster would be as follows: +The corresponding Python code to connect to the TiDB Cloud Starter instance would be as follows: ```python from pytidb import TiDBClient diff --git a/ai/quickstart-via-sql.md b/ai/quickstart-via-sql.md index eefe644429ead..a20a0b6324c33 100644 --- a/ai/quickstart-via-sql.md +++ b/ai/quickstart-via-sql.md @@ -29,7 +29,7 @@ To complete steps in this document, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Get started @@ -39,9 +39,9 @@ To complete steps in this document, you need: Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/ai/vector-search-get-started-using-python.md b/ai/vector-search-get-started-using-python.md index df34d7b755107..5eea22efc6048 100644 --- a/ai/vector-search-get-started-using-python.md +++ b/ai/vector-search-get-started-using-python.md @@ -25,7 +25,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Get started @@ -58,11 +58,11 @@ pip install sqlalchemy pymysql sentence-transformers tidb-vector python-dotenv Configure the cluster connection string depending on the TiDB deployment option you've selected. -
+
-For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: +For a {{{ .starter }}} instance, take the following steps to obtain the cluster connection string and configure environment variables: -1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-aws-appflow-integration.md b/develop/dev-guide-aws-appflow-integration.md index a826da95e3a69..f3400e49cb679 100644 --- a/develop/dev-guide-aws-appflow-integration.md +++ b/develop/dev-guide-aws-appflow-integration.md @@ -8,7 +8,7 @@ aliases: ['/tidb/stable/dev-guide-aws-appflow-integration/','/tidb/dev/dev-guide [Amazon AppFlow](https://aws.amazon.com/appflow/) is a fully managed API integration service that you use to connect your software as a service (SaaS) applications to AWS services, and securely transfer data. With Amazon AppFlow, you can import and export data from and to TiDB into many types of data providers, such as Salesforce, Amazon S3, LinkedIn, and GitHub. For more information, see [Supported source and destination applications](https://docs.aws.amazon.com/appflow/latest/userguide/app-specific.html) in AWS documentation. -This document describes how to integrate TiDB with Amazon AppFlow and takes integrating a {{{ .starter }}} cluster as an example. +This document describes how to integrate TiDB with Amazon AppFlow and takes integrating a {{{ .starter }}} instance as an example. If you do not have a TiDB cluster, you can create a [{{{ .starter }}}](https://tidbcloud.com/console/clusters) cluster, which is free and can be created in approximately 30 seconds. @@ -149,7 +149,7 @@ Choose the **Source details** and **Destination details**. TiDB connector can be ``` 5. After the `sf_account` table is created, click **Connect**. A connection dialog is displayed. -6. In the **Connect to TiDB-Connector** dialog, enter the connection properties of the TiDB cluster. If you use a {{{ .starter }}} cluster, you need to set the **TLS** option to `Yes`, which lets the TiDB connector use the TLS connection. Then, click **Connect**. +6. In the **Connect to TiDB-Connector** dialog, enter the connection properties of the TiDB cluster. If you use a {{{ .starter }}} instance, you need to set the **TLS** option to `Yes`, which lets the TiDB connector use the TLS connection. Then, click **Connect**. ![tidb connection message](/media/develop/aws-appflow-step-tidb-connection-message.png) diff --git a/develop/dev-guide-bookshop-schema-design.md b/develop/dev-guide-bookshop-schema-design.md index 3058b6b6cd833..55617e69389ed 100644 --- a/develop/dev-guide-bookshop-schema-design.md +++ b/develop/dev-guide-bookshop-schema-design.md @@ -75,7 +75,7 @@ You can delete the original table structure through the `--drop-tables` paramete 1. Open the **Import** page for your target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > diff --git a/develop/dev-guide-build-cluster-in-cloud.md b/develop/dev-guide-build-cluster-in-cloud.md index d4f98b7415855..aaac8d5d58ef6 100644 --- a/develop/dev-guide-build-cluster-in-cloud.md +++ b/develop/dev-guide-build-cluster-in-cloud.md @@ -1,28 +1,28 @@ --- -title: Create a {{{ .starter }}} Cluster -summary: Learn how to create a {{{ .starter }}} cluster and connect to it. +title: Create a {{{ .starter }}} Instance +summary: Learn how to create a {{{ .starter }}} instance and connect to it. aliases: ['/tidb/stable/dev-guide-build-cluster-in-cloud/','/tidb/dev/dev-guide-build-cluster-in-cloud/','/tidbcloud/dev-guide-build-cluster-in-cloud/'] --- -# Create a {{{ .starter }}} Cluster +# Create a {{{ .starter }}} Instance -This document walks you through the quickest way to get started with TiDB. You will use [TiDB Cloud](https://www.pingcap.com/tidb-cloud) to create a {{{ .starter }}} cluster, connect to it, and run a sample application on it. +This document walks you through the quickest way to get started with TiDB. You will use [TiDB Cloud](https://www.pingcap.com/tidb-cloud) to create a {{{ .starter }}} instance, connect to it, and run a sample application on it. If you need to run TiDB on your local machine, see [Starting TiDB Locally](/quick-start-with-tidb.md). -## Step 1. Create a {{{ .starter }}} cluster {#step-1-create-a-tidb-cloud-cluster} +## Step 1. Create a {{{ .starter }}} instance {#step-1-create-a-tidb-cloud-cluster} 1. If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/free-trial) to sign up for an account. 2. [Log in](https://tidbcloud.com/) to your TiDB Cloud account. -3. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click **Create Cluster**. +3. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click **Create Resource**. -4. On the **Create Cluster** page, **Starter** is selected by default. Update the default cluster name if necessary, and then select the region where you want to create your cluster. +4. On the **Create** page, **Starter** is selected by default. Update the default cluster name if necessary, and then select the region where you want to create your cluster. -5. Click **Create** to create a {{{ .starter }}} cluster. +5. Click **Create** to create a {{{ .starter }}} instance. Your TiDB Cloud cluster will be created in approximately 30 seconds. @@ -34,7 +34,7 @@ If you need to run TiDB on your local machine, see [Starting TiDB Locally](/quic > **Note:** > -> For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) clusters, when you connect to your cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](https://docs.pingcap.com/tidbcloud/select-cluster-tier#user-name-prefix). +> For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) instances, when you connect to your cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](https://docs.pingcap.com/tidbcloud/select-cluster-tier#user-name-prefix). ## Step 2. Connect to a cluster @@ -119,8 +119,8 @@ mysql Ver 15.1 Distrib 5.5.68-MariaDB, for Linux (x86_64) using readline 5.1 > **Note:** > -> - When you connect to a {{{ .starter }}} cluster, you must [use the TLS connection](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-clusters). -> - If you encounter problems when connecting to a {{{ .starter }}} cluster, you can read [Secure Connections to {{{ .starter }}} Clusters](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-clusters) for more information. +> - When you connect to a {{{ .starter }}} instance, you must [use the TLS connection](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-clusters). +> - If you encounter problems when connecting to a {{{ .starter }}} instance, you can read [Secure Connections to {{{ .starter }}} Instances](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-clusters) for more information. 3. Fill in the password to sign in. diff --git a/develop/dev-guide-connect-to-tidb.md b/develop/dev-guide-connect-to-tidb.md index c28d37a0caa3b..4247bac45d841 100644 --- a/develop/dev-guide-connect-to-tidb.md +++ b/develop/dev-guide-connect-to-tidb.md @@ -20,7 +20,7 @@ TiDB is highly compatible with the MySQL protocol, so you can connect to it usin - To build applications on TiDB, [choose a driver or ORM](/develop/dev-guide-choose-driver-or-orm.md) based on your programming language and framework. -- To connect to {{{ .starter }}} or {{{ .essential }}} clusters from edge environments via HTTP, use the [TiDB Cloud Serverless Driver](/develop/serverless-driver.md). Note that the serverless driver is in beta and only applicable to {{{ .starter }}} or {{{ .essential }}} clusters. +- To connect to {{{ .starter }}} or {{{ .essential }}} instances from edge environments via HTTP, use the [TiDB Cloud Serverless Driver](/develop/serverless-driver.md). Note that the serverless driver is in beta and only applicable to {{{ .starter }}} or {{{ .essential }}} instances. ## Need help? diff --git a/develop/dev-guide-create-database.md b/develop/dev-guide-create-database.md index 17b4dff049f57..93676cc9cc599 100644 --- a/develop/dev-guide-create-database.md +++ b/develop/dev-guide-create-database.md @@ -12,7 +12,7 @@ This document describes how to create a database using SQL and various programmi Before creating a database, do the following: -- [Create a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md). - Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md). ## What is database diff --git a/develop/dev-guide-create-secondary-indexes.md b/develop/dev-guide-create-secondary-indexes.md index d6ffb927eab37..8c4dfaa7fc132 100644 --- a/develop/dev-guide-create-secondary-indexes.md +++ b/develop/dev-guide-create-secondary-indexes.md @@ -12,7 +12,7 @@ This document describes how to create a secondary index using SQL and various pr Before creating a secondary index, do the following: -- [Create a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md). - Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md). - [Create a Database](/develop/dev-guide-create-database.md). - [Create a Table](/develop/dev-guide-create-table.md). diff --git a/develop/dev-guide-create-table.md b/develop/dev-guide-create-table.md index 5d66ed9af5b1f..a3e9335a35f52 100644 --- a/develop/dev-guide-create-table.md +++ b/develop/dev-guide-create-table.md @@ -12,7 +12,7 @@ This document introduces how to create tables using the SQL statement and the re Before reading this document, make sure that the following tasks are completed: -- [Create a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md). - Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md). - [Create a Database](/develop/dev-guide-create-database.md). @@ -263,7 +263,7 @@ ALTER TABLE `bookshop`.`ratings` SET TIFLASH REPLICA 1; > **Note:** > -> If your cluster does not contain **TiFlash** nodes, this SQL statement will report an error: `1105 - the tiflash replica count: 1 should be less than the total tiflash server count: 0`. You can use [Create a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-cloud-cluster) to create a {{{ .starter }}} cluster that includes **TiFlash**. +> If your cluster does not contain **TiFlash** nodes, this SQL statement will report an error: `1105 - the tiflash replica count: 1 should be less than the total tiflash server count: 0`. You can use [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-cloud-cluster) to create a {{{ .starter }}} instance that includes **TiFlash**. Then you can go on to perform the following query: diff --git a/develop/dev-guide-delete-data.md b/develop/dev-guide-delete-data.md index ca695370ffede..64c6a7d7327ac 100644 --- a/develop/dev-guide-delete-data.md +++ b/develop/dev-guide-delete-data.md @@ -12,7 +12,7 @@ This document describes how to use the [DELETE](/sql-statements/sql-statement-de Before reading this document, you need to prepare the following: -- [Create a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md) +- [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md) - Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md), [Create a Database](/develop/dev-guide-create-database.md), [Create a Table](/develop/dev-guide-create-table.md), and [Create Secondary Indexes](/develop/dev-guide-create-secondary-indexes.md) - [Insert Data](/develop/dev-guide-insert-data.md) diff --git a/develop/dev-guide-gui-datagrip.md b/develop/dev-guide-gui-datagrip.md index c2822821a5285..a69b5a4262968 100644 --- a/develop/dev-guide-gui-datagrip.md +++ b/develop/dev-guide-gui-datagrip.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Connect to TiDB @@ -38,7 +38,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -69,16 +69,16 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele If a **Download missing driver files** warning displays, click **Download** to acquire the driver files. -8. Click **Test Connection** to validate the connection to the {{{ .starter }}} cluster. +8. Click **Test Connection** to validate the connection to the {{{ .starter }}} instance. - ![Test the connection to a {{{ .starter }}} cluster](/media/develop/datagrip-test-connection.jpg) + ![Test the connection to a {{{ .starter }}} instance](/media/develop/datagrip-test-connection.jpg) 9. Click **OK** to save the connection configuration.
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-gui-dbeaver.md b/develop/dev-guide-gui-dbeaver.md index 382d8a4519c98..2c2b78ea0c1ec 100644 --- a/develop/dev-guide-gui-dbeaver.md +++ b/develop/dev-guide-gui-dbeaver.md @@ -23,7 +23,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. In addition, to connect to a {{{ .starter }}} or {{{ .essential }}} public endpoint from DBeaver on **Windows**, you must configure an additional SSL certificate (ISRG Root X1) as follows. Otherwise, the connection will fail. For other operating systems, you can skip these steps. @@ -47,7 +47,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -74,7 +74,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele ![Configure connection settings for {{{ .starter }}}](/media/develop/dbeaver-connection-settings-serverless.jpg) -8. Click **Test Connection** to validate the connection to the {{{ .starter }}} cluster. +8. Click **Test Connection** to validate the connection to the {{{ .starter }}} instance. If the **Download driver files** dialog is displayed, click **Download** to get the driver files. @@ -89,7 +89,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-gui-mysql-workbench.md b/develop/dev-guide-gui-mysql-workbench.md index 6053c12671b4a..cbe7b90992521 100644 --- a/develop/dev-guide-gui-mysql-workbench.md +++ b/develop/dev-guide-gui-mysql-workbench.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Connect to TiDB @@ -38,7 +38,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -65,7 +65,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se - **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 {{{ .starter }}} cluster, and then click **OK** to store the password. + - **Password**: click **Store in Keychain ...** or **Store in Vault**, enter the password of the {{{ .starter }}} instance, and then click **OK** to store the password. ![MySQL Workbench: store the password of {{{ .starter }}} in keychain](/media/develop/mysql-workbench-store-password-in-keychain.png) @@ -73,14 +73,14 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se ![MySQL Workbench: configure connection settings for {{{ .starter }}}](/media/develop/mysql-workbench-connection-config-serverless-parameters.png) -7. Click **Test Connection** to validate the connection to the {{{ .starter }}} cluster. +7. Click **Test Connection** to validate the connection to the {{{ .starter }}} instance. 8. If the connection test is successful, you can see the **Successfully made the MySQL connection** message. Click **OK** to save the connection configuration.
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-gui-navicat.md b/develop/dev-guide-gui-navicat.md index ce548b7c7efea..f94a465dc7f90 100644 --- a/develop/dev-guide-gui-navicat.md +++ b/develop/dev-guide-gui-navicat.md @@ -24,7 +24,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Connect to TiDB @@ -34,7 +34,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -61,7 +61,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se - **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 {{{ .starter }}} cluster. + - **Password**: enter the password of the {{{ .starter }}} instance. ![Navicat: configure connection general panel for {{{ .starter }}}](/media/develop/navicat-premium-connection-config-serverless-general.png) @@ -69,14 +69,14 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se ![Navicat: configure connection SSL panel for {{{ .starter }}}](/media/develop/navicat-premium-connection-config-serverless-ssl.png) -8. Click **Test Connection** to validate the connection to the {{{ .starter }}} cluster. +8. Click **Test Connection** to validate the connection to the {{{ .starter }}} instance. 9. If the connection test is successful, you can see the **Connection Successful** message. Click **OK** to finish the connection configuration.
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-gui-vscode-sqltools.md b/develop/dev-guide-gui-vscode-sqltools.md index c218073a963b8..03e91ff1c8b82 100644 --- a/develop/dev-guide-gui-vscode-sqltools.md +++ b/develop/dev-guide-gui-vscode-sqltools.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Connect to TiDB @@ -38,7 +38,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -84,7 +84,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se ![VS Code SQLTools: configure connection settings for {{{ .starter }}}](/media/develop/vsc-sqltools-connection-config-serverless.jpg) -7. Click **TEST CONNECTION** to validate the connection to the {{{ .starter }}} cluster. +7. Click **TEST CONNECTION** to validate the connection to the {{{ .starter }}} instance. 1. In the pop-up window, click **Allow**. 2. In the **SQLTools Driver Credentials** dialog, enter the password you created in step 4. @@ -96,7 +96,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-insert-data.md b/develop/dev-guide-insert-data.md index 7d5d332202fa1..4d5343f775971 100644 --- a/develop/dev-guide-insert-data.md +++ b/develop/dev-guide-insert-data.md @@ -14,7 +14,7 @@ This document describes how to insert data into TiDB by using the SQL language w Before reading this document, you need to prepare the following: -- [Create a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md). - Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md), [Create a Database](/develop/dev-guide-create-database.md), [Create a Table](/develop/dev-guide-create-table.md), and [Create Secondary Indexes](/develop/dev-guide-create-secondary-indexes.md) ## Insert rows diff --git a/develop/dev-guide-proxysql-integration.md b/develop/dev-guide-proxysql-integration.md index ab316d81e3631..97409f0a72bc5 100644 --- a/develop/dev-guide-proxysql-integration.md +++ b/develop/dev-guide-proxysql-integration.md @@ -120,11 +120,11 @@ systemctl start docker ### Option 1: Integrate TiDB Cloud with ProxySQL -For this integration, you will be using the [ProxySQL Docker image](https://hub.docker.com/r/proxysql/proxysql) along with a {{{ .starter }}} cluster. The following steps will set up ProxySQL on port `16033`, so make sure this port is available. +For this integration, you will be using the [ProxySQL Docker image](https://hub.docker.com/r/proxysql/proxysql) along with a {{{ .starter }}} instance. The following steps will set up ProxySQL on port `16033`, so make sure this port is available. -#### Step 1. Create a {{{ .starter }}} cluster +#### Step 1. Create a {{{ .starter }}} instance -1. [Create a free {{{ .starter }}} cluster](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart#step-1-create-a-tidb-cluster). Remember the root password that you set for your cluster. +1. [Create a free {{{ .starter }}} instance](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart#step-1-create-a-tidb-cluster). Remember the root password that you set for your cluster. 2. Get your cluster hostname, port, and username for later use. 1. On the [Clusters](https://tidbcloud.com/console/clusters) page, click your cluster name to go to the cluster overview page. @@ -328,12 +328,12 @@ For this integration, you will be using the [ProxySQL Docker image](https://hub. > > 1. Adds a user using the username and password of your cluster. > 2. Assigns the user to the monitoring account. - > 3. Adds your {{{ .starter }}} cluster to the list of hosts. - > 4. Enables a secure connection between ProxySQL and the {{{ .starter }}} cluster. + > 3. Adds your {{{ .starter }}} instance to the list of hosts. + > 4. Enables a secure connection between ProxySQL and the {{{ .starter }}} instance. > > To have a better understanding, it is strongly recommended that you check the `proxysql-prepare.sql` file. To learn more about ProxySQL configuration, see [ProxySQL documentation](https://proxysql.com/documentation/proxysql-configuration/). - The following is an example output. You will see that the hostname of your cluster is shown in the output, which means that the connectivity between ProxySQL and the {{{ .starter }}} cluster is established. + The following is an example output. You will see that the hostname of your cluster is shown in the output, which means that the connectivity between ProxySQL and the {{{ .starter }}} instance is established. ``` *************************** 1. row *************************** @@ -389,7 +389,7 @@ For this integration, you will be using the [ProxySQL Docker image](https://hub. SELECT VERSION(); ``` - If the TiDB version is displayed, you are successfully connected to your {{{ .starter }}} cluster through ProxySQL. To exit from the MySQL client anytime, enter `quit` and press enter. + If the TiDB version is displayed, you are successfully connected to your {{{ .starter }}} instance through ProxySQL. To exit from the MySQL client anytime, enter `quit` and press enter. > **Note:** > diff --git a/develop/dev-guide-sample-application-aws-lambda.md b/develop/dev-guide-sample-application-aws-lambda.md index e3aad2705f354..e29f9d5c4df0e 100644 --- a/develop/dev-guide-sample-application-aws-lambda.md +++ b/develop/dev-guide-sample-application-aws-lambda.md @@ -32,7 +32,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. If you don't have an AWS account or a user, you can create them by following the steps in the [Getting Started with Lambda](https://docs.aws.amazon.com/lambda/latest/dg/getting-started.html) guide. @@ -70,7 +70,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-golang-gorm.md b/develop/dev-guide-sample-application-golang-gorm.md index d247595afec84..cceb2ffe547de 100644 --- a/develop/dev-guide-sample-application-golang-gorm.md +++ b/develop/dev-guide-sample-application-golang-gorm.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -51,7 +51,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -98,7 +98,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-golang-sql-driver.md b/develop/dev-guide-sample-application-golang-sql-driver.md index 81cc97967f4c4..bc32deb7d1308 100644 --- a/develop/dev-guide-sample-application-golang-sql-driver.md +++ b/develop/dev-guide-sample-application-golang-sql-driver.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -51,7 +51,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -98,7 +98,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-java-hibernate.md b/develop/dev-guide-sample-application-java-hibernate.md index bb8ff1d6d18c1..141e9e98488f6 100644 --- a/develop/dev-guide-sample-application-java-hibernate.md +++ b/develop/dev-guide-sample-application-java-hibernate.md @@ -29,7 +29,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -52,7 +52,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -99,7 +99,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-java-jdbc.md b/develop/dev-guide-sample-application-java-jdbc.md index e9376409062a5..b5cf2c639f954 100644 --- a/develop/dev-guide-sample-application-java-jdbc.md +++ b/develop/dev-guide-sample-application-java-jdbc.md @@ -30,7 +30,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -53,7 +53,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -100,7 +100,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-java-mybatis.md b/develop/dev-guide-sample-application-java-mybatis.md index bbbb47c91c5ae..6c8ac313f7877 100644 --- a/develop/dev-guide-sample-application-java-mybatis.md +++ b/develop/dev-guide-sample-application-java-mybatis.md @@ -29,7 +29,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -52,7 +52,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -99,7 +99,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-java-spring-boot.md b/develop/dev-guide-sample-application-java-spring-boot.md index 3fa4d7221027a..7f494161f03d7 100644 --- a/develop/dev-guide-sample-application-java-spring-boot.md +++ b/develop/dev-guide-sample-application-java-spring-boot.md @@ -29,7 +29,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -52,7 +52,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -99,7 +99,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-nextjs.md b/develop/dev-guide-sample-application-nextjs.md index 00b0590b56a78..9f6245351e1b5 100644 --- a/develop/dev-guide-sample-application-nextjs.md +++ b/develop/dev-guide-sample-application-nextjs.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -64,7 +64,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters** page](https://tidbcloud.com/console/clusters), and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-nodejs-mysql2.md b/develop/dev-guide-sample-application-nodejs-mysql2.md index f8987de80aff4..c8cec43fc3d97 100644 --- a/develop/dev-guide-sample-application-nodejs-mysql2.md +++ b/develop/dev-guide-sample-application-nodejs-mysql2.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -70,7 +70,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -109,7 +109,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-nodejs-mysqljs.md b/develop/dev-guide-sample-application-nodejs-mysqljs.md index a7d2390856e79..0c65452938d96 100644 --- a/develop/dev-guide-sample-application-nodejs-mysqljs.md +++ b/develop/dev-guide-sample-application-nodejs-mysqljs.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -70,7 +70,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -109,7 +109,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-nodejs-prisma.md b/develop/dev-guide-sample-application-nodejs-prisma.md index 919b865b0d8e2..88c94c9475134 100644 --- a/develop/dev-guide-sample-application-nodejs-prisma.md +++ b/develop/dev-guide-sample-application-nodejs-prisma.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -70,7 +70,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -112,7 +112,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-nodejs-sequelize.md b/develop/dev-guide-sample-application-nodejs-sequelize.md index 389bda7918c3e..e21133b8ba0a5 100644 --- a/develop/dev-guide-sample-application-nodejs-sequelize.md +++ b/develop/dev-guide-sample-application-nodejs-sequelize.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -64,7 +64,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -108,7 +108,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-nodejs-typeorm.md b/develop/dev-guide-sample-application-nodejs-typeorm.md index fdc73622ac5e0..e0ca0a1fe6db8 100644 --- a/develop/dev-guide-sample-application-nodejs-typeorm.md +++ b/develop/dev-guide-sample-application-nodejs-typeorm.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -78,7 +78,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -117,7 +117,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-python-django.md b/develop/dev-guide-sample-application-python-django.md index 64152b3c84e9c..afba4a31108fa 100644 --- a/develop/dev-guide-sample-application-python-django.md +++ b/develop/dev-guide-sample-application-python-django.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -69,7 +69,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -116,7 +116,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-python-mysql-connector.md b/develop/dev-guide-sample-application-python-mysql-connector.md index e52f95719432d..3e2c692f2b798 100644 --- a/develop/dev-guide-sample-application-python-mysql-connector.md +++ b/develop/dev-guide-sample-application-python-mysql-connector.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -59,7 +59,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -104,7 +104,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-python-mysqlclient.md b/develop/dev-guide-sample-application-python-mysqlclient.md index a750fff3fab01..185cb5cb9f61a 100644 --- a/develop/dev-guide-sample-application-python-mysqlclient.md +++ b/develop/dev-guide-sample-application-python-mysqlclient.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -61,7 +61,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -108,7 +108,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-python-peewee.md b/develop/dev-guide-sample-application-python-peewee.md index b8975396bec9e..bf38ccf1b2490 100644 --- a/develop/dev-guide-sample-application-python-peewee.md +++ b/develop/dev-guide-sample-application-python-peewee.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -63,7 +63,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://{{{.console-url}}}/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -108,7 +108,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-python-pymysql.md b/develop/dev-guide-sample-application-python-pymysql.md index 29a112ae97dde..114b3d522da6f 100644 --- a/develop/dev-guide-sample-application-python-pymysql.md +++ b/develop/dev-guide-sample-application-python-pymysql.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -59,7 +59,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -104,7 +104,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-python-sqlalchemy.md b/develop/dev-guide-sample-application-python-sqlalchemy.md index 4dfd249d35701..c76ffc63e81e1 100644 --- a/develop/dev-guide-sample-application-python-sqlalchemy.md +++ b/develop/dev-guide-sample-application-python-sqlalchemy.md @@ -28,7 +28,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -67,9 +67,9 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele > **Note:** > -> Currently, {{{ .starter }}} clusters have a limitation: if there are no active connections for 5 minutes, they will shut down, which closes all connections. Therefore, when using SQLAlchemy with {{{ .starter }}} clusters, pooled connections might encounter `OperationalError` such as `Lost connection to MySQL server during query` or `MySQL Connection not available`. To avoid this error, you can set the `pool_recycle` parameter to `300`. For more information, see [Dealing with Disconnects](https://docs.sqlalchemy.org/en/20/core/pooling.html#dealing-with-disconnects) in SQLAlchemy documentation. +> Currently, {{{ .starter }}} instances have a limitation: if there are no active connections for 5 minutes, they will shut down, which closes all connections. Therefore, when using SQLAlchemy with {{{ .starter }}} instances, pooled connections might encounter `OperationalError` such as `Lost connection to MySQL server during query` or `MySQL Connection not available`. To avoid this error, you can set the `pool_recycle` parameter to `300`. For more information, see [Dealing with Disconnects](https://docs.sqlalchemy.org/en/20/core/pooling.html#dealing-with-disconnects) in SQLAlchemy documentation. -1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -114,7 +114,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-ruby-mysql2.md b/develop/dev-guide-sample-application-ruby-mysql2.md index e3304cdb1a617..a72e27a8bcf69 100644 --- a/develop/dev-guide-sample-application-ruby-mysql2.md +++ b/develop/dev-guide-sample-application-ruby-mysql2.md @@ -29,7 +29,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -71,7 +71,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -110,7 +110,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-sample-application-ruby-rails.md b/develop/dev-guide-sample-application-ruby-rails.md index 12bb58cbd99cc..f2cc0d403d2f5 100644 --- a/develop/dev-guide-sample-application-ruby-rails.md +++ b/develop/dev-guide-sample-application-ruby-rails.md @@ -29,7 +29,7 @@ To complete this tutorial, you need: **If you don't have a TiDB cluster, you can create one as follows:** -- (Recommended) Follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. +- (Recommended) Follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster. - Follow [Deploy a local test TiDB cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB cluster](/production-deployment-using-tiup.md) to create a local cluster. ## Run the sample app to connect to TiDB @@ -71,7 +71,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -100,7 +100,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele
-1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/develop/dev-guide-tidb-crud-sql.md b/develop/dev-guide-tidb-crud-sql.md index 01e9aafb708b2..020808452e9c3 100644 --- a/develop/dev-guide-tidb-crud-sql.md +++ b/develop/dev-guide-tidb-crud-sql.md @@ -10,7 +10,7 @@ This document briefly introduces how to use TiDB's CRUD SQL. ## Before you start -Please make sure you are connected to a TiDB cluster. If not, refer to [Create a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-cloud-cluster) to create a {{{ .starter }}} cluster. +Please make sure you are connected to a TiDB cluster. If not, refer to [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-cloud-cluster) to create a {{{ .starter }}} instance. ## Explore SQL with TiDB diff --git a/develop/dev-guide-update-data.md b/develop/dev-guide-update-data.md index 427aea2e0792f..05a0bdd798346 100644 --- a/develop/dev-guide-update-data.md +++ b/develop/dev-guide-update-data.md @@ -15,7 +15,7 @@ This document describes how to use the following SQL statements to update the da Before reading this document, you need to prepare the following: -- [Create a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md). - Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md), [Create a Database](/develop/dev-guide-create-database.md), [Create a Table](/develop/dev-guide-create-table.md), and [Create Secondary Indexes](/develop/dev-guide-create-secondary-indexes.md). - If you want to `UPDATE` data, you need to [insert data](/develop/dev-guide-insert-data.md) first. diff --git a/develop/dev-guide-wordpress.md b/develop/dev-guide-wordpress.md index 1f37e66bbc400..e17033d2ab676 100644 --- a/develop/dev-guide-wordpress.md +++ b/develop/dev-guide-wordpress.md @@ -18,7 +18,7 @@ In this tutorial, you can learn how to use {{{ .starter }}} to run WordPress for To complete this tutorial, you need: -- A {{{ .starter }}} cluster. Follow [creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster if you don't have one. +- A {{{ .starter }}} instance. Follow [creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster if you don't have one. ## Run WordPress with {{{ .starter }}} @@ -51,7 +51,7 @@ cd wordpress-tidb-docker Configure the WordPress database connection to {{{ .starter }}}. -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -84,7 +84,7 @@ Configure the WordPress database connection to {{{ .starter }}}. TIDB_DB_NAME='test' ``` - Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. By default, your {{{ .starter }}} comes with a `test` database. If you have already created another database in your {{{ .starter }}} cluster, you can replace `test` with your database name. + Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. By default, your {{{ .starter }}} comes with a `test` database. If you have already created another database in your {{{ .starter }}} instance, you can replace `test` with your database name. 7. Save the `.env` file. diff --git a/develop/serverless-driver-drizzle-example.md b/develop/serverless-driver-drizzle-example.md index 0bb2511dcdc9d..0d90faf4810ec 100644 --- a/develop/serverless-driver-drizzle-example.md +++ b/develop/serverless-driver-drizzle-example.md @@ -12,7 +12,7 @@ This tutorial describes how to use TiDB Cloud serverless driver with Drizzle in > **Tip:** > -> In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. +> In addition to {{{ .starter }}} instances, the steps in this document also work with {{{ .essential }}} instances. ## Use Drizzle and TiDB Cloud serverless driver in Node.js environments @@ -24,7 +24,7 @@ To complete this tutorial, you need the following: - [Node.js](https://nodejs.org/en) >= 18.0.0. - [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) or your preferred package manager. -- A {{{ .starter }}} cluster. If you don't have any, you can [create a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- A {{{ .starter }}} instance. If you don't have any, you can [create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). ### Step 1. Create a project @@ -74,7 +74,7 @@ To complete this tutorial, you need the following: ### Step 2. Set the environment -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. On the overview page, click **Connect** in the upper-right corner, select `Serverless Driver` in the **Connect With** drop-down list, and then click **Generate Password** to create a random password. @@ -96,7 +96,7 @@ To complete this tutorial, you need the following: ### Step 3. Use Drizzle to query data -1. Create a table in your {{{ .starter }}} cluster. +1. Create a table in your {{{ .starter }}} instance. You can use [SQL Editor in the TiDB Cloud console](https://docs.pingcap.com/tidbcloud/explore-data-with-chat2query) to execute SQL statements. Here is an example: @@ -160,7 +160,7 @@ To complete this tutorial, you need the following: - A [Vercel](https://vercel.com/docs) account that provides edge environment. - [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) or your preferred package manager. -- A {{{ .starter }}} cluster. If you don't have any, you can [create a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- A {{{ .starter }}} instance. If you don't have any, you can [create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). ### Step 1. Create a project @@ -190,7 +190,7 @@ To complete this tutorial, you need the following: ### Step 2. Set the environment -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page. 2. On the overview page, click **Connect** in the upper-right corner, select `Serverless Driver` in the **Connect With** drop-down list, and then click **Generate Password** to create a random password. @@ -206,7 +206,7 @@ To complete this tutorial, you need the following: ### Step 3. Create an edge function -1. Create a table in your {{{ .starter }}} cluster. +1. Create a table in your {{{ .starter }}} instance. You can use [SQL Editor in the TiDB Cloud console](https://docs.pingcap.com/tidbcloud/explore-data-with-chat2query.md) to execute SQL statements. Here is an example: diff --git a/develop/serverless-driver-kysely-example.md b/develop/serverless-driver-kysely-example.md index 3664ee53c725a..53136ed31e5dd 100644 --- a/develop/serverless-driver-kysely-example.md +++ b/develop/serverless-driver-kysely-example.md @@ -23,7 +23,7 @@ To complete this tutorial, you need the following: - [Node.js](https://nodejs.org/en) >= 18.0.0. - [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) or your preferred package manager. -- A {{{ .starter }}} cluster. If you don't have any, you can [create a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- A {{{ .starter }}} instance. If you don't have any, you can [create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). ### Step 1. Create a project @@ -74,7 +74,7 @@ To complete this tutorial, you need the following: ### Step 2. Set the environment -1. On the overview page of your {{{ .starter }}} cluster, click **Connect** in the upper-right corner, and then get the connection string for your database from the displayed dialog. The connection string looks like this: +1. On the overview page of your {{{ .starter }}} instance, click **Connect** in the upper-right corner, and then get the connection string for your database from the displayed dialog. The connection string looks like this: ``` mysql://[username]:[password]@[host]/[database] @@ -88,7 +88,7 @@ To complete this tutorial, you need the following: ### Step 3. Use Kysely to query data -1. Create a table in your {{{ .starter }}} cluster and insert some data. +1. Create a table in your {{{ .starter }}} instance and insert some data. You can use [SQL Editor in the TiDB Cloud console](https://docs.pingcap.com/tidbcloud/explore-data-with-chat2query) to execute SQL statements. Here is an example: @@ -167,7 +167,7 @@ To complete this tutorial, you need the following: - A [Vercel](https://vercel.com/docs) account that provides edge environment. - [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) or your preferred package manager. -- A {{{ .starter }}} cluster. If you don't have any, you can [create a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- A {{{ .starter }}} instance. If you don't have any, you can [create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). ### Step 1. Create a project @@ -192,7 +192,7 @@ To complete this tutorial, you need the following: ### Step 2. Set the environment -On the overview page of your {{{ .starter }}} cluster, click **Connect** in the upper-right corner, and then get the connection string for your database from the displayed dialog. The connection string looks like this: +On the overview page of your {{{ .starter }}} instance, click **Connect** in the upper-right corner, and then get the connection string for your database from the displayed dialog. The connection string looks like this: ``` mysql://[username]:[password]@[host]/[database] @@ -200,7 +200,7 @@ mysql://[username]:[password]@[host]/[database] ### Step 3. Create an edge function -1. Create a table in your {{{ .starter }}} cluster and insert some data. +1. Create a table in your {{{ .starter }}} instance and insert some data. You can use [SQL Editor in the TiDB Cloud console](https://docs.pingcap.com/tidbcloud/explore-data-with-chat2query) to execute SQL statements. Here is an example: diff --git a/develop/serverless-driver-node-example.md b/develop/serverless-driver-node-example.md index 6ccf82fbab52d..d6443ba91033f 100644 --- a/develop/serverless-driver-node-example.md +++ b/develop/serverless-driver-node-example.md @@ -10,7 +10,7 @@ This tutorial describes how to use TiDB Cloud serverless driver in a local Node. > **Note:** > -> - In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. +> - In addition to {{{ .starter }}} instances, the steps in this document also work with {{{ .essential }}} instances. > - To learn how to use TiDB Cloud serverless driver with Cloudflare Workers, Vercel Edge Functions, and Netlify Edge Functions, check out our [Insights into Automotive Sales](https://car-sales-insight.vercel.app/) and the [sample repository](https://github.com/tidbcloud/car-sales-insight). ## Before you begin @@ -19,7 +19,7 @@ To complete this step-by-step tutorial, you need the following: - [Node.js](https://nodejs.org/en) >= 18.0.0. - [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) or your preferred package manager. -- A {{{ .starter }}} cluster. If you don't have any, you can [create a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- A {{{ .starter }}} instance. If you don't have any, you can [create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). ## Step 1. Create a local Node.js project @@ -42,7 +42,7 @@ To complete this step-by-step tutorial, you need the following: The serverless driver supports both CommonJS and ES modules. The following steps take the usage of the ES module as an example. -1. On the overview page of your {{{ .starter }}} cluster, click **Connect** in the upper-right corner, and then get the connection string for your database from the displayed dialog. The connection string looks like this: +1. On the overview page of your {{{ .starter }}} instance, click **Connect** in the upper-right corner, and then get the connection string for your database from the displayed dialog. The connection string looks like this: ``` mysql://[username]:[password]@[host]/[database] @@ -66,7 +66,7 @@ The serverless driver supports both CommonJS and ES modules. The following steps ```js import { connect } from '@tidbcloud/serverless' - const conn = connect({url: 'mysql://[username]:[password]@[host]/[database]'}) // replace with your {{{ .starter }}} cluster information + const conn = connect({url: 'mysql://[username]:[password]@[host]/[database]'}) // replace with your {{{ .starter }}} instance information console.log(await conn.execute("show tables")) ``` diff --git a/develop/serverless-driver-prisma-example.md b/develop/serverless-driver-prisma-example.md index e750144db2210..81dd09de642ba 100644 --- a/develop/serverless-driver-prisma-example.md +++ b/develop/serverless-driver-prisma-example.md @@ -15,7 +15,7 @@ This tutorial describes how to use [@tidbcloud/prisma-adapter](https://github.co > **Tip:** > -> In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. +> In addition to {{{ .starter }}} instances, the steps in this document also work with {{{ .essential }}} instances. ## Install @@ -84,7 +84,7 @@ To complete this tutorial, you need the following: - [Node.js](https://nodejs.org/en) >= 18.0.0. - [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) or your preferred package manager. -- A {{{ .starter }}} cluster. If you don't have any, you can [create a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- A {{{ .starter }}} instance. If you don't have any, you can [create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). ### Step 1. Create a project @@ -123,7 +123,7 @@ To complete this tutorial, you need the following: ### Step 2. Set the environment -1. On the overview page of your {{{ .starter }}} cluster, click **Connect** in the upper-right corner, and then get the connection string for your database from the displayed dialog. The connection string looks like this: +1. On the overview page of your {{{ .starter }}} instance, click **Connect** in the upper-right corner, and then get the connection string for your database from the displayed dialog. The connection string looks like this: ``` mysql://[username]:[password]@[host]:4000/[database]?sslaccept=strict @@ -184,13 +184,13 @@ To complete this tutorial, you need the following: } ``` -3. Synchronize your database with the Prisma schema. You can either manually create the database tables in your {{{ .starter }}} cluster or use the Prisma CLI to create them automatically as follows: +3. Synchronize your database with the Prisma schema. You can either manually create the database tables in your {{{ .starter }}} instance or use the Prisma CLI to create them automatically as follows: ``` npx prisma db push ``` - This command will create the `user` table in your {{{ .starter }}} cluster through the traditional TCP connection, rather than through the HTTPS connection using `@tidbcloud/prisma-adapter`. This is because it uses the same engine as Prisma Migrate. For more information about this command, see [Prototype your schema](https://www.prisma.io/docs/concepts/components/prisma-migrate/db-push). + This command will create the `user` table in your {{{ .starter }}} instance through the traditional TCP connection, rather than through the HTTPS connection using `@tidbcloud/prisma-adapter`. This is because it uses the same engine as Prisma Migrate. For more information about this command, see [Prototype your schema](https://www.prisma.io/docs/concepts/components/prisma-migrate/db-push). 4. Generate Prisma Client: diff --git a/develop/serverless-driver.md b/develop/serverless-driver.md index 632d6da4e311b..7cc8e46b74452 100644 --- a/develop/serverless-driver.md +++ b/develop/serverless-driver.md @@ -8,13 +8,13 @@ aliases: ['/tidbcloud/serverless-driver-config/','/tidbcloud/serverless-driver/' > **Note:** > -> The serverless driver is in beta and only applicable to {{{ .starter }}} or {{{ .essential }}} clusters. +> The serverless driver is in beta and only applicable to {{{ .starter }}} or {{{ .essential }}} instances. ## Why use TiDB Cloud Serverless Driver (Beta) Traditional TCP-based MySQL drivers are not suitable for serverless functions due to their expectation of long-lived, persistent TCP connections, which contradict the short-lived nature of serverless functions. Moreover, in edge environments such as [Vercel Edge Functions](https://vercel.com/docs/functions/edge-functions) and [Cloudflare Workers](https://workers.cloudflare.com/), where comprehensive TCP support and full Node.js compatibility may be lacking, these drivers may not work at all. -[TiDB Cloud serverless driver (Beta)](https://github.com/tidbcloud/serverless-js) for JavaScript lets you connect to your {{{ .starter }}} or {{{ .essential }}} cluster over HTTP, which is generally supported by serverless environments. With it, it is now possible to connect to {{{ .starter }}} or {{{ .essential }}} clusters from edge environments and reduce connection overhead with TCP while keeping the similar development experience of traditional TCP-based MySQL drivers. +[TiDB Cloud serverless driver (Beta)](https://github.com/tidbcloud/serverless-js) for JavaScript lets you connect to your {{{ .starter }}} or {{{ .essential }}} instance over HTTP, which is generally supported by serverless environments. With it, it is now possible to connect to {{{ .starter }}} or {{{ .essential }}} instances from edge environments and reduce connection overhead with TCP while keeping the similar development experience of traditional TCP-based MySQL drivers. > **Note:** > @@ -30,11 +30,11 @@ npm install @tidbcloud/serverless ## Use the serverless driver -You can use the serverless driver to query data of a {{{ .starter }}} or {{{ .essential }}} cluster or perform interactive transactions. +You can use the serverless driver to query data of a {{{ .starter }}} or {{{ .essential }}} instance or perform interactive transactions. ### Query -To query data from a {{{ .starter }}} or {{{ .essential }}} cluster, you need to create a connection first. Then you can use the connection to execute raw SQL queries. For example: +To query data from a {{{ .starter }}} or {{{ .essential }}} instance, you need to create a connection first. Then you can use the connection to execute raw SQL queries. For example: ```ts import { connect } from '@tidbcloud/serverless' @@ -333,8 +333,8 @@ TiDB Cloud serverless driver has been integrated with the following ORMs: The serverless driver itself is free, but accessing data with the driver generates [Request Units (RUs)](https://docs.pingcap.com/tidbcloud/tidb-cloud-glossary#request-unit-ru) and storage usage. -- For {{{ .starter }}} clusters, the pricing follows the [{{{ .starter }}} pricing](https://www.pingcap.com/tidb-cloud-starter-pricing-details/) model. -- For {{{ .essential }}} clusters, the pricing follows the [{{{ .essential }}} pricing](https://www.pingcap.com/tidb-cloud-essential-pricing-details/) model. +- For {{{ .starter }}} instances, the pricing follows the [{{{ .starter }}} pricing](https://www.pingcap.com/tidb-cloud-starter-pricing-details/) model. +- For {{{ .essential }}} instances, the pricing follows the [{{{ .essential }}} pricing](https://www.pingcap.com/tidb-cloud-essential-pricing-details/) model. ## Limitations diff --git a/functions-and-operators/json-functions/json-functions-validate.md b/functions-and-operators/json-functions/json-functions-validate.md index 5ff481ec705c4..9e7d66cc2d15b 100644 --- a/functions-and-operators/json-functions/json-functions-validate.md +++ b/functions-and-operators/json-functions/json-functions-validate.md @@ -9,7 +9,7 @@ TiDB supports most of the [JSON schema validation functions](https://dev.mysql.c > **Note:** > -> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## `JSON_SCHEMA_VALID()` diff --git a/functions-and-operators/miscellaneous-functions.md b/functions-and-operators/miscellaneous-functions.md index e7d74c0ab0235..c1e2c82252f36 100644 --- a/functions-and-operators/miscellaneous-functions.md +++ b/functions-and-operators/miscellaneous-functions.md @@ -25,7 +25,7 @@ TiDB supports most of the [miscellaneous functions](https://dev.mysql.com/doc/re | [`IS_IPV6()`](#is_ipv6) | Whether argument is an IPv6 address | | [`IS_UUID()`](#is_uuid) | Whether argument is an UUID | | [`NAME_CONST()`](#name_const) | Can be used to rename a column name | -| [`SLEEP()`](#sleep) | Sleep for a number of seconds. Note that for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters, the `SLEEP()` function has a limitation wherein it can only support a maximum sleep time of 300 seconds. | +| [`SLEEP()`](#sleep) | Sleep for a number of seconds. Note that for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances, the `SLEEP()` function has a limitation wherein it can only support a maximum sleep time of 300 seconds. | | [`UUID()`](#uuid) | Return a Universal Unique Identifier (UUID) | | [`UUID_TO_BIN()`](#uuid_to_bin) | Convert UUID from text format to binary format | | [`VALUES()`](#values) | Defines the values to be used during an INSERT | diff --git a/index-advisor.md b/index-advisor.md index 90b5940d1e3cc..1fa59221c1332 100644 --- a/index-advisor.md +++ b/index-advisor.md @@ -9,7 +9,7 @@ In v8.5.0, TiDB introduces the Index Advisor feature, which helps optimize your > **Note:** > -> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. The Index Advisor analyzes queries to identify indexable columns from clauses such as `WHERE`, `GROUP BY`, and `ORDER BY`. Then, it generates index candidates and estimates their performance benefits using hypothetical indexes. TiDB uses a genetic search algorithm to select the optimal set of indexes starting with single-column indexes and iteratively exploring multi-column indexes, leveraging a "What-If" analysis to evaluate potential indexes based on their impact on optimizer plan costs. The advisor recommends indexes when they reduce the overall cost compared to executing queries without them. diff --git a/information-schema/information-schema-cluster-info.md b/information-schema/information-schema-cluster-info.md index 9cd3fc8164f0a..2b7169297a2a1 100644 --- a/information-schema/information-schema-cluster-info.md +++ b/information-schema/information-schema-cluster-info.md @@ -9,7 +9,7 @@ The `CLUSTER_INFO` cluster topology table provides the current topology informat > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. {{< copyable "sql" >}} diff --git a/information-schema/information-schema-placement-policies.md b/information-schema/information-schema-placement-policies.md index 4fac962198c94..4566e5d15935b 100644 --- a/information-schema/information-schema-placement-policies.md +++ b/information-schema/information-schema-placement-policies.md @@ -9,7 +9,7 @@ The `PLACEMENT_POLICIES` table provides information on all placement policies. F > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. {{< copyable "sql" >}} diff --git a/information-schema/information-schema-resource-groups.md b/information-schema/information-schema-resource-groups.md index 47f727fb12da2..9e6ae5a45c1a7 100644 --- a/information-schema/information-schema-resource-groups.md +++ b/information-schema/information-schema-resource-groups.md @@ -9,7 +9,7 @@ The `RESOURCE_GROUPS` table shows the information about all resource groups. For > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ```sql USE information_schema; diff --git a/information-schema/information-schema-runaway-watches.md b/information-schema/information-schema-runaway-watches.md index 274ceac5feb45..a658679bc4b13 100644 --- a/information-schema/information-schema-runaway-watches.md +++ b/information-schema/information-schema-runaway-watches.md @@ -9,7 +9,7 @@ The `RUNAWAY_WATCHES` table shows the watch list of runaway queries that consume > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ```sql USE INFORMATION_SCHEMA; diff --git a/information-schema/information-schema-slow-query.md b/information-schema/information-schema-slow-query.md index ff6798be9d14d..2125213f64308 100644 --- a/information-schema/information-schema-slow-query.md +++ b/information-schema/information-schema-slow-query.md @@ -19,7 +19,7 @@ The `SLOW_QUERY` table provides the slow query information of the current node, > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. @@ -131,7 +131,7 @@ The `CLUSTER_SLOW_QUERY` table provides the slow query information of all nodes > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. diff --git a/information-schema/information-schema-tidb-hot-regions-history.md b/information-schema/information-schema-tidb-hot-regions-history.md index 239d0de3e66e5..ecb00953b251b 100644 --- a/information-schema/information-schema-tidb-hot-regions-history.md +++ b/information-schema/information-schema-tidb-hot-regions-history.md @@ -9,7 +9,7 @@ The `TIDB_HOT_REGIONS_HISTORY` table provides information about history hot Regi > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. diff --git a/information-schema/information-schema-tidb-servers-info.md b/information-schema/information-schema-tidb-servers-info.md index f8c026e6c7881..2e0aa07bdc1d5 100644 --- a/information-schema/information-schema-tidb-servers-info.md +++ b/information-schema/information-schema-tidb-servers-info.md @@ -9,7 +9,7 @@ The `TIDB_SERVERS_INFO` table provides information about TiDB servers in the TiD > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ```sql USE INFORMATION_SCHEMA; diff --git a/information-schema/information-schema-tikv-region-peers.md b/information-schema/information-schema-tikv-region-peers.md index f685f17ee230b..6ce1fcd4b0dd7 100644 --- a/information-schema/information-schema-tikv-region-peers.md +++ b/information-schema/information-schema-tikv-region-peers.md @@ -9,7 +9,7 @@ The `TIKV_REGION_PEERS` table shows detailed information of a single Region node > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ```sql USE INFORMATION_SCHEMA; diff --git a/information-schema/information-schema-tikv-region-status.md b/information-schema/information-schema-tikv-region-status.md index ddb37d0f15b40..1856a0ebb67be 100644 --- a/information-schema/information-schema-tikv-region-status.md +++ b/information-schema/information-schema-tikv-region-status.md @@ -9,7 +9,7 @@ The `TIKV_REGION_STATUS` table shows some basic information of TiKV Regions via > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ```sql USE INFORMATION_SCHEMA; diff --git a/information-schema/information-schema-tikv-store-status.md b/information-schema/information-schema-tikv-store-status.md index 808a6a57a8a49..643e7a89f92e7 100644 --- a/information-schema/information-schema-tikv-store-status.md +++ b/information-schema/information-schema-tikv-store-status.md @@ -9,7 +9,7 @@ The `TIKV_STORE_STATUS` table shows some basic information of TiKV nodes via PD' > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ```sql USE INFORMATION_SCHEMA; diff --git a/information-schema/information-schema.md b/information-schema/information-schema.md index 9f949f0cef976..e090158e5ff7f 100644 --- a/information-schema/information-schema.md +++ b/information-schema/information-schema.md @@ -113,15 +113,15 @@ Many `INFORMATION_SCHEMA` tables have a corresponding `SHOW` statement. The bene | [`CLUSTER_CONFIG`](/information-schema/information-schema-cluster-config.md) | Provides details about configuration settings for the entire TiDB cluster. This table is not applicable to TiDB Cloud. | | `CLUSTER_DEADLOCKS` | Provides a cluster-level view of the `DEADLOCKS` table. | | [`CLUSTER_HARDWARE`](/information-schema/information-schema-cluster-hardware.md) | Provides details on the underlying physical hardware discovered on each TiDB component. This table is not applicable to TiDB Cloud. | -| [`CLUSTER_INFO`](/information-schema/information-schema-cluster-info.md) | Provides details on the current cluster topology. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| [`CLUSTER_INFO`](/information-schema/information-schema-cluster-info.md) | Provides details on the current cluster topology. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | | [`CLUSTER_LOAD`](/information-schema/information-schema-cluster-load.md) | Provides current load information for TiDB servers in the cluster. This table is not applicable to TiDB Cloud. | | [`CLUSTER_LOG`](/information-schema/information-schema-cluster-log.md) | Provides a log for the entire TiDB cluster. This table is not applicable to TiDB Cloud. | | `CLUSTER_MEMORY_USAGE` | Provides a cluster-level view of the `MEMORY_USAGE` table. | | `CLUSTER_MEMORY_USAGE_OPS_HISTORY` | Provides a cluster-level view of the `MEMORY_USAGE_OPS_HISTORY` table. | | `CLUSTER_PROCESSLIST` | Provides a cluster-level view of the `PROCESSLIST` table. | -| `CLUSTER_SLOW_QUERY` | Provides a cluster-level view of the `SLOW_QUERY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | -| `CLUSTER_STATEMENTS_SUMMARY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | -| `CLUSTER_STATEMENTS_SUMMARY_HISTORY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY_HISTORY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| `CLUSTER_SLOW_QUERY` | Provides a cluster-level view of the `SLOW_QUERY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | +| `CLUSTER_STATEMENTS_SUMMARY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | +| `CLUSTER_STATEMENTS_SUMMARY_HISTORY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY_HISTORY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | | `CLUSTER_TIDB_INDEX_USAGE` | Provides a cluster-level view of the `TIDB_INDEX_USAGE` table. | | `CLUSTER_TIDB_TRX` | Provides a cluster-level view of the `TIDB_TRX` table. | | [`CLUSTER_SYSTEMINFO`](/information-schema/information-schema-cluster-systeminfo.md) | Provides details about kernel parameter configuration for servers in the cluster. This table is not applicable to TiDB Cloud. | @@ -136,11 +136,11 @@ Many `INFORMATION_SCHEMA` tables have a corresponding `SHOW` statement. The bene | [`METRICS_SUMMARY`](/information-schema/information-schema-metrics-summary.md) | A summary of metrics extracted from Prometheus. This table is not applicable to TiDB Cloud. | | `METRICS_SUMMARY_BY_LABEL` | See `METRICS_SUMMARY` table. This table is not applicable to TiDB Cloud. | | [`METRICS_TABLES`](/information-schema/information-schema-metrics-tables.md) | Provides the PromQL definitions for tables in `METRICS_SCHEMA`. This table is not applicable to TiDB Cloud. | -| [`PLACEMENT_POLICIES`](/information-schema/information-schema-placement-policies.md) | Provides information on all placement policies. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| [`PLACEMENT_POLICIES`](/information-schema/information-schema-placement-policies.md) | Provides information on all placement policies. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | | [`SEQUENCES`](/information-schema/information-schema-sequences.md) | The TiDB implementation of sequences is based on MariaDB. | -| [`SLOW_QUERY`](/information-schema/information-schema-slow-query.md) | Provides information on slow queries on the current TiDB server. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | -| [`STATEMENTS_SUMMARY`](/statement-summary-tables.md) | Similar to performance_schema statement summary in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | -| [`STATEMENTS_SUMMARY_HISTORY`](/statement-summary-tables.md) | Similar to performance_schema statement summary history in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| [`SLOW_QUERY`](/information-schema/information-schema-slow-query.md) | Provides information on slow queries on the current TiDB server. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | +| [`STATEMENTS_SUMMARY`](/statement-summary-tables.md) | Similar to performance_schema statement summary in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | +| [`STATEMENTS_SUMMARY_HISTORY`](/statement-summary-tables.md) | Similar to performance_schema statement summary history in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | | [`TABLE_STORAGE_STATS`](/information-schema/information-schema-table-storage-stats.md) | Provides details about table sizes in storage. | | [`TIDB_HOT_REGIONS`](/information-schema/information-schema-tidb-hot-regions.md) | Provides statistics about which regions are hot. | | [`TIDB_HOT_REGIONS_HISTORY`](/information-schema/information-schema-tidb-hot-regions-history.md) | Provides history statistics about which Regions are hot. | @@ -169,15 +169,15 @@ Many `INFORMATION_SCHEMA` tables have a corresponding `SHOW` statement. The bene | [`CLUSTER_CONFIG`](https://docs.pingcap.com/tidb/stable/information-schema-cluster-config) | Provides details about configuration settings for the entire TiDB cluster. This table is not applicable to TiDB Cloud. | | `CLUSTER_DEADLOCKS` | Provides a cluster-level view of the `DEADLOCKS` table. | | [`CLUSTER_HARDWARE`](https://docs.pingcap.com/tidb/stable/information-schema-cluster-hardware) | Provides details on the underlying physical hardware discovered on each TiDB component. This table is not applicable to TiDB Cloud. | -| [`CLUSTER_INFO`](/information-schema/information-schema-cluster-info.md) | Provides details on the current cluster topology. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| [`CLUSTER_INFO`](/information-schema/information-schema-cluster-info.md) | Provides details on the current cluster topology. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | | [`CLUSTER_LOAD`](https://docs.pingcap.com/tidb/stable/information-schema-cluster-load) | Provides current load information for TiDB servers in the cluster. This table is not applicable to TiDB Cloud. | | [`CLUSTER_LOG`](https://docs.pingcap.com/tidb/stable/information-schema-cluster-log) | Provides a log for the entire TiDB cluster. This table is not applicable to TiDB Cloud. | | `CLUSTER_MEMORY_USAGE` | Provides a cluster-level view of the `MEMORY_USAGE` table. This table is not applicable to TiDB Cloud. | | `CLUSTER_MEMORY_USAGE_OPS_HISTORY` | Provides a cluster-level view of the `MEMORY_USAGE_OPS_HISTORY` table. This table is not applicable to TiDB Cloud. | | `CLUSTER_PROCESSLIST` | Provides a cluster-level view of the `PROCESSLIST` table. | -| `CLUSTER_SLOW_QUERY` | Provides a cluster-level view of the `SLOW_QUERY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | -| `CLUSTER_STATEMENTS_SUMMARY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | -| `CLUSTER_STATEMENTS_SUMMARY_HISTORY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY_HISTORY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| `CLUSTER_SLOW_QUERY` | Provides a cluster-level view of the `SLOW_QUERY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | +| `CLUSTER_STATEMENTS_SUMMARY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | +| `CLUSTER_STATEMENTS_SUMMARY_HISTORY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY_HISTORY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | | `CLUSTER_TIDB_TRX` | Provides a cluster-level view of the `TIDB_TRX` table. | | [`CLUSTER_SYSTEMINFO`](https://docs.pingcap.com/tidb/stable/information-schema-cluster-systeminfo) | Provides details about kernel parameter configuration for servers in the cluster. This table is not applicable to TiDB Cloud. | | [`DATA_LOCK_WAITS`](/information-schema/information-schema-data-lock-waits.md) | Provides the lock-waiting information on the TiKV server. | @@ -191,11 +191,11 @@ Many `INFORMATION_SCHEMA` tables have a corresponding `SHOW` statement. The bene | [`METRICS_SUMMARY`](https://docs.pingcap.com/tidb/stable/information-schema-metrics-summary) | A summary of metrics extracted from Prometheus. This table is not applicable to TiDB Cloud. | | `METRICS_SUMMARY_BY_LABEL` | See `METRICS_SUMMARY` table. This table is not applicable to TiDB Cloud. | | [`METRICS_TABLES`](https://docs.pingcap.com/tidb/stable/information-schema-metrics-tables) | Provides the PromQL definitions for tables in `METRICS_SCHEMA`. This table is not applicable to TiDB Cloud. | -| [`PLACEMENT_POLICIES`](https://docs.pingcap.com/tidb/stable/information-schema-placement-policies) | Provides information on all placement policies. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| [`PLACEMENT_POLICIES`](https://docs.pingcap.com/tidb/stable/information-schema-placement-policies) | Provides information on all placement policies. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | | [`SEQUENCES`](/information-schema/information-schema-sequences.md) | The TiDB implementation of sequences is based on MariaDB. | -| [`SLOW_QUERY`](/information-schema/information-schema-slow-query.md) | Provides information on slow queries on the current TiDB server. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | -| [`STATEMENTS_SUMMARY`](/statement-summary-tables.md) | Similar to performance_schema statement summary in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | -| [`STATEMENTS_SUMMARY_HISTORY`](/statement-summary-tables.md) | Similar to performance_schema statement summary history in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters.| +| [`SLOW_QUERY`](/information-schema/information-schema-slow-query.md) | Provides information on slow queries on the current TiDB server. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | +| [`STATEMENTS_SUMMARY`](/statement-summary-tables.md) | Similar to performance_schema statement summary in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. | +| [`STATEMENTS_SUMMARY_HISTORY`](/statement-summary-tables.md) | Similar to performance_schema statement summary history in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances.| | [`TABLE_STORAGE_STATS`](/information-schema/information-schema-table-storage-stats.md) | Provides details about table sizes in storage. | | [`TIDB_HOT_REGIONS`](https://docs.pingcap.com/tidb/stable/information-schema-tidb-hot-regions) | Provides statistics about which regions are hot. This table is not applicable to TiDB Cloud. | | [`TIDB_HOT_REGIONS_HISTORY`](/information-schema/information-schema-tidb-hot-regions-history.md) | Provides history statistics about which Regions are hot. | diff --git a/mysql-compatibility.md b/mysql-compatibility.md index bea14fd7213dd..24fcc99d90370 100644 --- a/mysql-compatibility.md +++ b/mysql-compatibility.md @@ -48,7 +48,7 @@ You can try out TiDB features on [TiDB Playground](https://play.tidbcloud.com/?u >**Note:** > - > Currently, only {{{ .starter }}} and {{{ .essential }}} clusters in certain AWS regions support [`FULLTEXT` syntax and indexes](https://docs.pingcap.com/tidbcloud/vector-search-full-text-search-sql). TiDB Self-Managed and TiDB Cloud Dedicated support parsing the `FULLTEXT` syntax but do not support using the `FULLTEXT` indexes. + > Currently, only {{{ .starter }}} and {{{ .essential }}} instances in certain AWS regions support [`FULLTEXT` syntax and indexes](https://docs.pingcap.com/tidbcloud/vector-search-full-text-search-sql). TiDB Self-Managed and TiDB Cloud Dedicated support parsing the `FULLTEXT` syntax but do not support using the `FULLTEXT` indexes. + `SPATIAL` (also known as `GIS`/`GEOMETRY`) functions, data types and indexes [#6347](https://github.com/pingcap/tidb/issues/6347) + Character sets other than `ascii`, `latin1`, `binary`, `utf8`, `utf8mb4`, and `gbk`. diff --git a/placement-rules-in-sql.md b/placement-rules-in-sql.md index 31b430cc45795..f71b91ee0b528 100644 --- a/placement-rules-in-sql.md +++ b/placement-rules-in-sql.md @@ -15,7 +15,7 @@ This feature can fulfill the following use cases: > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Overview diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index 489d9012631ef..8f0147b0c1b11 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -493,7 +493,7 @@ If you are ready to deploy a TiDB cluster for the production environment, here a If you are an application developer and want to quickly build an application using TiDB, here are the next steps: - [Developer Guide Overview](https://docs.pingcap.com/developer/) -- [Create a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md) +- [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md) - [Example Applications](/develop/dev-guide-sample-application-java-jdbc.md) If you are looking for an analytics solution with TiFlash, here are the next steps: diff --git a/schema-cache.md b/schema-cache.md index 7f75d940bfb3a..c187ccc65a5c7 100644 --- a/schema-cache.md +++ b/schema-cache.md @@ -9,7 +9,7 @@ In some multi-tenant scenarios, there might be hundreds of thousands or even mil > **Note:** > -> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Configure schema cache diff --git a/sql-statements/sql-statement-add-index.md b/sql-statements/sql-statement-add-index.md index fb25c5d67d8f0..145b1f5e6804f 100644 --- a/sql-statements/sql-statement-add-index.md +++ b/sql-statements/sql-statement-add-index.md @@ -100,7 +100,7 @@ mysql> EXPLAIN SELECT * FROM t1 WHERE c1 = 3; >**Note:** > - > Currently, only {{{ .starter }}} and {{{ .essential }}} clusters in certain AWS regions support [`FULLTEXT` syntax and indexes](https://docs.pingcap.com/tidbcloud/vector-search-full-text-search-sql). + > Currently, only {{{ .starter }}} and {{{ .essential }}} instances in certain AWS regions support [`FULLTEXT` syntax and indexes](https://docs.pingcap.com/tidbcloud/vector-search-full-text-search-sql). * Descending indexes are not supported (similar to MySQL 5.7). * Adding the primary key of the `CLUSTERED` type to a table is not supported. For more details about the primary key of the `CLUSTERED` type, refer to [clustered index](/clustered-indexes.md). diff --git a/sql-statements/sql-statement-admin-alter-ddl.md b/sql-statements/sql-statement-admin-alter-ddl.md index 159c1b2cf4e4d..5164c252b2e60 100644 --- a/sql-statements/sql-statement-admin-alter-ddl.md +++ b/sql-statements/sql-statement-admin-alter-ddl.md @@ -7,7 +7,7 @@ summary: An overview of the usage of `ADMIN ALTER DDL JOBS` for the TiDB databas > **Note:** > -> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. The `ADMIN ALTER DDL JOBS` statement allows you to modify the parameter of a single running DDL job. For example: diff --git a/sql-statements/sql-statement-admin.md b/sql-statements/sql-statement-admin.md index ddd623e50bbbe..19847ed98656a 100644 --- a/sql-statements/sql-statement-admin.md +++ b/sql-statements/sql-statement-admin.md @@ -58,7 +58,7 @@ The above statement is used to reload the blocklist of logic optimization rules. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ```sql ADMIN PLUGINS ENABLE plugin_name [, plugin_name] ...; @@ -132,7 +132,7 @@ The above statement is used to view the details of some special columns of a tab > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ```sql ADMIN SHOW SLOW RECENT N; diff --git a/sql-statements/sql-statement-alter-instance.md b/sql-statements/sql-statement-alter-instance.md index a4090b1c78b9a..dc1b559000dcd 100644 --- a/sql-statements/sql-statement-alter-instance.md +++ b/sql-statements/sql-statement-alter-instance.md @@ -9,7 +9,7 @@ The `ALTER INSTANCE` statement is used to make changes to a single TiDB instance > **Note:** > -> [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) can automatically refresh the TLS certificate, so this feature is not applicable to [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) can automatically refresh the TLS certificate, so this feature is not applicable to [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## RELOAD TLS diff --git a/sql-statements/sql-statement-alter-placement-policy.md b/sql-statements/sql-statement-alter-placement-policy.md index f469eb31677c9..34101b42684ea 100644 --- a/sql-statements/sql-statement-alter-placement-policy.md +++ b/sql-statements/sql-statement-alter-placement-policy.md @@ -9,7 +9,7 @@ summary: The usage of ALTER PLACEMENT POLICY in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. `ALTER PLACEMENT POLICY` _replaces_ the previous policy with the new definition. It does not _merge_ the old policy with the new one. In the following example, `FOLLOWERS=4` is lost when the `ALTER PLACEMENT POLICY` is executed: diff --git a/sql-statements/sql-statement-alter-range.md b/sql-statements/sql-statement-alter-range.md index f8cb02c14a0bb..811d479466d95 100644 --- a/sql-statements/sql-statement-alter-range.md +++ b/sql-statements/sql-statement-alter-range.md @@ -9,7 +9,7 @@ Currently, the `ALTER RANGE` statement can only be used to modify the range of a > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-alter-resource-group.md b/sql-statements/sql-statement-alter-resource-group.md index 21807344c7923..4d92108674481 100644 --- a/sql-statements/sql-statement-alter-resource-group.md +++ b/sql-statements/sql-statement-alter-resource-group.md @@ -9,7 +9,7 @@ The `ALTER RESOURCE GROUP` statement is used to modify a resource group in a dat > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-backup.md b/sql-statements/sql-statement-backup.md index e7d1e3c4069a1..9bb861137c147 100644 --- a/sql-statements/sql-statement-backup.md +++ b/sql-statements/sql-statement-backup.md @@ -10,7 +10,7 @@ This statement is used to perform a distributed backup of the TiDB cluster. > **Warning:** > > - This feature is experimental. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. -> - This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> - This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. The `BACKUP` statement uses the same engine as the [BR tool](https://docs.pingcap.com/tidb/stable/backup-and-restore-overview) does, except that the backup process is driven by TiDB itself rather than a separate BR tool. All benefits and warnings of BR also apply to this statement. diff --git a/sql-statements/sql-statement-cancel-distribution-job.md b/sql-statements/sql-statement-cancel-distribution-job.md index 5cc3f28161b77..fc9274cb44b5a 100644 --- a/sql-statements/sql-statement-cancel-distribution-job.md +++ b/sql-statements/sql-statement-cancel-distribution-job.md @@ -11,7 +11,7 @@ The `CANCEL DISTRIBUTION JOB` statement is used to cancel a Region scheduling ta > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. diff --git a/sql-statements/sql-statement-create-index.md b/sql-statements/sql-statement-create-index.md index 883fc1ca576da..2be1af049b23d 100644 --- a/sql-statements/sql-statement-create-index.md +++ b/sql-statements/sql-statement-create-index.md @@ -388,7 +388,7 @@ The system variables associated with the `CREATE INDEX` statement are `tidb_ddl_ >**Note:** > - > Currently, only {{{ .starter }}} and {{{ .essential }}} clusters in certain AWS regions support [`FULLTEXT` syntax and indexes](https://docs.pingcap.com/tidbcloud/vector-search-full-text-search-sql). + > Currently, only {{{ .starter }}} and {{{ .essential }}} instances in certain AWS regions support [`FULLTEXT` syntax and indexes](https://docs.pingcap.com/tidbcloud/vector-search-full-text-search-sql). * TiDB accepts index types such as `HASH`, `BTREE` and `RTREE` in syntax for compatibility with MySQL, but ignores them. * Descending indexes are not supported (similar to MySQL 5.7). diff --git a/sql-statements/sql-statement-create-placement-policy.md b/sql-statements/sql-statement-create-placement-policy.md index 8f6f774358dae..44249954617bd 100644 --- a/sql-statements/sql-statement-create-placement-policy.md +++ b/sql-statements/sql-statement-create-placement-policy.md @@ -9,7 +9,7 @@ summary: The usage of CREATE PLACEMENT POLICY in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-create-resource-group.md b/sql-statements/sql-statement-create-resource-group.md index 8e2902a96df73..e7e1c4499ba6c 100644 --- a/sql-statements/sql-statement-create-resource-group.md +++ b/sql-statements/sql-statement-create-resource-group.md @@ -9,7 +9,7 @@ You can use the `CREATE RESOURCE GROUP` statement to create a resource group. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-create-table.md b/sql-statements/sql-statement-create-table.md index dd3e775e6ca63..5399830bcbb77 100644 --- a/sql-statements/sql-statement-create-table.md +++ b/sql-statements/sql-statement-create-table.md @@ -281,7 +281,7 @@ mysql> DESC t1; >**Note:** > - > Currently, only {{{ .starter }}} and {{{ .essential }}} clusters in certain AWS regions support [`FULLTEXT` syntax and indexes](https://docs.pingcap.com/tidbcloud/vector-search-full-text-search-sql). + > Currently, only {{{ .starter }}} and {{{ .essential }}} instances in certain AWS regions support [`FULLTEXT` syntax and indexes](https://docs.pingcap.com/tidbcloud/vector-search-full-text-search-sql). * Setting a `PRIMARY KEY` or `UNIQUE INDEX` as a [global index](/global-indexes.md) with the `GLOBAL` index option is a TiDB extension for [partitioned tables](/partitioned-table.md) and is not compatible with MySQL. diff --git a/sql-statements/sql-statement-distribute-table.md b/sql-statements/sql-statement-distribute-table.md index 89ff8803eb34a..f9ab0673c64d3 100644 --- a/sql-statements/sql-statement-distribute-table.md +++ b/sql-statements/sql-statement-distribute-table.md @@ -13,7 +13,7 @@ summary: An overview of the usage of DISTRIBUTE TABLE for the TiDB database. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. diff --git a/sql-statements/sql-statement-drop-placement-policy.md b/sql-statements/sql-statement-drop-placement-policy.md index 851562ede2872..1278652dedb9e 100644 --- a/sql-statements/sql-statement-drop-placement-policy.md +++ b/sql-statements/sql-statement-drop-placement-policy.md @@ -9,7 +9,7 @@ summary: The usage of ALTER PLACEMENT POLICY in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-drop-resource-group.md b/sql-statements/sql-statement-drop-resource-group.md index e3d4bd39e93a5..72d128ba99a2d 100644 --- a/sql-statements/sql-statement-drop-resource-group.md +++ b/sql-statements/sql-statement-drop-resource-group.md @@ -9,7 +9,7 @@ You can use the `DROP RESOURCE GROUP` statement to drop a resource group. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-flashback-cluster.md b/sql-statements/sql-statement-flashback-cluster.md index ae9ebce2cd055..f2abb58f89f00 100644 --- a/sql-statements/sql-statement-flashback-cluster.md +++ b/sql-statements/sql-statement-flashback-cluster.md @@ -11,7 +11,7 @@ Starting from v6.5.6, v7.1.3, v7.5.1, and v7.6.0, TiDB introduces the `FLASHBACK > **Warning:** > -> The `FLASHBACK CLUSTER TO [TIMESTAMP|TSO]` syntax is not applicable to [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. To avoid unexpected results, do not execute this statement on {{{ .starter }}} and {{{ .essential }}} clusters. +> The `FLASHBACK CLUSTER TO [TIMESTAMP|TSO]` syntax is not applicable to [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. To avoid unexpected results, do not execute this statement on {{{ .starter }}} and {{{ .essential }}} instances. > **Warning:** > diff --git a/sql-statements/sql-statement-import-into.md b/sql-statements/sql-statement-import-into.md index 59a09b2fac1c6..86040ff8d6b11 100644 --- a/sql-statements/sql-statement-import-into.md +++ b/sql-statements/sql-statement-import-into.md @@ -197,7 +197,7 @@ For TiDB Self-Managed, `IMPORT INTO ... FROM FILE` supports importing data from > **Note:** > -> Global Sort is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> Global Sort is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. `IMPORT INTO ... FROM FILE` splits the data import job of a source data file into multiple sub-jobs, each sub-job independently encoding and sorting data before importing. If the encoded KV ranges of these sub-jobs have significant overlap (to learn how TiDB encodes data to KV, see [TiDB computing](/tidb-computing.md)), TiKV needs to keep compaction during import, leading to a decrease in import performance and stability. diff --git a/sql-statements/sql-statement-load-stats.md b/sql-statements/sql-statement-load-stats.md index e5f436d052e0e..c56bb6dd2827b 100644 --- a/sql-statements/sql-statement-load-stats.md +++ b/sql-statements/sql-statement-load-stats.md @@ -9,7 +9,7 @@ The `LOAD STATS` statement is used to load the statistics into TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-query-watch.md b/sql-statements/sql-statement-query-watch.md index 94fe22d7c28ff..41df792ab59b5 100644 --- a/sql-statements/sql-statement-query-watch.md +++ b/sql-statements/sql-statement-query-watch.md @@ -9,7 +9,7 @@ The `QUERY WATCH` statement is used to manually manage the watch list of runaway > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-restore.md b/sql-statements/sql-statement-restore.md index b33255d762afa..ae4d5cb75144e 100644 --- a/sql-statements/sql-statement-restore.md +++ b/sql-statements/sql-statement-restore.md @@ -10,7 +10,7 @@ This statement performs a distributed restore from a backup archive previously p > **Warning:** > > - This feature is experimental. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. -> - This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> - This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. The `RESTORE` statement uses the same engine as the [BR tool](https://docs.pingcap.com/tidb/stable/backup-and-restore-overview), except that the restore process is driven by TiDB itself rather than a separate BR tool. All benefits and caveats of BR also apply here. In particular, **`RESTORE` is currently not ACID-compliant**. Before running `RESTORE`, ensure that the following requirements are met: diff --git a/sql-statements/sql-statement-set-resource-group.md b/sql-statements/sql-statement-set-resource-group.md index 7f0ced5edce54..911741bd41c9d 100644 --- a/sql-statements/sql-statement-set-resource-group.md +++ b/sql-statements/sql-statement-set-resource-group.md @@ -9,7 +9,7 @@ summary: An overview of the usage of SET RESOURCE GROUP in the TiDB database. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-show-backups.md b/sql-statements/sql-statement-show-backups.md index eed71c1e541b4..09ad6023f2c5f 100644 --- a/sql-statements/sql-statement-show-backups.md +++ b/sql-statements/sql-statement-show-backups.md @@ -13,7 +13,7 @@ Use `SHOW BACKUPS` to query `BACKUP` tasks and use `SHOW RESTORES` to query `RES > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. Backups and restores that were started with the `br` commandline tool are not shown. diff --git a/sql-statements/sql-statement-show-create-placement-policy.md b/sql-statements/sql-statement-show-create-placement-policy.md index 2908fe31aac22..de7925f8d0ec2 100644 --- a/sql-statements/sql-statement-show-create-placement-policy.md +++ b/sql-statements/sql-statement-show-create-placement-policy.md @@ -9,7 +9,7 @@ summary: The usage of SHOW CREATE PLACEMENT POLICY in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-show-create-resource-group.md b/sql-statements/sql-statement-show-create-resource-group.md index ebe48b3adf5e1..3faf1119d0b77 100644 --- a/sql-statements/sql-statement-show-create-resource-group.md +++ b/sql-statements/sql-statement-show-create-resource-group.md @@ -9,7 +9,7 @@ You can use the `SHOW CREATE RESOURCE GROUP` statement to view the current defin > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-show-distribution-jobs.md b/sql-statements/sql-statement-show-distribution-jobs.md index f7d1ec48f0ad0..e085c4d38579e 100644 --- a/sql-statements/sql-statement-show-distribution-jobs.md +++ b/sql-statements/sql-statement-show-distribution-jobs.md @@ -11,7 +11,7 @@ The `SHOW DISTRIBUTION JOBS` statement shows all current Region distribution job > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. diff --git a/sql-statements/sql-statement-show-placement-for.md b/sql-statements/sql-statement-show-placement-for.md index aac4826d6ee32..cf087654baf62 100644 --- a/sql-statements/sql-statement-show-placement-for.md +++ b/sql-statements/sql-statement-show-placement-for.md @@ -9,7 +9,7 @@ summary: The usage of SHOW PLACEMENT FOR in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. The statement returns a result set in which the `Scheduling_State` field indicates the current progress that the Placement Driver (PD) has made in scheduling the placement: diff --git a/sql-statements/sql-statement-show-placement-labels.md b/sql-statements/sql-statement-show-placement-labels.md index 1d47e4ae8b294..c692bcb48b36d 100644 --- a/sql-statements/sql-statement-show-placement-labels.md +++ b/sql-statements/sql-statement-show-placement-labels.md @@ -9,7 +9,7 @@ summary: The usage of SHOW PLACEMENT LABELS in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-show-placement.md b/sql-statements/sql-statement-show-placement.md index f62fcdb88a157..e3886abe70a85 100644 --- a/sql-statements/sql-statement-show-placement.md +++ b/sql-statements/sql-statement-show-placement.md @@ -9,7 +9,7 @@ summary: The usage of SHOW PLACEMENT in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. The statement returns a result set in which the `Scheduling_State` field indicates the current progress that the Placement Driver (PD) has made in scheduling the placement: diff --git a/sql-statements/sql-statement-show-plugins.md b/sql-statements/sql-statement-show-plugins.md index ec8790fa7074c..ca4b229554da7 100644 --- a/sql-statements/sql-statement-show-plugins.md +++ b/sql-statements/sql-statement-show-plugins.md @@ -9,7 +9,7 @@ summary: An overview of the usage of SHOW PLUGINS for the TiDB database. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/sql-statements/sql-statement-show-table-distribution.md b/sql-statements/sql-statement-show-table-distribution.md index 489a2194b71f2..1375d0f12d132 100644 --- a/sql-statements/sql-statement-show-table-distribution.md +++ b/sql-statements/sql-statement-show-table-distribution.md @@ -11,7 +11,7 @@ The `SHOW TABLE DISTRIBUTION` statement shows the Region distribution informatio > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. diff --git a/sql-statements/sql-statement-show-table-regions.md b/sql-statements/sql-statement-show-table-regions.md index a66206f0c8bb6..224a23ff7a2f3 100644 --- a/sql-statements/sql-statement-show-table-regions.md +++ b/sql-statements/sql-statement-show-table-regions.md @@ -9,7 +9,7 @@ The `SHOW TABLE REGIONS` statement is used to show the Region information of a t > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Syntax diff --git a/sql-statements/sql-statement-split-region.md b/sql-statements/sql-statement-split-region.md index b158fcd51b00d..94b22994998db 100644 --- a/sql-statements/sql-statement-split-region.md +++ b/sql-statements/sql-statement-split-region.md @@ -13,7 +13,7 @@ To solve the hotspot problem in the above scenario, TiDB introduces the pre-spli > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Synopsis diff --git a/statement-summary-tables.md b/statement-summary-tables.md index 80d4a0d0b6d01..6cf25a383449f 100644 --- a/statement-summary-tables.md +++ b/statement-summary-tables.md @@ -17,7 +17,7 @@ Therefore, starting from v4.0.0-rc.1, TiDB provides system tables in `informatio > **Note:** > -> The preceding tables are not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> The preceding tables are not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. This document details these tables and introduces how to use them to troubleshoot SQL performance issues. diff --git a/statistics.md b/statistics.md index 39db445c5a660..062c51c5ec29f 100644 --- a/statistics.md +++ b/statistics.md @@ -460,7 +460,7 @@ You can run the [`DROP STATS`](/sql-statements/sql-statement-drop-stats.md) stat > **Note:** > -> Loading statistics is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> Loading statistics is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. By default, depending on the size of column statistics, TiDB loads statistics differently as follows: diff --git a/system-variables.md b/system-variables.md index d736b0cac6381..585787b6272ef 100644 --- a/system-variables.md +++ b/system-variables.md @@ -1618,7 +1618,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > > - If you are using a [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated) cluster, to improve the speed for index creation using this variable, make sure that your TiDB cluster is hosted on AWS and your TiDB node size is at least 8 vCPU. > - For [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated) clusters with 4 vCPU, it is recommended to manually disable [`tidb_ddl_enable_fast_reorg`](/system-variables.md#tidb_ddl_enable_fast_reorg-new-in-v630) to prevent resource limitations from affecting cluster stability during index creation. Disabling this setting allows indexes to be created using transactions, which reduces the overall impact on the cluster. -> - For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters, this variable is read-only. +> - For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances, this variable is read-only. - Scope: GLOBAL - Persists to cluster: Yes @@ -2310,7 +2310,7 @@ Assume that you have a cluster with 4 TiDB nodes and multiple TiKV nodes. In thi > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -2392,7 +2392,7 @@ Assume that you have a cluster with 4 TiDB nodes and multiple TiKV nodes. In thi > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -2724,7 +2724,7 @@ Assume that you have a cluster with 4 TiDB nodes and multiple TiKV nodes. In thi > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -2788,7 +2788,7 @@ Assume that you have a cluster with 4 TiDB nodes and multiple TiKV nodes. In thi > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -2900,7 +2900,7 @@ Query OK, 0 rows affected (0.09 sec) > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -3123,7 +3123,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -3143,7 +3143,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -3173,7 +3173,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -3188,7 +3188,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -3206,7 +3206,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -3301,7 +3301,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -3336,7 +3336,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -3349,7 +3349,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -3628,7 +3628,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: SESSION - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): Yes @@ -3729,7 +3729,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: No, only applicable to the current TiDB instance that you are connecting to. @@ -5271,7 +5271,7 @@ SHOW WARNINGS; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -5604,7 +5604,7 @@ SHOW WARNINGS; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -5644,7 +5644,7 @@ SHOW WARNINGS; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -5662,7 +5662,7 @@ SHOW WARNINGS; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -5675,7 +5675,7 @@ SHOW WARNINGS; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -5741,7 +5741,7 @@ SHOW WARNINGS; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -5899,7 +5899,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -6046,7 +6046,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6060,7 +6060,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6073,7 +6073,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6099,7 +6099,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6121,7 +6121,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6194,7 +6194,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6297,7 +6297,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6361,7 +6361,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6374,7 +6374,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6387,7 +6387,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6400,7 +6400,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6413,7 +6413,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6426,7 +6426,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6439,7 +6439,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No @@ -6452,7 +6452,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No @@ -6465,7 +6465,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: GLOBAL - Persists to cluster: Yes @@ -6543,7 +6543,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -6568,7 +6568,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: SESSION - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No @@ -6583,7 +6583,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: SESSION - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No @@ -6776,7 +6776,7 @@ Internally, the TiDB parser transforms the `SET TRANSACTION ISOLATION LEVEL [REA > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: SESSION - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No @@ -6909,7 +6909,7 @@ Internally, the TiDB parser transforms the `SET TRANSACTION ISOLATION LEVEL [REA > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. - Scope: SESSION | GLOBAL - Persists to cluster: Yes diff --git a/tidb-cloud/ai-feature-concepts.md b/tidb-cloud/ai-feature-concepts.md index 48a60ef7a9ea6..d77a813cc5636 100644 --- a/tidb-cloud/ai-feature-concepts.md +++ b/tidb-cloud/ai-feature-concepts.md @@ -13,7 +13,7 @@ This document highlights these AI features and how they enhance the TiDB experie Chat2Query is an AI-powered feature integrated into SQL Editor that assists users in generating, debugging, or rewriting SQL queries using natural language instructions. For more information, see [Explore your data with AI-assisted SQL Editor](/tidb-cloud/explore-data-with-chat2query.md). -In addition, TiDB Cloud provides a Chat2Query API for {{{ .starter }}} clusters. After it is enabled, TiDB Cloud will automatically create a system Data App called Chat2Query and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md). +In addition, TiDB Cloud provides a Chat2Query API for {{{ .starter }}} instances. After it is enabled, TiDB Cloud will automatically create a system Data App called Chat2Query and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md). ## Vector search (Beta) diff --git a/tidb-cloud/architecture-concepts.md b/tidb-cloud/architecture-concepts.md index 3cd1090afd695..0ebc62756cf44 100644 --- a/tidb-cloud/architecture-concepts.md +++ b/tidb-cloud/architecture-concepts.md @@ -95,7 +95,7 @@ For more information, see [TiDB Cloud API Overview](https://docs.pingcap.com/api In TiDB Cloud, each cluster consists of TiDB, TiKV, and TiFlash nodes. - In a TiDB Cloud Dedicated cluster, you can fully manage the number and size of your dedicated TiDB, TiKV, and TiFlash nodes according to your performance requirements. For more information, see [Scalability](/tidb-cloud/scalability-concepts.md). -- In a {{{ .starter }}} or {{{ .essential }}} cluster, the number and size of TiDB, TiKV, and TiFlash nodes are automatically managed. This ensures seamless scaling, eliminating the need for users to handle node configuration or management tasks. +- In a {{{ .starter }}} or {{{ .essential }}} instance, the number and size of TiDB, TiKV, and TiFlash nodes are automatically managed. This ensures seamless scaling, eliminating the need for users to handle node configuration or management tasks. ### TiDB node diff --git a/tidb-cloud/backup-and-restore-concepts.md b/tidb-cloud/backup-and-restore-concepts.md index 86ad3e67beeed..fc9c8c679ccfa 100644 --- a/tidb-cloud/backup-and-restore-concepts.md +++ b/tidb-cloud/backup-and-restore-concepts.md @@ -13,7 +13,7 @@ For TiDB Cloud clusters, snapshot backups are taken automatically by default and For more information, see the following: -- [Automatic backups for {{{ .starter }}} and {{{ .essential }}} clusters](/tidb-cloud/backup-and-restore-serverless.md#automatic-backups) +- [Automatic backups for {{{ .starter }}} and {{{ .essential }}} instances](/tidb-cloud/backup-and-restore-serverless.md#automatic-backups) - [Automatic backups for TiDB Cloud Dedicated clusters](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup) ## Manual backup @@ -38,6 +38,6 @@ Point-in-time Restore is a feature that enables you to restore data of any point If you want to perform Point-in-time Restore, note the following: -- For {{{ .starter }}} clusters, Point-in-time Restore is not available. -- For {{{ .essential }}} clusters, you can restore to any time within the last 30 days. For more information, see [Restore mode](/tidb-cloud/backup-and-restore-serverless.md#restore-mode). +- For {{{ .starter }}} instances, Point-in-time Restore is not available. +- For {{{ .essential }}} instances, you can restore to any time within the last 30 days. For more information, see [Restore mode](/tidb-cloud/backup-and-restore-serverless.md#restore-mode). - For TiDB Cloud Dedicated clusters, you need to [enable PITR](/tidb-cloud/backup-and-restore.md#turn-on-point-in-time-restore) in advance. diff --git a/tidb-cloud/backup-and-restore-serverless.md b/tidb-cloud/backup-and-restore-serverless.md index 789c850247d9b..7c6e06b4cc811 100644 --- a/tidb-cloud/backup-and-restore-serverless.md +++ b/tidb-cloud/backup-and-restore-serverless.md @@ -1,12 +1,12 @@ --- title: Back Up and Restore {{{ .starter }}} or Essential Data -summary: Learn how to back up and restore your {{{ .starter }}} or {{{ .essential }}} clusters. +summary: Learn how to back up and restore your {{{ .starter }}} or {{{ .essential }}} instances. aliases: ['/tidbcloud/restore-deleted-tidb-cluster'] --- # Back Up and Restore {{{ .starter }}} or Essential Data -This document describes how to back up and restore your data on {{{ .starter }}} or {{{ .essential }}} clusters. +This document describes how to back up and restore your data on {{{ .starter }}} or {{{ .essential }}} instances. > **Tip:** > @@ -14,7 +14,7 @@ This document describes how to back up and restore your data on {{{ .starter }}} ## View the Backup page -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page, click the name of your target cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. > **Tip:** > @@ -24,11 +24,11 @@ This document describes how to back up and restore your data on {{{ .starter }}} ## Automatic backups -TiDB Cloud automatically backs up your cluster data, allowing you to restore data from a backup snapshot to minimize data loss in the event of a disaster. +TiDB Cloud automatically backs up your data, allowing you to restore data from a backup snapshot to minimize data loss in the event of a disaster. ### Learn about the backup setting -Automatic backup settings vary between {{{ .starter }}} clusters and {{{ .essential }}} clusters, as shown in the following table: +Automatic backup settings vary between {{{ .starter }}} instances and {{{ .essential }}} instances, as shown in the following table: | Backup setting | {{{ .starter }}} (free) | {{{ .starter }}} (with spending limit > 0) | {{{ .essential }}} | |------------------|----------------------------|----------------------------|----------------------------| @@ -40,48 +40,48 @@ Automatic backup settings vary between {{{ .starter }}} clusters and {{{ .essent - **Backup Retention** is the duration for which backups are retained. Expired backups cannot be restored. - - For a free {{{ .starter }}} cluster, the backup retention is 1 day. - - For a {{{ .starter }}} (with spending limit > 0) or {{{ .essential }}} cluster, you can configure the backup retention to any value between 1 and 30 days. The default retention is 14 days. + - For a free {{{ .starter }}} instance, the backup retention is 1 day. + - For a {{{ .starter }}} (with spending limit > 0) or {{{ .essential }}} instance, you can configure the backup retention to any value between 1 and 30 days. The default retention is 14 days. - **Backup Time** is the time when the backup starts to be scheduled. Note that the final backup time might fall behind the configured backup time. - - For a free {{{ .starter }}} cluster, the backup time is a randomly fixed time. - - For a {{{ .starter }}} (with spending limit > 0) or {{{ .essential }}} cluster, you can configure the backup time to every half an hour. The default value is a randomly fixed time. + - For a free {{{ .starter }}} instance, the backup time is a randomly fixed time. + - For a {{{ .starter }}} (with spending limit > 0) or {{{ .essential }}} instance, you can configure the backup time to every half an hour. The default value is a randomly fixed time. ### Configure the backup setting -To set the backup time for a {{{ .essential }}} cluster, perform the following steps: +To set the backup time for a {{{ .essential }}} instance, perform the following steps: -1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster. +1. Navigate to the [**Backup**](#view-the-backup-page) page of your {{{ .starter }}} or Essential instance. 2. Click **Backup Setting**. This will open the **Backup Setting** window, where you can configure the automatic backup settings according to your requirements. -3. In **Backup Time**, schedule a start time for the daily cluster backup. +3. In **Backup Time**, schedule a start time for the daily backup. 4. Click **Confirm**. ## Restore -TiDB Cloud clusters offer restore functionality to help recover data in case of accidental loss or corruption. +TiDB Cloud offer restore functionality to help recover data in case of accidental loss or corruption. ### Restore mode -TiDB Cloud supports snapshot restore and point-in-time restore for your cluster. +TiDB Cloud supports snapshot restore and point-in-time restore for your {{{ .starter }}} or Essential instance. -- **Snapshot Restore**: restores your cluster from a specific backup snapshot. +- **Snapshot Restore**: restores your {{{ .starter }}} or Essential instance from a specific backup snapshot. -- **Point-in-Time Restore (beta)**: restores your cluster to a specific time. +- **Point-in-Time Restore (beta)**: restores your {{{ .essential }}} instance to a specific time. - - {{{ .starter }}} clusters: not supported. - - {{{ .essential }}} clusters: restores to any time within the backup retention, but not earlier than the cluster creation time or later than one minute before the current time. + - {{{ .starter }}} instances: not supported. + - {{{ .essential }}} instances: restores to any time within the backup retention, but not earlier than the {{{ .essential }}} instance creation time or later than one minute before the current time. ### Restore destination -TiDB Cloud supports restoring data to a new cluster. +TiDB Cloud supports restoring data to a new {{{ .starter }}} or Essential instance. ### Restore timeout -The restore process typically completes within a few minutes. If the restore takes longer than three hours, it is automatically canceled and the new cluster is deleted, while the source cluster remains unchanged. +The restore process typically completes within a few minutes. If the restore takes longer than three hours, it is automatically canceled and the new {{{ .starter }}} or Essential instance is deleted, while the source instance remains unchanged. If the data is corrupted after a canceled restore and cannot be recovered, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) for assistance. @@ -89,11 +89,11 @@ If the data is corrupted after a canceled restore and cannot be recovered, conta > **Note:** > -> User credentials and permissions from the source cluster will not be restored to the new cluster. +> User credentials and permissions from the source {{{ .starter }}} or Essential instance will not be restored to the new {{{ .starter }}} or Essential instance. -To restore your data to a new cluster, take the following steps: +To restore your data to a new {{{ .starter }}} or Essential instance, take the following steps: -1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster. +1. Navigate to the [**Backup**](#view-the-backup-page) page of your {{{ .starter }}} or Essential instance. 2. Click **Restore**. @@ -110,7 +110,7 @@ To restore your data to a new cluster, take the following steps:
- To restore to a specific point in time for a {{{ .essential }}} cluster, take the following steps: + To restore to a specific point in time for a {{{ .essential }}} instance, take the following steps: 1. Click **Point-in-Time Restore**. 2. Select the date and time you want to restore to. @@ -118,18 +118,18 @@ To restore your data to a new cluster, take the following steps:
-4. Enter a name for the new cluster. -5. Choose a plan for the new cluster and update the capacity as needed. +4. Enter a name for the new instance. +5. Choose a plan for the new instance and update the capacity as needed. - - If you choose a {{{ .starter }}} cluster and need more resources than the [free quota](/tidb-cloud/select-cluster-tier.md#usage-quota), set a monthly spending limit. - - If you choose a {{{ .essential }}} cluster, set the minimum RCU and maximum RCU, and then configure advanced settings as needed. + - If you choose a {{{ .starter }}} instance and need more resources than the [free quota](/tidb-cloud/select-cluster-tier.md#usage-quota), set a monthly spending limit. + - If you choose a {{{ .essential }}} instance, set the minimum RCU and maximum RCU, and then configure advanced settings as needed. 6. Click **Restore** to begin the restore process. -Once the restore process begins, the cluster status changes to **Restoring**. The cluster will remain unavailable until the restore is complete and the status changes to **Available**. +Once the restore process begins, the {{{ .starter }}} or Essential instance status changes to **Restoring**. The {{{ .starter }}} or Essential instance will remain unavailable until the restore is complete and the status changes to **Available**. ## Limitations - If a TiFlash replica is enabled, it will be unavailable for a period after the restore, because the data needs to be rebuilt in TiFlash. -- Manual backups are not supported for {{{ .starter }}} and {{{ .essential }}} clusters. +- Manual backups are not supported for {{{ .starter }}} and {{{ .essential }}} instances. - Clusters with more than 1 TiB of data do not support restoring to new clusters by default. Contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) for assistance with larger datasets. diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index 7d2620f538b25..4379eb17f5484 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -10,7 +10,7 @@ This document describes how to back up and restore your TiDB Cloud Dedicated clu > **Tip** > -> To learn how to back up and restore data on {{{ .starter }}} or {{{ .essential }}} clusters, see [Back Up and Restore Data on {{{ .starter }}} or Essential](/tidb-cloud/backup-and-restore-serverless.md). +> To learn how to back up and restore data on {{{ .starter }}} or {{{ .essential }}} instances, see [Back Up and Restore Data on {{{ .starter }}} or Essential](/tidb-cloud/backup-and-restore-serverless.md). ## Limitations @@ -24,7 +24,7 @@ This document describes how to back up and restore your TiDB Cloud Dedicated clu ### View the Backup page -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. > **Tip:** > diff --git a/tidb-cloud/branch-github-integration.md b/tidb-cloud/branch-github-integration.md index 785592d9cdc1d..cc57e2f3b5b07 100644 --- a/tidb-cloud/branch-github-integration.md +++ b/tidb-cloud/branch-github-integration.md @@ -11,13 +11,13 @@ summary: Learn how to integrate the TiDB Cloud Branching feature with GitHub. If you use GitHub for application development, you can integrate TiDB Cloud Branching into your GitHub CI/CD pipeline, which lets you automatically test your pull requests with branches without affecting the production database. -In the integration process, you will be prompted to install the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) GitHub App. The app can automatically manage branches of your {{{ .starter }}} or {{{ .essential }}} cluster according to pull requests in your GitHub repository. For example, when you create a pull request, the app will create a corresponding branch for your cluster, in which you can work on new features or bug fixes in isolation without affecting the production database. +In the integration process, you will be prompted to install the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) GitHub App. The app can automatically manage branches of your {{{ .starter }}} or {{{ .essential }}} instance according to pull requests in your GitHub repository. For example, when you create a pull request, the app will create a corresponding branch for your {{{ .starter }}} or Essential instance, in which you can work on new features or bug fixes in isolation without affecting the production database. This document covers the following topics: 1. How to integrate TiDB Cloud Branching with GitHub 2. How does the TiDB Cloud Branching app work -3. How to build a branching-based CI workflow to test every pull request using branches rather than the production cluster +3. How to build a branching-based CI workflow to test every pull request using branches rather than the production {{{ .starter }}} or Essential instance ## Before you begin @@ -25,13 +25,13 @@ Before the integration, make sure that you have the following: - A GitHub account - A GitHub repository for your application -- A [{{{ .starter }}} or {{{ .essential }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) +- A [{{{ .starter }}} or {{{ .essential }}} instance](/tidb-cloud/create-tidb-cluster-serverless.md) ## Integrate TiDB Cloud Branching with your GitHub repository {#integrate-branching-with-your-github-repository} To integrate TiDB Cloud Branching with your GitHub repository, take the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} instance to go to its overview page. 2. Click **Branches** in the left navigation pane. @@ -48,17 +48,17 @@ To integrate TiDB Cloud Branching with your GitHub repository, take the followin 5. Select your target repository in the **GitHub Repository** drop-down list. If the list is long, you can search the repository by typing the name. -6. Click **Connect** to connect between your cluster and your GitHub repository. +6. Click **Connect** to connect between your {{{ .starter }}} or Essential instance and your GitHub repository. ## TiDB Cloud Branching app behaviors -After you connect your {{{ .starter }}} or {{{ .essential }}} cluster to your GitHub repository, for each pull request in this repository, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) GitHub App can automatically manage its corresponding branch for your cluster. The following lists the default behaviors for pull request changes: +After you connect your {{{ .starter }}} or {{{ .essential }}} instance to your GitHub repository, for each pull request in this repository, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) GitHub App can automatically manage its corresponding branch for your {{{ .starter }}} or Essential instance. The following lists the default behaviors for pull request changes: | Pull request changes | TiDB Cloud Branching app behaviors | |------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Create a pull request | When you create a pull request in the repository, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) app creates a branch for your cluster. When `branch.mode` is set to `reset`, the branch name follows the `${github_branch_name}_${pr_id}` format. When `branch.mode` is set to `reserve`, the branch name follows the `${github_branch_name}_${pr_id}_${commit_sha}` format. Note that the number of branches has a [limit](/tidb-cloud/branch-overview.md#limitations-and-quotas). | +| Create a pull request | When you create a pull request in the repository, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) app creates a branch for your {{{ .starter }}} or Essential instance. When `branch.mode` is set to `reset`, the branch name follows the `${github_branch_name}_${pr_id}` format. When `branch.mode` is set to `reserve`, the branch name follows the `${github_branch_name}_${pr_id}_${commit_sha}` format. Note that the number of branches has a [limit](/tidb-cloud/branch-overview.md#limitations-and-quotas). | | Push new commits to a pull request | When `branch.mode` is set to `reset`, every time you push a new commit to a pull request in the repository, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) app resets the branch. When `branch.mode` is set to `reserve`, the app creates a new branch for the latest commit. | | Close or merge a pull request | When you close or merge a pull request, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) app deletes the branch for this pull request. | | Reopen a pull request | When you reopen a pull request, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) app creates a branch for the lasted commit of the pull request. | @@ -113,7 +113,7 @@ github: **Type:** boolean. **Default:** `true`. -If it is set to `false`, the TiDB Cloud Branching app will not delete the branch for your {{{ .starter }}} or {{{ .essential }}} cluster when a pull request is closed or merged. +If it is set to `false`, the TiDB Cloud Branching app will not delete the branch for your {{{ .starter }}} or {{{ .essential }}} instance when a pull request is closed or merged. ```yaml github: @@ -123,7 +123,7 @@ github: ## Create a branching CI workflow -One of the best practices for using branches is to create a branching CI workflow. With the workflow, you can test your code using a branch of your cluster instead of using the production cluster before merging the pull request. You can find a live demo [here](https://github.com/shiyuhang0/tidbcloud-branch-gorm-example). +One of the best practices for using branches is to create a branching CI workflow. With the workflow, you can test your code using a branch of your {{{ .starter }}} or Essential instance instead of using the production instance itself before merging the pull request. You can find a live demo [here](https://github.com/shiyuhang0/tidbcloud-branch-gorm-example). Here are the main steps to create the workflow: @@ -133,7 +133,7 @@ Here are the main steps to create the workflow: You can use the [wait-for-tidbcloud-branch](https://github.com/tidbcloud/wait-for-tidbcloud-branch) action to wait for the readiness of the branch and get the connection information of the branch. - Taking the branch of a {{{ .starter }}} cluster as an example: + Taking the branch of a {{{ .starter }}} instance as an example: ```yaml steps: diff --git a/tidb-cloud/branch-manage.md b/tidb-cloud/branch-manage.md index c0b8f59b06e29..b765efc16cb73 100644 --- a/tidb-cloud/branch-manage.md +++ b/tidb-cloud/branch-manage.md @@ -5,7 +5,7 @@ summary: Learn How to manage TiDB Cloud branches. # Manage TiDB Cloud Branches -This document describes how to manage branches of your {{{ .starter }}} or {{{ .essential }}} cluster using the [TiDB Cloud console](https://tidbcloud.com). To manage it using the TiDB Cloud CLI, see [`ticloud branch`](/tidb-cloud/ticloud-branch-create.md). +This document describes how to manage branches of your {{{ .starter }}} or {{{ .essential }}} instance using the [TiDB Cloud console](https://tidbcloud.com). To manage it using the TiDB Cloud CLI, see [`ticloud branch`](/tidb-cloud/ticloud-branch-create.md). ## Required access @@ -18,11 +18,11 @@ For more information about permissions, see [User roles](/tidb-cloud/manage-user > **Note:** > -> You can only create branches for {{{ .starter }}} or {{{ .essential }}} clusters that are created after July 5, 2023. See [Limitations and quotas](/tidb-cloud/branch-overview.md#limitations-and-quotas) for more limitations. +> You can only create branches for {{{ .starter }}} or {{{ .essential }}} instances that are created after July 5, 2023. See [Limitations and quotas](/tidb-cloud/branch-overview.md#limitations-and-quotas) for more limitations. To create a branch, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} instance to go to its overview page. 2. Click **Branches** in the left navigation pane. 3. In the upper-right corner of the **Branches** page, click **Create Branch**. A dialog is displayed. @@ -31,38 +31,38 @@ To create a branch, perform the following steps: 4. In the **Create Branch** dialog, configure the following options: - **Name**: enter a name for the branch. - - **Parent branch**: select the original cluster or an existing branch. `main` represents the current cluster. + - **Parent branch**: select the original {{{ .starter }}} or Essential instance or an existing branch. `main` represents the current instance. - **Include data up to**: choose one of the following: - **Current point in time**: create a branch from the current state. - **Specific date and time**: create a branch from a specified time. 5. Click **Create**. -Depending on the data size in your cluster, the branch creation will be completed in a few minutes. +Depending on the data size in your {{{ .starter }}} or Essential instance, the branch creation will be completed in a few minutes. ## View branches -To view branches for your cluster, perform the following steps: +To view branches for your {{{ .starter }}} or Essential instance, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} instance to go to its overview page. 2. Click **Branches** in the left navigation pane. - The branch list of the cluster is displayed in the right pane. + The branch list of the {{{ .starter }}} or Essential instance is displayed in the right pane. ## Connect to a branch To connect to a branch, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} instance to go to its overview page. 2. Click **Branches** in the left navigation pane. 3. In the row of your target branch to be connected, click **...** in the **Action** column. 4. Click **Connect** in the drop-down list. The dialog for the connection information is displayed. 5. Click **Generate Password** or **Reset Password** to create or reset the root password. 6. Connect to the branch using the connection information. -Alternatively, you can get the connection string from the cluster overview page: +Alternatively, you can get the connection string from the overview page of your {{{ .starter }}} or Essential instance: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. 3. Select the branch you want to connect to in the `Branch` drop-down list. 4. Click **Generate Password** or **Reset Password** to create or reset the root password. @@ -72,7 +72,7 @@ Alternatively, you can get the connection string from the cluster overview page: To delete a branch, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} instance to go to its overview page. 2. Click **Branches** in the left navigation pane. 3. In the row of your target branch to be deleted, click **...** in the **Action** column. 4. Click **Delete** in the drop-down list. @@ -88,7 +88,7 @@ Resetting a branch synchronizes it with the latest data from its parent. To reset a branch, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} instance to go to its overview page. 2. Click **Branches** in the left navigation pane. 3. In the row of your target branch to be reset, click **...** in the **Action** column. 4. Click **Reset** in the drop-down list. diff --git a/tidb-cloud/branch-overview.md b/tidb-cloud/branch-overview.md index 6b0871743a49c..f136517546f3b 100644 --- a/tidb-cloud/branch-overview.md +++ b/tidb-cloud/branch-overview.md @@ -5,7 +5,7 @@ summary: Learn the concept of TiDB Cloud branches. # TiDB Cloud Branching (Beta) Overview -TiDB Cloud lets you create branches for {{{ .starter }}} and {{{ .essential }}} clusters. A branch for a cluster is a separate instance that contains a diverged copy of data from the original cluster. It provides an isolated environment, allowing you to experiment freely without worrying about affecting the original cluster. +TiDB Cloud lets you create branches for {{{ .starter }}} and {{{ .essential }}} instances. A branch for a {{{ .starter }}} or Essential instance is a separate instance that contains a diverged copy of data from the original {{{ .starter }}} or Essential instance. It provides an isolated environment, allowing you to experiment freely without worrying about affecting the original {{{ .starter }}} or Essential instance. With branches, developers can work in parallel, iterate rapidly on new features, troubleshoot issues without affecting the production database, and easily revert changes if needed. This feature streamlines the development and deployment process while ensuring a high level of stability and reliability for the production database. @@ -15,9 +15,9 @@ With branches, developers can work in parallel, iterate rapidly on new features, ## Implementations -When a branch for a cluster is created, the data in the branch diverges from the original cluster or its parent branch at a specific point in time. This means that subsequent changes made in either the parent or the branch will not be synchronized with each other. +When a branch for a {{{ .starter }}} or Essential instance is created, the data in the branch diverges from the original {{{ .starter }}} or Essential instance or its parent branch at a specific point in time. This means that subsequent changes made in either the parent or the branch will not be synchronized with each other. -To ensure fast and seamless branch creation, TiDB Cloud uses a copy-on-write technique for sharing data between the original cluster and its branches. This process usually completes within a few minutes and is imperceptible to users, ensuring that it does not affect the performance of your original cluster. +To ensure fast and seamless branch creation, TiDB Cloud uses a copy-on-write technique for sharing data between the original {{{ .starter }}} or Essential instance and its branches. This process usually completes within a few minutes and is imperceptible to users, ensuring that it does not affect the performance of your original {{{ .starter }}} or Essential instance. ## Scenarios @@ -39,18 +39,18 @@ You can create branches easily and quickly to get isolated data environments. Br Currently, TiDB Cloud branches are in beta and free of charge. -- For each organization in TiDB Cloud, you can create a maximum of five branches by default across all the clusters. The branches of a cluster will be created in the same region as the cluster, and you cannot create branches for a throttled cluster or a cluster larger than 100 GiB. +- For each organization in TiDB Cloud, you can create a maximum of five branches by default across all {{{ .starter }}} and Essential instances. The branches of a {{{ .starter }}} or Essential instance will be created in the same region as the instance, and you cannot create branches for a {{{ .starter }}} or Essential instance that is throttled or larger than 100 GiB. -- For each branch of a free cluster, 10 GiB storage is allowed. For each branch of a cluster with spending limit > 0, 100 GiB storage is allowed. Once the storage is reached, the read and write operations on this branch will be throttled until you reduce the storage. +- For each branch of a free {{{ .starter }}} instance, 10 GiB storage is allowed. For each branch of a {{{ .starter }}} instance with spending limit > 0, 100 GiB storage is allowed. Once the storage is reached, the read and write operations on this branch will be throttled until you reduce the storage. - Branches are intended for short-term feature development and functional testing. Because branches lack auto-scaling capability, they are not suitable for performance testing. -- If your cluster has tables with TiFlash replicas, these replicas will be temporarily unavailable in the new branch after you create it, because TiFlash needs to rebuild the replica data. +- If your {{{ .starter }}} or Essential instance has tables with TiFlash replicas, these replicas will be temporarily unavailable in the new branch after you create it, because TiFlash needs to rebuild the replica data. - When [creating a branch](/tidb-cloud/branch-manage.md#create-a-branch) from a specific point in time: - - For a free {{{ .starter }}} cluster, you can select any time within the last 24 hours. - - For a {{{ .starter }}} (with spending limit > 0) or {{{ .essential }}} cluster, you can select any time within the last 14 days. + - For a free {{{ .starter }}} instance, you can select any time within the last 24 hours. + - For a {{{ .starter }}} (with spending limit > 0) or {{{ .essential }}} instance, you can select any time within the last 14 days. If you need more quotas, [contact TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). diff --git a/tidb-cloud/built-in-monitoring.md b/tidb-cloud/built-in-monitoring.md index ae15526713ad6..916b04048d848 100644 --- a/tidb-cloud/built-in-monitoring.md +++ b/tidb-cloud/built-in-monitoring.md @@ -11,7 +11,7 @@ TiDB Cloud collects and displays a full set of standard metrics of your cluster To view the metrics on the **Metrics** page, take the following steps: -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target resource to go to its overview page. > **Tip:** > @@ -86,9 +86,9 @@ The following sections illustrate the metrics on the **Metrics** page for TiDB C | TiProxy Throughput | node | The bytes transferred per second on each TiProxy node. | | TiProxy Sessions Migration Reasons | reason | The number of session migrations that happen every minute and the reasons for them. | -## Metrics for {{{ .starter }}} and {{{ .essential }}} clusters +## Metrics for {{{ .starter }}} and {{{ .essential }}} instances -The **Metrics** page provides two tabs for metrics of {{{ .starter }}} and {{{ .essential }}} clusters: +The **Metrics** page provides two tabs for metrics of {{{ .starter }}} and {{{ .essential }}} instances: - **Cluster Status**: displays the cluster-level main metrics. - **Database Status**: displays the database-level main metrics. @@ -99,16 +99,16 @@ The following table illustrates the cluster-level main metrics under the **Clust | Metric name | Labels | Description | | :------------| :------| :-------------------------------------------- | -| Request Units | RU per second | The Request Unit (RU) is a unit of measurement used to track the resource consumption of a query or transaction in a {{{ .starter }}} cluster. Besides user queries, background activities can also consume RUs, so when QPS is 0, RU usage per second might still be nonzero.| -| Capacity vs Usage (RU/s) | Provisioned capacity (RCU), Consumed RU/s | The Request Capacity Units (RCUs) and the consumed Request Units (RU) per second in a {{{ .essential }}} cluster. | +| Request Units | RU per second | The Request Unit (RU) is a unit of measurement used to track the resource consumption of a query or transaction in a {{{ .starter }}} instance. Besides user queries, background activities can also consume RUs, so when QPS is 0, RU usage per second might still be nonzero.| +| Capacity vs Usage (RU/s) | Provisioned capacity (RCU), Consumed RU/s | The Request Capacity Units (RCUs) and the consumed Request Units (RU) per second in a {{{ .essential }}} instance. | | Used Storage Size | Row-based storage, Columnar storage | The size of row-based storage and columnar storage. This metric is displayed only when each storage type is 50 MiB or larger. | | Query Per Second | All, {SQL type} | The number of SQL statements executed per second, which are collected by SQL types, such as `SELECT`, `INSERT`, and `UPDATE`. | -| Query Duration | Avg, P99, P99-{SQL type} | The duration from receiving a request from the client to the {{{ .starter }}} or {{{ .essential }}} cluster until the cluster executes the request and returns the result to the client. | +| Query Duration | Avg, P99, P99-{SQL type} | The duration from receiving a request from the client to the {{{ .starter }}} or {{{ .essential }}} instance until the cluster executes the request and returns the result to the client. | | Failed Query | All | The number of SQL statement execution errors per second. | | Transaction Per Second | All | The number of transactions executed per second. | | Transaction Duration | Avg, P99 | The execution duration of transactions. | | Lock-wait | P95, P99 | Time spent by transactions waiting to acquire pessimistic locks. High values indicate contention on the same rows or keys. | -| Total Connection | All | The number of connections to the {{{ .starter }}} or {{{ .essential }}} cluster. | +| Total Connection | All | The number of connections to the {{{ .starter }}} or {{{ .essential }}} instance. | | Idle Connection Duration | P99, P99(in-txn), P99(not-in-txn) | The time that connections remain idle while inside an open transaction. Long durations typically indicate slow application logic or long-running transactions. | ### Database Status diff --git a/tidb-cloud/changefeed-overview.md b/tidb-cloud/changefeed-overview.md index 30c7040105e70..e6df8e87c533d 100644 --- a/tidb-cloud/changefeed-overview.md +++ b/tidb-cloud/changefeed-overview.md @@ -11,19 +11,20 @@ TiDB Cloud changefeed helps you stream data from TiDB Cloud to other data servic > > - Currently, TiDB Cloud only allows up to 100 changefeeds per clusterinstance. > - Currently, TiDB Cloud only allows up to 100 table filter rules per changefeed. -> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters, the changefeed feature is unavailable. +> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) instances, the changefeed feature is unavailable. +> - For [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) instances, the changefeed feature is in beta. For more information, see [Changefeed (Beta)](/tidb-cloud/essential-changefeed-overview.md). ## View the Changefeed page To access the changefeed feature, take the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project.navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page. +1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters. -2. Click the name of your target clusterinstance to go to its overview page, and then click **Data** > **Changefeed** in the left navigation pane. The changefeed page is displayed. +2. Click the name of your target TiDB Cloud Dedicated cluster{{{ .premium }}} instance to go to its overview page, and then click **Data** > **Changefeed** in the left navigation pane. The changefeed page is displayed. On the **Changefeed** page, you can create a changefeed, view a list of existing changefeeds, and operate the existing changefeeds (such as scaling, pausing, resuming, editing, and deleting a changefeed). diff --git a/tidb-cloud/changefeed-sink-to-apache-pulsar.md b/tidb-cloud/changefeed-sink-to-apache-pulsar.md index 229fcb8e5c7bb..1303227aeba17 100644 --- a/tidb-cloud/changefeed-sink-to-apache-pulsar.md +++ b/tidb-cloud/changefeed-sink-to-apache-pulsar.md @@ -10,7 +10,8 @@ This document describes how to create a changefeed to stream data from TiDB Clou > **Note:** > > - To replicate data to Apache Pulsar using the changefeed feature, make sure that your TiDB Cloud Dedicated cluster version is v7.5.1 or later. -> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters, the changefeed feature is unavailable. +> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) instances, the changefeed feature is unavailable. +> - For [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) instances, the changefeed feature is in beta. For more information, see [Changefeed (Beta)](/tidb-cloud/essential-changefeed-overview.md). ## Restrictions diff --git a/tidb-cloud/changefeed-sink-to-cloud-storage.md b/tidb-cloud/changefeed-sink-to-cloud-storage.md index bf173590854cc..efd27e9321ecf 100644 --- a/tidb-cloud/changefeed-sink-to-cloud-storage.md +++ b/tidb-cloud/changefeed-sink-to-cloud-storage.md @@ -10,7 +10,8 @@ This document describes how to create a changefeed to stream data from TiDB Clou > **Note:** > > - To stream data to cloud storage, make sure that your TiDB cluster version is v7.1.1 or later. To upgrade your TiDB Cloud Dedicated cluster to v7.1.1 or later, [contact TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). -> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters, the changefeed feature is unavailable. +> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) instances, the changefeed feature is unavailable. +> - For [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) instances, the changefeed feature is in beta. For more information, see [Changefeed (Beta)](/tidb-cloud/essential-changefeed-overview.md). ## Restrictions diff --git a/tidb-cloud/changefeed-sink-to-tidb-cloud.md b/tidb-cloud/changefeed-sink-to-tidb-cloud.md index 32bfcea1e1f60..4caac41b845f2 100644 --- a/tidb-cloud/changefeed-sink-to-tidb-cloud.md +++ b/tidb-cloud/changefeed-sink-to-tidb-cloud.md @@ -1,11 +1,11 @@ --- title: Sink to TiDB Cloud -summary: This document explains how to stream data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} or {{{ .essential }}} cluster. There are restrictions on the number of changefeeds and regions available for the feature. Prerequisites include extending tidb_gc_life_time, backing up data, and obtaining the start position of TiDB Cloud sink. To create a TiDB Cloud sink, navigate to the cluster overview page, establish the connection, customize table and event filters, fill in the start replication position, specify the changefeed specification, review the configuration, and create the sink. Finally, restore tidb_gc_life_time to its original value. +summary: This document explains how to stream data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} or {{{ .essential }}} instance. There are restrictions on the number of changefeeds and regions available for the feature. Prerequisites include extending tidb_gc_life_time, backing up data, and obtaining the start position of TiDB Cloud sink. To create a TiDB Cloud sink, navigate to the cluster overview page, establish the connection, customize table and event filters, fill in the start replication position, specify the changefeed specification, review the configuration, and create the sink. Finally, restore tidb_gc_life_time to its original value. --- # Sink to TiDB Cloud -This document describes how to stream data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} or {{{ .essential }}} cluster. +This document describes how to stream data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} or {{{ .essential }}} instance. > **Note:** > @@ -23,14 +23,14 @@ This document describes how to stream data from a TiDB Cloud Dedicated cluster t - AWS Singapore (ap-southeast-1) - AWS Tokyo (ap-northeast-1) -- The source TiDB Cloud Dedicated cluster and the destination {{{ .starter }}} or {{{ .essential }}} cluster must be in the same project and the same region. -- The **Sink to TiDB Cloud** feature only supports network connection via private endpoints. When you create a changefeed to stream data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} or {{{ .essential }}} cluster, TiDB Cloud will automatically set up the private endpoint connection between the two clusters. +- The source TiDB Cloud Dedicated cluster and the destination {{{ .starter }}} or {{{ .essential }}} instance must be in the same project and the same region. +- The **Sink to TiDB Cloud** feature only supports network connection via private endpoints. When you create a changefeed to stream data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} or {{{ .essential }}} instance, TiDB Cloud will automatically set up the private endpoint connection between the two clusters. ## Prerequisites -The **Sink to TiDB Cloud** connector can only sink incremental data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} or {{{ .essential }}} cluster after a certain [TSO](https://docs.pingcap.com/tidb/stable/glossary#tso). +The **Sink to TiDB Cloud** connector can only sink incremental data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} or {{{ .essential }}} instance after a certain [TSO](https://docs.pingcap.com/tidb/stable/glossary#tso). -Before creating a changefeed, you need to export existing data from the source TiDB Cloud Dedicated cluster and load the data to the destination {{{ .starter }}} or {{{ .essential }}} cluster. +Before creating a changefeed, you need to export existing data from the source TiDB Cloud Dedicated cluster and load the data to the destination {{{ .starter }}} or {{{ .essential }}} instance. 1. Extend the [tidb_gc_life_time](https://docs.pingcap.com/tidb/stable/system-variables#tidb_gc_life_time-new-in-v50) to be longer than the total time of the following two operations, so that historical data during the time is not garbage collected by TiDB. @@ -43,7 +43,7 @@ Before creating a changefeed, you need to export existing data from the source T SET GLOBAL tidb_gc_life_time = '720h'; ``` -2. Use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export data from your TiDB Cloud Dedicated cluster, then use [the import feature](/tidb-cloud/import-csv-files-serverless.md) to load data to the destination {{{ .starter }}} or {{{ .essential }}} cluster. +2. Use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export data from your TiDB Cloud Dedicated cluster, then use [the import feature](/tidb-cloud/import-csv-files-serverless.md) to load data to the destination {{{ .starter }}} or {{{ .essential }}} instance. 3. From the [exported files of Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview#format-of-exported-files), get the start position of TiDB Cloud sink from the metadata file: @@ -59,13 +59,13 @@ Before creating a changefeed, you need to export existing data from the source T ## Create a TiDB Cloud sink -After completing the prerequisites, you can sink your data to the destination {{{ .starter }}} or {{{ .essential }}} cluster. +After completing the prerequisites, you can sink your data to the destination {{{ .starter }}} or {{{ .essential }}} instance. 1. Navigate to the cluster overview page of the target TiDB cluster, and then click **Data** > **Changefeed** in the left navigation pane. 2. Click **Create Changefeed**, and select **TiDB Cloud** as the destination. -3. In the **TiDB Cloud Connection** area, select the destination {{{ .starter }}} or {{{ .essential }}} cluster, and then fill in the user name and password of the destination cluster. +3. In the **TiDB Cloud Connection** area, select the destination {{{ .starter }}} or {{{ .essential }}} instance, and then fill in the user name and password of the destination cluster. 4. Click **Next** to establish the connection between the two TiDB clusters and test whether the changefeed can connect them successfully: diff --git a/tidb-cloud/cli-reference.md b/tidb-cloud/cli-reference.md index ee3d40436dd22..99539538cd91c 100644 --- a/tidb-cloud/cli-reference.md +++ b/tidb-cloud/cli-reference.md @@ -9,11 +9,11 @@ summary: Provides an overview of TiDB Cloud CLI. > > Currently, TiDB Cloud CLI is in beta and not applicable to TiDB Cloud Dedicated clusters. -TiDB Cloud CLI is a command line interface, which allows you to operate TiDB Cloud from your terminal with a few lines of commands. In the TiDB Cloud CLI, you can easily manage your TiDB Cloud clusters, import data to your clusters, and perform more operations. +TiDB Cloud CLI is a command line interface, which allows you to operate TiDB Cloud from your terminal with a few lines of commands. In the TiDB Cloud CLI, you can easily manage your {{{ .starter }}} and Essential instances, import data to your clusters, and perform more operations. ## Before you begin -Make sure to first [set up your TiDB Cloud CLI environment](/tidb-cloud/get-started-with-cli.md). Once you have installed the `ticloud` CLI, you can use it to manage your TiDB Cloud clusters from the command lines. +Make sure to first [set up your TiDB Cloud CLI environment](/tidb-cloud/get-started-with-cli.md). Once you have installed the `ticloud` CLI, you can use it to manage your {{{ .starter }}} and Essential instances from the command lines. ## Commands available @@ -24,12 +24,12 @@ To use the `ticloud` CLI in your terminal, run `ticloud [command] [subcommand]`. | Command | Subcommand | Description | |-----------------------|-----------------------------------------------------------------------|------------------------------------------------| | auth | login, logout, whoami | Login and logout | -| serverless (alias: s) | create, delete, describe, list, update, spending-limit, region, shell | Manage {{{ .starter }}} or {{{ .essential }}} cluster | -| serverless branch | create, delete, describe, list, shell | Manage branches for your {{{ .starter }}} or {{{ .essential }}} cluster | -| serverless import | cancel, describe, list, start | Manage import tasks for your {{{ .starter }}} or {{{ .essential }}} cluster | -| serverless export | create, describe, list, cancel, download | Manage export tasks for your {{{ .starter }}} or {{{ .essential }}} cluster | -| serverless sql-user | create, list, delete, update | Manage SQL users for your {{{ .starter }}} or {{{ .essential }}} cluster | -| serverless audit-log | config, describe, filter-rule (alias: filter), download | Manage database audit logging for your {{{ .starter }}} or {{{ .essential }}} cluster | +| serverless (alias: s) | create, delete, describe, list, update, spending-limit, region, shell | Manage {{{ .starter }}} or {{{ .essential }}} instance | +| serverless branch | create, delete, describe, list, shell | Manage branches for your {{{ .starter }}} or {{{ .essential }}} instance | +| serverless import | cancel, describe, list, start | Manage import tasks for your {{{ .starter }}} or {{{ .essential }}} instance | +| serverless export | create, describe, list, cancel, download | Manage export tasks for your {{{ .starter }}} or {{{ .essential }}} instance | +| serverless sql-user | create, list, delete, update | Manage SQL users for your {{{ .starter }}} or {{{ .essential }}} instance | +| serverless audit-log | config, describe, filter-rule (alias: filter), download | Manage database audit logging for your {{{ .starter }}} or {{{ .essential }}} instance | | completion | bash, fish, powershell, zsh | Generate completion script for specified shell | | config | create, delete, describe, edit, list, set, use | Configure user profiles | | project | list | Manage projects | diff --git a/tidb-cloud/configure-external-storage-access.md b/tidb-cloud/configure-external-storage-access.md index 3796e472fbd11..aff3947cd911d 100644 --- a/tidb-cloud/configure-external-storage-access.md +++ b/tidb-cloud/configure-external-storage-access.md @@ -8,7 +8,7 @@ aliases: ['/tidbcloud/serverless-external-storage'] -If you want to import data from or export data to an external storage in a TiDB Cloud cluster, you need to configure cross-account access. This document describes how to configure access to an external storage for {{{ .starter }}} and {{{ .essential }}} clusters. +If you want to import data from or export data to an external storage in a {{{ .starter }}} or Essential instance, you need to configure cross-account access. This document describes how to configure access to an external storage for {{{ .starter }}} and {{{ .essential }}} instances. @@ -22,7 +22,7 @@ If you need to configure these external storages for a TiDB Cloud Dedicated clus ## Configure Amazon S3 access -To allow a TiDB Cloud clusterinstance to access the source data in your Amazon S3 bucket, configure the bucket access for the clusterinstance using either of the following methods: +To allow a {{{ .starter }}} or Essential{{{ .premium }}} instance to access the source data in your Amazon S3 bucket, configure the bucket access for the instance using either of the following methods: - [Use a Role ARN](#configure-amazon-s3-access-using-a-role-arn): use a Role ARN to access your Amazon S3 bucket. - [Use an AWS access key](#configure-amazon-s3-access-using-an-aws-access-key): use the access key of an IAM user to access your Amazon S3 bucket. @@ -33,13 +33,12 @@ It is recommended that you use [AWS CloudFormation](https://docs.aws.amazon.com/ > **Note:** > -> Role ARN access to Amazon S3 is only supported for clustersinstances with AWS as the cloud provider. If you use a different cloud provider, use an AWS access key instead. For more information, see [Configure Amazon S3 access using an AWS access key](#configure-amazon-s3-access-using-an-aws-access-key). +> Role ARN access to Amazon S3 is only supported when the cloud provider of your target {{{ .starter }}} or Essential{{{ .premium }}} instance is AWS. If you use a different cloud provider, use an AWS access key instead. For more information, see [Configure Amazon S3 access using an AWS access key](#configure-amazon-s3-access-using-an-aws-access-key). -1. Open the **Import** page for your target clusterinstance. +1. Open the **Import** page for your target {{{ .starter }}} or Essential{{{ .premium }}} instance. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project.navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page. - - 2. Click the name of your target clusterinstance to go to its overview page, and then click **Data** > **Import** in the left navigation pane. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. + 2. Click the name of your target {{{ .starter }}} or Essential{{{ .premium }}} instance to go to its overview page, and then click **Data** > **Import** in the left navigation pane. 2. Open the **Add New ARN** dialog. @@ -51,7 +50,7 @@ It is recommended that you use [AWS CloudFormation](https://docs.aws.amazon.com/ - If you want to export data to Amazon S3, open the **Add New ARN** dialog as follows: - 1. Click **Export data to...** > **Amazon S3**. If your clusterinstance has neither imported nor exported any data before, click **Click here to export data to...** > **Amazon S3** at the bottom of the page. + 1. Click **Export data to...** > **Amazon S3**. If your {{{ .starter }}} or Essential{{{ .premium }}} instance has neither imported nor exported any data before, click **Click here to export data to...** > **Amazon S3** at the bottom of the page. 2. Fill in the **Folder URI** field. 3. Choose **AWS Role ARN** and click **Click here to create new one with AWS CloudFormation**. @@ -90,10 +89,10 @@ If you have any trouble creating a role ARN with AWS CloudFormation, you can tak 4. On the **Create policy** page, click the **JSON** tab. - 5. Configure the policy in the policy text field according to your needs. The following is an example that you can use to export data from and import data into a TiDB Cloud clusterinstance. + 5. Configure the policy in the policy text field according to your needs. The following is an example that you can use to export data from and import data into a {{{ .starter }}} or Essential{{{ .premium }}} instance. - - Exporting data from a TiDB Cloud clusterinstance needs the **s3:PutObject** and **s3:ListBucket** permissions. - - Importing data into a TiDB Cloud clusterinstance needs the **s3:GetObject**, **s3:GetObjectVersion**, and **s3:ListBucket** permissions. + - Exporting data from a {{{ .starter }}} or Essential{{{ .premium }}} instance needs the **s3:PutObject** and **s3:ListBucket** permissions. + - Importing data into a {{{ .starter }}} or Essential{{{ .premium }}} instance needs the **s3:GetObject**, **s3:GetObjectVersion**, and **s3:ListBucket** permissions. ```json { @@ -161,7 +160,7 @@ If you have any trouble creating a role ARN with AWS CloudFormation, you can tak - In **Trusted entity type**, select **AWS account**. - In **An AWS account**, select **Another AWS account**, and then paste the TiDB Cloud account ID to the **Account ID** field. - - In **Options**, click **Require external ID (Best practice when a third party will assume this role)**, and then paste the TiDB Cloud External ID to the **External ID** field. If the role is created without a Require external ID, once the configuration is done for one TiDB cluster in a project, all TiDB clusters in that project can use the same Role ARN to access your Amazon S3 bucket. If the role is created with the account ID and external ID, only the corresponding TiDB cluster can access the bucket. + - In **Options**, click **Require external ID (Best practice when a third party will assume this role)**, and then paste the TiDB Cloud External ID to the **External ID** field. If the role is created without a Require external ID, once the configuration is done for one {{{ .starter }}} or Essential instance in a project, all {{{ .starter }}} and Essential instances in that project can use the same Role ARN to access your Amazon S3 bucket. If the role is created with the account ID and external ID, only the corresponding {{{ .starter }}} or Essential instance can access the bucket. 3. Click **Next** to open the policy list, choose the policy you just created, and then click **Next**. @@ -193,7 +192,7 @@ Take the following steps to configure an access key: ## Configure GCS access -To allow a TiDB Cloud cluster to access your GCS bucket, you need to configure the GCS access for the bucket. You can use a service account key to configure the bucket access: +To allow a {{{ .starter }}} or Essential instance to access your GCS bucket, you need to configure the GCS access for the bucket. You can use a service account key to configure the bucket access: Take the following steps to configure a service account key: @@ -204,8 +203,8 @@ Take the following steps to configure a service account key: 3. Click **CREATE AND CONTINUE** to create the service account. 4. In the `Grant this service account access to project`, choose the [IAM roles](https://cloud.google.com/iam/docs/understanding-roles) with the needed permission. - - Exporting data from a TiDB Cloud cluster needs a role with `storage.objects.create` permission. - - Importing data into a TiDB Cloud cluster needs a role with `storage.buckets.get`, `storage.objects.get`, and `storage.objects.list` permissions. + - Exporting data from a {{{ .starter }}} or Essential instance needs a role with `storage.objects.create` permission. + - Importing data into a {{{ .starter }}} or Essential instance needs a role with `storage.buckets.get`, `storage.objects.get`, and `storage.objects.list` permissions. 5. Click **Continue** to go to the next step. 6. Optional: In the `Grant users access to this service account`, choose members that need to [attach the service account to other resources](https://cloud.google.com/iam/docs/attach-service-accounts). @@ -217,7 +216,7 @@ Take the following steps to configure a service account key: ![service-account-key](/media/tidb-cloud/serverless-external-storage/gcs-service-account-key.png) -3. Choose the default `JSON` key type, and then click **CREATE** to download the Google Cloud credentials file. The file contains the service account key that you need to use when configuring the GCS access for the TiDB Cloud cluster. +3. Choose the default `JSON` key type, and then click **CREATE** to download the Google Cloud credentials file. The file contains the service account key that you need to use when configuring the GCS access for the {{{ .starter }}} or Essential instance. @@ -231,15 +230,15 @@ You can create a SAS token either using an [Azure ARM template](https://learn.mi To create a SAS token using an Azure ARM template, take the following steps: -1. Open the **Import** page for your target cluster. +1. Open the **Import** page for your target {{{ .starter }}} or Essential instance. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. 2. Click the name of your target cluster to go to its overview page, and then click **Data** > **Import** in the left navigation pane. 2. Open the **Generate New SAS Token via ARM Template Deployment** dialog. - 1. Click **Export data to...** > **Azure Blob Storage**. If your cluster has neither imported nor exported any data before, click **Click here to export data to...** > **Azure Blob Storage** at the bottom of the page. + 1. Click **Export data to...** > **Azure Blob Storage**. If your {{{ .starter }}} or Essential instance has neither imported nor exported any data before, click **Click here to export data to...** > **Azure Blob Storage** at the bottom of the page. 2. Scroll down to the **Azure Blob Storage Settings** area, and then click **Click here to create a new one with Azure ARM template** under the SAS Token field. @@ -274,8 +273,8 @@ If you have any trouble creating a SAS token with the Azure ARM template, take t 2. In the **Allowed Resource types** section, choose **Container** and **Object**. 3. In the **Allowed permissions** section, choose the permission as needed. - - Exporting data from a TiDB Cloud cluster needs the **Read** and **Write** permissions. - - Importing data into a TiDB Cloud cluster needs the **Read** and **List** permissions. + - Exporting data from a {{{ .starter }}} or Essential instance needs the **Read** and **Write** permissions. + - Importing data into a {{{ .starter }}} or Essential instance needs the **Read** and **List** permissions. 4. Adjust **Start and expiry date/time** as needed. 5. You can keep the default values for other settings. @@ -304,9 +303,9 @@ Take the following steps to configure an AccessKey pair: - In the **Service** section, select **Object Storage Service**. - In the **Action** section, select the permissions as needed. - To import data into a TiDB Cloud clusterinstance, grant **oss:GetObject**, **oss:GetBucketInfo**, and **oss:ListObjects** permissions. + To import data into a {{{ .starter }}} or Essential{{{ .premium }}} instance, grant **oss:GetObject**, **oss:GetBucketInfo**, and **oss:ListObjects** permissions. - To export data from a TiDB Cloud clusterinstance, grant `oss:PutObject` and `oss:GetBucketInfo` permissions. + To export data from a {{{ .starter }}} or Essential{{{ .premium }}} instance, grant `oss:PutObject` and `oss:GetBucketInfo` permissions. - In the **Resource** section, select the bucket and the objects in the bucket. diff --git a/tidb-cloud/configure-ip-access-list.md b/tidb-cloud/configure-ip-access-list.md index e9ebd2256107f..95f5459346980 100644 --- a/tidb-cloud/configure-ip-access-list.md +++ b/tidb-cloud/configure-ip-access-list.md @@ -13,7 +13,7 @@ For each TiDB Cloud Dedicated cluster in TiDB Cloud, you can configure an IP acc To configure an IP access list for your TiDB Cloud Dedicated cluster, take the following steps: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. > **Tip:** > diff --git a/tidb-cloud/configure-security-settings.md b/tidb-cloud/configure-security-settings.md index 3ccb82e4a5aa5..b8dae61a15f01 100644 --- a/tidb-cloud/configure-security-settings.md +++ b/tidb-cloud/configure-security-settings.md @@ -9,15 +9,15 @@ For TiDB Cloud Dedicated clusters, you can configure the root password and allow > **Note:** > -> For {{{ .starter }}} or {{{ .essential }}} clusters, this document is inapplicable and you can refer to [TLS Connection to {{{ .starter }}} or Essential](/tidb-cloud/secure-connections-to-serverless-clusters.md) instead. +> For {{{ .starter }}} or {{{ .essential }}} instances, this document is inapplicable and you can refer to [TLS Connection to {{{ .starter }}} or Essential](/tidb-cloud/secure-connections-to-serverless-clusters.md) instead. -1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. In the TiDB Cloud console, navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters. -2. In the row of your target cluster, click **...** and select **Password Settings**. +2. In the row of your target TiDB Cloud Dedicated cluster, click **...** and select **Password Settings**. 3. Set the root password to connect to your cluster, and then click **Save**. You can click **Auto-generate Password** to generate a random password. The generated password will not show again, so save your password in a secure location. diff --git a/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md b/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md index 2c899def81f67..55f61110c2790 100644 --- a/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md +++ b/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md @@ -1,11 +1,11 @@ --- -title: Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints -summary: Learn how to configure and manage firewall rules with public access to your {{{ .starter }}} or {{{ .essential }}} cluster securely. +title: Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints +summary: Learn how to configure and manage firewall rules with public access to your {{{ .starter }}} or {{{ .essential }}} instance securely. --- # Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints -This document describes the public connectivity option for {{{ .starter }}} and {{{ .essential }}} clusters. You will learn key concepts for securely managing a cluster accessible via the internet. +This document describes the public connectivity option for {{{ .starter }}} and {{{ .essential }}} instances. You will learn key concepts for securely managing a {{{ .starter }}} or Essential instance accessible via the internet. > **Note:** > @@ -13,15 +13,15 @@ This document describes the public connectivity option for {{{ .starter }}} and ## Public endpoints -Configuring public access on your cluster allows the cluster access through a public endpoint. That is, the cluster is accessible through the internet. The public endpoint is a publicly resolvable DNS address. The term "authorized network" refers to a range of IP addresses you choose to permit access to your cluster. These permissions are enforced through **firewall rules**. +Configuring public access on your {{{ .starter }}} or Essential instance allows the instance access through a public endpoint. That is, the {{{ .starter }}} or Essential instance is accessible through the internet. The public endpoint is a publicly resolvable DNS address. The term "authorized network" refers to a range of IP addresses you choose to permit access to your {{{ .starter }}} or Essential instance. These permissions are enforced through **firewall rules**. ### Characteristics of public access -- Only specified IP addresses can access your cluster. +- Only specified IP addresses can access your {{{ .starter }}} or Essential instance. - By default, all IP addresses (`0.0.0.0 - 255.255.255.255`) are allowed. - - You can update allowed IP addresses after cluster creation. -- Your cluster has a publicly resolvable DNS name. -- Network traffic to and from your cluster is routed over the **public internet** rather than a private network. + - You can update allowed IP addresses after {{{ .starter }}} or Essential instance creation. +- Your {{{ .starter }}} or Essential instance has a publicly resolvable DNS name. +- Network traffic to and from your {{{ .starter }}} or Essential instance is routed over the **public internet** rather than a private network. ### Firewall rules @@ -31,17 +31,17 @@ You can create a maximum of 200 IP firewall rules. ### Allow AWS access -If your {{{ .starter }}} cluster is hosted on AWS, you can enable access from **all AWS IP addresses** by referring to the official [AWS IP address list](https://docs.aws.amazon.com/vpc/latest/userguide/aws-ip-ranges.html). +If your {{{ .starter }}} instance is hosted on AWS, you can enable access from **all AWS IP addresses** by referring to the official [AWS IP address list](https://docs.aws.amazon.com/vpc/latest/userguide/aws-ip-ranges.html). TiDB Cloud regularly updates this list and uses the reserved IP address **169.254.65.87** to represent all AWS IP addresses. ## Create and manage a firewall rule -This section describes how to manage firewall rules for a {{{ .starter }}} or {{{ .essential }}} cluster. With a public endpoint, the connections to your cluster are restricted to the IP addresses specified in the firewall rules. +This section describes how to manage firewall rules for a {{{ .starter }}} or {{{ .essential }}} instance. With a public endpoint, the connections to your instance are restricted to the IP addresses specified in the firewall rules. -To add firewall rules to a {{{ .starter }}} or {{{ .essential }}} cluster, take the following steps: +To add firewall rules to a {{{ .starter }}} or {{{ .essential }}} instance, take the following steps: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. @@ -51,7 +51,7 @@ To add firewall rules to a {{{ .starter }}} or {{{ .essential }}} cluster, take > > In some situations, the IP address observed by the TiDB Cloud console differs from the IP address used when accessing the internet. Therefore, you might need to change the start and end IP addresses to make the rule function as expected. You can use a search engine or other online tool to check your own IP address. For example, search for "what is my IP." -4. Click **Add rule** to add more address ranges. In the displayed window, you can specify a single IP address or a range of IP addresses. If you want to limit the rule to a single IP address, type the same IP address in the **Start IP Address** and **End IP Address** fields. Opening the firewall enables administrators, users, and applications to access any database on your cluster to which they have valid credentials. Click **Submit** to add the firewall rule. +4. Click **Add rule** to add more address ranges. In the displayed window, you can specify a single IP address or a range of IP addresses. If you want to limit the rule to a single IP address, type the same IP address in the **Start IP Address** and **End IP Address** fields. Opening the firewall enables administrators, users, and applications to access any database on your {{{ .starter }}} or Essential instance to which they have valid credentials. Click **Submit** to add the firewall rule. ## What's next diff --git a/tidb-cloud/configure-sql-users.md b/tidb-cloud/configure-sql-users.md index db6352b2396bd..361c1b3b8cdb4 100644 --- a/tidb-cloud/configure-sql-users.md +++ b/tidb-cloud/configure-sql-users.md @@ -40,7 +40,7 @@ After a SQL user is granted both a built-in role and multiple custom roles, the To view SQL users of a cluster, take the following steps: -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target resource to go to its overview page. > **Tip:** > diff --git a/tidb-cloud/connect-to-tidb-cluster-serverless.md b/tidb-cloud/connect-to-tidb-cluster-serverless.md index 9dd93545e9e71..570a69b841c1c 100644 --- a/tidb-cloud/connect-to-tidb-cluster-serverless.md +++ b/tidb-cloud/connect-to-tidb-cluster-serverless.md @@ -1,11 +1,11 @@ --- -title: Connect to Your {{{ .starter }}} or Essential Cluster -summary: Learn how to connect to your {{{ .starter }}} or {{{ .essential }}} cluster via different methods. +title: Connect to Your {{{ .starter }}} or Essential Instance +summary: Learn how to connect to your {{{ .starter }}} or {{{ .essential }}} instance via different methods. --- -# Connect to Your {{{ .starter }}} or Essential Cluster +# Connect to Your {{{ .starter }}} or Essential Instance -This document describes how to connect to your {{{ .starter }}} or {{{ .essential }}} cluster. +This document describes how to connect to your {{{ .starter }}} or {{{ .essential }}} instance. > **Tip:** > @@ -14,19 +14,19 @@ This document describes how to connect to your {{{ .starter }}} or {{{ .essentia ## Network connection methods -After your {{{ .starter }}} or {{{ .essential }}} cluster is created on TiDB Cloud, you can connect to it via one of the following methods: +After your {{{ .starter }}} or {{{ .essential }}} instance is created on TiDB Cloud, you can connect to it via one of the following methods: - Direct connections - Direct connections mean the MySQL native connection system over TCP. You can connect to your cluster using any tool that supports MySQL connection, such as [MySQL client](https://dev.mysql.com/doc/refman/8.0/en/mysql.html). + Direct connections mean the MySQL native connection system over TCP. You can connect to your {{{ .starter }}} or Essential instance using any tool that supports MySQL connection, such as [MySQL client](https://dev.mysql.com/doc/refman/8.0/en/mysql.html). - [Data Service (beta)](/tidb-cloud/data-service-overview.md) - TiDB Cloud provides a Data Service feature that enables you to connect to your {{{ .starter }}} cluster hosted on AWS via an HTTPS request using a custom API endpoint. Unlike direct connections, Data Service accesses your cluster data via a RESTful API rather than raw SQL. + TiDB Cloud provides a Data Service feature that enables you to connect to your {{{ .starter }}} instance hosted on AWS via an HTTPS request using a custom API endpoint. Unlike direct connections, Data Service accesses your {{{ .starter }}} or Essential instance data via a RESTful API rather than raw SQL. - [Serverless Driver (beta)](/develop/serverless-driver.md) - TiDB Cloud provides a serverless driver for JavaScript, which allows you to connect to your {{{ .starter }}} or {{{ .essential }}} cluster in edge environments with the same experience as direct connections. + TiDB Cloud provides a serverless driver for JavaScript, which allows you to connect to your {{{ .starter }}} or {{{ .essential }}} instance in edge environments with the same experience as direct connections. In the preceding connection methods, you can choose your desired one based on your needs: @@ -46,9 +46,9 @@ There are two network connection types for {{{ .starter }}} and {{{ .essential } - [Public endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) - The standard connection exposes a public endpoint, so you can connect to your TiDB cluster via a SQL client from your laptop. + The standard connection exposes a public endpoint, so you can connect to your {{{ .starter }}} or Essential instance via a SQL client from your laptop. - {{{ .starter }}} and {{{ .essential }}} require [TLS connections](/tidb-cloud/secure-connections-to-serverless-clusters.md), which ensures the security of data transmission from your applications to TiDB clusters. + {{{ .starter }}} and {{{ .essential }}} require [TLS connections](/tidb-cloud/secure-connections-to-serverless-clusters.md), which ensures the security of data transmission from your applications to {{{ .starter }}} or Essential instances. The following table shows the network you can use in different connection methods: @@ -60,4 +60,4 @@ The following table shows the network you can use in different connection method ## What's next -After you have successfully connected to your TiDB cluster, you can [explore SQL statements with TiDB](/basic-sql-operations.md). +After you have successfully connected to your {{{ .starter }}} or Essential instance, you can [explore SQL statements with TiDB](/basic-sql-operations.md). diff --git a/tidb-cloud/connect-to-tidb-cluster.md b/tidb-cloud/connect-to-tidb-cluster.md index 92b06eb3e36c5..cfaccb722bf3c 100644 --- a/tidb-cloud/connect-to-tidb-cluster.md +++ b/tidb-cloud/connect-to-tidb-cluster.md @@ -9,7 +9,7 @@ This document introduces the methods to connect to your TiDB Cloud Dedicated clu > **Tip:** > -> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster, see [Connect to Your {{{ .starter }}} or Essential Cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md). +> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} instance, see [Connect to Your {{{ .starter }}} or Essential Instance](/tidb-cloud/connect-to-tidb-cluster-serverless.md). > - This document focuses on the network connection methods for TiDB Cloud Dedicated. To connect to TiDB via a specific tool, driver, or ORM, see [Connect to TiDB](/develop/dev-guide-connect-to-tidb.md). After your TiDB Cloud Dedicated cluster is created on TiDB Cloud, you can connect to it via one of the following network connection methods: diff --git a/tidb-cloud/connect-via-sql-shell.md b/tidb-cloud/connect-via-sql-shell.md index 80427ab1e3a0f..2c81c3d1ac769 100644 --- a/tidb-cloud/connect-via-sql-shell.md +++ b/tidb-cloud/connect-via-sql-shell.md @@ -9,11 +9,11 @@ In TiDB Cloud SQL Shell, you can try TiDB SQL, test out TiDB's compatibility wit > **Note:** > -> You cannot connect to [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) or [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) using SQL Shell. To connect to your {{{ .starter }}} or {{{ .essential }}} cluster, see [Connect to {{{ .starter }}} or Essential Cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md). +> You cannot connect to [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) or [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) using SQL Shell. To connect to your {{{ .starter }}} or {{{ .essential }}} instance, see [Connect to {{{ .starter }}} or Essential Instance](/tidb-cloud/connect-to-tidb-cluster-serverless.md). To connect to your TiDB cluster using SQL shell, perform the following steps: -1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > diff --git a/tidb-cloud/connect-via-standard-connection-serverless.md b/tidb-cloud/connect-via-standard-connection-serverless.md index 7732dd82e4d8f..5b2c606ed2796 100644 --- a/tidb-cloud/connect-via-standard-connection-serverless.md +++ b/tidb-cloud/connect-via-standard-connection-serverless.md @@ -1,11 +1,11 @@ --- title: Connect to {{{ .starter }}} or Essential via Public Endpoint -summary: Learn how to connect to your {{{ .starter }}} or {{{ .essential }}} cluster via public endpoint. +summary: Learn how to connect to your {{{ .starter }}} or {{{ .essential }}} instance via public endpoint. --- # Connect to {{{ .starter }}} or Essential via Public Endpoint -This document describes how to connect to your {{{ .starter }}} or {{{ .essential }}} cluster via a public endpoint, using a SQL client from your computer, as well as how to disable a public endpoint. +This document describes how to connect to your {{{ .starter }}} or {{{ .essential }}} instance via a public endpoint, using a SQL client from your computer, as well as how to disable a public endpoint. ## Connect via a public endpoint @@ -13,9 +13,9 @@ This document describes how to connect to your {{{ .starter }}} or {{{ .essentia > > To learn how to connect to a TiDB Cloud Dedicated cluster via public endpoint, see [Connect to TiDB Cloud Dedicated via Public Connection](/tidb-cloud/connect-via-standard-connection.md). -To connect to a {{{ .starter }}} or {{{ .essential }}} cluster via public endpoint, take the following steps: +To connect to a {{{ .starter }}} or {{{ .essential }}} instance via public endpoint, take the following steps: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. @@ -42,22 +42,22 @@ To connect to a {{{ .starter }}} or {{{ .essential }}} cluster via public endpoi -4. TiDB Cloud lets you create [branches](/tidb-cloud/branch-overview.md) for your {{{ .starter }}} or {{{ .essential }}} 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. +4. TiDB Cloud lets you create [branches](/tidb-cloud/branch-overview.md) for your {{{ .starter }}} or {{{ .essential }}} instance. After a branch is created, you can choose to connect to the branch via the **Branch** drop-down list. `main` represents the {{{ .starter }}} or Essential instance itself. 5. If you have not set a password yet, click **Generate Password** to generate a random password. The generated password will not show again, so save your password in a secure location. -6. Connect to your cluster with the connection string. +6. Connect to your {{{ .starter }}} or Essential instance with the connection string. > **Note:** > - > When you connect to a {{{ .starter }}} or {{{ .essential }}} cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). - > Your client IP must be in the allowed IP rules of the public endpoint of your cluster. For more information, see [Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md). + > When you connect to a {{{ .starter }}} or {{{ .essential }}} instance, you must include the prefix for your {{{ .starter }}} or Essential instance in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). + > Your client IP must be in the allowed IP rules of the public endpoint of your {{{ .starter }}} or Essential instance. For more information, see [Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md). ## Disable a public endpoint -If you do not need to use a public endpoint of a {{{ .starter }}} or {{{ .essential }}} cluster, you can disable it to prevent connections from the internet: +If you do not need to use a public endpoint of a {{{ .starter }}} or {{{ .essential }}} instance, you can disable it to prevent connections from the internet: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. @@ -65,7 +65,7 @@ If you do not need to use a public endpoint of a {{{ .starter }}} or {{{ .essent 4. Click **Disable** in the confirmation dialog. -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. +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 {{{ .starter }}} or Essential instance from the public endpoint, they will get an error. > **Note:** > @@ -73,7 +73,7 @@ After disabling the public endpoint, the `Public` entry in the **Connection Type You can re-enable the public endpoint after disabling it: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. @@ -81,4 +81,4 @@ You can re-enable the public endpoint after disabling it: ## What's next -After you have successfully connected to your TiDB cluster, you can [explore SQL statements with TiDB](/basic-sql-operations.md). +After you have successfully connected to your {{{ .starter }}} or Essential instance, you can [explore SQL statements with TiDB](/basic-sql-operations.md). diff --git a/tidb-cloud/connect-via-standard-connection.md b/tidb-cloud/connect-via-standard-connection.md index 63e190a8c0261..07240cc1ca41c 100644 --- a/tidb-cloud/connect-via-standard-connection.md +++ b/tidb-cloud/connect-via-standard-connection.md @@ -9,7 +9,7 @@ This document describes how to connect to your TiDB Cloud Dedicated cluster via > **Tip:** > -> To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via public connection, see [Connect to {{{ .starter }}} or Essential via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md). +> To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} instance via public connection, see [Connect to {{{ .starter }}} or Essential via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md). ## Prerequisite: Configure IP access list @@ -21,7 +21,7 @@ To connect to a TiDB Cloud Dedicated cluster via public connection, take the fol 1. Open the overview page of the target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > diff --git a/tidb-cloud/create-tidb-cluster-serverless.md b/tidb-cloud/create-tidb-cluster-serverless.md index a5ebf4a10d925..eff4526f1c724 100644 --- a/tidb-cloud/create-tidb-cluster-serverless.md +++ b/tidb-cloud/create-tidb-cluster-serverless.md @@ -1,11 +1,11 @@ --- -title: Create a {{{ .starter }}} or Essential Cluster -summary: Learn how to create a {{{ .starter }}} or {{{ .essential }}} cluster. +title: Create a {{{ .starter }}} or Essential Instance +summary: Learn how to create a {{{ .starter }}} or {{{ .essential }}} instance. --- -# Create a {{{ .starter }}} or Essential Cluster +# Create a {{{ .starter }}} or Essential Instance -This document describes how to create a {{{ .starter }}} or {{{ .essential }}} cluster in the [TiDB Cloud console](https://tidbcloud.com/). +This document describes how to create a {{{ .starter }}} or {{{ .essential }}} instance in the [TiDB Cloud console](https://tidbcloud.com/). > **Tip:** > @@ -36,42 +36,42 @@ If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/sign ## Steps -If you are in the `Organization Owner` or the `Project Owner` role, you can create a {{{ .starter }}} or {{{ .essential }}} cluster as follows: +If you are in the `Organization Owner` or the `Project Owner` role, you can create a {{{ .starter }}} or {{{ .essential }}} instance as follows: -1. Log in to the [TiDB Cloud console](https://tidbcloud.com/), and then navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/), and then navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. -2. Click **Create Cluster**. +2. Click **Create Resource**. -3. Select a cluster plan. +3. Select a plan. - You can start with a **Starter** cluster and later upgrade to an **Essential** cluster as your needs grow. For more information, see [cluster plans](/tidb-cloud/select-cluster-tier.md). + You can start with a **Starter** instance and later upgrade to an **Essential** instance as your needs grow. For more information, see [Select a Plan](/tidb-cloud/select-cluster-tier.md). -4. Choose a cloud provider and a region where you want to host your cluster. +4. Choose a cloud provider and a region where you want to host your instance. -5. Update the default cluster name if necessary. +5. Update the default instance name if necessary. -6. Update the capacity of the cluster. +6. Update the capacity of the instance. - **Starter** plan: - - You can update the spending limit for your cluster. If the spending limit is set to 0, the cluster remains free. If the spending limit is greater than 0, you need to add a credit card before creating the cluster. + - You can update the spending limit for your {{{ .starter }}} instance. If the spending limit is set to 0, the instance remains free. If the spending limit is greater than 0, you need to add a credit card before creating the {{{ .starter }}} instance. - By default, each organization can create up to five [free Starter clusters](/tidb-cloud/select-cluster-tier.md#starter). To create additional Starter clusters, you must add a credit card and specify a spending limit. - **Essential** plan: - - You must specify both a minimum and maximum number of Request Capacity Units (RCUs) for your cluster. + - You must specify both a minimum and maximum number of Request Capacity Units (RCUs) for your {{{ .essential }}} instance. - - RCUs represent the compute resources provisioned for your workload. TiDB Cloud automatically scales your cluster within this range based on demand. + - RCUs represent the compute resources provisioned for your workload. TiDB Cloud automatically scales your {{{ .essential }}} instance within this range based on demand. 7. Click **Create**. - The cluster creation process starts and your TiDB Cloud cluster will be created in approximately 30 seconds. + The instance creation process starts and your instance will be created in approximately 30 seconds. ## What's next -After your cluster is created, follow the instructions in [Connect to TiDB Cloud via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) to create a password for your cluster. +After your {{{ .starter }}} or Essential instance is created, follow the instructions in [Connect to TiDB Cloud via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) to create a password for your instance. > **Note:** > -> If you do not set a password, you cannot connect to the cluster. +> If you do not set a password, you cannot connect to the {{{ .starter }}} or Essential instance. diff --git a/tidb-cloud/create-tidb-cluster.md b/tidb-cloud/create-tidb-cluster.md index ee95d7ee36930..ec392f28882a1 100644 --- a/tidb-cloud/create-tidb-cluster.md +++ b/tidb-cloud/create-tidb-cluster.md @@ -9,7 +9,7 @@ This tutorial guides you through signing up and creating a TiDB Cloud Dedicated > **Tip:** > -> To learn how to create a {{{ .starter }}} or {{{ .essential }}} cluster, see [Create a {{{ .starter }}} or Essential Cluster](/tidb-cloud/create-tidb-cluster-serverless.md). +> To learn how to create a {{{ .starter }}} or {{{ .essential }}} instance, see [Create a {{{ .starter }}} or Essential Instance](/tidb-cloud/create-tidb-cluster-serverless.md). ## Before you begin @@ -41,15 +41,15 @@ If you are an organization owner, you can rename the default project or create a If you are in the `Organization Owner` or the `Project Owner` role, you can create a TiDB Cloud Dedicated cluster as follows: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters. -2. Click **Create Cluster**. +2. Click **Create Resource**. -3. On the **Create Cluster** page, select **Dedicated**, and then configure the cluster information as follows: +3. On the **Create** page, select **Dedicated**, and then configure the cluster information as follows: 1. Choose a cloud provider and a region. diff --git a/tidb-cloud/data-service-get-started.md b/tidb-cloud/data-service-get-started.md index 5804f51ce04d6..c04d3178344ad 100644 --- a/tidb-cloud/data-service-get-started.md +++ b/tidb-cloud/data-service-get-started.md @@ -17,7 +17,7 @@ This document introduces how to quickly get started with TiDB Cloud Data Service ## Before you begin -Before creating a Data App, make sure that you have created a [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md) cluster hosted on AWS. If you do not have one, follow the steps in [Create a {{{ .starter }}} or Essential Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) to create one. +Before creating a Data App, make sure that you have created a [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md) cluster hosted on AWS. If you do not have one, follow the steps in [Create a {{{ .starter }}} or Essential Instance](/tidb-cloud/create-tidb-cluster-serverless.md) to create one. > **Note:** > diff --git a/tidb-cloud/data-service-oas-with-nextjs.md b/tidb-cloud/data-service-oas-with-nextjs.md index f06f3071f1429..1d023b1055bc9 100644 --- a/tidb-cloud/data-service-oas-with-nextjs.md +++ b/tidb-cloud/data-service-oas-with-nextjs.md @@ -11,12 +11,12 @@ This document introduces how to use the OpenAPI Specification of a [Data App](/t Before using OpenAPI Specification with Next.js, make sure that you have the following: -- A TiDB cluster. For more information, see [Create a {{{ .starter }}} or Essential Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) or [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). +- A TiDB cluster. For more information, see [Create a {{{ .starter }}} or Essential Instance](/tidb-cloud/create-tidb-cluster-serverless.md) or [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). - [Node.js](https://nodejs.org/en/download) - [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) - [yarn](https://yarnpkg.com/getting-started/install) -This document uses a {{{ .starter }}} cluster as an example. +This document uses a {{{ .starter }}} instance as an example. ## Step 1. Prepare data diff --git a/tidb-cloud/dedicated-external-storage.md b/tidb-cloud/dedicated-external-storage.md index abcf80e4492b0..36649858e79ce 100644 --- a/tidb-cloud/dedicated-external-storage.md +++ b/tidb-cloud/dedicated-external-storage.md @@ -8,7 +8,7 @@ aliases: ['/tidb-cloud/config-s3-and-gcs-access'] If your source data is stored in Amazon S3 buckets, Azure Blob Storage containers, or Google Cloud Storage (GCS) buckets, before importing or migrating the data to TiDB Cloud, you need to configure cross-account access to the buckets. This document describes how to do this for TiDB Cloud Dedicated clusters. -If you need to configure these external storages for {{{ .starter }}} or {{{ .essential }}} clusters, see [Configure External Storage Access for {{{ .starter }}} or Essential](/tidb-cloud/configure-external-storage-access.md). +If you need to configure these external storages for {{{ .starter }}} or {{{ .essential }}} instances, see [Configure External Storage Access for {{{ .starter }}} or Essential](/tidb-cloud/configure-external-storage-access.md). ## Configure Amazon S3 access @@ -23,13 +23,13 @@ Configure the bucket access for TiDB Cloud and get the Role ARN as follows: 1. In the [TiDB Cloud console](https://tidbcloud.com/), get the corresponding TiDB Cloud account ID and external ID of the target TiDB cluster. - 1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters. - 2. Click the name of your target cluster to go to its overview page, and then click **Data** > **Import** in the left navigation pane. + 2. Click the name of your target TiDB Cloud Dedicated cluster to go to its overview page, and then click **Data** > **Import** in the left navigation pane. 3. Select **Import data from Cloud Storage**, and then click **Amazon S3**. @@ -153,13 +153,13 @@ To allow TiDB Cloud to access the source data in your GCS bucket, you need to co 1. In the TiDB Cloud console, get the Google Cloud Service Account ID of the target TiDB cluster. - 1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters. - 2. Click the name of your target cluster to go to its overview page, and then click **Data** > **Import** in the left navigation pane. + 2. Click the name of your target TiDB Cloud Dedicated cluster to go to its overview page, and then click **Data** > **Import** in the left navigation pane. 3. Select **Import data from Cloud Storage**, and then click **Google Cloud Storage**. diff --git a/tidb-cloud/delete-tidb-cluster.md b/tidb-cloud/delete-tidb-cluster.md index 19b2d20f5e13d..9733bad9f6a6a 100644 --- a/tidb-cloud/delete-tidb-cluster.md +++ b/tidb-cloud/delete-tidb-cluster.md @@ -9,7 +9,7 @@ This document describes how to delete a TiDB cluster on TiDB Cloud. You can delete a cluster at any time by performing the following steps: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. 2. In the row of your target cluster to be deleted, click **...**. > **Tip:** @@ -26,7 +26,7 @@ You can delete a cluster at any time by performing the following steps: > **Note:** > - > [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters do not support restoring data after the deletion. If you want to delete a {{{ .starter }}} or {{{ .essential }}} cluster and restore its data in the future, see [Export Data from {{{ .starter }}} or Essential](/tidb-cloud/serverless-export.md) to export your data as a backup. + > [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) instances do not support restoring data after the deletion. If you want to delete a {{{ .starter }}} or {{{ .essential }}} instance and restore its data in the future, see [Export Data from {{{ .starter }}} or Essential](/tidb-cloud/serverless-export.md) to export your data as a backup. 5. Click **I understand, delete it**. diff --git a/tidb-cloud/essential-changefeed-overview.md b/tidb-cloud/essential-changefeed-overview.md index 563016ca1502c..9f8d924b6b685 100644 --- a/tidb-cloud/essential-changefeed-overview.md +++ b/tidb-cloud/essential-changefeed-overview.md @@ -9,8 +9,8 @@ TiDB Cloud changefeed helps you stream data from TiDB Cloud to other data servic > **Note:** > -> - Currently, TiDB Cloud only allows up to 10 changefeeds per {{{ .essential }}} cluster. -> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) clusters, the changefeed feature is unavailable. +> - Currently, TiDB Cloud only allows up to 10 changefeeds per {{{ .essential }}} instance. +> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) instances, the changefeed feature is unavailable. ## Restrictions @@ -32,7 +32,7 @@ Additional regions will be supported in the future. For immediate support in a s To access the changefeed feature, take the following steps: -1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -56,7 +56,7 @@ You can view a changefeed using the TiDB Cloud console or the TiDB Cloud CLI.
-1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster. +1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target {{{ .essential }}} instance. 2. Locate the corresponding changefeed you want to view, and click **...** > **View** in the **Action** column. 3. You can see the details of a changefeed, including its configuration, status, and metrics. @@ -80,7 +80,7 @@ You can pause or resume a changefeed using the TiDB Cloud console or the TiDB Cl
-1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster. +1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target {{{ .essential }}}instance. 2. Locate the corresponding changefeed you want to pause or resume, and click **...** > **Pause/Resume** in the **Action** column.
@@ -113,7 +113,7 @@ You can edit a changefeed using the TiDB Cloud console or the TiDB Cloud CLI.
-1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster. +1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target {{{ .essential }}} instance. 2. Locate the changefeed you want to pause, and click **...** > **Pause** in the **Action** column. 3. When the changefeed status changes to `Paused`, click **...** > **Edit** to edit the corresponding changefeed. @@ -145,7 +145,7 @@ ticloud serverless changefeed edit --cluster-id --changefeed-id **Duplicate**. 3. TiDB Cloud automatically populates the new changefeed configuration with the original settings. You can review and modify the configuration as needed. 4. After confirming the configuration, click **Submit** to create and start the new changefeed. @@ -157,7 +157,7 @@ You can delete a changefeed using the TiDB Cloud console or the TiDB Cloud CLI.
-1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target TiDB cluster. +1. Navigate to the [**Changefeed**](#view-the-changefeed-page) page of your target {{{ .essential }}} instance. 2. Locate the changefeed you want to delete, and click **...** > **Delete** in the **Action** column.
diff --git a/tidb-cloud/essential-changefeed-sink-to-kafka.md b/tidb-cloud/essential-changefeed-sink-to-kafka.md index 4326ec396012e..8de712300b6b2 100644 --- a/tidb-cloud/essential-changefeed-sink-to-kafka.md +++ b/tidb-cloud/essential-changefeed-sink-to-kafka.md @@ -9,7 +9,7 @@ This document describes how to create a changefeed to stream data from {{{ .esse ## Restrictions -- For each {{{ .essential }}} cluster, you can create up to 10 changefeeds. +- For each {{{ .essential }}} instance, you can create up to 10 changefeeds. - Currently, {{{ .essential }}} does not support uploading self-signed TLS certificates to connect to Kafka brokers. - Because {{{ .essential }}} uses TiCDC to establish changefeeds, it has the same [restrictions as TiCDC](https://docs.pingcap.com/tidb/stable/ticdc-overview#unsupported-scenarios). - If the table to be replicated does not have a primary key or a non-null unique index, the absence of a unique constraint during replication could result in duplicated data being inserted downstream in some retry scenarios. @@ -23,7 +23,7 @@ Before creating a changefeed to stream data to Apache Kafka, you need to complet ### Network -Ensure that your {{{ .essential }}} cluster can connect to the Apache Kafka service. You can choose one of the following connection methods: +Ensure that your {{{ .essential }}} instance can connect to the Apache Kafka service. You can choose one of the following connection methods: - Private Link Connection: meeting security compliance and ensuring network quality. - Public Network: suitable for a quick setup. @@ -64,7 +64,7 @@ For example, if your Kafka cluster is in Confluent Cloud, refer to [Resources](h ## Step 1. Open the Changefeed page for Apache Kafka 1. Log in to the [TiDB Cloud console](https://tidbcloud.com). -2. Navigate to the overview page of the target {{{ .essential }}} cluster, and then click **Data** > **Changefeed** in the left navigation pane. +2. Navigate to the overview page of the target {{{ .essential }}} instance, and then click **Data** > **Changefeed** in the left navigation pane. 3. Click **Create Changefeed**, and then select **Kafka** as **Destination**. ## Step 2. Configure the changefeed target diff --git a/tidb-cloud/essential-changefeed-sink-to-mysql.md b/tidb-cloud/essential-changefeed-sink-to-mysql.md index 5cba762687d5b..762e4516206a5 100644 --- a/tidb-cloud/essential-changefeed-sink-to-mysql.md +++ b/tidb-cloud/essential-changefeed-sink-to-mysql.md @@ -9,7 +9,7 @@ This document describes how to stream data from {{{ .essential }}} to MySQL usin ## Restrictions -- For each {{{ .essential }}} cluster, you can create up to 10 changefeeds. +- For each {{{ .essential }}} instance, you can create up to 10 changefeeds. - Because {{{ .essential }}} uses TiCDC to establish changefeeds, it has the same [restrictions as TiCDC](https://docs.pingcap.com/tidb/stable/ticdc-overview#unsupported-scenarios). - If the table to be replicated does not have a primary key or a non-null unique index, the absence of a unique constraint during replication could result in duplicated data being inserted downstream in some retry scenarios. @@ -23,7 +23,7 @@ Before creating a changefeed, you need to complete the following prerequisites: ### Network -Make sure that your {{{ .essential }}} cluster can connect to the MySQL service. You can choose one of the following connection methods: +Make sure that your {{{ .essential }}} instance can connect to the MySQL service. You can choose one of the following connection methods: - Private Link Connection: meeting security compliance and ensuring network quality. - Public Network: suitable for a quick setup. @@ -33,7 +33,7 @@ Make sure that your {{{ .essential }}} cluster can connect to the MySQL service. Private link connections leverage **Private Link** technologies from cloud providers, enabling resources in your VPC to connect to services in other VPCs through private IP addresses, as if those services were hosted directly within your VPC. -You can connect your {{{ .essential }}} cluster to your MySQL service securely through a private link connection. If the private link connection is not available for your MySQL service, follow [Connect to Amazon RDS via a Private Link Connection](/tidb-cloud/serverless-private-link-connection-to-aws-rds.md) or [Connect to Alibaba Cloud ApsaraDB RDS for MySQL via a Private Link Connection](/tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md) to create one. +You can connect your {{{ .essential }}} instance to your MySQL service securely through a private link connection. If the private link connection is not available for your MySQL service, follow [Connect to Amazon RDS via a Private Link Connection](/tidb-cloud/serverless-private-link-connection-to-aws-rds.md) or [Connect to Alibaba Cloud ApsaraDB RDS for MySQL via a Private Link Connection](/tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md) to create one.
@@ -47,7 +47,7 @@ If your MySQL service can be accessed over the public network, you can choose to ### Load existing data (optional) -The **Sink to MySQL** connector can only sink incremental data from your {{{ .essential }}} cluster to MySQL after a certain timestamp. If you already have data in your {{{ .essential }}} cluster, you can export and load the existing data of your {{{ .essential }}} cluster into MySQL before enabling **Sink to MySQL**. +The **Sink to MySQL** connector can only sink incremental data from your {{{ .essential }}} instance to MySQL after a certain timestamp. If you already have data in your {{{ .essential }}} instance, you can export and load the existing data of your {{{ .essential }}} instance into MySQL before enabling **Sink to MySQL**. To load the existing data: @@ -62,7 +62,7 @@ To load the existing data: SET GLOBAL tidb_gc_life_time = '72h'; ``` -2. Use the [Export](/tidb-cloud/serverless-export.md) feature to export data from your {{{ .essential }}} cluster, then use community tools such as [mydumper/myloader](https://centminmod.com/mydumper.html) to load the data into the MySQL service. +2. Use the [Export](/tidb-cloud/serverless-export.md) feature to export data from your {{{ .essential }}} instance, then use community tools such as [mydumper/myloader](https://centminmod.com/mydumper.html) to load the data into the MySQL service. 3. Record the snapshot time returned by [Export](/tidb-cloud/serverless-export.md). Use this timestamp as the starting position when you configure the MySQL sink. @@ -74,7 +74,7 @@ If you do not load the existing data, you need to create corresponding target ta After completing the prerequisites, you can sink your data to MySQL. -1. Navigate to the overview page of the target {{{ .essential }}} cluster, and then click **Data** > **Changefeed** in the left navigation pane. +1. Navigate to the overview page of the target {{{ .essential }}} instance, and then click **Data** > **Changefeed** in the left navigation pane. 2. Click **Create Changefeed**, and select **MySQL** as **Destination**. @@ -106,7 +106,7 @@ After completing the prerequisites, you can sink your data to MySQL. 8. In **Start Replication Position**, configure the starting position for your MySQL sink. - If you have [loaded the existing data](#load-existing-data-optional) using Export, select **From Time** and fill in the snapshot time returned by Export. Ensure that the time zone is correct. - - If you do not have any data in the upstream TiDB cluster, select **Start replication from now on**. + - If you do not have any data in the upstream {{{ .essential }}} instance, select **Start replication from now on**. 9. Click **Next** to configure your changefeed. diff --git a/tidb-cloud/essential-database-audit-logging.md b/tidb-cloud/essential-database-audit-logging.md index 6b511807b58bb..4cbd7b9d14325 100644 --- a/tidb-cloud/essential-database-audit-logging.md +++ b/tidb-cloud/essential-database-audit-logging.md @@ -1,6 +1,6 @@ --- title: Database Audit Logging (Beta) for {{{ .essential }}} -summary: Learn about how to audit a {{{ .essential }}} cluster in TiDB Cloud. +summary: Learn about how to audit a {{{ .essential }}} instance in TiDB Cloud. aliases: ['/tidbcloud/serverless-audit-logging'] --- @@ -14,7 +14,7 @@ aliases: ['/tidbcloud/serverless-audit-logging'] To evaluate the effectiveness of user access policies and other information security measures of your organization, it is a security best practice to periodically analyze database audit logs. -The audit logging feature is **disabled by default**. To audit a TiDB cluster, you need to enable audit logging for it. +The audit logging feature is **disabled by default**. To audit a {{{ .essential }}} instance, you need to enable audit logging for it. ## Audit logging configurations @@ -137,7 +137,7 @@ You can enable, edit, and disable audit logging. ### Enable audit logging -You can enable audit logging for a {{{ .essential }}} cluster using the TiDB Cloud console or the TiDB Cloud CLI. +You can enable audit logging for a {{{ .essential }}} instance using the TiDB Cloud console or the TiDB Cloud CLI. > **Note:** > @@ -146,7 +146,7 @@ You can enable audit logging for a {{{ .essential }}} cluster using the TiDB Clo
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -177,12 +177,12 @@ The `--rotation-size-mib`, `--rotation-interval-minutes`, and `--unredacted` par ### Edit audit logging -You can edit the audit logging for a {{{ .essential }}} cluster after enabling it. +You can edit the audit logging for a {{{ .essential }}} instance after enabling it.
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -209,12 +209,12 @@ ticloud serverless audit-log config update -c --rotation-size-mib < ### Disable audit logging -You can disable audit logging for a {{{ .essential }}} cluster. +You can disable audit logging for a {{{ .essential }}} instance.
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -250,7 +250,7 @@ To create a filter rule, define which users and events you want to capture in th
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -280,7 +280,7 @@ ticloud serverless audit-log filter create --cluster-id --display-n
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -310,7 +310,7 @@ ticloud serverless audit-log filter update --cluster-id --filter-ru
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -338,7 +338,7 @@ ticloud serverless audit-log filter update --cluster-id --filter-ru
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -373,7 +373,7 @@ When you store audit logs in TiDB Cloud, {{{ .essential }}} saves them as readab
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -420,9 +420,9 @@ All classes of audit logs contain the following information: | `TABLES` | The accessed tables related to this audit record. | | `STATUS_CODE` | The status code of the audit record. `1` means success, and `0` means failure. | | `KEYSPACE_NAME` | The keyspace name of the audit record. | -| `SERVERLESS_TENANT_ID` | The ID of the serverless tenant that the cluster belongs to. | -| `SERVERLESS_PROJECT_ID` | The ID of the serverless project that the cluster belongs to. | -| `SERVERLESS_CLUSTER_ID` | The ID of the serverless cluster that the audit record belongs to. | +| `SERVERLESS_TENANT_ID` | The ID of the serverless tenant that the {{{ .essential }}} instance belongs to. | +| `SERVERLESS_PROJECT_ID` | The ID of the serverless project that the {{{ .essential }}} instance belongs to. | +| `SERVERLESS_CLUSTER_ID` | The ID of the serverless {{{ .essential }}} instance that the audit record belongs to. | | `REASON` | The error message of the audit record. Only recorded when an error occurs during the operation.| ### SQL statement information diff --git a/tidb-cloud/explore-data-with-chat2query.md b/tidb-cloud/explore-data-with-chat2query.md index 883496c645846..519526e9acf7f 100644 --- a/tidb-cloud/explore-data-with-chat2query.md +++ b/tidb-cloud/explore-data-with-chat2query.md @@ -21,17 +21,17 @@ The recommended use cases of SQL Editor are as follows: - SQL queries generated by the AI might not be 100% accurate, and you might need to refine them. - SQL Editor is only supported for TiDB clusters that are v6.5.0 or later and hosted on AWS. -- SQL Editor is available only for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) clusters hosted on AWS. To use SQL Editor and Chat2Query on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md). +- SQL Editor is available only for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) instances hosted on AWS. To use SQL Editor and Chat2Query on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md). ## Access SQL Editor -1. Go to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Go to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters. -2. Click your cluster name, and then click **SQL Editor** in the left navigation pane. +2. Click the name of your {{{ .starter }}} instance or TiDB Cloud Dedicated cluster, and then click **SQL Editor** in the left navigation pane. > **Note:** > diff --git a/tidb-cloud/get-started-with-cli.md b/tidb-cloud/get-started-with-cli.md index 6e79c55b29e48..d9a4a1b3a5be7 100644 --- a/tidb-cloud/get-started-with-cli.md +++ b/tidb-cloud/get-started-with-cli.md @@ -87,11 +87,11 @@ Install the MySQL command-line client if you do not have it. You can refer to th ## Quick start -[{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) is the best way to get started with TiDB Cloud. In this section, you will learn how to create a {{{ .starter }}} cluster with TiDB Cloud CLI. +[{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) is the best way to get started with TiDB Cloud. In this section, you will learn how to create a {{{ .starter }}} instance with TiDB Cloud CLI. ### Create a user profile or log into TiDB Cloud -Before creating a cluster with TiDB Cloud CLI, you need to either create a user profile or log into TiDB Cloud. +Before creating a {{{ .starter }}} instance with TiDB Cloud CLI, you need to either create a user profile or log into TiDB Cloud. - Create a user profile with your [TiDB Cloud API key](https://docs.pingcap.com/tidbcloud/api/v1beta#section/Authentication/API-Key-Management): @@ -115,9 +115,9 @@ Before creating a cluster with TiDB Cloud CLI, you need to either create a user > > In the preceding two methods, the TiDB Cloud API key takes precedence over the OAuth token. If both are available, the API key will be used. -### Create a {{{ .starter }}} cluster +### Create a {{{ .starter }}} instance -To create a {{{ .starter }}} cluster, enter the following command, and then follow the CLI prompts to provide the required information: +To create a {{{ .starter }}} instance, enter the following command, and then follow the CLI prompts to provide the required information: ```shell ticloud serverless create diff --git a/tidb-cloud/import-csv-files-serverless.md b/tidb-cloud/import-csv-files-serverless.md index 80df511c07642..063463d85c246 100644 --- a/tidb-cloud/import-csv-files-serverless.md +++ b/tidb-cloud/import-csv-files-serverless.md @@ -76,15 +76,15 @@ Because CSV files do not contain schema information, before importing data from To allow TiDB Cloud to access the CSV files in the Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service bucket, do one of the following: -- If your CSV files are located in Amazon S3, [configure Amazon S3 access](/tidb-cloud/configure-external-storage-access.md#configure-amazon-s3-access) for your cluster. +- If your CSV files are located in Amazon S3, [configure Amazon S3 access](/tidb-cloud/configure-external-storage-access.md#configure-amazon-s3-access) for your {{{ .starter }}} or Essential instance. You can use either an AWS access key or a Role ARN to access your bucket. Once finished, make a note of the access key (including the access key ID and secret access key) or the Role ARN value as you will need it in [Step 4](#step-4-import-csv-files). -- If your CSV files are located in GCS, [configure GCS access](/tidb-cloud/configure-external-storage-access.md#configure-gcs-access) for your cluster. +- If your CSV files are located in GCS, [configure GCS access](/tidb-cloud/configure-external-storage-access.md#configure-gcs-access) for your {{{ .starter }}} or Essential instance. -- If your CSV files are located in Azure Blob Storage, [configure Azure Blob Storage access](/tidb-cloud/configure-external-storage-access.md#configure-azure-blob-storage-access) for your cluster. +- If your CSV files are located in Azure Blob Storage, [configure Azure Blob Storage access](/tidb-cloud/configure-external-storage-access.md#configure-azure-blob-storage-access) for your {{{ .starter }}} or Essential instance. -- If your CSV files are located in Alibaba Cloud Object Storage Service (OSS), [configure Alibaba Cloud Object Storage Service (OSS) access](/tidb-cloud/configure-external-storage-access.md#configure-alibaba-cloud-object-storage-service-oss-access) for your cluster. +- If your CSV files are located in Alibaba Cloud Object Storage Service (OSS), [configure Alibaba Cloud Object Storage Service (OSS) access](/tidb-cloud/configure-external-storage-access.md#configure-alibaba-cloud-object-storage-service-oss-access) for your {{{ .starter }}} or Essential instance. ## Step 4. Import CSV files @@ -93,9 +93,9 @@ To import the CSV files to {{{ .starter }}} or {{{ .essential }}}, take the foll
-1. Open the **Import** page for your target cluster. +1. Open the **Import** page for your target {{{ .starter }}} or Essential instance. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -146,9 +146,9 @@ To import the CSV files to {{{ .starter }}} or {{{ .essential }}}, take the foll
-1. Open the **Import** page for your target cluster. +1. Open the **Import** page for your target {{{ .starter }}} or Essential instance. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -197,9 +197,9 @@ To import the CSV files to {{{ .starter }}} or {{{ .essential }}}, take the foll
-1. Open the **Import** page for your target cluster. +1. Open the **Import** page for your target {{{ .starter }}} or Essential instance. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -248,9 +248,9 @@ To import the CSV files to {{{ .starter }}} or {{{ .essential }}}, take the foll
-1. Open the **Import** page for your target cluster. +1. Open the **Import** page for your target {{{ .starter }}} or Essential instance. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > diff --git a/tidb-cloud/import-csv-files.md b/tidb-cloud/import-csv-files.md index 3a1d35c2bf47c..4f9855533b72b 100644 --- a/tidb-cloud/import-csv-files.md +++ b/tidb-cloud/import-csv-files.md @@ -97,7 +97,7 @@ To import the CSV files to TiDB Cloud, take the following steps: 1. Open the **Import** page for your target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -141,7 +141,7 @@ To import the CSV files to TiDB Cloud, take the following steps: 1. Open the **Import** page for your target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -182,7 +182,7 @@ To import the CSV files to TiDB Cloud, take the following steps: 1. Open the **Import** page for your target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > diff --git a/tidb-cloud/import-parquet-files-serverless.md b/tidb-cloud/import-parquet-files-serverless.md index 3068b4e50e9bc..4bbe944b38db9 100644 --- a/tidb-cloud/import-parquet-files-serverless.md +++ b/tidb-cloud/import-parquet-files-serverless.md @@ -81,15 +81,15 @@ Because Parquet files do not contain schema information, before importing data f To allow TiDB Cloud to access the Parquet files in the Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service bucket, do one of the following: -- If your Parquet files are located in Amazon S3, [configure Amazon S3 access](/tidb-cloud/configure-external-storage-access.md#configure-amazon-s3-access) for your cluster. +- If your Parquet files are located in Amazon S3, [configure Amazon S3 access](/tidb-cloud/configure-external-storage-access.md#configure-amazon-s3-access) for your {{{ .starter }}} or Essential instance. You can use either an AWS access key or a Role ARN to access your bucket. Once finished, make a note of the access key (including the access key ID and secret access key) or the Role ARN value as you will need it in [Step 4](#step-4-import-parquet-files). -- If your Parquet files are located in GCS, [configure GCS access](/tidb-cloud/configure-external-storage-access.md#configure-gcs-access) for your cluster. +- If your Parquet files are located in GCS, [configure GCS access](/tidb-cloud/configure-external-storage-access.md#configure-gcs-access) for your {{{ .starter }}} or Essential instance. -- If your Parquet files are located in Azure Blob Storage, [configure Azure Blob Storage access](/tidb-cloud/configure-external-storage-access.md#configure-azure-blob-storage-access) for your cluster. +- If your Parquet files are located in Azure Blob Storage, [configure Azure Blob Storage access](/tidb-cloud/configure-external-storage-access.md#configure-azure-blob-storage-access) for your {{{ .starter }}} or Essential instance. -- If your Parquet files are located in Alibaba Cloud Object Storage Service (OSS), [configure Alibaba Cloud Object Storage Service (OSS) access](/tidb-cloud/configure-external-storage-access.md#configure-alibaba-cloud-object-storage-service-oss-access) for your cluster. +- If your Parquet files are located in Alibaba Cloud Object Storage Service (OSS), [configure Alibaba Cloud Object Storage Service (OSS) access](/tidb-cloud/configure-external-storage-access.md#configure-alibaba-cloud-object-storage-service-oss-access) for your {{{ .starter }}} or Essential instance. ## Step 4. Import Parquet files @@ -98,9 +98,9 @@ To import the Parquet files to {{{ .starter }}} or {{{ .essential }}}, take the
-1. Open the **Import** page for your target cluster. +1. Open the **Import** page for your target {{{ .starter }}} or Essential instance. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -151,9 +151,9 @@ To import the Parquet files to {{{ .starter }}} or {{{ .essential }}}, take the
-1. Open the **Import** page for your target cluster. +1. Open the **Import** page for your target {{{ .starter }}} or Essential instance. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -202,9 +202,9 @@ To import the Parquet files to {{{ .starter }}} or {{{ .essential }}}, take the
-1. Open the **Import** page for your target cluster. +1. Open the **Import** page for your target {{{ .starter }}} or Essential instance. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -253,9 +253,9 @@ To import the Parquet files to {{{ .starter }}} or {{{ .essential }}}, take the
-1. Open the **Import** page for your target cluster. +1. Open the **Import** page for your target {{{ .starter }}} or Essential instance. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > diff --git a/tidb-cloud/import-parquet-files.md b/tidb-cloud/import-parquet-files.md index 0a64ad746f9e3..266a2c0d1d873 100644 --- a/tidb-cloud/import-parquet-files.md +++ b/tidb-cloud/import-parquet-files.md @@ -103,7 +103,7 @@ To import the Parquet files to TiDB Cloud, take the following steps: 1. Open the **Import** page for your target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -146,7 +146,7 @@ To import the Parquet files to TiDB Cloud, take the following steps: 1. Open the **Import** page for your target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -186,7 +186,7 @@ To import the Parquet files to TiDB Cloud, take the following steps: 1. Open the **Import** page for your target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > diff --git a/tidb-cloud/import-sample-data-serverless.md b/tidb-cloud/import-sample-data-serverless.md index fdfc108621791..04d6192637ffd 100644 --- a/tidb-cloud/import-sample-data-serverless.md +++ b/tidb-cloud/import-sample-data-serverless.md @@ -5,15 +5,15 @@ summary: Learn how to import sample data into {{{ .starter }}} or {{{ .essential # Import Sample Data (SQL Files) into {{{ .starter }}} or Essential from Cloud Storage -This document describes how to import the sample data (SQL files) into {{{ .starter }}} or {{{ .essential }}} via the UI. The sample data used is the system data from Capital Bikeshare, released under the Capital Bikeshare Data License Agreement. Before importing the sample data, you need to have one TiDB cluster. +This document describes how to import the sample data (SQL files) into {{{ .starter }}} or {{{ .essential }}} via the UI. The sample data used is the system data from Capital Bikeshare, released under the Capital Bikeshare Data License Agreement. Before importing the sample data, you need to have one {{{ .starter }}} or Essential instance. > **Note:** > > The sample data used in this document is from Amazon S3. -1. Open the **Import** page for your target cluster. +1. Open the **Import** page for your target {{{ .starter }}} or Essential instance. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -41,7 +41,7 @@ This document describes how to import the sample data (SQL files) into {{{ .star 8. When the import progress shows **Completed**, check the imported tables. -After connecting to the cluster, you can run some queries in your terminal to check the result, for example: +After connecting to the {{{ .starter }}} or Essential instance, you can run some queries in your terminal to check the result, for example: 1. Get the trip records starting at "12th & U St NW": diff --git a/tidb-cloud/import-sample-data.md b/tidb-cloud/import-sample-data.md index d19a24b1774cc..6fe2355dac6b6 100644 --- a/tidb-cloud/import-sample-data.md +++ b/tidb-cloud/import-sample-data.md @@ -12,7 +12,7 @@ This document describes how to import the sample data (SQL files) into TiDB Clou 1. Open the **Import** page for your target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -38,7 +38,7 @@ This document describes how to import the sample data (SQL files) into TiDB Clou 1. Open the **Import** page for your target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -65,7 +65,7 @@ This document describes how to import the sample data (SQL files) into TiDB Clou 1. Open the **Import** page for your target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > diff --git a/tidb-cloud/import-with-mysql-cli-serverless.md b/tidb-cloud/import-with-mysql-cli-serverless.md index 9d25b8416f6c3..33aba88ea7964 100644 --- a/tidb-cloud/import-with-mysql-cli-serverless.md +++ b/tidb-cloud/import-with-mysql-cli-serverless.md @@ -11,14 +11,14 @@ This document describes how to import data into {{{ .starter }}} or {{{ .essenti Before you can import data via MySQL CLI to {{{ .starter }}} or {{{ .essential }}}, you need the following prerequisites: -- You have access to your {{{ .starter }}} or {{{ .essential }}} cluster. If you do not have, create one following the instructions in [Build a TiDB Cloud Cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- You have access to your {{{ .starter }}} or {{{ .essential }}} instance. If you do not have, create one following the instructions in [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md). - Install MySQL CLI on your local computer. -## Step 1. Connect to your {{{ .starter }}} or {{{ .essential }}} cluster +## Step 1. Connect to your {{{ .starter }}} or Essential instance -Connect to your TiDB cluster. +Connect to your {{{ .starter }}} or Essential instance. -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. diff --git a/tidb-cloud/import-with-mysql-cli.md b/tidb-cloud/import-with-mysql-cli.md index 22e3e800069e8..e3ca9b2158b1f 100644 --- a/tidb-cloud/import-with-mysql-cli.md +++ b/tidb-cloud/import-with-mysql-cli.md @@ -18,7 +18,7 @@ Before you can import data via MySQL CLI to TiDB Cloud Dedicated, you need the f Connect to your TiDB cluster. -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. diff --git a/tidb-cloud/integrate-tidbcloud-with-airbyte.md b/tidb-cloud/integrate-tidbcloud-with-airbyte.md index 21bc0e5e8c20e..0f6167ee08708 100644 --- a/tidb-cloud/integrate-tidbcloud-with-airbyte.md +++ b/tidb-cloud/integrate-tidbcloud-with-airbyte.md @@ -54,7 +54,7 @@ Conveniently, the steps are the same for setting TiDB as the source and the dest - Username: The username to access the database - Password: The password of the username - You can get the parameter values from the connection dialog of your cluster. To open the dialog, go to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page, and then click **Connect** in the upper-right corner. + You can get the parameter values from the connection dialog of your cluster. To open the dialog, go to the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target resource to go to its overview page, and then click **Connect** in the upper-right corner. 3. Enable **SSL Connection**, and set TLS protocols to **TLSv1.2** or **TLSv1.3** in **JDBC URL Params**. diff --git a/tidb-cloud/integrate-tidbcloud-with-aws-lambda.md b/tidb-cloud/integrate-tidbcloud-with-aws-lambda.md index d122b7a470b37..5ac7d384356a1 100644 --- a/tidb-cloud/integrate-tidbcloud-with-aws-lambda.md +++ b/tidb-cloud/integrate-tidbcloud-with-aws-lambda.md @@ -9,14 +9,14 @@ This document provides a step-by-step guide on how to use [AWS CloudFormation](h > **Note:** > -> In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. +> In addition to {{{ .starter }}} instances, the steps in this document also work with {{{ .essential }}} instances. ## Solution overview In this guide, you will create a fully functional online bookshop with the following components: -- AWS Lambda Function: handles requests and queries data from a {{{ .starter }}} cluster using Sequelize ORM and Fastify API framework. -- AWS Secrets Manager SDK: retrieves and manages connection configurations for the {{{ .starter }}} cluster. +- AWS Lambda Function: handles requests and queries data from a {{{ .starter }}} instance using Sequelize ORM and Fastify API framework. +- AWS Secrets Manager SDK: retrieves and manages connection configurations for the {{{ .starter }}} instance. - AWS API Gateway: handles HTTP request routes. - {{{ .starter }}}: a cloud-native distributed SQL database. @@ -37,7 +37,7 @@ Before getting started, ensure that you have the following: - [Lambda services](https://aws.amazon.com/lambda/) - [S3](https://aws.amazon.com/s3/) - [IAM Roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) -- A [TiDB Cloud](https://tidbcloud.com) account and a {{{ .starter }}} cluster. Get the connection information for your {{{ .starter }}} cluster: +- A [TiDB Cloud](https://tidbcloud.com) account and a {{{ .starter }}} instance. Get the connection information for your {{{ .starter }}} instance: ![TiDB Cloud connection information](/media/develop/aws-lambda-tidbcloud-connection-info.png) diff --git a/tidb-cloud/integrate-tidbcloud-with-cloudflare.md b/tidb-cloud/integrate-tidbcloud-with-cloudflare.md index 61e0f65650f9d..5daaa0a04dc95 100644 --- a/tidb-cloud/integrate-tidbcloud-with-cloudflare.md +++ b/tidb-cloud/integrate-tidbcloud-with-cloudflare.md @@ -20,7 +20,7 @@ This document shows how to connect to Cloudflare Workers with TiDB Cloud serverl Before you try the steps in this article, you need to prepare the following things: - A [TiDB Cloud account](https://tidbcloud.com/signup). -- A {{{ .starter }}} or {{{ .essential }}} cluster. If you do not have one, see [Create a {{{ .starter }}} or Essential Cluster](/tidb-cloud/create-tidb-cluster-serverless.md). +- A {{{ .starter }}} or {{{ .essential }}} instance. If you do not have one, see [Create a {{{ .starter }}} or Essential Instance](/tidb-cloud/create-tidb-cluster-serverless.md). - A [Cloudflare Workers account](https://dash.cloudflare.com/login). - [npm](https://docs.npmjs.com/about-npm) is installed. diff --git a/tidb-cloud/integrate-tidbcloud-with-dbt.md b/tidb-cloud/integrate-tidbcloud-with-dbt.md index 483e39970f9ea..4ec1248af7443 100644 --- a/tidb-cloud/integrate-tidbcloud-with-dbt.md +++ b/tidb-cloud/integrate-tidbcloud-with-dbt.md @@ -90,7 +90,7 @@ To configure the project, take the following steps: password: "your_password" # The password to use for authenticating to the TiDB Cloud clusters ``` - You can get the values of `server`, `port`, and `username` from the connection dialog of your cluster. To open this dialog, go to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page, and then click **Connect** in the upper-right corner. + You can get the values of `server`, `port`, and `username` from the connection dialog of your cluster. To open this dialog, go to the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target resource to go to its overview page, and then click **Connect** in the upper-right corner. 2. Complete the project configuration. diff --git a/tidb-cloud/integrate-tidbcloud-with-n8n.md b/tidb-cloud/integrate-tidbcloud-with-n8n.md index c852784ed8c22..6e88b479ba488 100644 --- a/tidb-cloud/integrate-tidbcloud-with-n8n.md +++ b/tidb-cloud/integrate-tidbcloud-with-n8n.md @@ -7,11 +7,11 @@ summary: Learn the use of TiDB Cloud node in n8n. [n8n](https://n8n.io/) is an extendable workflow automation tool. With a [fair-code](https://faircode.io/) distribution model, n8n will always have visible source code, be available to self-host, and allow you to add your custom functions, logic, and apps. -This document introduces how to build an auto-workflow: create a {{{ .starter }}} cluster, gather Hacker News RSS, store it to TiDB and send a briefing email. +This document introduces how to build an auto-workflow: create a {{{ .starter }}} instance, gather Hacker News RSS, store it to TiDB and send a briefing email. > **Note:** > -> In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. +> In addition to {{{ .starter }}} instances, the steps in this document also work with {{{ .essential }}} instances. ## Prerequisites: Get TiDB Cloud API key @@ -80,9 +80,9 @@ The final workflow should look like the following image. ![img](/media/tidb-cloud/integration-n8n-workflow-rss.jpg) -### (Optional) Create a {{{ .starter }}} cluster +### (Optional) Create a {{{ .starter }}} instance -If you don't have a {{{ .starter }}} cluster, you can use this node to create one. Otherwise, feel free to skip this operation. +If you don't have a {{{ .starter }}} instance, you can use this node to create one. Otherwise, feel free to skip this operation. 1. Navigate to **Workflows** panel, and click **Add workflow**. 2. In new workflow workspace, click **+** in the top right corner and choose **All** field. @@ -97,7 +97,7 @@ If you don't have a {{{ .starter }}} cluster, you can use this node to create on > **Note:** > -> It takes several seconds to create a new {{{ .starter }}} cluster. +> It takes several seconds to create a new {{{ .starter }}} instance. ### Create a workflow @@ -207,7 +207,7 @@ This trigger will execute your workflow every morning at 8 AM. After building up the workflow, you can click **Execute Workflow** to test run it. -If the workflow runs as expected, you'll get Hacker News briefing emails. These news contents will be logged to your {{{ .starter }}} cluster, so you don't have to worry about losing them. +If the workflow runs as expected, you'll get Hacker News briefing emails. These news contents will be logged to your {{{ .starter }}} instance, so you don't have to worry about losing them. Now you can activate this workflow in the **Workflows** panel. This workflow will help you get the front-page articles on Hacker News every day. @@ -217,7 +217,7 @@ Now you can activate this workflow in the **Workflows** panel. This workflow wil TiDB Cloud node acts as a [regular node](https://docs.n8n.io/workflows/nodes/#regular-nodes) and only supports the following five operations: -- **Create Serverless Cluster**: creates a {{{ .starter }}} cluster. +- **Create Serverless Cluster**: creates a {{{ .starter }}} instance. - **Execute SQL**: executes an SQL statement in TiDB. - **Delete**: deletes rows in TiDB. - **Insert**: inserts rows in TiDB. diff --git a/tidb-cloud/integrate-tidbcloud-with-netlify.md b/tidb-cloud/integrate-tidbcloud-with-netlify.md index ebd8ccfc1b553..540b2a90880db 100644 --- a/tidb-cloud/integrate-tidbcloud-with-netlify.md +++ b/tidb-cloud/integrate-tidbcloud-with-netlify.md @@ -24,7 +24,7 @@ You are expected to have a Netlify account and CLI. If you do not have any, refe You are expected to have an account and a cluster in TiDB Cloud. If you do not have any, refer to the following to create one: -- [Create a {{{ .starter }}} or {{{ .essential }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) +- [Create a {{{ .starter }}} or {{{ .essential }}} instance](/tidb-cloud/create-tidb-cluster-serverless.md) - [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md) One TiDB Cloud cluster can connect to multiple Netlify sites. @@ -33,7 +33,7 @@ One TiDB Cloud cluster can connect to multiple Netlify sites. For TiDB Cloud Dedicated clusters, make sure that the traffic filter of the cluster allows all IP addresses (set to `0.0.0.0/0`) for connection. This is because Netlify deployments use dynamic IP addresses. -{{{ .starter }}} and {{{ .essential }}} clusters allow all IP addresses for connection by default, so you do not need to configure any traffic filter. +{{{ .starter }}} and {{{ .essential }}} instances allow all IP addresses for connection by default, so you do not need to configure any traffic filter. ## Step 1. Get the example project and the connection string @@ -52,7 +52,7 @@ To help you get started quickly, TiDB Cloud provides a fullstack example app in ### Get the TiDB Cloud connection string -For a {{{ .starter }}} or {{{ .essential }}} cluster, you can get the connection string either from [TiDB Cloud CLI](/tidb-cloud/cli-reference.md) or from [TiDB Cloud console](https://tidbcloud.com/). +For a {{{ .starter }}} or {{{ .essential }}} instance, you can get the connection string either from [TiDB Cloud CLI](/tidb-cloud/cli-reference.md) or from [TiDB Cloud console](https://tidbcloud.com/). For a TiDB Cloud Dedicated cluster, you can get the connection string only from the TiDB Cloud console. @@ -99,7 +99,7 @@ For a TiDB Cloud Dedicated cluster, you can get the connection string only from
-1. In the [TiDB Cloud console](https://tidbcloud.com/), go to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page, and then click **Connect** in the upper-right corner. In the displayed dialog, you can get the following connection parameters from the connection string. +1. In the [TiDB Cloud console](https://tidbcloud.com/), go to the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target resource to go to its overview page, and then click **Connect** in the upper-right corner. In the displayed dialog, you can get the following connection parameters from the connection string. - `${host}` - `${port}` diff --git a/tidb-cloud/integrate-tidbcloud-with-vercel.md b/tidb-cloud/integrate-tidbcloud-with-vercel.md index e9500016a5ef5..b1086e116dde6 100644 --- a/tidb-cloud/integrate-tidbcloud-with-vercel.md +++ b/tidb-cloud/integrate-tidbcloud-with-vercel.md @@ -38,11 +38,11 @@ One Vercel project can only connect to one TiDB Cloud cluster. To change the int You are expected to have an account and a cluster in TiDB Cloud. If you do not have any, refer to the following to create one: -- [Create a {{{ .starter }}} or {{{ .essential }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) +- [Create a {{{ .starter }}} or {{{ .essential }}} instance](/tidb-cloud/create-tidb-cluster-serverless.md) > **Note:** > - > The TiDB Cloud Vercel integration supports creating {{{ .starter }}} and {{{ .essential }}} clusters. You can also create one later during the integration process. + > The TiDB Cloud Vercel integration supports creating {{{ .starter }}} and {{{ .essential }}} instances. You can also create one later during the integration process. - [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md) @@ -71,7 +71,7 @@ To connect via the TiDB Cloud Vercel integration, go to the [TiDB Cloud integrat > **Note:** > -> This method is only available for {{{ .starter }}} and {{{ .essential }}} clusters. If you want to connect to a TiDB Cloud Dedicated cluster, use the [manual method](#connect-via-manually-setting-environment-variables). +> This method is only available for {{{ .starter }}} and {{{ .essential }}} instances. If you want to connect to a TiDB Cloud Dedicated cluster, use the [manual method](#connect-via-manually-setting-environment-variables). ### Integration workflow @@ -89,7 +89,7 @@ The detailed steps are as follows: 1. Select your target Vercel projects and click **Next**. 2. Select your target TiDB Cloud organization and project. 3. Select **Cluster** as your connection type. - 4. Select your target TiDB Cloud cluster. If the **Cluster** drop-down list is empty or you want to select a new {{{ .starter }}} or {{{ .essential }}} cluster, click **+ Create Cluster** in the list to create one. + 4. Select your target TiDB Cloud cluster. If the **Cluster** drop-down list is empty or you want to select a new {{{ .starter }}} or {{{ .essential }}} instance, click **+ Create Cluster** in the list to create one. 5. Select the database that you want to connect to. If the **Database** drop-down list is empty or you want to select a new Database, click **+ Create Database** in the list to create one. 6. Select the framework that your Vercel projects are using. If the target framework is not listed, select **General**. Different frameworks determine different environment variables. 7. Choose whether to enable **Branching** to create new branches for preview environments. @@ -211,7 +211,7 @@ After you push changes to the Git repository, Vercel will trigger a preview depl > **Note:** > -> For each organization in TiDB Cloud, you can create a maximum of five branches for {{{ .starter }}} clusters by default. To avoid exceeding the limit, you can delete the branches of your cluster that are no longer needed. For more information, see [Manage TiDB Cloud branches](/tidb-cloud/branch-manage.md). +> For each organization in TiDB Cloud, you can create a maximum of five branches for {{{ .starter }}} instances by default. To avoid exceeding the limit, you can delete the branches of your cluster that are no longer needed. For more information, see [Manage TiDB Cloud branches](/tidb-cloud/branch-manage.md). ## Connect via manually setting environment variables @@ -220,13 +220,13 @@ After you push changes to the Git repository, Vercel will trigger a preview depl 1. Get the connection information of your TiDB cluster. - You can get the connection information from the connection dialog of your cluster. To open the dialog, go to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page, and then click **Connect** in the upper-right corner. + You can get the connection information from the connection dialog of your cluster. To open the dialog, go to the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target resource to go to its overview page, and then click **Connect** in the upper-right corner. 2. Go to your Vercel dashboard > Vercel project > **Settings** > **Environment Variables**, and then [declare each environment variable value](https://vercel.com/docs/concepts/projects/environment-variables#declare-an-environment-variable) according to the connection information of your TiDB cluster. ![Vercel Environment Variables](/media/tidb-cloud/vercel/integration-vercel-environment-variables.png) -Here we use a Prisma application and a {{{ .starter }}} cluster as an example. The following is a datasource setting in the Prisma schema file for a {{{ .starter }}} cluster: +Here we use a Prisma application and a {{{ .starter }}} instance as an example. The following is a datasource setting in the Prisma schema file for a {{{ .starter }}} instance: ``` datasource db { diff --git a/tidb-cloud/integrate-tidbcloud-with-zapier.md b/tidb-cloud/integrate-tidbcloud-with-zapier.md index 14c1a48c52032..7b21094c94f3a 100644 --- a/tidb-cloud/integrate-tidbcloud-with-zapier.md +++ b/tidb-cloud/integrate-tidbcloud-with-zapier.md @@ -27,7 +27,7 @@ Before you start, you need: - A [Zapier account](https://zapier.com/app/login). - A [GitHub account](https://github.com/login). -- A [TiDB Cloud account](https://tidbcloud.com/signup) and a {{{ .starter }}} cluster on TiDB Cloud. For more details, see [TiDB Cloud Quick Start](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart#step-1-create-a-tidb-cluster). +- A [TiDB Cloud account](https://tidbcloud.com/signup) and a {{{ .starter }}} instance on TiDB Cloud. For more details, see [TiDB Cloud Quick Start](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart#step-1-create-a-tidb-cluster). ### Step 1: Get the template @@ -161,15 +161,15 @@ The following table lists the actions supported by TiDB Cloud App. Note that som | Action | Description | Resource | |---|---|---| | Find Cluster | Finds an existing {{{ .starter }}} or TiDB Cloud Dedicated cluster. | None | -| Create Cluster | Creates a new cluster. Only supports creating a {{{ .starter }}} cluster. | None | -| Find Database | Finds an existing database. | A {{{ .starter }}} cluster | -| Create Database | Creates a new database. | A {{{ .starter }}} cluster | -| Find Table | Finds an existing Table. | A {{{ .starter }}} cluster and a database | -| Create Table | Creates a new table. | A {{{ .starter }}} cluster and a database | -| Create Row | Creates a new row. | A {{{ .starter }}} cluster, a database, and a table | -| Update Row | Updates an existing row. | A {{{ .starter }}} cluster, a database, and a table | -| Find Row | Finds a row in a table via a lookup column. | A {{{ .starter }}} cluster, a database, and a table | -| Find Row (Custom Query) | Finds a row in a table via a custom query the you provide. | A {{{ .starter }}} cluster, a database, and a table | +| Create Cluster | Creates a new cluster. Only supports creating a {{{ .starter }}} instance. | None | +| Find Database | Finds an existing database. | A {{{ .starter }}} instance | +| Create Database | Creates a new database. | A {{{ .starter }}} instance | +| Find Table | Finds an existing Table. | A {{{ .starter }}} instance and a database | +| Create Table | Creates a new table. | A {{{ .starter }}} instance and a database | +| Create Row | Creates a new row. | A {{{ .starter }}} instance, a database, and a table | +| Update Row | Updates an existing row. | A {{{ .starter }}} instance, a database, and a table | +| Find Row | Finds a row in a table via a lookup column. | A {{{ .starter }}} instance, a database, and a table | +| Find Row (Custom Query) | Finds a row in a table via a custom query the you provide. | A {{{ .starter }}} instance, a database, and a table | ## TiDB Cloud App templates diff --git a/tidb-cloud/manage-serverless-spend-limit.md b/tidb-cloud/manage-serverless-spend-limit.md index c32478969cf48..6acce773e6f19 100644 --- a/tidb-cloud/manage-serverless-spend-limit.md +++ b/tidb-cloud/manage-serverless-spend-limit.md @@ -1,39 +1,39 @@ --- -title: Manage Spending Limit for {{{ .starter }}} Clusters -summary: Learn how to manage spending limit for your {{{ .starter }}} clusters. +title: Manage Spending Limit for {{{ .starter }}} Instances +summary: Learn how to manage spending limit for your {{{ .starter }}} instances. --- -# Manage Spending Limit for {{{ .starter }}} Clusters +# Manage Spending Limit for {{{ .starter }}} Instances > **Note:** > -> The spending limit is only applicable to {{{ .starter }}} clusters. +> The spending limit is only applicable to {{{ .starter }}} instances. -Spending limit refers to the maximum amount of money that you are willing to spend on a particular workload in a month. It is a cost-control mechanism that allows you to set a budget for your {{{ .starter }}} clusters. +Spending limit refers to the maximum amount of money that you are willing to spend on a particular workload in a month. It is a cost-control mechanism that allows you to set a budget for your {{{ .starter }}} instances. -For each organization in TiDB Cloud, you can create a maximum of five [free {{{ .starter }}} clusters](/tidb-cloud/select-cluster-tier.md#starter) by default. To create more {{{ .starter }}} clusters, you need to add a credit card and set a monthly spending limit for the usage. But if you delete some of your previous clusters before creating more, the new cluster can still be created without a credit card. +For each organization in TiDB Cloud, you can create a maximum of five [free {{{ .starter }}} instances](/tidb-cloud/select-cluster-tier.md#starter) by default. To create more {{{ .starter }}} instances, you need to add a credit card and set a monthly spending limit for the usage. But if you delete some of your previous {{{ .starter }}} instances before creating more, the new {{{ .starter }}} instance can still be created without a credit card. ## Usage quota -For the first five {{{ .starter }}} clusters in your organization, whether they are free or scalable, TiDB Cloud provides a free usage quota for each of them as follows: +For the first five {{{ .starter }}} instances in your organization, whether they are free or scalable, TiDB Cloud provides a free usage quota for each of them as follows: - Row-based storage: 5 GiB - Columnar storage: 5 GiB - [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit-ru): 50 million RUs per month -Once a cluster reaches its usage quota, it immediately denies any new connection attempts until you [increase the quota](#update-spending-limit) or the usage is reset upon the start of a new month. Existing connections established before reaching the quota will remain active but will experience throttling. For example, when the row-based storage of a cluster exceeds 5 GiB for a free cluster, the cluster automatically restricts any new connection attempts. +Once a {{{ .starter }}} instance reaches its usage quota, it immediately denies any new connection attempts until you [increase the quota](#update-spending-limit) or the usage is reset upon the start of a new month. Existing connections established before reaching the quota will remain active but will experience throttling. For example, when the row-based storage of a {{{ .starter }}} instance exceeds 5 GiB for a free {{{ .starter }}} instance, the {{{ .starter }}} instance automatically restricts any new connection attempts. To learn more about the RU consumption of different resources (including read, write, SQL CPU, and network egress), the pricing details, and the throttled information, see [{{{ .starter }}} Pricing Details](https://www.pingcap.com/tidb-cloud-starter-pricing-details/). -If you want to create a {{{ .starter }}} cluster with an additional quota, you can edit the spending limit on the cluster creation page. For more information, see [Create a {{{ .starter }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md). +If you want to create a {{{ .starter }}} instance with an additional quota, you can edit the spending limit on the {{{ .starter }}} instance creation page. For more information, see [Create a {{{ .starter }}} instance](/tidb-cloud/create-tidb-cluster-serverless.md). ## Update spending limit -For a {{{ .starter }}} free cluster, you can increase the usage quota by setting a monthly spending limit when creating the cluster. For an existing cluster, you can adjust the monthly spending limit directly. +For a free {{{ .starter }}} instance, you can increase the usage quota by setting a monthly spending limit when creating the {{{ .starter }}} instance. For an existing {{{ .starter }}} instance, you can adjust the monthly spending limit directly. -To update the spending limit for a {{{ .starter }}} cluster, perform the following steps: +To update the spending limit for a {{{ .starter }}} instance, perform the following steps: -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} instance to go to its overview page. > **Tip:** > diff --git a/tidb-cloud/manage-user-access.md b/tidb-cloud/manage-user-access.md index 3ca4d6026e33c..44ad5fa740a90 100644 --- a/tidb-cloud/manage-user-access.md +++ b/tidb-cloud/manage-user-access.md @@ -103,9 +103,9 @@ At the project level, TiDB Cloud defines three roles, in which `Project Owner` c | Manage project settings | ✅ | ❌ | ❌ | ❌ | | Invite users to or remove users from a project, and edit project roles of users. | ✅ | ❌ | ❌ | ❌ | | Manage [database audit logging](/tidb-cloud/tidb-cloud-auditing.md) of the project. | ✅ | ❌ | ❌ | ❌ | -| Manage [spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for all {{{ .starter }}} clusters in the project. | ✅ | ❌ | ❌ | ❌ | +| Manage [spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for all {{{ .starter }}} instances in the project. | ✅ | ❌ | ❌ | ❌ | | Manage cluster operations in the project, such as cluster creation, modification, and deletion. | ✅ | ❌ | ❌ | ❌ | -| Manage branches for {{{ .starter }}} and {{{ .essential }}} clusters in the project, such as branch creation, connection, and deletion. | ✅ | ❌ | ❌ | ❌ | +| Manage branches for {{{ .starter }}} and {{{ .essential }}} instances in the project, such as branch creation, connection, and deletion. | ✅ | ❌ | ❌ | ❌ | | Manage cluster data such as data import, data backup and restore, and data migration. | ✅ | ✅ | ❌ | ❌ | | Manage [Data Service](/tidb-cloud/data-service-overview.md) for data read-only operations such as using or creating endpoints to read data. | ✅ | ✅ | ✅ | ❌ | | Manage [Data Service](/tidb-cloud/data-service-overview.md) for data read and write operations. | ✅ | ✅ | ❌ | ❌ | diff --git a/tidb-cloud/migrate-from-mysql-using-aws-dms.md b/tidb-cloud/migrate-from-mysql-using-aws-dms.md index 8d2a859210e7a..bcf740e3e03b2 100644 --- a/tidb-cloud/migrate-from-mysql-using-aws-dms.md +++ b/tidb-cloud/migrate-from-mysql-using-aws-dms.md @@ -97,7 +97,7 @@ Before you start the migration, make sure you have read the following: ![Copy the public and private network IP addresses](/media/tidb-cloud/aws-dms-tidb-cloud/aws-dms-to-tidb-cloud-copy-ip.png) -2. In the TiDB Cloud console, go to the [**Clusters**](https://tidbcloud.com/project/clusters) page, click the name of your target cluster, and then click **Connect** in the upper-right corner to get the TiDB Cloud database connection information. +2. In the TiDB Cloud console, go to the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target resource, and then click **Connect** in the upper-right corner to get the TiDB Cloud database connection information. 3. Under **Step 1: Create traffic filter** in the dialog, click **Edit**, enter the public and private network IP addresses that you copied from the AWS DMS console, and then click **Update Filter**. It is recommended to add the public IP address and private IP address of the AWS DMS replication instance to the TiDB cluster traffic filter at the same time. Otherwise, AWS DMS might not be able to connect to the TiDB cluster in some scenarios. diff --git a/tidb-cloud/migrate-from-mysql-using-data-migration.md b/tidb-cloud/migrate-from-mysql-using-data-migration.md index d708402cb6502..a43a86cff00e4 100644 --- a/tidb-cloud/migrate-from-mysql-using-data-migration.md +++ b/tidb-cloud/migrate-from-mysql-using-data-migration.md @@ -43,7 +43,7 @@ You can create up to 200 migration jobs on {{{ .dedicated }}} clusters for each -You can create up to 100 migration jobs on {{{ .essential }}} clusters for each organization. To create more migration jobs, you need to [file a support ticket](/tidb-cloud/tidb-cloud-support.md). +You can create up to 100 migration jobs on {{{ .essential }}} instances for each organization. To create more migration jobs, you need to [file a support ticket](/tidb-cloud/tidb-cloud-support.md). @@ -471,7 +471,7 @@ GRANT CREATE, SELECT, INSERT, UPDATE, DELETE, ALTER, DROP, INDEX ON *.* TO 'dm_t ## Step 1: Go to the Data Migration page -1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -725,7 +725,7 @@ When scaling a migration job specification, note the following: ### Scaling procedure -1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. 2. Click the name of your target cluster to go to its overview page, and then click **Data** > **Data Migration** in the left navigation pane. diff --git a/tidb-cloud/migrate-from-op-tidb.md b/tidb-cloud/migrate-from-op-tidb.md index d5452af1f15dd..899d8efb97fa0 100644 --- a/tidb-cloud/migrate-from-op-tidb.md +++ b/tidb-cloud/migrate-from-op-tidb.md @@ -204,7 +204,7 @@ After you export data from the TiDB Self-Managed cluster to Amazon S3, you need 1. In the [TiDB Cloud console](https://tidbcloud.com/), get the Account ID and External ID of your target cluster according to the following documentation: - For TiDB Cloud Dedicated clusters, see [Configure Amazon S3 access using a Role ARN](/tidb-cloud/dedicated-external-storage.md#configure-amazon-s3-access-using-a-role-arn). - - For {{{ .starter }}} or {{{ .essential }}} clusters, see [Configure Amazon S3 access using a Role ARN](/tidb-cloud/configure-external-storage-access.md#configure-amazon-s3-access-using-a-role-arn). + - For {{{ .starter }}} or {{{ .essential }}} instances, see [Configure Amazon S3 access using a Role ARN](/tidb-cloud/configure-external-storage-access.md#configure-amazon-s3-access-using-a-role-arn). 2. Configure access permissions for Amazon S3. Usually you need the following read-only permissions: @@ -271,7 +271,7 @@ After you export data from the TiDB Self-Managed cluster to Amazon S3, you need 6. Import data to TiDB Cloud. - For TiDB Cloud Dedicated clusters, see [Import CSV Files from Cloud Storage into TiDB Cloud Dedicated](/tidb-cloud/import-csv-files.md). - - For {{{ .starter }}} or {{{ .essential }}} clusters, see [Import CSV Files from Cloud Storage into {{{ .starter }}} or Essential](/tidb-cloud/import-csv-files-serverless.md). + - For {{{ .starter }}} or {{{ .essential }}} instances, see [Import CSV Files from Cloud Storage into {{{ .starter }}} or Essential](/tidb-cloud/import-csv-files-serverless.md). ## Replicate incremental data @@ -283,14 +283,14 @@ To replicate incremental data, do the following: 2. Grant TiCDC to connect to TiDB Cloud. - 1. In the [TiDB Cloud console](https://tidbcloud.com/project/clusters), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. + 1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target resource to go to its overview page. 2. In the left navigation pane, click **Settings** > **Networking**. 3. On the **Networking** page, click **Add IP Address**. 4. In the displayed dialog, select **Use IP addresses**, click **+**, fill in the public IP address of the TiCDC component in the **IP Address** field, and then click **Confirm**. Now TiCDC can access TiDB Cloud. For more information, see [Configure an IP Access List](/tidb-cloud/configure-ip-access-list.md). 3. Get the connection information of the downstream TiDB Cloud cluster. - 1. In the [TiDB Cloud console](https://tidbcloud.com/project/clusters), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. + 1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target resource to go to its overview page. 2. Click **Connect** in the upper-right corner. 3. In the connection dialog, select **Public** from the **Connection Type** drop-down list and select **General** from the **Connect With** drop-down list. 4. From the connection information, you can get the host IP address and port of the cluster. For more information, see [Connect via public connection](/tidb-cloud/connect-via-standard-connection.md). diff --git a/tidb-cloud/migrate-from-oracle-using-aws-dms.md b/tidb-cloud/migrate-from-oracle-using-aws-dms.md index 6339fee66fe04..b5b1af6580f9a 100644 --- a/tidb-cloud/migrate-from-oracle-using-aws-dms.md +++ b/tidb-cloud/migrate-from-oracle-using-aws-dms.md @@ -9,7 +9,7 @@ This document describes a step-by-step example of how to migrate data from Amazo > **Tip:** > -> In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. +> In addition to {{{ .starter }}} instances, the steps in this document also work with {{{ .essential }}} instances. If you are interested in learning more about TiDB Cloud and AWS DMS, see the following: @@ -73,13 +73,13 @@ After you finish executing the SQL script, check the data in Oracle. The followi ![Oracle RDS Data](/media/tidb-cloud/aws-dms-from-oracle-to-tidb-3.png) -## Step 4. Create a {{{ .starter }}} cluster +## Step 4. Create a {{{ .starter }}} instance 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/project/clusters). -2. [Create a {{{ .starter }}} cluster](/tidb-cloud/tidb-cloud-quickstart.md). +2. [Create a {{{ .starter }}} instance](/tidb-cloud/tidb-cloud-quickstart.md). -3. In the [**Clusters**](https://tidbcloud.com/project/clusters) page, click the target cluster name to go to its overview page. +3. In the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} instance to go to its overview page. 4. In the upper-right corner, click **Connect**. @@ -143,7 +143,7 @@ For more information, see [Migrating your source schema to your target database ## Step 9. Check data in the downstream TiDB cluster -Connect to the [{{{ .starter }}} cluster](https://tidbcloud.com/clusters/create-cluster) and check the `admin.github_event` table data. As shown in the following screenshot, DMS successfully migrated table `github_events` and 10000 rows of data. +Connect to the [{{{ .starter }}} instance](https://tidbcloud.com/clusters/create-cluster) and check the `admin.github_event` table data. As shown in the following screenshot, DMS successfully migrated table `github_events` and 10000 rows of data. ![Check Data In TiDB](/media/tidb-cloud/aws-dms-from-oracle-to-tidb-14.png) diff --git a/tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration.md b/tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration.md index 50e8d07d0cfd8..07aec19f92698 100644 --- a/tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration.md +++ b/tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration.md @@ -142,7 +142,7 @@ To enable the GTID mode for a self-hosted MySQL instance, follow these steps: ## Step 1: Go to the Data Migration page -1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > diff --git a/tidb-cloud/migrate-prometheus-metrics-integrations.md b/tidb-cloud/migrate-prometheus-metrics-integrations.md index 70e3f6d2ad1b6..682d93c243cf5 100644 --- a/tidb-cloud/migrate-prometheus-metrics-integrations.md +++ b/tidb-cloud/migrate-prometheus-metrics-integrations.md @@ -29,7 +29,7 @@ Do the following to migrate the Prometheus integration. Repeat the following steps for each [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) cluster in the project. -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the left navigation panel, click **Settings** > **Integrations**. diff --git a/tidb-cloud/migrate-sql-shards.md b/tidb-cloud/migrate-sql-shards.md index 5eec10e3e00f7..abe4f6b785f07 100644 --- a/tidb-cloud/migrate-sql-shards.md +++ b/tidb-cloud/migrate-sql-shards.md @@ -177,7 +177,7 @@ After configuring the Amazon S3 access, you can perform the data import task in 1. Open the **Import** page for your target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > diff --git a/tidb-cloud/monitor-built-in-alerting.md b/tidb-cloud/monitor-built-in-alerting.md index f5af9bdfabe3b..2b7f4c5a51ba3 100644 --- a/tidb-cloud/monitor-built-in-alerting.md +++ b/tidb-cloud/monitor-built-in-alerting.md @@ -17,13 +17,13 @@ This document describes how to do these operations and provides the TiDB Cloud b In TiDB Cloud, you can view both active and closed alerts on the **Alerts** page. -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters. -2. Click the name of the target cluster. The cluster overview page is displayed. +2. Click the name of the target resource. The overview page of that resource is displayed. 3. Click **Alerts** in the left navigation pane. 4. The **Alerts** page displays the active alerts by default. You can view the information of each active alert such as the alert name, trigger time, and duration. 5. If you also want to view the closed alerts, just click the **Status** drop-down list and select **Closed** or **All**. diff --git a/tidb-cloud/monitor-datadog-integration.md b/tidb-cloud/monitor-datadog-integration.md index aea15f77e14c5..3b7ecc916cede 100644 --- a/tidb-cloud/monitor-datadog-integration.md +++ b/tidb-cloud/monitor-datadog-integration.md @@ -39,7 +39,7 @@ Depending on your [Datadog integration version](#datadog-integration-version), t
-1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the left navigation pane, click **Settings** > **Integrations**. 3. On the **Integrations** page, click **Integration to Datadog**. 4. Enter your Datadog API key and choose your Datadog site. diff --git a/tidb-cloud/monitor-new-relic-integration.md b/tidb-cloud/monitor-new-relic-integration.md index 07c3383b12abc..b839d97e57b88 100644 --- a/tidb-cloud/monitor-new-relic-integration.md +++ b/tidb-cloud/monitor-new-relic-integration.md @@ -39,7 +39,7 @@ Depending on your [New Relic integration version](#new-relic-integration-version
-1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the left navigation pane, click **Settings** > **Integrations**. 3. On the **Integrations** page, click **Integration to New Relic**. 4. Enter your API key of New Relic and choose the site of New Relic. diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index 49c61ddb418c1..1f050551a22a7 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -43,7 +43,7 @@ Depending on your [Prometheus integration version](#prometheus-integration-versi
-1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the left navigation pane, click **Settings** > **Integrations**. 3. On the **Integrations** page, click **Integration to Prometheus**. 4. Click **Add File** to generate and show the `scrape_config` file for the current cluster. diff --git a/tidb-cloud/monitor-tidb-cluster.md b/tidb-cloud/monitor-tidb-cluster.md index 0dc5499ab4a82..8cce227e5034b 100644 --- a/tidb-cloud/monitor-tidb-cluster.md +++ b/tidb-cloud/monitor-tidb-cluster.md @@ -67,7 +67,7 @@ The **Overview** page provides general metrics of a cluster. To view metrics on the cluster overview page, take the following steps: -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target resource to go to its overview page. > **Tip:** > @@ -81,7 +81,7 @@ The **Metrics** page provides a full set of metrics of a cluster. By viewing the To view metrics on the **Metrics** page, take the following steps: -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target resource to go to its overview page. > **Tip:** > diff --git a/tidb-cloud/notifications.md b/tidb-cloud/notifications.md index 79f86e757b393..525f7c86bb27f 100644 --- a/tidb-cloud/notifications.md +++ b/tidb-cloud/notifications.md @@ -37,15 +37,15 @@ The following table lists the notifications available in TiDB Cloud, along with | Notification | Trigger event | Notification recipient | | --- | --- | --- | -| {{{ .starter }}} cluster creation | A [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) cluster is created. | All project members | -| {{{ .starter }}} cluster deletion | A {{{ .starter }}} cluster is deleted. | All project members | -| {{{ .essential }}} cluster creation | A [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) cluster is created. | All project members | -| {{{ .essential }}} cluster deletion | A [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) cluster is deleted. | All project members | +| {{{ .starter }}} instance creation | A [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) instance is created. | All project members | +| {{{ .starter }}} instance deletion | A {{{ .starter }}} instance is deleted. | All project members | +| {{{ .essential }}} instance creation | A [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) instances is created. | All project members | +| {{{ .essential }}} instance deletion | A [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) instances is deleted. | All project members | | TiDB Cloud Dedicated cluster creation | A [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) cluster is created. | All project members | | TiDB Cloud Dedicated cluster deletion | A TiDB Cloud Dedicated cluster is deleted. | All project members | | Organization Budget threshold alert | The organization [budget threshold](/tidb-cloud/tidb-cloud-budget.md) is reached. | `Organization Owner`, `Organization Billing Manager`, and `Organization Billing Viewer` | | Project Budget threshold alert | The project [budget threshold](/tidb-cloud/tidb-cloud-budget.md) is reached. | `Organization Owner`, `Organization Billing Manager`, `Organization Billing Viewer`, and `Project Owner` | -| Starter cluster spending limit threshold alert | The [spending limit threshold](/tidb-cloud/manage-serverless-spend-limit.md) for {{{ .starter }}} clusters in the organization is reached. | `Organization Owner`, `Organization Billing Manager`, `Organization Billing Viewer`, and `Project Owner` | +| Starter cluster spending limit threshold alert | The [spending limit threshold](/tidb-cloud/manage-serverless-spend-limit.md) for {{{ .starter }}} instances in the organization is reached. | `Organization Owner`, `Organization Billing Manager`, `Organization Billing Viewer`, and `Project Owner` | | Credits update | [Credits](/tidb-cloud/tidb-cloud-billing.md#credits) for the organization are applied, fully used, reclaimed, or expired. | `Organization Owner`, `Organization Billing Manager`, and `Organization Billing Viewer` | | Discount update | [Discounts](/tidb-cloud/tidb-cloud-billing.md#discounts) for the organization are applied, reclaimed, or expired. | `Organization Owner`, `Organization Billing Manager`, and `Organization Billing Viewer` | | Marketplace update | The organization has a subscription or unsubscription through a cloud provider marketplace. | All organization members | diff --git a/tidb-cloud/pause-or-resume-tidb-cluster.md b/tidb-cloud/pause-or-resume-tidb-cluster.md index 75848db442ac4..41417f2671451 100644 --- a/tidb-cloud/pause-or-resume-tidb-cluster.md +++ b/tidb-cloud/pause-or-resume-tidb-cluster.md @@ -13,7 +13,7 @@ Comparing with backup and restore, pausing and resuming a cluster takes less tim > **Note:** > -> You cannot pause a [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) or [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) cluster. +> You cannot pause a [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) or [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) instances. ## Limitations @@ -71,12 +71,12 @@ When a cluster is paused, note the following: To pause a cluster, take the following steps: -1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. -2. In the row of the cluster that you want to pause, click **...**. +1. In the TiDB Cloud console, navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. +2. In the row of the TiDB Cloud Dedicated cluster that you want to pause, click **...**. > **Tip:** > - > Alternatively, you can click the name of the cluster that you want to pause on the **Clusters** page, and then click **...** in the upper-right corner. + > Alternatively, you can click the name of the cluster that you want to pause on the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click **...** in the upper-right corner. 3. Click **Pause** in the drop-down menu. @@ -98,8 +98,8 @@ After a paused cluster is resumed, note the following: To resume a paused cluster, take the following steps: -1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. -2. For the cluster that you want to resume, click **Resume**. The **Resume your cluster** dialog is displayed. +1. In the TiDB Cloud console, navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. +2. For the TiDB Cloud Dedicated cluster that you want to resume, click **Resume**. The **Resume your cluster** dialog is displayed. > **Note:** > diff --git a/tidb-cloud/premium/backup-and-restore-premium.md b/tidb-cloud/premium/backup-and-restore-premium.md index 392acfacbd4c0..71be1e243b2f8 100644 --- a/tidb-cloud/premium/backup-and-restore-premium.md +++ b/tidb-cloud/premium/backup-and-restore-premium.md @@ -16,7 +16,7 @@ Backup files can originate from the following sources: > **Tip:** > > - To learn how to back up and restore data on {{{ .dedicated }}} clusters, see [Back Up and Restore {{{ .dedicated }}} Data](/tidb-cloud/backup-and-restore.md). -> - To learn how to back up and restore data on {{{ .starter }}} or {{{ .essential }}} clusters, see [Back Up and Restore {{{ .starter }}} or Essential Data](/tidb-cloud/backup-and-restore-serverless.md). +> - To learn how to back up and restore data on {{{ .starter }}} or {{{ .essential }}} instances, see [Back Up and Restore {{{ .starter }}} or Essential Data](/tidb-cloud/backup-and-restore-serverless.md). ## View the Backup page @@ -147,11 +147,11 @@ To restore a backup generated by a {{{ .dedicated }}} cluster, follow these step 1. Log in to the [TiDB Cloud console](https://tidbcloud.com), and then navigate to the [**TiDB Instances**](https://tidbcloud.com/tidbs) page. In the upper-right corner, click **...**, and then click **Restore from Another Plan**. -2. On the **Select Backup** page, select the project that contains the target {{{ .dedicated }}} cluster. Select the cluster, select the backup snapshot that you want to restore, and then click **Next**. +2. On the **Select Backup** page, select the project that contains the target {{{ .dedicated }}} cluster. Select the {{{ .dedicated }}} cluster, select the backup snapshot that you want to restore, and then click **Next**. > **Note:** > - > - Ensure that the cluster that contains the backup snapshot is in either the **Active** or **Deleted** status within the selected project. + > - Ensure that the {{{ .dedicated }}} cluster that contains the backup snapshot is in either the **Active** or **Deleted** status within the selected project. > - The snapshot must be located in a region that {{{ .premium }}} supports. If the region is not supported, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) to open a new region for {{{ .premium }}}, or select another backup snapshot. 3. On the **Restore** page, follow the same steps as [Restore to a new instance](#restore-to-a-new-instance) to restore the backup to a new instance. diff --git a/tidb-cloud/premium/built-in-monitoring-premium.md b/tidb-cloud/premium/built-in-monitoring-premium.md index b3b9b3269588a..99d1bb1702748 100644 --- a/tidb-cloud/premium/built-in-monitoring-premium.md +++ b/tidb-cloud/premium/built-in-monitoring-premium.md @@ -5,7 +5,7 @@ summary: Learn how to view {{{ .premium }}} built-in metrics and understand the # {{{ .premium }}} Built-in Metrics -TiDB Cloud collects and displays a full set of standard metrics of your cluster on the Metrics page. By viewing these metrics, you can easily identify performance issues and determine whether your current database deployment meets your requirements. +TiDB Cloud collects and displays a full set of standard metrics of your {{{ .premium }}} instance on the Metrics page. By viewing these metrics, you can easily identify performance issues and determine whether your current database deployment meets your requirements. ## View the Metrics page @@ -70,8 +70,8 @@ The following sections illustrate the metrics on the **Metrics** page for {{{ .p If a pane does not provide any metrics, the possible reasons are as follows: -- The workload of the corresponding cluster does not trigger this metric. For example, the failed query metric is always empty in the case of no failed queries. -- The cluster version is low. You need to upgrade it to the latest version of TiDB to see these metrics. +- The workload of the corresponding {{{ .premium }}} instance does not trigger this metric. For example, the failed query metric is always empty in the case of no failed queries. +- The TiDB version of the {{{ .premium }}} instance is low. You need to upgrade it to the latest version of TiDB to see these metrics. If all these reasons are excluded, you can contact the [PingCAP support team](/tidb-cloud/tidb-cloud-support.md) for troubleshooting. diff --git a/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md b/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md index eaf8775f3e014..935678ff4a280 100644 --- a/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md +++ b/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md @@ -9,7 +9,7 @@ This document describes how to connect to your {{{ .premium }}} instance via [AW > **Tip:** > -> To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via AWS PrivateLink, see [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). +> To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} instance via AWS PrivateLink, see [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). TiDB Cloud supports highly secure and one-way access to the TiDB Cloud service hosted in an AWS VPC via [AWS PrivateLink](https://aws.amazon.com/privatelink), as if the service were in your own VPC. A private endpoint is exposed in your VPC and you can create a connection to the TiDB Cloud service via the endpoint with permission. diff --git a/tidb-cloud/premium/connect-to-premium-via-public-connection.md b/tidb-cloud/premium/connect-to-premium-via-public-connection.md index f3ee4b024bf66..f4dfe1988b96c 100644 --- a/tidb-cloud/premium/connect-to-premium-via-public-connection.md +++ b/tidb-cloud/premium/connect-to-premium-via-public-connection.md @@ -9,7 +9,7 @@ This document describes how to connect to your {{{ .premium }}} instance via pub > **Tip:** > -> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via public connection, see [Connect to {{{ .starter }}} or Essential via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md). +> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} instance via public connection, see [Connect to {{{ .starter }}} or Essential via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md). > - To learn how to connect to a TiDB Cloud Dedicated cluster via public endpoint, see [Connect to TiDB Cloud Dedicated via Public Connection](/tidb-cloud/connect-via-standard-connection.md). ## Prerequisite: Configure IP access list diff --git a/tidb-cloud/premium/migrate-from-op-tidb-premium.md b/tidb-cloud/premium/migrate-from-op-tidb-premium.md index ec3a6dab98ea4..bc989f9280331 100644 --- a/tidb-cloud/premium/migrate-from-op-tidb-premium.md +++ b/tidb-cloud/premium/migrate-from-op-tidb-premium.md @@ -83,11 +83,11 @@ You need the following privileges to export data from the upstream database: ### Deploy TiCDC -You need to [deploy TiCDC](https://docs.pingcap.com/tidb/dev/deploy-ticdc) to replicate incremental data from the upstream TiDB cluster to {{{ .premium }}}. +You need to [deploy TiCDC](https://docs.pingcap.com/tidb/dev/deploy-ticdc) to replicate incremental data from the upstream TiDB Self-Managed cluster to {{{ .premium }}}. -1. Confirm whether the current TiDB version supports TiCDC. TiDB v4.0.8.rc.1 and later versions support TiCDC. You can check the TiDB version by executing `select tidb_version();` in the TiDB cluster. If you need to upgrade it, see [Upgrade TiDB Using TiUP](https://docs.pingcap.com/tidb/dev/deploy-ticdc#upgrade-ticdc-using-tiup). +1. Confirm whether the current TiDB version supports TiCDC. TiDB v4.0.8.rc.1 and later versions support TiCDC. You can check the TiDB version by executing `select tidb_version();` in the TiDB Self-Managed cluster. If you need to upgrade it, see [Upgrade TiDB Using TiUP](https://docs.pingcap.com/tidb/dev/deploy-ticdc#upgrade-ticdc-using-tiup). -2. Add the TiCDC component to the TiDB cluster. See [Add or scale out TiCDC to an existing TiDB cluster using TiUP](https://docs.pingcap.com/tidb/dev/deploy-ticdc#add-or-scale-out-ticdc-to-an-existing-tidb-cluster-using-tiup). Edit the `scale-out.yml` file to add TiCDC: +2. Add the TiCDC component to the TiDB Self-Managed cluster. See [Add or scale out TiCDC to an existing TiDB cluster using TiUP](https://docs.pingcap.com/tidb/dev/deploy-ticdc#add-or-scale-out-ticdc-to-an-existing-tidb-cluster-using-tiup). Edit the `scale-out.yml` file to add TiCDC: ```yaml cdc_servers: @@ -117,7 +117,7 @@ To migrate data from the TiDB Self-Managed cluster to {{{ .premium }}}, perform You need to migrate data from the TiDB Self-Managed cluster to Amazon S3 using Dumpling. -If your TiDB cluster is in a local IDC, or the network between the Dumpling server and Amazon S3 is not connected, you can export the files to the local storage first, and then upload them to Amazon S3 later. +If your TiDB Self-Managed cluster is in a local IDC, or the network between the Dumpling server and Amazon S3 is not connected, you can export the files to the local storage first, and then upload them to Amazon S3 later. #### Step 1. Disable the GC mechanism of the upstream TiDB Self-Managed cluster temporarily @@ -155,9 +155,9 @@ Create an access key in the AWS console. See [Create an access key](https://docs ![Download CSV file](/media/tidb-cloud/op-to-cloud-create-access-key02.png) -#### Step 3. Export data from the upstream TiDB cluster to Amazon S3 using Dumpling +#### Step 3. Export data from the upstream TiDB Self-Managed cluster to Amazon S3 using Dumpling -Do the following to export data from the upstream TiDB cluster to Amazon S3 using Dumpling: +Do the following to export data from the upstream TiDB Self-Managed cluster to Amazon S3 using Dumpling: 1. Configure the environment variables for Dumpling. diff --git a/tidb-cloud/releases/notification-2024-04-09-monitoring-features-maintenance.md b/tidb-cloud/releases/notification-2024-04-09-monitoring-features-maintenance.md index acc17d4d89800..71bbdf73fa669 100644 --- a/tidb-cloud/releases/notification-2024-04-09-monitoring-features-maintenance.md +++ b/tidb-cloud/releases/notification-2024-04-09-monitoring-features-maintenance.md @@ -30,7 +30,7 @@ During the maintenance window, the monitoring features in the following regions - Cloud Provider: Google Cloud, Region: Iowa (us-central1) - Cloud Provider: Google Cloud, Region: Taiwan (asia-east1) -- {{{ .starter }}} clusters： +- {{{ .starter }}} instances： - Cloud Provider: AWS, Region: Frankfurt (eu-central-1) - Cloud Provider: AWS, Region: Oregon (us-west-2) diff --git a/tidb-cloud/releases/notification-2024-04-16-monitoring-features-maintenance.md b/tidb-cloud/releases/notification-2024-04-16-monitoring-features-maintenance.md index 17d92e1d1b976..150fe8e8c5b1c 100644 --- a/tidb-cloud/releases/notification-2024-04-16-monitoring-features-maintenance.md +++ b/tidb-cloud/releases/notification-2024-04-16-monitoring-features-maintenance.md @@ -23,7 +23,7 @@ During the maintenance window, the monitoring features in the following regions - Cloud Provider: AWS, Region: Tokyo (ap-northeast-1) - Cloud Provider: AWS, Region: N. Virginia (us-east-1) -- {{{ .starter }}} clusters： +- {{{ .starter }}} instances： - Cloud Provider: AWS, Region: Tokyo (ap-northeast-1) - Cloud Provider: AWS, Region: N. Virginia (us-east-1) diff --git a/tidb-cloud/scale-tidb-cluster.md b/tidb-cloud/scale-tidb-cluster.md index 2fec6e68ff546..1187ea753df89 100644 --- a/tidb-cloud/scale-tidb-cluster.md +++ b/tidb-cloud/scale-tidb-cluster.md @@ -7,7 +7,7 @@ summary: Learn how to scale your TiDB Cloud cluster. > **Note:** > -> - [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) scale automatically based on your application's workload changes. However, you cannot manually scale a {{{ .starter }}} or {{{ .essential }}} cluster. +> - [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) scale automatically based on your application's workload changes. However, you cannot manually scale a {{{ .starter }}} or {{{ .essential }}} instance. > - When a cluster is in the **MODIFYING** status, you cannot perform any new scaling operations on it. You can scale a TiDB cluster in the following dimensions: @@ -36,12 +36,12 @@ You can increase or decrease the number of TiDB, TiKV, or TiFlash nodes. To change the number of TiDB, TiKV, or TiFlash nodes, take the following steps: -1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. -2. In the row of the cluster that you want to scale, click **...**. +1. In the TiDB Cloud console, navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. +2. In the row of the TiDB Cloud Dedicated cluster that you want to scale, click **...**. > **Tip:** > - > Alternatively, you can also click the name of the cluster that you want to scale on the **Clusters** page and click **...** in the upper-right corner. + > Alternatively, you can also click the name of the TiDB Cloud Dedicated cluster that you want to scale on the **My TiDB** page and click **...** in the upper-right corner. 3. Click **Modify** in the drop-down menu. The **Modify Cluster** page is displayed. 4. On the **Modify Cluster** page, change the number of TiDB, TiKV, or TiFlash nodes. @@ -64,12 +64,12 @@ You can increase or decrease vCPU and RAM of TiDB, TiKV, or TiFlash nodes. To change the vCPU and RAM of TiDB, TiKV, or TiFlash nodes, take the following steps: -1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. -2. In the row of the cluster that you want to scale, click **...**. +1. In the TiDB Cloud console, navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. +2. In the row of the TiDB Cloud Dedicated cluster that you want to scale, click **...**. > **Tip:** > - > Alternatively, you can also click the name of the cluster that you want to scale on the **Clusters** page and click **...** in the upper-right corner. + > Alternatively, you can also click the name of the TiDB Cloud Dedicated cluster that you want to scale on the **My TiDB** page and click **...** in the upper-right corner. 3. Click **Modify** in the drop-down menu. The **Modify Cluster** page is displayed. 4. On the **Modify Cluster** page, change the vCPU and RAM of TiDB, TiKV, or TiFlash nodes. @@ -88,12 +88,12 @@ You can increase the storage of TiKV or TiFlash. To change the storage of TiKV or TiFlash, take the following steps: -1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. -2. In the row of the cluster that you want to scale, click **...**. +1. In the TiDB Cloud console, navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. +2. In the row of the TiDB Cloud Dedicated cluster that you want to scale, click **...**. > **Tip:** > - > Alternatively, you can also click the name of the cluster that you want to scale on the **Clusters** page and click **...** in the upper-right corner. + > Alternatively, you can also click the name of the TiDB Cloud Dedicated cluster that you want to scale on the **My TiDB** page and click **...** in the upper-right corner. 3. Click **Modify** in the drop-down menu. The **Modify Cluster** page is displayed. 4. On the **Modify Cluster** page, change the storage of each TiKV or TiFlash node. diff --git a/tidb-cloud/secure-connections-to-serverless-clusters.md b/tidb-cloud/secure-connections-to-serverless-clusters.md index d5ff993cd32ac..70e1b4d7f2809 100644 --- a/tidb-cloud/secure-connections-to-serverless-clusters.md +++ b/tidb-cloud/secure-connections-to-serverless-clusters.md @@ -6,7 +6,7 @@ aliases: ['/tidbcloud/secure-connections-to-serverless-tier-clusters'] # TLS Connections to {{{ .starter }}} or Essential -Establishing a secure TLS connection between your client and your {{{ .starter }}} or {{{ .essential }}} cluster is one of the basic security practices for connecting to your databases. The server certificate for TiDB Cloud is issued by an independent third-party certificate provider. You can easily connect to your TiDB Cloud cluster without downloading a server-side digital certificate. +Establishing a secure TLS connection between your client and your {{{ .starter }}} or {{{ .essential }}} instance is one of the basic security practices for connecting to your databases. The server certificate for TiDB Cloud is issued by an independent third-party certificate provider. You can easily connect to your {{{ .starter }}} or Essential instance without downloading a server-side digital certificate. > **Note:** > @@ -15,39 +15,39 @@ Establishing a secure TLS connection between your client and your {{{ .starter } ## Prerequisites - Log in to TiDB Cloud via [Password Authentication](/tidb-cloud/tidb-cloud-password-authentication.md) or [SSO Authentication](/tidb-cloud/tidb-cloud-sso-authentication.md). -- [Create a TiDB Cloud cluster](/tidb-cloud/tidb-cloud-quickstart.md). +- [Create a {{{ .starter }}} or Essential instance](/tidb-cloud/create-tidb-cluster-serverless.md). -## TLS connection to a TiDB Cloud cluster +## TLS connection to a {{{ .starter }}} or Essential instance -In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of different connection methods and connect to your TiDB Cloud cluster as follows: +In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of different connection methods and connect to your {{{ .starter }}} or Essential instance as follows: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A dialog is displayed. 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 cluster. The password will be automatically embedded in the sample connection string for connecting to your cluster easily. +4. If you have not set a password yet, click **Generate Password** to generate a random password for your {{{ .starter }}} or Essential instance. The password will be automatically embedded in the sample connection string for connecting to your {{{ .starter }}} or Essential instance easily. > **Note:** > > - The random password consists of 16 characters, including uppercase and lowercase letters, numbers, and special characters. > - After you close this dialog, the generated password will not show again, so you need to save the password in a secure location. If you forget it, you can click **Reset Password** in this dialog to reset it. - > - The TiDB Cloud cluster can be accessed through the internet. If you need to use the password elsewhere, it is recommended that you reset it to ensure database security. + > - The {{{ .starter }}} or Essential instance can be accessed through the internet. If you need to use the password elsewhere, it is recommended that you reset it to ensure database security. -5. Connect to your cluster with the connection string. +5. Connect to your {{{ .starter }}} or Essential instance with the connection string. > **Note:** > - > When you connect to a TiDB Cloud cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). + > When you connect to a {{{ .starter }}} or Essential instance, you must include the prefix for your {{{ .starter }}} or Essential instance in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). ## Root certificate management ### Root certificate issuance and validity -TiDB Cloud uses certificates from [Let's Encrypt](https://letsencrypt.org/) as a Certificate Authority (CA) for TLS connection between clients and TiDB Cloud clusters. Once the TiDB Cloud certificate expires, it will be automatically rotated without affecting the normal operations of your cluster and the established TLS secure connection. +TiDB Cloud uses certificates from [Let's Encrypt](https://letsencrypt.org/) as a Certificate Authority (CA) for TLS connection between clients and {{{ .starter }}} or Essential instances. Once the TiDB Cloud certificate expires, it will be automatically rotated without affecting the normal operations of your {{{ .starter }}} or Essential instance and the established TLS secure connection. -If the client uses the system's root CA stores by default, such as Java and Go, you can easily connect securely to TiDB Cloud clusters without specifying the path of CA roots. However, some drivers and ORMs do not use the system root CA stores. In those cases, you need to configure the CA root path of the drivers or ORMs to your system root CA stores. For example, when you use [mysqlclient](https://github.com/PyMySQL/mysqlclient) to connect a TiDB Cloud cluster in Python on macOS, you need to set `ca: /etc/ssl/cert.pem` in the `ssl` argument. +If the client uses the system's root CA stores by default, such as Java and Go, you can easily connect securely to {{{ .starter }}} or Essential instances without specifying the path of CA roots. However, some drivers and ORMs do not use the system root CA stores. In those cases, you need to configure the CA root path of the drivers or ORMs to your system root CA stores. For example, when you use [mysqlclient](https://github.com/PyMySQL/mysqlclient) to connect a {{{ .starter }}} or Essential instance in Python on macOS, you need to set `ca: /etc/ssl/cert.pem` in the `ssl` argument. If you are using a GUI client, such as DBeaver, which does not accept a certificate file with multiple certificates inside, you must download the [ISRG Root X1](https://letsencrypt.org/certs/isrgrootx1.pem) certificate. @@ -90,11 +90,11 @@ In different operating systems, the default storage paths of the root certificat Windows does not offer a specific path to the CA root. Instead, it uses the [registry](https://learn.microsoft.com/en-us/windows-hardware/drivers/install/local-machine-and-current-user-certificate-stores) to store certificates. For this reason, to specify the CA root path on Windows, take the following steps: 1. Download the [ISRG Root X1 certificate](https://letsencrypt.org/certs/isrgrootx1.pem) and then save it in a path you prefer, such as ``. -2. Use the path (``) as your CA root path when you connect to a TiDB Cloud cluster. +2. Use the path (``) as your CA root path when you connect to a {{{ .starter }}} or Essential instance. ## FAQs -### Which TLS versions are supported to connect to my TiDB Cloud cluster? +### Which TLS versions are supported to connect to my {{{ .starter }}} or Essential instance? For security reasons, TiDB Cloud only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions. See IETF [Deprecating TLS 1.0 and TLS 1.1](https://datatracker.ietf.org/doc/rfc8996/) for details. @@ -102,10 +102,10 @@ For security reasons, TiDB Cloud only supports TLS 1.2 and TLS 1.3, and does not No. -TiDB Cloud only supports one-way TLS authentication, which means your client uses the public key to verify the signature of your TiDB Cloud cluster certificate's private key while the cluster does not validate the client. +TiDB Cloud only supports one-way TLS authentication, which means your client uses the public key to verify the signature of your {{{ .starter }}} or Essential instance certificate's private key while the {{{ .starter }}} or Essential instance does not validate the client. ### Does TiDB Cloud have to configure TLS to establish a secure connection? -For standard connection, TiDB Cloud only allows TLS connections and prohibits non-SSL/TLS connections. The reason is that SSL/TLS is one of the most basic security measures for you to reduce the risk of data exposure to the internet when you connect to the TiDB Cloud cluster through the internet. +For standard connection, TiDB Cloud only allows TLS connections and prohibits non-SSL/TLS connections. The reason is that SSL/TLS is one of the most basic security measures for you to reduce the risk of data exposure to the internet when you connect to the {{{ .starter }}} or Essential instance through the internet. For private endpoint connection, because it supports highly secure and one-way access to the TiDB Cloud service and does not expose your data to the public internet, configuring TLS is optional. diff --git a/tidb-cloud/security-concepts.md b/tidb-cloud/security-concepts.md index c4da4ca74e275..ac6d89d73afb2 100644 --- a/tidb-cloud/security-concepts.md +++ b/tidb-cloud/security-concepts.md @@ -219,7 +219,7 @@ TiDB Cloud safeguards static data with advanced encryption capabilities, ensurin - Encrypts static data and backups with CMEK keys when enabled. -- For TiDB Cloud Dedicated clusters without CMEK, TiDB Cloud uses escrow keys; {{{ .starter }}} and {{{ .essential }}} clusters rely exclusively on escrow keys. +- For TiDB Cloud Dedicated clusters without CMEK, TiDB Cloud uses escrow keys; {{{ .starter }}} and {{{ .essential }}} instances rely exclusively on escrow keys. **Best practices:** diff --git a/tidb-cloud/select-cluster-tier.md b/tidb-cloud/select-cluster-tier.md index 6728ee5673fa2..26606b70984b8 100644 --- a/tidb-cloud/select-cluster-tier.md +++ b/tidb-cloud/select-cluster-tier.md @@ -1,10 +1,10 @@ --- -title: Select Your Cluster Plan -summary: Learn how to select your cluster plan on TiDB Cloud. +title: Select a Plan +summary: Learn how to select a plan on TiDB Cloud. aliases: ['/tidbcloud/developer-tier-cluster'] --- -# Select Your Cluster Plan +# Select a Plan The cluster plan determines the throughput and performance of your cluster. @@ -30,9 +30,9 @@ The free cluster plan is ideal for those who are getting started with {{{ .start ### Usage quota -For each organization in TiDB Cloud, you can create a maximum of five free {{{ .starter }}} clusters by default. To create more {{{ .starter }}} clusters, you need to add a credit card and specify a spending limit. +For each organization in TiDB Cloud, you can create a maximum of five free {{{ .starter }}} instances by default. To create more {{{ .starter }}} instances, you need to add a credit card and specify a spending limit. -For the first five {{{ .starter }}} clusters in your organization, whether they are free or scalable, TiDB Cloud provides a free usage quota for each of them as follows: +For the first five {{{ .starter }}} instances in your organization, whether they are free or scalable, TiDB Cloud provides a free usage quota for each of them as follows: - Row-based storage: 5 GiB - Columnar storage: 5 GiB @@ -57,7 +57,7 @@ For applications experiencing growing workloads and needing scalability in real -For each {{{ .starter }}} or {{{ .essential }}} cluster, TiDB Cloud generates a unique prefix to distinguish it from other clusters. +For each {{{ .starter }}} or {{{ .essential }}} instance, TiDB Cloud generates a unique prefix to distinguish it from other clusters. Whenever you use or set a database user name, you must include the prefix in the user name. For example, assume that the prefix of your cluster is `3pTAoNNegb47Uc8`. @@ -79,8 +79,8 @@ Whenever you use or set a database user name, you must include the prefix in the To get the prefix for your cluster, take the following steps: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page. -2. Click the name of your target cluster to go to its overview page, and then click **Connect** in the upper-right corner. A connection dialog is displayed. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. +2. Click the name of your target {{{ .starter }}} or Essential instance to go to its overview page, and then click **Connect** in the upper-right corner. A connection dialog is displayed. 3. In the dialog, get the prefix from the connection string. ## TiDB Cloud Dedicated diff --git a/tidb-cloud/serverless-export.md b/tidb-cloud/serverless-export.md index d0c5efb4b8f94..92056e2f8af05 100644 --- a/tidb-cloud/serverless-export.md +++ b/tidb-cloud/serverless-export.md @@ -1,15 +1,15 @@ --- title: Export Data from {{{ .starter }}} or Essential -summary: Learn how to export data from {{{ .starter }}} or {{{ .essential }}} clusters. +summary: Learn how to export data from {{{ .starter }}} or {{{ .essential }}} instances. --- # Export Data from {{{ .starter }}} or Essential -TiDB Cloud enables you to export data from a {{{ .starter }}} or Essential cluster to a local file or an external storage service. You can use the exported data for backup, migration, data analysis, or other purposes. +TiDB Cloud enables you to export data from a {{{ .starter }}} or Essential instance to a local file or an external storage service. You can use the exported data for backup, migration, data analysis, or other purposes. -While you can also export data using tools such as [mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) and TiDB [Dumpling](https://docs.pingcap.com/tidb/dev/dumpling-overview), the export feature provided by TiDB Cloud offers a more convenient and efficient way to export data from a cluster. It brings the following benefits: +While you can also export data using tools such as [mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) and TiDB [Dumpling](https://docs.pingcap.com/tidb/dev/dumpling-overview), the export feature provided by TiDB Cloud offers a more convenient and efficient way to export data from a {{{ .starter }}} or Essential instance. It brings the following benefits: -- Convenience: the export service provides a simple and easy-to-use way to export data from a cluster, eliminating the need for additional tools or resources. +- Convenience: the export service provides a simple and easy-to-use way to export data from a {{{ .starter }}} or Essential instance, eliminating the need for additional tools or resources. - Isolation: the export service uses separate computing resources, ensuring isolation from the resources used by your online services. - Consistency: the export service ensures the consistency of the exported data without causing locks, which does not affect your online services. @@ -35,7 +35,7 @@ You can export data to the following locations: ### A local file -To export data from a TiDB Cloud cluster to a local file, you need to export data [using the TiDB Cloud console](#export-data-to-a-local-file) or [using the TiDB Cloud CLI](/tidb-cloud/ticloud-serverless-export-create.md), and then download the exported data using the TiDB Cloud CLI. +To export data from a {{{ .starter }}} or Essential instance to a local file, you need to export data [using the TiDB Cloud console](#export-data-to-a-local-file) or [using the TiDB Cloud CLI](/tidb-cloud/ticloud-serverless-export-create.md), and then download the exported data using the TiDB Cloud CLI. Exporting data to a local file has the following limitations: @@ -175,7 +175,7 @@ When exporting data to the Parquet format, the data conversion between TiDB and
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -192,7 +192,7 @@ When exporting data to the Parquet format, the data conversion between TiDB and > **Tip:** > - > If your cluster has neither imported nor exported any data before, you need to click **Click here to export data to...** at the bottom of the page to export data. + > If your {{{ .starter }}} or Essential instance has neither imported nor exported any data before, you need to click **Click here to export data to...** at the bottom of the page to export data. 4. Click **Export**. @@ -226,7 +226,7 @@ When exporting data to the Parquet format, the data conversion between TiDB and
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -270,7 +270,7 @@ ticloud serverless export create -c --target-type S3 --s3.uri
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -308,7 +308,7 @@ ticloud serverless export create -c --target-type GCS --gcs.uri
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -346,7 +346,7 @@ ticloud serverless export create -c --target-type AZURE_BLOB --azbl
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -389,7 +389,7 @@ To cancel an ongoing export task, take the following steps:
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -416,7 +416,7 @@ ticloud serverless export cancel -c -e ## Export speed -The export speed depends on your [cluster plan](/tidb-cloud/select-cluster-tier.md): +The export speed varies between {{{ .starter }}} and {{{ .essential }}}: - **{{{ .starter }}}**: diff --git a/tidb-cloud/serverless-faqs.md b/tidb-cloud/serverless-faqs.md index 4561e6d2bd33f..cf9a46bd4d635 100644 --- a/tidb-cloud/serverless-faqs.md +++ b/tidb-cloud/serverless-faqs.md @@ -29,15 +29,15 @@ To make the purpose of this entry tier clearer, we’ve renamed it to Starter, t - A fully managed database with both row-based and columnar storage, ideal for hybrid OLTP and OLAP workloads. - Automatic and request-driven scaling, no capacity planning or manual tuning required. - Built-in vector search and full-text search to power GenAI retrieval, chatbots, and other AI applications. -- Always-free monthly quota for up to five clusters per organization (5 GiB row data + 5 GiB columnar data + 50 million [RUs](/tidb-cloud/tidb-cloud-glossary.md#request-unit-ru) per cluster). +- Always-free monthly quota for up to five {{{ .starter }}} instances per organization (5 GiB row data + 5 GiB columnar data + 50 million [RUs](/tidb-cloud/tidb-cloud-glossary.md#request-unit-ru) per {{{ .starter }}} instance). ### How do I get started with {{{ .starter }}}? Get started with the 5-minute [TiDB Cloud Quick Start](/tidb-cloud/tidb-cloud-quickstart.md) -### How many {{{ .starter }}} clusters can I create in TiDB Cloud? +### How many {{{ .starter }}} instances can I create in TiDB Cloud? -For each organization in TiDB Cloud, you can create a maximum of five [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) clusters by default. To create more {{{ .starter }}} clusters, you need to add a credit card and set the [spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for the usage. +For each organization in TiDB Cloud, you can create a maximum of five [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) instances by default. To create more {{{ .starter }}} instances, you need to add a credit card and set the [spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for the usage. ### Are all TiDB Cloud features fully supported on {{{ .starter }}}? @@ -47,9 +47,9 @@ Some of TiDB Cloud features are partially supported or not supported on {{{ .sta We are actively working on expanding {{{ .starter }}} to other cloud platforms, including Google Cloud and Azure. However, we do not have an exact timeline for now as we currently focus on filling gaps and ensuring seamless functionality across all environments. Rest assured, we are working hard to make {{{ .starter }}} available on more cloud platforms, and we will keep our community updated as we progress. -### I created a Developer Tier cluster before {{{ .starter }}} was available. Can I still use my cluster? +### I created a Developer Tier cluster before {{{ .starter }}} was available. Can I still use my {{{ .starter }}} instance? -Yes, your Developer Tier cluster has been automatically migrated to the {{{ .starter }}} cluster, providing you with an improved user experience without any disruptions to your prior usage. +Yes, your Developer Tier cluster has been automatically migrated to the {{{ .starter }}} instance, providing you with an improved user experience without any disruptions to your prior usage. ### What is columnar storage in {{{ .starter }}}? @@ -57,7 +57,7 @@ Columnar storage in {{{ .starter }}} acts as an additional replica of row-based Columnar storage is a key feature that enables the Hybrid Transactional and Analytical Processing (HTAP) capabilities of TiDB by seamlessly blending transactional and analytical workloads. -To efficiently manage columnar storage data, {{{ .starter }}} uses a separate elastic TiFlash engine. During query execution, the optimizer guides the cluster to automatically decide whether to retrieve data from row-based or columnar storage. +To efficiently manage columnar storage data, {{{ .starter }}} uses a separate elastic TiFlash engine. During query execution, the optimizer guides the {{{ .starter }}} instance to automatically decide whether to retrieve data from row-based or columnar storage. ### When should I use columnar storage in {{{ .starter }}}? @@ -86,43 +86,43 @@ When you connect via a Public Endpoint, your connection passes through various n ### Why did I receive a "Connection limit exceeded" error? -This error occurs when your cluster exceeds its maximum concurrent connection limit. For more information, see [Connection limitations](/tidb-cloud/serverless-limitations.md#connection). +This error occurs when your {{{ .starter }}} instance exceeds its maximum concurrent connection limit. For more information, see [Connection limitations](/tidb-cloud/serverless-limitations.md#connection). ## Billing and metering FAQs ### What are Request Units? -{{{ .starter }}} adopts a pay-as-you-go model, meaning that you only pay for the storage space and cluster usage. In this model, all cluster activities such as SQL queries, bulk operations, and background jobs are quantified in [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit-ru). RU is an abstract measurement for the size and intricacy of requests initiated on your cluster. For more information, see [{{{ .starter }}} Pricing Details](https://www.pingcap.com/tidb-cloud-starter-pricing-details/). +{{{ .starter }}} adopts a pay-as-you-go model, meaning that you only pay for the storage space and {{{ .starter }}} instance usage. In this model, all {{{ .starter }}} instance activities such as SQL queries, bulk operations, and background jobs are quantified in [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit-ru). RU is an abstract measurement for the size and intricacy of requests initiated on your {{{ .starter }}} instance. For more information, see [{{{ .starter }}} Pricing Details](https://www.pingcap.com/tidb-cloud-starter-pricing-details/). ### Is there any free plan available for {{{ .starter }}}? -For the first five {{{ .starter }}} clusters in your organization, TiDB Cloud provides a free usage quota for each of them as follows: +For the first five {{{ .starter }}} instances in your organization, TiDB Cloud provides a free usage quota for each of them as follows: - Row-based storage: 5 GiB - Columnar storage: 5 GiB - [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit-ru): 50 million RUs per month -If the monthly spending limit is set for a {{{ .starter }}} cluster, usage beyond the free quota will be charged. For a free cluster, once the free quota is reached, the read and write operations on this cluster will be throttled until you set a monthly spending limit or the usage is reset upon the start of a new month. +If the monthly spending limit is set for a {{{ .starter }}} instance, usage beyond the free quota will be charged. For a free {{{ .starter }}} instance, once the free quota is reached, the read and write operations on this instance will be throttled until you set a monthly spending limit or the usage is reset upon the start of a new month. For more information, see [{{{ .starter }}} usage quota](/tidb-cloud/select-cluster-tier.md#usage-quota). ### What are the limitations of the free plan? -Under the free plan, cluster performance is limited due to non-scalable resources. This results in a restriction on memory allocation per query to 256 MiB and might cause observable bottlenecks in request units (RUs) per second. To maximize cluster performance and avoid these limitations, you can [set a monthly spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for your {{{ .starter }}} cluster. +Under the free plan, {{{ .starter }}} instance performance is limited due to non-scalable resources. This results in a restriction on memory allocation per query to 256 MiB and might cause observable bottlenecks in request units (RUs) per second. To maximize the performance of the {{{ .starter }}} instance and avoid these limitations, you can [set a monthly spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for your {{{ .starter }}} instance. ### How can I estimate the number of RUs required by my workloads and plan my monthly budget? To get the RU consumption of individual SQL statements, you can use the [`EXPLAIN ANALYZE`](/sql-statements/sql-statement-explain-analyze.md#ru-request-unit-consumption) SQL statement. However, it is important to note that the RUs usage returned in `EXPLAIN ANALYZE` does not incorporate egress RUs, as egress usage is measured separately in the gateway, which is unknown to the TiDB server. -To get the RUs and storage used by your cluster, view the **Usage this month** pane on your cluster overview page. With your past resource usage data and real-time resource usage in this pane, you can track your cluster's resource consumption and estimate a reasonable spending limit. If the free quota cannot meet your requirement, you can edit the spending limit for additional resources. For more information, see [{{{ .starter }}} usage quota](/tidb-cloud/select-cluster-tier.md#usage-quota). +To get the RUs and storage used by your {{{ .starter }}} instance, navigate to the overview page of your {{{ .starter }}} instance, and then view the **Usage this month** pane. With your past resource usage data and real-time resource usage in this pane, you can track the resource consumption of your {{{ .starter }}} instance and estimate a reasonable spending limit. If the free quota cannot meet your requirement, you can edit the spending limit for additional resources. For more information, see [{{{ .starter }}} usage quota](/tidb-cloud/select-cluster-tier.md#usage-quota). ### How can I optimize my workload to minimize the number of RUs consumed? -Ensure that your queries have been carefully optimized for optimal performance by following the guidelines in [Optimizing SQL Performance](/develop/dev-guide-optimize-sql-overview.md). To identify the SQL statements that consume the most RUs, navigate to the [**Diagnosis**](/tidb-cloud/tune-performance.md#view-the-diagnosis-page) page of your cluster, and then check the **SQL Statements** tab, where you can observe SQL execution and view the top statements sorted by **Total RU** or **Mean RU**. For more information, see [Statement Analysis](/tidb-cloud/tune-performance.md#statement-analysis). In addition, minimizing the amount of egress traffic is also crucial for reducing RUs consumption. To achieve this, it is recommended to return only the necessary columns and rows in your query, which in turn helps reduce network egress traffic. This can be achieved by carefully selecting and filtering the columns and rows to be returned, thereby optimizing network utilization. +Ensure that your queries have been carefully optimized for optimal performance by following the guidelines in [Optimizing SQL Performance](/develop/dev-guide-optimize-sql-overview.md). To identify the SQL statements that consume the most RUs, navigate to the [**Diagnosis**](/tidb-cloud/tune-performance.md#view-the-diagnosis-page) page of your {{{ .starter }}} instance, and then check the **SQL Statements** tab, where you can observe SQL execution and view the top statements sorted by **Total RU** or **Mean RU**. For more information, see [Statement Analysis](/tidb-cloud/tune-performance.md#statement-analysis). In addition, minimizing the amount of egress traffic is also crucial for reducing RUs consumption. To achieve this, it is recommended to return only the necessary columns and rows in your query, which in turn helps reduce network egress traffic. This can be achieved by carefully selecting and filtering the columns and rows to be returned, thereby optimizing network utilization. ### How storage is metered for {{{ .starter }}}？ -The storage is metered based on the amount of data stored in a {{{ .starter }}} cluster, measured in GiB per month. It is calculated by multiplying the total size of all the tables and indexes (excluding data compression or replicas) with the number of hours the data is stored in that month. +The storage is metered based on the amount of data stored in a {{{ .starter }}} instance, measured in GiB per month. It is calculated by multiplying the total size of all the tables and indexes (excluding data compression or replicas) with the number of hours the data is stored in that month. ### Why does the storage usage size remain unchanged after dropping a table or database immediately? @@ -136,13 +136,13 @@ RU consumptions can occur in various scenarios. One common scenario is during ba A spike in RU usage can occur due to necessary background jobs in TiDB. These jobs, such as automatically analyzing tables and rebuilding statistics, are required for generating optimized query plans. -### What happens when my cluster exhausts its free quota or exceeds its spending limit? +### What happens when my {{{ .starter }}} instance exhausts its free quota or exceeds its spending limit? -Once a cluster reaches its free quota or spending limit, the cluster immediately denies any new connection attempts until the quota is increased or the usage is reset at the start of a new month. Existing connections established before reaching the quota will remain active but will experience throttling. For more information, see [{{{ .starter }}} Limitations and Quotas](/tidb-cloud/serverless-limitations.md#usage-quota). +Once a {{{ .starter }}} instance reaches its free quota or spending limit, the instance immediately denies any new connection attempts until the quota is increased or the usage is reset at the start of a new month. Existing connections established before reaching the quota will remain active but will experience throttling. For more information, see [{{{ .starter }}} Limitations and Quotas](/tidb-cloud/serverless-limitations.md#usage-quota). ### Why do I observe spikes in RU usage while importing data? -During the data import process of a {{{ .starter }}} cluster, RU consumption occurs only when the data is successfully imported, which leads to spikes in RU usage. +During the data import process of a {{{ .starter }}} instance, RU consumption occurs only when the data is successfully imported, which leads to spikes in RU usage. ### What costs are involved when using columnar storage in {{{ .starter }}}? @@ -167,10 +167,10 @@ The serverless technology is designed for multi-tenancy and the resources used b ### How does {{{ .starter }}} ensure security? - Your connections are encrypted by Transport Layer Security (TLS). For more information about using TLS to connect to {{{ .starter }}}, see [TLS Connection to {{{ .starter }}}](/tidb-cloud/secure-connections-to-serverless-clusters.md). -- All persisted data on {{{ .starter }}} is encrypted-at-rest using the tool of the cloud provider that your cluster is running in. +- All persisted data on {{{ .starter }}} is encrypted-at-rest using the tool of the cloud provider that your {{{ .starter }}} instance is running in. ## Maintenance FAQ -### Can I upgrade the version of TiDB that my cluster is running on? +### Can I upgrade the version of TiDB that my {{{ .starter }}} instance is running on? -No. {{{ .starter }}} clusters are upgraded automatically as we roll out new TiDB versions on TiDB Cloud. You can see what version of TiDB your cluster is running in the [TiDB Cloud console](https://tidbcloud.com/project/clusters) or in the latest [release note](https://docs.pingcap.com/tidbcloud/tidb-cloud-release-notes). Alternatively, you can also connect to your cluster and use `SELECT version()` or `SELECT tidb_version()` to check the TiDB version. +No. {{{ .starter }}} instances are upgraded automatically as we roll out new TiDB versions on TiDB Cloud. You can see what version of TiDB your {{{ .starter }}} instance is running in the [TiDB Cloud console](https://tidbcloud.com/project/clusters) or in the latest [release note](https://docs.pingcap.com/tidbcloud/tidb-cloud-release-notes). Alternatively, you can also connect to your {{{ .starter }}} instance and use `SELECT version()` or `SELECT tidb_version()` to check the TiDB version. diff --git a/tidb-cloud/serverless-high-availability.md b/tidb-cloud/serverless-high-availability.md index be95f68373a4a..4ad922247cbf9 100644 --- a/tidb-cloud/serverless-high-availability.md +++ b/tidb-cloud/serverless-high-availability.md @@ -22,8 +22,8 @@ TiDB Cloud extends these capabilities with zonal high availability and regional > **Note:** > -> - For {{{ .starter }}} clusters, only zonal high availability is enabled, and it is not configurable. -> - For {{{ .essential }}} clusters hosted in the AWS Tokyo (ap-northeast-1) region or any Alibaba Cloud region, regional high availability is enabled by default. You can change it to zonal high availability as needed during cluster creation. For {{{ .essential }}} clusters hosted in other regions, only zonal high availability is enabled, and it is not configurable. +> - For {{{ .starter }}} instances, only zonal high availability is enabled, and it is not configurable. +> - For {{{ .essential }}} instances hosted in the AWS Tokyo (ap-northeast-1) region or any Alibaba Cloud region, regional high availability is enabled by default. You can change it to zonal high availability as needed during {{{ .essential }}} instance creation. For {{{ .essential }}} instances hosted in other regions, only zonal high availability is enabled, and it is not configurable. @@ -31,19 +31,19 @@ TiDB Cloud extends these capabilities with zonal high availability and regional > **Note:** > -> - For {{{ .starter }}} clusters, only zonal high availability is enabled, and it is not configurable. +> - For {{{ .starter }}} instances, only zonal high availability is enabled, and it is not configurable. > - For {{{ .premium }}} clusters, only regional high availability is enabled, and it is not configurable. -> - For {{{ .essential }}} clusters hosted in the AWS Tokyo (ap-northeast-1) region or any Alibaba Cloud region, regional high availability is enabled by default. You can change it to zonal high availability as needed during cluster creation. For {{{ .essential }}} clusters hosted in other regions, only zonal high availability is enabled, and it is not configurable. +> - For {{{ .essential }}} instances hosted in the AWS Tokyo (ap-northeast-1) region or any Alibaba Cloud region, regional high availability is enabled by default. You can change it to zonal high availability as needed during {{{ .essential }}} instance creation. For {{{ .essential }}} instances hosted in other regions, only zonal high availability is enabled, and it is not configurable. - **Zonal high availability**: This option places all nodes within a single availability zone, reducing network latency. It ensures high availability without requiring application-level redundancy across zones, making it suitable for applications that prioritize low latency within a single zone. For more information, see [Zonal high availability architecture](#zonal-high-availability-architecture). -- **Regional high availability (beta)**: This option distributes nodes across multiple availability zones, offering maximum infrastructure isolation and redundancy. It provides the highest level of availability but requires application-level redundancy across zones. It is recommended to choose this option if you need maximum availability protection against infrastructure failures within a zone. Note that it increases latency and might incur cross-zone data transfer fees. This feature is available in regions with more than three availability zones and can only be enabled during cluster creation. For more information, see [Regional high availability architecture](#regional-high-availability-architecture). +- **Regional high availability (beta)**: This option distributes nodes across multiple availability zones, offering maximum infrastructure isolation and redundancy. It provides the highest level of availability but requires application-level redundancy across zones. It is recommended to choose this option if you need maximum availability protection against infrastructure failures within a zone. Note that it increases latency and might incur cross-zone data transfer fees. This feature is available in regions with more than three availability zones. For more information, see [Regional high availability architecture](#regional-high-availability-architecture). ## Zonal high availability architecture -When you create a cluster with the default zonal high availability, all components, including Gateway, TiDB, TiKV, and TiFlash compute/write nodes, run in the same availability zone. The placement of these components in the data plane offer infrastructure redundancy with virtual machine pools, which minimizes failover time and network latency due to colocation. +When you create a {{{ .starter }}} or Essential instance with the zonal high availability, all components, including Gateway, TiDB, TiKV, and TiFlash compute/write nodes, run in the same availability zone. The placement of these components in the data plane offer infrastructure redundancy with virtual machine pools, which minimizes failover time and network latency due to colocation. @@ -99,7 +99,7 @@ The gateway and computing layers are stateless, so failover involves restarting ## Regional high availability architecture -When you create a cluster with regional high availability, critical OLTP (Online Transactional Processing) workload components, such as PD and TiKV, are deployed across multiple availability zones to ensure redundant replication and maximizing availability. During normal operations, components like Gateway, TiDB, and TiFlash compute/write nodes are hosted in the primary availability zone. These components in data plane offer infrastructure redundancy through virtual machine pools, which minimizes failover time and network latency due to colocation. +When you create a {{{ .essential }}} or {{{ .premium }}} instance with regional high availability, critical OLTP (Online Transactional Processing) workload components, such as PD and TiKV, are deployed across multiple availability zones to ensure redundant replication and maximizing availability. During normal operations, components like Gateway, TiDB, and TiFlash compute/write nodes are hosted in the primary availability zone. These components in data plane offer infrastructure redundancy through virtual machine pools, which minimizes failover time and network latency due to colocation. > **Note:** > diff --git a/tidb-cloud/serverless-limitations.md b/tidb-cloud/serverless-limitations.md index 12e23884136bc..8814aabfd3619 100644 --- a/tidb-cloud/serverless-limitations.md +++ b/tidb-cloud/serverless-limitations.md @@ -16,14 +16,14 @@ We are constantly filling in the feature gaps between {{{ .starter }}}/Essential ### Audit logs -- [Database audit logging](/tidb-cloud/essential-database-audit-logging.md) is currently unavailable for {{{ .starter }}} clusters. +- [Database audit logging](/tidb-cloud/essential-database-audit-logging.md) is currently unavailable for {{{ .starter }}} instances. ### Connection -- Only [Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) and [Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) can be used. You cannot use [VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) to connect to {{{ .starter }}} or {{{ .essential }}} clusters. +- Only [Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) and [Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) can be used. You cannot use [VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) to connect to {{{ .starter }}} or {{{ .essential }}} instances. - No [Firewall Rules](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md) support for Private Endpoint. - Your database client connections might be terminated unexpectedly if they remain open for more than 30 minutes. This can occur when a TiDB server shuts down, restarts, or undergoes maintenance, potentially causing application disruptions. To avoid this issue, configure a maximum connection lifetime. It is recommended to start with 5 minutes and increase it gradually if it affects tail latency. For more information, see [Recommended settings for connection pools](/develop/dev-guide-connection-parameters.md). -- For a {{{ .starter }}} cluster, you can have up to 400 concurrent connections. If you set a [spending limit](/tidb-cloud/manage-serverless-spend-limit.md), this limit increases to 5,000. +- For a {{{ .starter }}} instance, you can have up to 400 concurrent connections. If you set a [spending limit](/tidb-cloud/manage-serverless-spend-limit.md), this limit increases to 5,000. > **Note:** > @@ -31,7 +31,7 @@ We are constantly filling in the feature gaps between {{{ .starter }}}/Essential ### Encryption -- Data persisted in your {{{ .starter }}} or {{{ .essential }}} cluster is encrypted using the encryption tool provided by the cloud provider that manages your cluster. For {{{ .starter }}} (with spending limit > 0) and {{{ .essential }}} clusters, an optional second layer of encryption is available during the cluster creation process, providing an additional level of security beyond the default encryption at rest. +- Data persisted in your {{{ .starter }}} or {{{ .essential }}} instance is encrypted using the encryption tool provided by the cloud provider that manages your instance. For {{{ .starter }}} (with spending limit > 0) and {{{ .essential }}} instances, an optional second layer of encryption is available during the instance creation process, providing an additional level of security beyond the default encryption at rest. - Using [customer-managed encryption keys (CMEK)](/tidb-cloud/tidb-cloud-encrypt-cmek-aws.md) is currently unavailable. ### Maintenance window @@ -64,9 +64,9 @@ We are constantly filling in the feature gaps between {{{ .starter }}}/Essential ## Usage quota -For each organization in TiDB Cloud, you can create a maximum of five [free {{{ .starter }}} clusters](/tidb-cloud/select-cluster-tier.md#starter) by default. To create more {{{ .starter }}} clusters, you need to add a credit card and [set a monthly spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for the usage. +For each organization in TiDB Cloud, you can create a maximum of five [free {{{ .starter }}} instances](/tidb-cloud/select-cluster-tier.md#starter) by default. To create more {{{ .starter }}} instances, you need to add a credit card and [set a monthly spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for the usage. -For the first five {{{ .starter }}} clusters in your organization, TiDB Cloud provides a free usage quota for each of them as follows: +For the first five {{{ .starter }}} instances in your organization, TiDB Cloud provides a free usage quota for each of them as follows: - Row-based storage: 5 GiB - Columnar storage: 5 GiB @@ -74,10 +74,10 @@ For the first five {{{ .starter }}} clusters in your organization, TiDB Cloud pr The Request Unit (RU) is a unit of measurement used to track the resource consumption of a query or transaction. It is a metric that allows you to estimate the computational resources required to process a specific request in the database. The request unit is also the billing unit for {{{ .starter }}} service. -Once a cluster reaches its usage quota, it immediately denies any new connection attempts until you [increase the quota](/tidb-cloud/manage-serverless-spend-limit.md#update-spending-limit) or the usage is reset upon the start of a new month. Existing connections established before reaching the quota will remain active but will experience throttling. +Once a {{{ .starter}}} instance reaches its usage quota, it immediately denies any new connection attempts until you [increase the quota](/tidb-cloud/manage-serverless-spend-limit.md#update-spending-limit) or the usage is reset upon the start of a new month. Existing connections established before reaching the quota will remain active but will experience throttling. To learn more about the RU consumption of different resources (including read, write, SQL CPU, and network egress), the pricing details, and the throttled information, see [{{{ .starter }}} Pricing Details](https://www.pingcap.com/tidb-cloud-starter-pricing-details/). -If you want to create a {{{ .starter }}} cluster with an additional quota, you can set the monthly spending limit on the cluster creation page. For more information, see [Create a {{{ .starter }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md). +If you want to create a {{{ .starter }}} instance with an additional quota, you can set the monthly spending limit on the {{{ .starter}}} instance creation page. For more information, see [Create a {{{ .starter }}} instance](/tidb-cloud/create-tidb-cluster-serverless.md). -After creating a {{{ .starter }}} cluster, you can still check and edit the spending limit on your cluster overview page. For more information, see [Manage Spending Limit for {{{ .starter }}} Clusters](/tidb-cloud/manage-serverless-spend-limit.md). +After creating a {{{ .starter }}} instance, you can still check and edit the spending limit on the overview page of your {{{ .starter}}} instance. For more information, see [Manage Spending Limit for {{{ .starter }}} Instances](/tidb-cloud/manage-serverless-spend-limit.md). diff --git a/tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md b/tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md index fbb6a9c393493..2efa76cf56ebf 100644 --- a/tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md +++ b/tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md @@ -5,7 +5,7 @@ summary: Learn how to connect to an Alibaba Cloud ApsaraDB RDS for MySQL instanc # Connect to Alibaba Cloud ApsaraDB RDS for MySQL via a Private Link Connection -This document describes how to connect a {{{ .essential }}} cluster to an [Alibaba Cloud ApsaraDB RDS for MySQL](https://www.alibabacloud.com/en/product/apsaradb-for-rds-mysql) instance using an [Alibaba Cloud Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md). +This document describes how to connect a {{{ .essential }}} instance to an [Alibaba Cloud ApsaraDB RDS for MySQL](https://www.alibabacloud.com/en/product/apsaradb-for-rds-mysql) instance using an [Alibaba Cloud Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md). ## Prerequisites @@ -16,14 +16,14 @@ This document describes how to connect a {{{ .essential }}} cluster to an [Aliba - Manage load balancer - Manage endpoint services -- Your {{{ .essential }}} cluster is on Alibaba Cloud, and it is active. Retrieve and save the following details for later use: +- Your {{{ .essential }}} instance is on Alibaba Cloud, and it is active. Retrieve and save the following details for later use: - Alibaba Cloud account ID - Availability Zones (AZ) To view the Alibaba Cloud account ID and availability zones, do the following: -1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of the TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane. +1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the overview page of your {{{ .essential }}} instance, and then click **Settings** > **Networking** in the left navigation pane. 2. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection**. 3. In the displayed dialog, you can find the Alibaba Cloud account ID and availability zones. @@ -33,8 +33,8 @@ Identify an Alibaba Cloud ApsaraDB RDS for MySQL that you want to use, or [creat Your ApsaraDB RDS for MySQL instance must meet the following requirements: -- Region match: the instance must reside in the same Alibaba Cloud region as your {{{ .essential }}} cluster. -- AZ (Availability Zone) availability: the availability zones must overlap with those of your {{{ .essential }}} cluster. +- Region match: the instance must reside in the same Alibaba Cloud region as your {{{ .essential }}} instance. +- AZ (Availability Zone) availability: the availability zones must overlap with those of your {{{ .essential }}} instance. - Network accessibility: the instance must be configured with a proper IP allowlist and be accessible within the VPC. > **Note** @@ -63,7 +63,7 @@ Set up the load balancer in the same region as your ApsaraDB RDS for MySQL as fo - **Network Type**: select `Internal-facing` - **VPC**: select the VPC where your ApsaraDB RDS for MySQL is located - - **Zone**: it must overlap with your {{{ .essential }}} cluster + - **Zone**: it must overlap with your {{{ .essential }}} instance - **IP Version**: select `IPv4` 4. Find the load balancer you created, and then click **Create Listener**. Provide the following information: diff --git a/tidb-cloud/serverless-private-link-connection-to-aws-confluent.md b/tidb-cloud/serverless-private-link-connection-to-aws-confluent.md index 77d2da048d9de..08926db8422d1 100644 --- a/tidb-cloud/serverless-private-link-connection-to-aws-confluent.md +++ b/tidb-cloud/serverless-private-link-connection-to-aws-confluent.md @@ -5,7 +5,7 @@ summary: Learn how to connect to a Confluent Cloud Dedicated cluster on AWS usin # Connect to Confluent Cloud on AWS via a Private Link Connection -This document describes how to connect a {{{ .essential }}} cluster to a [Confluent Cloud Dedicated cluster](https://docs.confluent.io/cloud/current/clusters/cluster-types.html) on AWS using an [AWS Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md). +This document describes how to connect a {{{ .essential }}} instance to a [Confluent Cloud Dedicated cluster](https://docs.confluent.io/cloud/current/clusters/cluster-types.html) on AWS using an [AWS Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md). > **Note** > @@ -22,7 +22,7 @@ This document describes how to connect a {{{ .essential }}} cluster to a [Conflu To view the AWS account ID and availability zones, do the following: -1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of the TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane. +1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the overview page of your {{{ .essential }}} instance, and then click **Settings** > **Networking** in the left navigation pane. 2. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection**. 3. In the displayed dialog, you can find the AWS account ID and availability zones. @@ -33,8 +33,8 @@ Identify a Confluent Cloud network that you want to use, or [create a new Conflu The Confluent Cloud network must meet the following requirements: - Type: the network must be a **PrivateLink** network. -- Region match: the network must reside in the same AWS region as your {{{ .essential }}} cluster. -- AZ (Availability Zone) availability: the availability zones of the network must overlap with those of your {{{ .essential }}} cluster. +- Region match: the network must reside in the same AWS region as your {{{ .essential }}} instance. +- AZ (Availability Zone) availability: the availability zones of the network must overlap with those of your {{{ .essential }}} instance. To get the unique name of the Confluent Cloud network, take the following steps: diff --git a/tidb-cloud/serverless-private-link-connection-to-aws-rds.md b/tidb-cloud/serverless-private-link-connection-to-aws-rds.md index efb618239a566..4adc78c121580 100644 --- a/tidb-cloud/serverless-private-link-connection-to-aws-rds.md +++ b/tidb-cloud/serverless-private-link-connection-to-aws-rds.md @@ -5,7 +5,7 @@ summary: Learn how to connect to an Amazon RDS instance using an AWS Endpoint Se # Connect to Amazon RDS via a Private Link Connection -This document describes how to connect a {{{ .essential }}} cluster to an [Amazon RDS](https://aws.amazon.com/rds/) instance using an [AWS Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md). +This document describes how to connect a {{{ .essential }}} instance to an [Amazon RDS](https://aws.amazon.com/rds/) instance using an [AWS Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md). ## Prerequisites @@ -24,7 +24,7 @@ This document describes how to connect a {{{ .essential }}} cluster to an [Amazo To view the AWS account ID and availability zones, do the following: -1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of the TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane. +1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the overview page of your {{{ .essential }}} instance, and then click **Settings** > **Networking** in the left navigation pane. 2. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection**. 3. In the displayed dialog, you can find the AWS account ID and availability zones. @@ -34,8 +34,8 @@ Identify an Amazon RDS instance to use, or [create a new one](https://docs.aws.a The Amazon RDS instance must meet the following requirements: -- Region match: the instance must reside in the same AWS region as your {{{ .essential }}} cluster. -- The [subnet group](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) of your Amazon RDS instance must have availability zones that overlap with those of your {{{ .essential }}} cluster. +- Region match: the instance must reside in the same AWS region as your {{{ .essential }}} instance. +- The [subnet group](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) of your Amazon RDS instance must have availability zones that overlap with those of your {{{ .essential }}} instance. - Set your Amazon RDS instance with a proper security group, and ensure that it is accessible within the VPC. For example, you can create a security group with the following rules: - An inbound rule that allows MySQL/Aurora: @@ -73,7 +73,7 @@ To set up the load balancer in the same region as your RDS, take the following s - **Schema**: select `Internal` - **Load balancer IP address type**: select `IPv4` - **VPC**: select the VPC where your RDS is located - - **Availability Zones**: select the availability zones that overlap with your {{{ .essential }}} cluster + - **Availability Zones**: select the availability zones that overlap with your {{{ .essential }}} instance - **Security groups**: create a new security group with the following rules: - An inbound rule that allows MySQL/Aurora: - Type: `MySQL/Aurora` diff --git a/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md b/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md index 64539e2b7d0a8..47497ce2ede78 100644 --- a/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md +++ b/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md @@ -5,7 +5,7 @@ summary: Learn how to connect to an Alibaba Cloud self-hosted Kafka using an Ali # Connect to Alibaba Cloud Self-Hosted Kafka via a Private Link Connection -The document describes how to connect a {{{ .essential }}} cluster to a self-hosted Kafka cluster in Alibaba Cloud, using an [Alibaba Cloud Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md). +The document describes how to connect a {{{ .essential }}} instance to a self-hosted Kafka cluster in Alibaba Cloud, using an [Alibaba Cloud Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md). The mechanism works as follows: @@ -42,7 +42,7 @@ For example, the port mapping is as follows: To view the Alibaba Cloud account ID and availability zones, do the following: -1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of the TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane. +1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the overview page of your {{{ .essential }}} instance, and then click **Settings** > **Networking** in the left navigation pane. 2. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection**. 3. In the displayed dialog, you can find the Alibaba Cloud account ID and availability zones. @@ -57,9 +57,9 @@ The following table shows an example of the deployment information. ## Step 1. Set up a Kafka cluster -If you need to deploy a new cluster, follow the instructions in [Deploy a new Kafka cluster](#deploy-a-new-kafka-cluster). +If you need to deploy a new Kafka cluster, follow the instructions in [Deploy a new Kafka cluster](#deploy-a-new-kafka-cluster). -If you need to expose an existing cluster, follow the instructions in [Reconfigure a running Kafka cluster](#reconfigure-a-running-kafka-cluster). +If you need to expose an existing Kafka cluster, follow the instructions in [Reconfigure a running Kafka cluster](#reconfigure-a-running-kafka-cluster). ### Deploy a new Kafka cluster @@ -446,7 +446,7 @@ LOG_DIR=$KAFKA_LOG_DIR nohup $KAFKA_START_CMD "$KAFKA_CONFIG_DIR/server.properti ### Reconfigure a running Kafka cluster -Ensure that your Kafka cluster is deployed in the same region and AZs as the TiDB cluster. If any brokers are in different AZs, move them to the correct ones. +Ensure that your Kafka cluster is deployed in the same region and AZs as the {{{ .essential }}} instance. If any brokers are in different AZs, move them to the correct ones. #### 1. Configure the EXTERNAL listener for brokers diff --git a/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md b/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md index 6905f6e061532..628fd5243b14b 100644 --- a/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md +++ b/tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md @@ -5,7 +5,7 @@ summary: Learn how to connect to an AWS Self-Hosted Kafka using an AWS Endpoint # Connect to AWS Self-Hosted Kafka via Private Link Connection -This document describes how to connect a {{{ .essential }}} cluster to a self-hosted Kafka cluster in AWS using an [AWS Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md). +This document describes how to connect a {{{ .essential }}} instance to a self-hosted Kafka cluster in AWS using an [AWS Endpoint Service private link connection](/tidb-cloud/serverless-private-link-connection.md). The mechanism works as follows: @@ -36,7 +36,7 @@ The mechanism works as follows: To view the AWS account ID and availability zones, do the following: -1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of your TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane. +1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the overview page of your {{{ .essential }}} instance, and then click **Settings** > **Networking** in the left navigation pane. 2. In the **Private Link Connection For Dataflow** area, click **Create Private Link Connection**. 3. In the displayed dialog, you can find the AWS account ID and availability zones. @@ -51,9 +51,9 @@ The following table shows an example of the deployment information. ## Step 1. Set up a Kafka cluster -If you need to deploy a new cluster, follow the instructions in [Deploy a new Kafka cluster](#deploy-a-new-kafka-cluster). +If you need to deploy a new Kafka cluster, follow the instructions in [Deploy a new Kafka cluster](#deploy-a-new-kafka-cluster). -If you need to expose an existing cluster, follow the instructions in [Reconfigure a running Kafka cluster](#reconfigure-a-running-kafka-cluster). +If you need to expose an existing Kafka cluster, follow the instructions in [Reconfigure a running Kafka cluster](#reconfigure-a-running-kafka-cluster). ### Deploy a new Kafka cluster @@ -513,7 +513,7 @@ LOG_DIR=$KAFKA_LOG_DIR nohup $KAFKA_START_CMD "$KAFKA_CONFIG_DIR/server.properti ### Reconfigure a running Kafka cluster -Ensure that your Kafka cluster is deployed in the same region and AZs as the TiDB cluster. If any brokers are in different AZs, move them to the correct ones. +Ensure that your Kafka cluster is deployed in the same region and AZs as the {{{ .essential }}} instance. If any brokers are in different AZs, move them to the correct ones. #### 1. Configure the EXTERNAL listener for brokers diff --git a/tidb-cloud/serverless-private-link-connection.md b/tidb-cloud/serverless-private-link-connection.md index 61d43b530d8b5..b8a3c0deb9d1e 100644 --- a/tidb-cloud/serverless-private-link-connection.md +++ b/tidb-cloud/serverless-private-link-connection.md @@ -11,17 +11,17 @@ Private link connections enable direct connectivity between {{{ .essential }}} a ## Private link connection types -Private link connections for dataflow are available in different types, depending on the cloud provider and the service you want to access. Each type enables secure and private network access between your TiDB Cloud cluster and external resources (for example, RDS or Kafka) in the same cloud environment. +Private link connections for dataflow are available in different types, depending on the cloud provider and the service you want to access. Each type enables secure and private network access between your {{{ .essential }}} instance and external resources (for example, RDS or Kafka) in the same cloud environment. ### AWS Endpoint Service -This type of private link connection enables TiDB Cloud clusters on **AWS** to connect to your [AWS endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html) powered by AWS PrivateLink. +This type of private link connection enables {{{ .essential }}} instances on **AWS** to connect to your [AWS endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html) powered by AWS PrivateLink. The private link connection can access various AWS services, such as RDS instances and Kafka services, by associating them with the endpoint service. ### Alibaba Cloud Endpoint Service -This type of private link connection enables TiDB Cloud clusters on **Alibaba Cloud** to connect to your [Alibaba Cloud endpoint service](https://www.alibabacloud.com/help/en/privatelink/share-your-service/#51976edba8no7) powered by Alibaba Cloud PrivateLink. +This type of private link connection enables {{{ .essential }}} instances on **Alibaba Cloud** to connect to your [Alibaba Cloud endpoint service](https://www.alibabacloud.com/help/en/privatelink/share-your-service/#51976edba8no7) powered by Alibaba Cloud PrivateLink. The private link connection can access various Alibaba Cloud services, such as RDS instances and Kafka services, by associating them with the endpoint service. @@ -31,9 +31,9 @@ You can create an AWS Endpoint Service private link connection using the TiDB Cl Ensure that the AWS endpoint service: -- Resides in the same region as your TiDB Cloud cluster. +- Resides in the same region as your {{{ .essential }}} instance. - Add the TiDB Cloud account ID to the **Allow principals** list. -- Has availability zones that overlap with your TiDB Cloud cluster. +- Has availability zones that overlap with your {{{ .essential }}} instance. You can get the account ID and availability zones information at the bottom of the **Create Private Link Connection** dialog, or by running the following command: @@ -44,7 +44,7 @@ ticloud serverless private-link-connection zones --cluster-id
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -57,7 +57,7 @@ ticloud serverless private-link-connection zones --cluster-id 4. In the **Create Private Link Connection** dialog, enter the required information: - **Private Link Connection Name**: enter a name for the private link connection. - - **Connection Type**: select **AWS Endpoint Service**. If this option is not displayed, ensure that your cluster is created on AWS. + - **Connection Type**: select **AWS Endpoint Service**. If this option is not displayed, ensure that your {{{ .essential }}} instance is created on AWS. - **Endpoint Service Name**: enter your AWS endpoint service name, for example, `com.amazonaws.vpce..vpce-svc-xxxxxxxxxxxxxxxxx`. 5. Click **Create**. @@ -87,9 +87,9 @@ You can create an Alibaba Cloud Endpoint Service private link connection using t Ensure that the Alibaba Cloud endpoint service: -- Resides in the same region as your TiDB Cloud cluster. +- Resides in the same region as your {{{ .essential }}} instance. - Add the TiDB Cloud account ID to the **Service Whitelist**. -- Has availability zones that overlap with your TiDB Cloud cluster. +- Has availability zones that overlap with your {{{ .essential }}} instance. You can get the account ID and available zones information at the bottom of the **Create Private Link Connection** dialog, or by running the following command: @@ -100,7 +100,7 @@ ticloud serverless private-link-connection zones --cluster-id
-1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -113,7 +113,7 @@ ticloud serverless private-link-connection zones --cluster-id 4. In the **Create Private Link Connection** dialog, enter the required information: - **Private Link Connection Name**: enter a name for the private link connection. - - **Connection Type**: select **Alibaba Cloud Endpoint Service**. If this option is not displayed, ensure that your cluster is created on Alibaba Cloud. + - **Connection Type**: select **Alibaba Cloud Endpoint Service**. If this option is not displayed, ensure that your {{{ .essential }}} instance is created on Alibaba Cloud. - **Endpoint Service Name**: enter the Alibaba Cloud endpoint service name, for example, `com.aliyuncs.privatelink..epsrv-xxxxxxxxxxxxxxxxx`. 5. Click **Create**. @@ -157,7 +157,7 @@ You can attach domains to a private link connection using the TiDB Cloud console To attach domains to a private link connection using the TiDB Cloud console, do the following: -1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -210,7 +210,7 @@ You can detach domains from a private link connection using the TiDB Cloud conso To detach domains from a private link connection using the TiDB Cloud console, do the following: -1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -252,7 +252,7 @@ You can delete a private link connection using the TiDB Cloud console or the TiD To delete a private link connection using the TiDB Cloud console, do the following: -1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > diff --git a/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md b/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md index 4af012f718bad..a88375068c398 100644 --- a/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md +++ b/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md @@ -1,15 +1,15 @@ --- title: Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint -summary: Learn how to connect to your TiDB Cloud cluster via Alibaba Cloud private endpoint. +summary: Learn how to connect to your {{{ .starter }}} or Essential instance via Alibaba Cloud private endpoint. --- # Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint -This tutorial walks you through the steps to connect to your {{{ .starter }}} or Essential cluster via a private endpoint on Alibaba Cloud. Connecting through a private endpoint allows secure and private communication between your services and your TiDB Cloud cluster without using the public internet. +This tutorial walks you through the steps to connect to your {{{ .starter }}} or Essential instance via a private endpoint on Alibaba Cloud. Connecting through a private endpoint allows secure and private communication between your services and your {{{ .starter }}} or Essential instance without using the public internet. > **Tip:** > -> To learn how to connect to a {{{ .starter }}} or Essential cluster via AWS PrivateLink, see [Connect to TiDB Cloud via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). +> To learn how to connect to a {{{ .starter }}} or Essential instance via AWS PrivateLink, see [Connect to TiDB Cloud via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). ## Restrictions @@ -18,15 +18,15 @@ This tutorial walks you through the steps to connect to your {{{ .starter }}} or ## Set up a private endpoint with Alibaba Cloud -To connect to your {{{ .starter }}} or {{{ .essential }}} cluster via a private endpoint, follow these steps: +To connect to your {{{ .starter }}} or {{{ .essential }}} instance via a private endpoint, follow these steps: -1. [Choose a TiDB cluster](#step-1-choose-a-tidb-cluster) +1. [Choose a {{{ .starter }}} or Essential instance](#step-1-choose-a-instancer) 2. [Create a private endpoint on Alibaba Cloud](#step-2-create-a-private-endpoint-on-alibaba-cloud) -3. [Connect to your TiDB cluster using the private endpoint](#step-3-connect-to-your-tidb-cluster-using-the-private-endpoint) +3. [Connect to your {{{ .starter }}} or Essential instance using the private endpoint](#step-3-connect-to-your-instance-using-the-private-endpoint) -### Step 1. Choose a TiDB cluster +### Step 1. Choose a {{{ .starter }}} or Essential instance {#step-1-choose-a-instance} -1. On the [**Clusters**](https://{{{.console-url}}}/project/clusters) page, click the name of your target TiDB Cloud cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. 3. In the **Connection Type** drop-down list, select **Private Endpoint**. 4. Take a note of **Service Name**, **Availability Zone ID**, and **Region ID**. @@ -39,7 +39,7 @@ To use the Alibaba Cloud Management Console to create a VPC interface endpoint, 2. Navigate to **VPC** > **Endpoints**. 3. Under the **Interface Endpoints** tab, click **Create Endpoint**. 4. Fill out the endpoint information: - - **Region**: select the same region as your TiDB Cloud cluster. + - **Region**: select the same region as your {{{ .starter }}} or Essential instance. - **Endpoint Name**: choose a name for the endpoint. - **Endpoint Type**: select **Interface Endpoint**. - **Endpoint Service**: select **Other Endpoint Services**. @@ -50,15 +50,15 @@ To use the Alibaba Cloud Management Console to create a VPC interface endpoint, 8. Click **OK** to create the endpoint. 9. Wait for the endpoint status to become **Active** and the connection status to become **Connected**. -### Step 3: Connect to your TiDB cluster using the private endpoint +### Step 3: Connect to your {{{ .starter }}} or Essential instance using the private endpoint {#step-3-connect-to-your-instance-using-the-private-endpoint} After you have created the interface endpoint, go back to the TiDB Cloud console and take the following steps: -1. On the [**Clusters**](https://{{{.console-url}}}/project/clusters) page, click the name of your target cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. 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. For the host, go to the **Endpoint Details** page in Alibaba Cloud, and copy the **Domain Name of Endpoint Service** as your host. -5. Connect to your cluster with the connection string. +5. Connect to your {{{ .starter }}} or Essential instance with the connection string. diff --git a/tidb-cloud/set-up-private-endpoint-connections-on-azure.md b/tidb-cloud/set-up-private-endpoint-connections-on-azure.md index cb0d0d68e08a9..c83e956435627 100644 --- a/tidb-cloud/set-up-private-endpoint-connections-on-azure.md +++ b/tidb-cloud/set-up-private-endpoint-connections-on-azure.md @@ -13,7 +13,7 @@ This document describes how to connect to your TiDB Cloud Dedicated cluster via > > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with AWS, see [Connect to a TiDB Cloud Dedicated Cluster via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md). > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with Google Cloud, see [Connect to a TiDB Cloud Dedicated Cluster via Google Cloud Private Service Connect](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md) -> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, see the following documents: +> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} instance via private endpoint, see the following documents: > - [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) > - [Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) @@ -25,7 +25,7 @@ This document describes how to connect to your TiDB Cloud Dedicated cluster via > > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with AWS, see [Connect to a TiDB Cloud Dedicated Cluster via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md). > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with Google Cloud, see [Connect to a TiDB Cloud Dedicated Cluster via Google Cloud Private Service Connect](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md) -> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, see [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). +> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} instance via private endpoint, see [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). @@ -61,7 +61,7 @@ If you have multiple clusters, you need to repeat these steps for each cluster t ### Step 1. Select a TiDB cluster -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target TiDB cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. 3. In the **Connection Type** drop-down list, select **Private Endpoint**, and then click **Create Private Endpoint Connection** to open the **Create Azure Private Endpoint Connection** dialog. diff --git a/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md b/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md index 82cfad4bcb797..9c6c9eba0a4af 100644 --- a/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md +++ b/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md @@ -13,7 +13,7 @@ This document describes how to connect to your TiDB Cloud Dedicated cluster via > > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with AWS, see [Connect to a TiDB Cloud Dedicated Cluster via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md). > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with Azure, see [Connect to a TiDB Cloud Dedicated Cluster via Azure Private Link](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md). -> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, see the following documents: +> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} instance via private endpoint, see the following documents: > - [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) > - [Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) @@ -25,7 +25,7 @@ This document describes how to connect to your TiDB Cloud Dedicated cluster via > > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with AWS, see [Connect to a TiDB Cloud Dedicated Cluster via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md). > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with Azure, see [Connect to a TiDB Cloud Dedicated Cluster via Azure Private Link](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md). -> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, see [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). +> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} instance via private endpoint, see [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). @@ -94,7 +94,7 @@ Before you begin to create an endpoint: ### Step 1. Select a TiDB cluster -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target TiDB cluster to go to its overview page. You can select a cluster with any of the following statuses: +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. You can select a cluster with any of the following statuses: - **Available** - **Restoring** diff --git a/tidb-cloud/set-up-private-endpoint-connections-serverless.md b/tidb-cloud/set-up-private-endpoint-connections-serverless.md index a55c18dd54508..5c69727c1976b 100644 --- a/tidb-cloud/set-up-private-endpoint-connections-serverless.md +++ b/tidb-cloud/set-up-private-endpoint-connections-serverless.md @@ -1,11 +1,11 @@ --- title: Connect to {{{ .starter }}} or Essential via AWS PrivateLink -summary: Learn how to connect to your TiDB Cloud cluster via private endpoint. +summary: Learn how to connect to your {{{ .starter }}} or Essential instance via private endpoint. --- # Connect to {{{ .starter }}} or Essential via AWS PrivateLink -This document describes how to connect to your {{{ .starter }}} or {{{ .essential }}} cluster via AWS PrivateLink. +This document describes how to connect to your {{{ .starter }}} or {{{ .essential }}} instance via AWS PrivateLink. > **Tip:** > @@ -37,22 +37,22 @@ Make sure that DNS hostnames and DNS resolution are both enabled in your AWS VPC ## Set up a private endpoint with AWS -To connect to your {{{ .starter }}} or {{{ .essential }}} cluster via a private endpoint, follow these steps: +To connect to your {{{ .starter }}} or {{{ .essential }}} instance via a private endpoint, follow these steps: -1. [Choose a TiDB cluster](#step-1-choose-a-tidb-cluster) +1. [Choose a {{{ .starter }}} or Essential instance](#step-1-choose-a-tidb-x-instance) 2. [Create an AWS interface endpoint](#step-2-create-an-aws-interface-endpoint) -3. [Connect to your TiDB cluster](#step-3-connect-to-your-tidb-cluster) +3. [Connect to your {{{ .starter }}} or Essential instance](#step-3-connect-to-your-tidb) -### Step 1. Choose a TiDB cluster +### Step 1. Choose a {{{ .starter }}} or Essential instance {#step-1-choose-a-tidb-x-instance} -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page, click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} or {{{ .essential }}} instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. 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:** > - > You only need to create one private endpoint per AWS region, which can be shared by all {{{ .starter }}} or {{{ .essential }}} clusters located in the same region. + > You only need to create one private endpoint per AWS region, which can be shared by all {{{ .starter }}} or {{{ .essential }}} instances located in the same region. ### Step 2. Create an AWS interface endpoint @@ -72,7 +72,7 @@ To use the AWS Management Console to create a VPC interface endpoint, perform th 4. Enter the service name that you found in [step 1](#step-1-choose-a-tidb-cluster). 5. Click **Verify service**. 6. Select your VPC in the drop-down list. Expand **Additional settings** and select the **Enable DNS name** checkbox. -7. In the **Subnets** area, select the availability zone where your TiDB cluster is located, and select the Subnet ID. +7. In the **Subnets** area, select the availability zone where your {{{ .starter }}} or Essential instance is located, and select the Subnet ID. 8. Select your security group properly in the **Security groups** area. > **Note:** @@ -102,25 +102,25 @@ aws ec2 create-vpc-endpoint --vpc-id ${your_vpc_id} --region ${region_id} --serv Then you can connect to the endpoint service with the private DNS name. -### Step 3: Connect to your TiDB cluster +### Step 3: Connect to your {{{ .starter }}} or Essential instance {#step-3-connect-to-your-tidb} After you have created the interface endpoint, go back to the TiDB Cloud console and take the following steps: -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page, click the name of your target cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} or Essential instance to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. 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. +5. Connect to your {{{ .starter }}} or Essential instance with the connection string. > **Tip:** > -> If you cannot connect to the cluster, the reason might be that the security group of your VPC endpoint in AWS is not properly set. See [this FAQ](#troubleshooting) for solutions. +> If you cannot connect to the {{{ .starter }}} or Essential instance, the reason might be that the security group of your VPC endpoint in AWS is not properly set. See [this FAQ](#troubleshooting) for solutions. > > When creating a VPC endpoint, if you encounter an error `private-dns-enabled cannot be set because there is already a conflicting DNS domain for gatewayXX-privatelink.XX.prod.aws.tidbcloud.com in the VPC vpc-XXXXX`, it is due to that a private endpoint has already been created, and creating a new one is unnecessary. ## Troubleshooting -### I cannot connect to a TiDB cluster via a private endpoint after enabling private DNS. Why? +### I cannot connect to a {{{ .starter }}} or Essential instance via a private endpoint after enabling private DNS. Why? You might need to properly set the security group for your VPC endpoint in the AWS Management Console. Go to **VPC** > **Endpoints**. Right-click your VPC endpoint and select the proper **Manage security groups**. A proper security group within your VPC that allows inbound access from your EC2 instances on Port 4000 or a customer-defined port. diff --git a/tidb-cloud/set-up-private-endpoint-connections.md b/tidb-cloud/set-up-private-endpoint-connections.md index ecc47ba6cca76..6acd61ffd113e 100644 --- a/tidb-cloud/set-up-private-endpoint-connections.md +++ b/tidb-cloud/set-up-private-endpoint-connections.md @@ -9,7 +9,7 @@ This document describes how to connect to your TiDB Cloud Dedicated cluster via > **Tip:** > -> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via AWS PrivateLink, see [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). +> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} instance via AWS PrivateLink, see [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with Azure, see [Connect to a TiDB Cloud Dedicated Cluster via Azure Private Link](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md). > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with Google Cloud, see [Connect to a TiDB Cloud Dedicated Cluster via Google Cloud Private Service Connect](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md). @@ -55,7 +55,7 @@ If you have multiple clusters, you need to repeat these steps for each cluster t ### Step 1. Select a TiDB cluster -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target TiDB cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A connection dialog is displayed. 3. In the **Connection Type** drop-down list, select **Private Endpoint**, and then click **Create Private Endpoint Connection**. diff --git a/tidb-cloud/set-up-sink-private-endpoint.md b/tidb-cloud/set-up-sink-private-endpoint.md index b70b45da96ce0..e6481ebe21534 100644 --- a/tidb-cloud/set-up-sink-private-endpoint.md +++ b/tidb-cloud/set-up-sink-private-endpoint.md @@ -63,7 +63,7 @@ If the Private Endpoint Service is not available for your downstream service, fo 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/). -2. On the [**Clusters**](https://tidbcloud.com/project/clusters) page, click the name of your target cluster to go to its overview page. +2. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. > **Tip:** > diff --git a/tidb-cloud/set-up-vpc-peering-connections.md b/tidb-cloud/set-up-vpc-peering-connections.md index 59b41e57a50dc..29b4d515f3f70 100644 --- a/tidb-cloud/set-up-vpc-peering-connections.md +++ b/tidb-cloud/set-up-vpc-peering-connections.md @@ -90,7 +90,7 @@ You can add VPC peering requests on either the project-level **Network Access** 1. Open the overview page of the target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -279,7 +279,7 @@ You can add VPC peering requests on either the project-level **Network Access** 1. Open the overview page of the target cluster. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -322,7 +322,7 @@ Now you have successfully set up the VPC peering connection. Next, [connect to t ## Connect to the TiDB cluster -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner, and select **VPC Peering** from the **Connection Type** drop-down list. diff --git a/tidb-cloud/setup-azure-self-hosted-kafka-private-link-service.md b/tidb-cloud/setup-azure-self-hosted-kafka-private-link-service.md index 193f09712e5c6..03862ae5c3ffd 100644 --- a/tidb-cloud/setup-azure-self-hosted-kafka-private-link-service.md +++ b/tidb-cloud/setup-azure-self-hosted-kafka-private-link-service.md @@ -34,7 +34,7 @@ The document provides an example of connecting to a Kafka Private Link service i 3. Get the Kafka deployment information from your [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) cluster. - 1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. + 1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the left navigation pane, click **Data** > **Changefeed**. 3. On the **Changefeed** page, click **Create Changefeed** in the upper-right corner, and then provide the following information: 1. In **Destination**, select **Kafka**. diff --git a/tidb-cloud/setup-self-hosted-kafka-private-service-connect.md b/tidb-cloud/setup-self-hosted-kafka-private-service-connect.md index 5615b2291f4ca..c6f2967f1f49c 100644 --- a/tidb-cloud/setup-self-hosted-kafka-private-service-connect.md +++ b/tidb-cloud/setup-self-hosted-kafka-private-service-connect.md @@ -37,7 +37,7 @@ The document provides an example of connecting to a Kafka Private Service Connec 3. Get the Kafka deployment information from your TiDB Cloud Dedicated cluster. - 1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. + 1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. On the overview page, find the region of the TiDB cluster. Ensure that your Kafka cluster will be deployed to the same region. 3. Click **Data** > **Changefeed** in the left navigation pane, click **Create Changefeed** in the upper-right corner, and then provide the following information: 1. In **Destination**, select **Kafka**. diff --git a/tidb-cloud/size-your-cluster.md b/tidb-cloud/size-your-cluster.md index 7584ae528aeb6..25c44e0ec2645 100644 --- a/tidb-cloud/size-your-cluster.md +++ b/tidb-cloud/size-your-cluster.md @@ -9,7 +9,7 @@ This document describes how to determine the size of a TiDB Cloud Dedicated clus > **Note:** > -> You cannot change the size of a {{{ .starter }}} or {{{ .essential }}} cluster. +> You cannot change the size of a {{{ .starter }}} or {{{ .essential }}} instance. ## Size TiDB @@ -40,7 +40,7 @@ The supported vCPU and RAM sizes include the following: > - 4 vCPU TiDB can only be used with 4 vCPU TiKV. > - TiFlash is unavailable. > -> The **4 vCPU, 16 GiB** size of TiDB is designed for learning, testing, and trial purposes. It is suitable for pre-production environments or small, non-critical workloads. However, it is **NOT** recommended for full-scale production due to performance limitations. If you need lower costs and an SLA guarantee for production, consider using the [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) cluster plan. +> The **4 vCPU, 16 GiB** size of TiDB is designed for learning, testing, and trial purposes. It is suitable for pre-production environments or small, non-critical workloads. However, it is **NOT** recommended for full-scale production due to performance limitations. If you need lower costs and an SLA guarantee for production, consider using the [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) plan. ### TiDB node count @@ -106,7 +106,7 @@ The supported vCPU and RAM sizes include the following: > - 4 vCPU TiKV can only be used with 4 vCPU TiDB. > - TiFlash is unavailable. > -> The **4 vCPU, 16 GiB** size of TiKV is designed for learning, testing, and trial purposes. It is suitable for pre-production environments or small, non-critical workloads. However, it is **NOT** recommended for full-scale production due to performance limitations. If you need lower costs and an SLA guarantee for production, consider using the [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) cluster plan. +> The **4 vCPU, 16 GiB** size of TiKV is designed for learning, testing, and trial purposes. It is suitable for pre-production environments or small, non-critical workloads. However, it is **NOT** recommended for full-scale production due to performance limitations. If you need lower costs and an SLA guarantee for production, consider using the [TiDB Cloud Essential](/tidb-cloud/select-cluster-tier.md#essential) plan. ### TiKV node count diff --git a/tidb-cloud/sql-proxy-account.md b/tidb-cloud/sql-proxy-account.md index 814b24c5303b2..7a8a8df9f8873 100644 --- a/tidb-cloud/sql-proxy-account.md +++ b/tidb-cloud/sql-proxy-account.md @@ -64,7 +64,7 @@ Examples: > **Note:** > -> In the preceding table, `{user_name_prefix}` is a unique prefix generated by TiDB Cloud to distinguish {{{ .starter }}} clusters. For details, see the [user name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix) of {{{ .starter }}} clusters. +> In the preceding table, `{user_name_prefix}` is a unique prefix generated by TiDB Cloud to distinguish {{{ .starter }}} instances. For details, see the [user name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix) of {{{ .starter }}} instances. ## SQL proxy account password diff --git a/tidb-cloud/terraform-use-backup-resource.md b/tidb-cloud/terraform-use-backup-resource.md index 5ba7c3c9d9539..d9ff7beace6eb 100644 --- a/tidb-cloud/terraform-use-backup-resource.md +++ b/tidb-cloud/terraform-use-backup-resource.md @@ -15,7 +15,7 @@ The features of the `tidbcloud_backup` resource include the following: ## Prerequisites - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md). -- The backup and restore feature introduced in this document is unavailable to {{{ .starter }}} or {{{ .essential }}} clusters. To use `tidbcloud_backup` resources, make sure that you have created a TiDB Cloud Dedicated cluster. +- The backup and restore feature introduced in this document is unavailable to {{{ .starter }}} or {{{ .essential }}} instances. To use `tidbcloud_backup` resources, make sure that you have created a TiDB Cloud Dedicated cluster. ## Create a backup with the `tidbcloud_backup` resource diff --git a/tidb-cloud/terraform-use-cluster-resource.md b/tidb-cloud/terraform-use-cluster-resource.md index dda82b82dba80..ffbc1aaae1bd6 100644 --- a/tidb-cloud/terraform-use-cluster-resource.md +++ b/tidb-cloud/terraform-use-cluster-resource.md @@ -15,9 +15,9 @@ In addition, you will also learn how to get the necessary information with the ` The features of the `tidbcloud_cluster` resource include the following: -- Create {{{ .starter }}} and TiDB Cloud Dedicated clusters. +- Create {{{ .starter }}} instances and TiDB Cloud Dedicated clusters. - Modify TiDB Cloud Dedicated clusters. -- Delete {{{ .starter }}} and TiDB Cloud Dedicated clusters. +- Delete {{{ .starter }}} instances and TiDB Cloud Dedicated clusters. ## Prerequisites diff --git a/tidb-cloud/terraform-use-import-resource.md b/tidb-cloud/terraform-use-import-resource.md index 164008b209e49..4db8d19a5357f 100644 --- a/tidb-cloud/terraform-use-import-resource.md +++ b/tidb-cloud/terraform-use-import-resource.md @@ -17,7 +17,7 @@ The features of the `tidbcloud_import` resource include the following: - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md). - Refer to one of the following documents to create a TiDB Cloud cluster: - - [Create a {{{ .starter }}} or Essential cluster](/tidb-cloud/create-tidb-cluster-serverless.md) + - [Create a {{{ .starter }}} or Essential instance](/tidb-cloud/create-tidb-cluster-serverless.md) - [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). ## Create and run an import task @@ -28,7 +28,7 @@ You can manage either a local import task or an Amazon S3 import task using the > **Note:** > -> Importing local files is supported only for {{{ .starter }}} or {{{ .essential }}} clusters, not for TiDB Cloud Dedicated clusters. +> Importing local files is supported only for {{{ .starter }}} or {{{ .essential }}} instances, not for TiDB Cloud Dedicated clusters. 1. Create a CSV file for import. For example: diff --git a/tidb-cloud/terraform-use-restore-resource.md b/tidb-cloud/terraform-use-restore-resource.md index 22ae8a74f230a..789d3ae00c317 100644 --- a/tidb-cloud/terraform-use-restore-resource.md +++ b/tidb-cloud/terraform-use-restore-resource.md @@ -14,7 +14,7 @@ The features of the `tidbcloud_restore` resource include the following: ## Prerequisites - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md). -- The backup and restore feature introduced in this document is unavailable for {{{ .starter }}} and {{{ .essential }}} clusters. To use `tidbcloud_restore` resources, make sure that you have created a TiDB Cloud Dedicated cluster. +- The backup and restore feature introduced in this document is unavailable for {{{ .starter }}} and {{{ .essential }}} instances. To use `tidbcloud_restore` resources, make sure that you have created a TiDB Cloud Dedicated cluster. ## Create a restore task diff --git a/tidb-cloud/terraform-use-serverless-branch-resource.md b/tidb-cloud/terraform-use-serverless-branch-resource.md index 4cbfd5e611d72..aa901689bcdd0 100644 --- a/tidb-cloud/terraform-use-serverless-branch-resource.md +++ b/tidb-cloud/terraform-use-serverless-branch-resource.md @@ -20,7 +20,7 @@ The features of the `tidbcloud_serverless_branch` resource include the following ## Prerequisites - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md) v0.4.0 or later. -- [Create a {{{ .starter }}} or {{{ .essential }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md). +- [Create a {{{ .starter }}} or {{{ .essential }}} instance](/tidb-cloud/create-tidb-cluster-serverless.md). ## Create a {{{ .starter }}} or {{{ .essential }}} branch diff --git a/tidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.md b/tidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.md index 3772bc598812d..184f076c2467a 100644 --- a/tidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.md +++ b/tidb-cloud/terraform-use-serverless-cluster-resource-manage-essential.md @@ -1,20 +1,20 @@ --- title: Use the `tidbcloud_serverless_cluster` Resource -summary: Learn how to use the `tidbcloud_serverless_cluster` resource to create and modify a {{{ .essential }}} cluster. +summary: Learn how to use the `tidbcloud_serverless_cluster` resource to create and modify a {{{ .essential }}} instance. --- # Use the `tidbcloud_serverless_cluster` Resource -This document describes how to manage a [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) cluster with the `tidbcloud_serverless_cluster` resource. +This document describes how to manage a [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) instance with the `tidbcloud_serverless_cluster` resource. You will also learn how to get the necessary information with the `tidbcloud_projects` data source. The features of the `tidbcloud_serverless_cluster` resource include the following: -- Create {{{ .essential }}} clusters. -- Modify {{{ .essential }}} clusters. -- Import {{{ .essential }}} clusters. -- Delete {{{ .essential }}} clusters. +- Create {{{ .essential }}} instances. +- Modify {{{ .essential }}} instances. +- Import {{{ .essential }}} instances. +- Delete {{{ .essential }}} instances. ## Prerequisites @@ -22,7 +22,7 @@ The features of the `tidbcloud_serverless_cluster` resource include the followin ## Get project IDs using the `tidbcloud_projects` data source -Each TiDB cluster belongs to a project. Before creating a {{{ .essential }}} cluster, you need to obtain the ID of the project where you want to create the cluster. If no `project_id` is specified, the default project will be used. +Each {{{ .essential }}} instance belongs to a project. Before creating a {{{ .essential }}} instance, you need to obtain the ID of the project where you want to create the {{{ .essential }}} instance. If no `project_id` is specified, the default project will be used. To retrieve the information about all available projects, use the `tidbcloud_projects` data source as follows: @@ -119,11 +119,11 @@ To retrieve the information about all available projects, use the `tidbcloud_pro Now, you can get all the available projects from the output. Copy one of the project IDs that you need. -## Create a {{{ .essential }}} cluster +## Create a {{{ .essential }}} instance -You can create a {{{ .essential }}} cluster using the `tidbcloud_serverless_cluster` resource. +You can create a {{{ .essential }}} instance using the `tidbcloud_serverless_cluster` resource. -1. Create a directory for the cluster and enter it. +1. Create a directory for the {{{ .essential }}} instance and enter it. 2. Create a `cluster.tf` file. @@ -160,7 +160,7 @@ You can create a {{{ .essential }}} cluster using the `tidbcloud_serverless_clus - To use the `tidbcloud_serverless_cluster` resource, set the resource type as `tidbcloud_serverless_cluster`. - For the resource name, you can define it as needed. For example, `example`. - - For resource details, you can configure them according to the Project ID and the [`tidbcloud_serverless_cluster` specification](https://registry.terraform.io/providers/tidbcloud/tidbcloud/latest/docs/resources/serverless_cluster). To create a {{{ .essential }}} cluster, you must specify the `auto_scaling` attribute in resource details. + - For resource details, you can configure them according to the Project ID and the [`tidbcloud_serverless_cluster` specification](https://registry.terraform.io/providers/tidbcloud/tidbcloud/latest/docs/resources/serverless_cluster). To create a {{{ .essential }}} instance, you must specify the `auto_scaling` attribute in resource details. 3. Run the `terraform apply` command. It is not recommended to use `terraform apply --auto-approve` when you apply a resource. @@ -291,16 +291,16 @@ You can create a {{{ .essential }}} cluster using the `tidbcloud_serverless_clus } ``` -## Modify a {{{ .essential }}} cluster +## Modify a {{{ .essential }}} instance -For a {{{ .essential }}} cluster, you can use Terraform to manage resources. The arguments that you can modify include: +For a {{{ .essential }}} instance, you can use Terraform to manage resources. The arguments that you can modify include: -- `display_name`: The display name of the cluster. -- `auto_scaling`: The auto scaling configuration of the cluster. +- `display_name`: The display name of the {{{ .essential }}} instance. +- `auto_scaling`: The auto scaling configuration of the {{{ .essential }}} instance. - `endpoints.public.disabled`: Whether to disable the public endpoint. - `automated_backup_policy.start_time`: The UTC time of day in `HH:mm` format when the automated backup starts. -To modify a {{{ .essential }}} cluster, you can modify the configuration of the `tidbcloud_serverless_cluster` resource, then use the `terraform apply` command to apply the changes. For example, you can modify the `display_name` and `auto_scaling` as follows: +To modify a {{{ .essential }}} instance, you can modify the configuration of the `tidbcloud_serverless_cluster` resource, then use the `terraform apply` command to apply the changes. For example, you can modify the `display_name` and `auto_scaling` as follows: ``` resource "tidbcloud_serverless_cluster" "example" { @@ -423,9 +423,9 @@ resource "tidbcloud_serverless_cluster" "example" { } ``` -## Import a {{{ .essential }}} cluster +## Import a {{{ .essential }}} instance -For a {{{ .essential }}} cluster that is not managed by Terraform, you can bring it under Terraform management by importing it. +For a {{{ .essential }}} instance that is not managed by Terraform, you can bring it under Terraform management by importing it. 1. Add an import block for the new `tidbcloud_serverless_cluster` resource. @@ -461,11 +461,11 @@ For a {{{ .essential }}} cluster that is not managed by Terraform, you can bring Apply complete! Resources: 1 imported, 0 added, 0 changed, 0 destroyed. ``` -Now you can manage the imported cluster with Terraform. +Now you can manage the imported {{{ .essential }}} instance with Terraform. -## Delete a {{{ .essential }}} cluster +## Delete a {{{ .essential }}} instance -To delete a {{{ .essential }}} cluster, you can delete the configuration of the `tidbcloud_serverless_cluster` resource, then use the `terraform apply` command to destroy the resource: +To delete a {{{ .essential }}} instance, you can delete the configuration of the `tidbcloud_serverless_cluster` resource, then use the `terraform apply` command to destroy the resource: ```shell $ terraform apply diff --git a/tidb-cloud/terraform-use-serverless-cluster-resource.md b/tidb-cloud/terraform-use-serverless-cluster-resource.md index aa7b992e2a001..77938a1d41f1f 100644 --- a/tidb-cloud/terraform-use-serverless-cluster-resource.md +++ b/tidb-cloud/terraform-use-serverless-cluster-resource.md @@ -1,20 +1,20 @@ --- title: Use the `tidbcloud_serverless_cluster` Resource -summary: Learn how to use the `tidbcloud_serverless_cluster` resource to create and modify a {{{ .starter }}} cluster. +summary: Learn how to use the `tidbcloud_serverless_cluster` resource to create and modify a {{{ .starter }}} instance. --- # Use the `tidbcloud_serverless_cluster` Resource -This document describes how to manage a [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) cluster with the `tidbcloud_serverless_cluster` resource. +This document describes how to manage a [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) instance with the `tidbcloud_serverless_cluster` resource. You will also learn how to get the necessary information with the `tidbcloud_projects` data source. The features of the `tidbcloud_serverless_cluster` resource include the following: -- Create {{{ .starter }}} clusters. -- Modify {{{ .starter }}} clusters. -- Import {{{ .starter }}} clusters. -- Delete {{{ .starter }}} clusters. +- Create {{{ .starter }}} instances. +- Modify {{{ .starter }}} instances. +- Import {{{ .starter }}} instances. +- Delete {{{ .starter }}} instances. ## Prerequisites @@ -22,7 +22,7 @@ The features of the `tidbcloud_serverless_cluster` resource include the followin ## Get project IDs using the `tidbcloud_projects` data source -Each TiDB cluster belongs to a project. Before creating a {{{ .starter }}} cluster, you need to obtain the ID of the project where you want to create the cluster. If no `project_id` is specified, the default project will be used. +Each {{{ .starter }}} instance belongs to a project. Before creating a {{{ .starter }}} instance, you need to obtain the ID of the project where you want to create the {{{ .starter }}} instance. If no `project_id` is specified, the default project will be used. To retrieve the information about all available projects, use the `tidbcloud_projects` data source as follows: @@ -119,11 +119,11 @@ To retrieve the information about all available projects, use the `tidbcloud_pro Now, you can get all the available projects from the output. Copy one of the project IDs that you need. -## Create a {{{ .starter }}} cluster +## Create a {{{ .starter }}} instance -You can create a {{{ .starter }}} cluster using the `tidbcloud_serverless_cluster` resource. +You can create a {{{ .starter }}} instance using the `tidbcloud_serverless_cluster` resource. -1. Create a directory for the cluster and enter it. +1. Create a directory for the {{{ .starter }}} instance and enter it. 2. Create a `cluster.tf` file. @@ -288,16 +288,16 @@ You can create a {{{ .starter }}} cluster using the `tidbcloud_serverless_cluste } ``` -## Modify a {{{ .starter }}} cluster +## Modify a {{{ .starter }}} instance -For a {{{ .starter }}} cluster, you can use Terraform to manage resources. The arguments that you can modify include: +For a {{{ .starter }}} instance, you can use Terraform to manage resources. The arguments that you can modify include: -- `display_name`: The display name of the cluster. -- `spending_limit`: The spending limit of the cluster. +- `display_name`: The display name of the {{{ .starter }}} instance. +- `spending_limit`: The spending limit of the {{{ .starter }}} instance. - `endpoints.public.disabled`: Whether to disable the public endpoint. - `automated_backup_policy.start_time`: The UTC time of day in `HH:mm` format when the automated backup starts. -To modify a {{{ .starter }}} cluster, you can modify the configuration of the `tidbcloud_serverless_cluster` resource, then use the `terraform apply` command to apply the changes. For example, you can modify the `display_name` and `spending_limit` as follows: +To modify a {{{ .starter }}} instance, you can modify the configuration of the `tidbcloud_serverless_cluster` resource, then use the `terraform apply` command to apply the changes. For example, you can modify the `display_name` and `spending_limit` as follows: ``` resource "tidbcloud_serverless_cluster" "example" { @@ -417,9 +417,9 @@ resource "tidbcloud_serverless_cluster" "example" { } ``` -## Import a {{{ .starter }}} cluster +## Import a {{{ .starter }}} instance -For a {{{ .starter }}} cluster that is not managed by Terraform, you can bring it under Terraform management by importing it. +For a {{{ .starter }}} instance that is not managed by Terraform, you can bring it under Terraform management by importing it. 1. Add an import block for the new `tidbcloud_serverless_cluster` resource. @@ -455,11 +455,11 @@ For a {{{ .starter }}} cluster that is not managed by Terraform, you can bring i Apply complete! Resources: 1 imported, 0 added, 0 changed, 0 destroyed. ``` -Now you can manage the imported cluster with Terraform. +Now you can manage the imported {{{ .starter }}} instance with Terraform. -## Delete a {{{ .starter }}} cluster +## Delete a {{{ .starter }}} instance -To delete a {{{ .starter }}} cluster, you can delete the configuration of the `tidbcloud_serverless_cluster` resource, then use the `terraform apply` command to destroy the resource: +To delete a {{{ .starter }}} instance, you can delete the configuration of the `tidbcloud_serverless_cluster` resource, then use the `terraform apply` command to destroy the resource: ```shell $ terraform apply diff --git a/tidb-cloud/terraform-use-serverless-export-resource.md b/tidb-cloud/terraform-use-serverless-export-resource.md index 6dc11c96d285f..9ae6937634bbb 100644 --- a/tidb-cloud/terraform-use-serverless-export-resource.md +++ b/tidb-cloud/terraform-use-serverless-export-resource.md @@ -1,17 +1,17 @@ --- title: Use `tidbcloud_serverless_export` Resource -summary: Learn how to use the `tidbcloud_serverless_export` resource to create and modify data export tasks for {{{ .starter }}} or {{{ .essential }}} clusters. +summary: Learn how to use the `tidbcloud_serverless_export` resource to create and modify data export tasks for {{{ .starter }}} or {{{ .essential }}} instances. --- # Use `tidbcloud_serverless_export` Resource -This document describes how to manage data export tasks for {{{ .starter }}} or {{{ .essential }}} clusters using the `tidbcloud_serverless_export` resource. +This document describes how to manage data export tasks for {{{ .starter }}} or {{{ .essential }}} instances using the `tidbcloud_serverless_export` resource. The features of the `tidbcloud_serverless_export` resource include the following: -- Create data export tasks for {{{ .starter }}} or {{{ .essential }}} clusters. -- Import data export tasks for {{{ .starter }}} or {{{ .essential }}} clusters. -- Delete data export tasks for {{{ .starter }}} or {{{ .essential }}} clusters. +- Create data export tasks for {{{ .starter }}} or {{{ .essential }}} instances. +- Import data export tasks for {{{ .starter }}} or {{{ .essential }}} instances. +- Delete data export tasks for {{{ .starter }}} or {{{ .essential }}} instances. > **Note:** > @@ -20,11 +20,11 @@ The features of the `tidbcloud_serverless_export` resource include the following ## Prerequisites - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md) v0.4.0 or later. -- [Create a {{{ .starter }}} or {{{ .essential }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md). +- [Create a {{{ .starter }}} or {{{ .essential }}} instance](/tidb-cloud/create-tidb-cluster-serverless.md). -## Create a data export task for a {{{ .starter }}} or {{{ .essential }}} cluster +## Create a data export task for a {{{ .starter }}} or {{{ .essential }}} instance -You can create a data export task for a {{{ .starter }}} or {{{ .essential }}} cluster using the `tidbcloud_serverless_export` resource. +You can create a data export task for a {{{ .starter }}} or {{{ .essential }}} instance using the `tidbcloud_serverless_export` resource. 1. Create a directory for the export and enter it. @@ -115,7 +115,7 @@ You can create a data export task for a {{{ .starter }}} or {{{ .essential }}} c Apply complete! Resources: 1 added, 0 changed, 0 destroyed. ``` - In this example, the `tidbcloud_serverless_export.example` resource will create an export task to export data from the entire cluster. + In this example, the `tidbcloud_serverless_export.example` resource will create an export task to export data from the entire {{{ .starter }}} or {{{ .essential }}} instance. This resource is not synchronized. You can use `terraform refresh` to retrieve its latest state. @@ -142,9 +142,9 @@ You can create a data export task for a {{{ .starter }}} or {{{ .essential }}} c } ``` -## Import a data export task for a {{{ .starter }}} or {{{ .essential }}} cluster +## Import a data export task for a {{{ .starter }}} or {{{ .essential }}} instance -If a data export task for a {{{ .starter }}} or {{{ .essential }}} cluster is not managed by Terraform, you can bring it under Terraform management by importing it. +If a data export task for a {{{ .starter }}} or {{{ .essential }}} instance is not managed by Terraform, you can bring it under Terraform management by importing it. 1. Add an import block for the new `tidbcloud_serverless_export` resource. @@ -182,9 +182,9 @@ If a data export task for a {{{ .starter }}} or {{{ .essential }}} cluster is no Now you can manage the imported export with Terraform. -## Delete a data export task for a {{{ .starter }}} or {{{ .essential }}} cluster +## Delete a data export task for a {{{ .starter }}} or {{{ .essential }}} instance -To delete a data export task for a {{{ .starter }}} or {{{ .essential }}} cluster, you can delete the configuration of the `tidbcloud_serverless_export` resource, then use the `terraform apply` command to destroy the resource: +To delete a data export task for a {{{ .starter }}} or {{{ .essential }}} instance, you can delete the configuration of the `tidbcloud_serverless_export` resource, then use the `terraform apply` command to destroy the resource: ```shell $ terraform apply diff --git a/tidb-cloud/terraform-use-sql-user-resource.md b/tidb-cloud/terraform-use-sql-user-resource.md index 4cfea3afeaba8..97c9093182ffa 100644 --- a/tidb-cloud/terraform-use-sql-user-resource.md +++ b/tidb-cloud/terraform-use-sql-user-resource.md @@ -18,7 +18,7 @@ The features of the `tidbcloud_sql_user` resource include the following: - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md) v0.4.0 or later. - Refer to one of the following documents to create a TiDB Cloud cluster: - - [Create a {{{ .starter }}} or Essential cluster](/tidb-cloud/create-tidb-cluster-serverless.md) + - [Create a {{{ .starter }}} or Essential instance](/tidb-cloud/create-tidb-cluster-serverless.md) - [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). ## Create a SQL user @@ -57,7 +57,7 @@ The following example shows how to create a TiDB Cloud SQL user. - To use the `tidbcloud_sql_user` resource, set the resource type as `tidbcloud_sql_user`. - For the resource name, you can define it as needed. For example, `example`. - - For SQL users in the {{{ .starter }}} or {{{ .essential }}} cluster, the `user_name` and builtin role `role_readonly` and `role_readwrite` must start with the user prefix, you can get the user prefix by running the `tidbcloud_serverless_cluster` data source. + - For SQL users in the {{{ .starter }}} or {{{ .essential }}} instance, the `user_name` and builtin role `role_readonly` and `role_readwrite` must start with the user prefix, you can get the user prefix by running the `tidbcloud_serverless_cluster` data source. - To get the SQL user specification information, see [`tidbcloud_sql_user` (Resource)](https://registry.terraform.io/providers/tidbcloud/tidbcloud/latest/docs/resources/sql_user). 3. Run the `terraform apply` command. It is not recommended to use `terraform apply --auto-approve` when you apply a resource. diff --git a/tidb-cloud/ticloud-branch-create.md b/tidb-cloud/ticloud-branch-create.md index 6c0bf7ca5707e..b260ecaf47e14 100644 --- a/tidb-cloud/ticloud-branch-create.md +++ b/tidb-cloud/ticloud-branch-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless branch create`. # ticloud serverless branch create -Create a [branch](/tidb-cloud/branch-overview.md) for a {{{ .starter }}} or {{{ .essential }}} cluster: +Create a [branch](/tidb-cloud/branch-overview.md) for a {{{ .starter }}} or {{{ .essential }}} instance: ```shell ticloud serverless branch create [flags] @@ -13,13 +13,13 @@ ticloud serverless branch create [flags] ## Examples -Create a branch for a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: +Create a branch for a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless branch create ``` -Create a branch for a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: +Create a branch for a {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode: ```shell ticloud serverless branch create --cluster-id --display-name diff --git a/tidb-cloud/ticloud-branch-delete.md b/tidb-cloud/ticloud-branch-delete.md index d1ad6e4b19c8e..8b8810b5bd74b 100644 --- a/tidb-cloud/ticloud-branch-delete.md +++ b/tidb-cloud/ticloud-branch-delete.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless branch delete`. # ticloud serverless branch delete -Delete a branch from your {{{ .starter }}} or {{{ .essential }}} cluster: +Delete a branch from your {{{ .starter }}} or {{{ .essential }}} instance: ```shell ticloud serverless branch delete [flags] diff --git a/tidb-cloud/ticloud-branch-describe.md b/tidb-cloud/ticloud-branch-describe.md index 911efdd04c349..924a2e8f126f6 100644 --- a/tidb-cloud/ticloud-branch-describe.md +++ b/tidb-cloud/ticloud-branch-describe.md @@ -19,13 +19,13 @@ ticloud serverless branch get [flags] ## Examples -Get branch information of a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: +Get branch information of a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless branch describe ``` -Get branch information of a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: +Get branch information of a {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode: ```shell ticloud serverless branch describe --branch-id --cluster-id diff --git a/tidb-cloud/ticloud-branch-list.md b/tidb-cloud/ticloud-branch-list.md index fbf7d462a8a0f..aaf323066d0dc 100644 --- a/tidb-cloud/ticloud-branch-list.md +++ b/tidb-cloud/ticloud-branch-list.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless branch list`. # ticloud serverless branch list -List all branches for a {{{ .starter }}} or {{{ .essential }}} cluster: +List all branches for a {{{ .starter }}} or {{{ .essential }}} instance: ```shell ticloud serverless branch list [flags] @@ -19,19 +19,19 @@ ticloud serverless branch ls [flags] ## Examples -List all branches for a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: +List all branches for a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless branch list ``` -List all branches for a specific {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: +List all branches for a specific {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode: ```shell ticloud serverless branch list -c ``` -List all branches for a specific {{{ .starter }}} or {{{ .essential }}} cluster in the JSON format: +List all branches for a specific {{{ .starter }}} or {{{ .essential }}} instance in the JSON format: ```shell ticloud serverless branch list -o json diff --git a/tidb-cloud/ticloud-branch-shell.md b/tidb-cloud/ticloud-branch-shell.md index dd1dfb0255c8c..06beac188e720 100644 --- a/tidb-cloud/ticloud-branch-shell.md +++ b/tidb-cloud/ticloud-branch-shell.md @@ -6,7 +6,7 @@ aliases: ['/tidbcloud/ticloud-connect'] # ticloud serverless branch shell -Connect to a branch of a {{{ .starter }}} or {{{ .essential }}} cluster: +Connect to a branch of a {{{ .starter }}} or {{{ .essential }}} instance: ```shell ticloud serverless branch shell [flags] diff --git a/tidb-cloud/ticloud-cluster-create.md b/tidb-cloud/ticloud-cluster-create.md index 78c6718cabb4a..29595d8fe50d5 100644 --- a/tidb-cloud/ticloud-cluster-create.md +++ b/tidb-cloud/ticloud-cluster-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless create`. # ticloud serverless create -Create a TiDB Cloud cluster: +Create a {{{ .starter }}} or Essential instance: ```shell ticloud serverless create [flags] @@ -13,25 +13,25 @@ ticloud serverless create [flags] ## Examples -Create a TiDB Cloud cluster in interactive mode: +Create a {{{ .starter }}} or Essential instance in interactive mode: ```shell ticloud serverless create ``` -Create a TiDB Cloud cluster in non-interactive mode: +Create a {{{ .starter }}} or Essential instance in non-interactive mode: ```shell ticloud serverless create --display-name --region ``` -Create a {{{ .starter }}} cluster with a spending limit in non-interactive mode: +Create a {{{ .starter }}} instance with a spending limit in non-interactive mode: ```shell ticloud serverless create --display-name --region --spending-limit-monthly ``` -Create a {{{ .essential }}} cluster in non-interactive mode: +Create a {{{ .essential }}} instance in non-interactive mode: ```shell ticloud serverless create --display-name --region --max-rcu --min-rcu @@ -43,14 +43,14 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |------------------------------|----------------------------------------------------------------------------------------------------------------|----------|-----------------------------------------------------| -| -n --display-name string | Specifies the name of the cluster to be created. | Yes | Only works in non-interactive mode. | +| -n --display-name string | Specifies the name of the {{{ .starter }}} or Essential instance to be created. | Yes | Only works in non-interactive mode. | | --spending-limit-monthly int | Specifies the maximum monthly spending limit in USD cents. | No | Only works in non-interactive mode. | -| -p, --project-id string | Specifies the ID of the project, in which the cluster will be created. The default value is `default project`. | No | Only works in non-interactive mode. | +| -p, --project-id string | Specifies the ID of the project, in which the {{{ .starter }}} or Essential instance will be created. The default value is `default project`. | No | Only works in non-interactive mode. | | -r, --region string | Specifies the name of the cloud region. You can view all available regions using the `ticloud serverless region` command. | Yes | Only works in non-interactive mode. | -| --disable-public-endpoint | Disables the public endpoint. Use this option if you want to prevent public access to the cluster. | No | Only works in non-interactive mode. | -| --encryption | Enables dual-layer data encryption. It is enabled by default for {{{ .essential }}} clusters, and disabled by default for {{{ .starter }}} clusters. | No | Only works in non-interactive mode. | -| --max-rcu int32 | Sets the maximum Request Capacity Units (RCUs) for the {{{ .essential }}} cluster, up to 100000. | No | Only works in non-interactive mode. | -| --min-rcu int32 | Sets the minimum Request Capacity Units (RCUs) for the {{{ .essential }}} cluster, at least 2000. | No | Only works in non-interactive mode. | +| --disable-public-endpoint | Disables the public endpoint. Use this option if you want to prevent public access to the {{{ .starter }}} or Essential instance. | No | Only works in non-interactive mode. | +| --encryption | Enables dual-layer data encryption. It is enabled by default for {{{ .essential }}} instances, and disabled by default for {{{ .starter }}} instances. | No | Only works in non-interactive mode. | +| --max-rcu int32 | Sets the maximum Request Capacity Units (RCUs) for the {{{ .essential }}} instance, up to 100000. | No | Only works in non-interactive mode. | +| --min-rcu int32 | Sets the minimum Request Capacity Units (RCUs) for the {{{ .essential }}} instance, at least 2000. | No | Only works in non-interactive mode. | | -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes | ## Inherited flags diff --git a/tidb-cloud/ticloud-cluster-delete.md b/tidb-cloud/ticloud-cluster-delete.md index eea820c386fd1..c31dedac27959 100644 --- a/tidb-cloud/ticloud-cluster-delete.md +++ b/tidb-cloud/ticloud-cluster-delete.md @@ -1,11 +1,11 @@ --- -title: ticloud serverless cluster delete +title: ticloud serverless delete summary: The reference of `ticloud serverless delete`. --- # ticloud serverless delete -Delete a {{{ .starter }}} or {{{ .essential }}} cluster from your project: +Delete a {{{ .starter }}} or {{{ .essential }}} instance from your project: ```shell ticloud serverless delete [flags] @@ -19,13 +19,13 @@ ticloud serverless rm [flags] ## Examples -Delete a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: +Delete a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless delete ``` -Delete a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: +Delete a {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode: ```shell ticloud serverless delete --cluster-id @@ -38,7 +38,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|----------------------------------------|----------|------------------------------------------------------| | -c, --cluster-id string | Specifies the ID of the cluster to be deleted. | Yes | Only works in non-interactive mode. | -| --force | Deletes a cluster without confirmation. | No | Works in both non-interactive and interactive modes. | +| --force | Deletes a {{{ .starter }}} or Essential instance without confirmation. | No | Works in both non-interactive and interactive modes. | | -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags diff --git a/tidb-cloud/ticloud-cluster-describe.md b/tidb-cloud/ticloud-cluster-describe.md index 064d382aaef71..4ff9ed07b1939 100644 --- a/tidb-cloud/ticloud-cluster-describe.md +++ b/tidb-cloud/ticloud-cluster-describe.md @@ -1,11 +1,11 @@ --- -title: ticloud serverless cluster describe +title: ticloud serverless describe summary: The reference of `ticloud serverless describe`. --- # ticloud serverless describe -Get information about a {{{ .starter }}} or {{{ .essential }}} cluster (such as the cluster configurations and cluster status): +Get information about a {{{ .starter }}} or {{{ .essential }}} instance (such as the instance configurations and instance status): ```shell ticloud serverless describe [flags] @@ -19,13 +19,13 @@ ticloud serverless get [flags] ## Examples -Get information about a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: +Get information about a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless describe ``` -Get information about a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: +Get information about a {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode: ```shell ticloud serverless describe --cluster-id diff --git a/tidb-cloud/ticloud-cluster-list.md b/tidb-cloud/ticloud-cluster-list.md index 01369bd28502e..6022d5b92ab82 100644 --- a/tidb-cloud/ticloud-cluster-list.md +++ b/tidb-cloud/ticloud-cluster-list.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless list`. # ticloud serverless list -List all {{{ .starter }}} and {{{ .essential }}} clusters in a project: +List all {{{ .starter }}} and {{{ .essential }}} instances in a project: ```shell ticloud serverless list [flags] @@ -19,19 +19,19 @@ ticloud serverless ls [flags] ## Examples -List all {{{ .starter }}} and {{{ .essential }}} clusters in interactive mode: +List all {{{ .starter }}} and {{{ .essential }}} instances in interactive mode: ```shell ticloud serverless list ``` -List all {{{ .starter }}} and {{{ .essential }}} clusters in a specified project in non-interactive mode: +List all {{{ .starter }}} and {{{ .essential }}} instances in a specified project in non-interactive mode: ```shell ticloud serverless list -p ``` -List all {{{ .starter }}} and {{{ .essential }}} clusters in a specified project with the JSON format in non-interactive mode: +List all {{{ .starter }}} and {{{ .essential }}} instances in a specified project with the JSON format in non-interactive mode: ```shell ticloud serverless list -p -o json diff --git a/tidb-cloud/ticloud-import-list.md b/tidb-cloud/ticloud-import-list.md index 55cd733c718d8..fb1195b4a1cb3 100644 --- a/tidb-cloud/ticloud-import-list.md +++ b/tidb-cloud/ticloud-import-list.md @@ -31,7 +31,7 @@ List import tasks in non-interactive mode: ticloud serverless import list --cluster-id ``` -List import tasks for a specified cluster in the JSON format: +List import tasks for a specified {{{ .starter }}} or Essential instance in the JSON format: ```shell ticloud serverless import list --cluster-id --output json diff --git a/tidb-cloud/ticloud-serverless-audit-log-config-describe.md b/tidb-cloud/ticloud-serverless-audit-log-config-describe.md index 5855a29bc45fb..fc6ab876533f9 100644 --- a/tidb-cloud/ticloud-serverless-audit-log-config-describe.md +++ b/tidb-cloud/ticloud-serverless-audit-log-config-describe.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log config describe`. # ticloud serverless audit-log config describe -Describe the database audit logging configuration for a {{{ .essential }}} cluster. +Describe the database audit logging configuration for a {{{ .essential }}} instance. ```shell ticloud serverless audit-log config describe [flags] diff --git a/tidb-cloud/ticloud-serverless-audit-log-config-update.md b/tidb-cloud/ticloud-serverless-audit-log-config-update.md index 9725f78d29b1c..5bd3592e1f20d 100644 --- a/tidb-cloud/ticloud-serverless-audit-log-config-update.md +++ b/tidb-cloud/ticloud-serverless-audit-log-config-update.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log config update`. # ticloud serverless audit-log config update -Update the database audit logging configuration for a {{{ .essential }}} cluster. +Update the database audit logging configuration for a {{{ .essential }}} instance. ```shell ticloud serverless audit-log config update [flags] diff --git a/tidb-cloud/ticloud-serverless-audit-log-download.md b/tidb-cloud/ticloud-serverless-audit-log-download.md index b278065120691..29a1aa60ed8b3 100644 --- a/tidb-cloud/ticloud-serverless-audit-log-download.md +++ b/tidb-cloud/ticloud-serverless-audit-log-download.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log download`. # ticloud serverless audit-log download -Download the database audit log files from a {{{ .essential }}} cluster. +Download the database audit log files from a {{{ .essential }}} instance. ```shell ticloud serverless audit-log download [flags] diff --git a/tidb-cloud/ticloud-serverless-audit-log-filter-rule-create.md b/tidb-cloud/ticloud-serverless-audit-log-filter-rule-create.md index 4a02ad5fc22da..738ebf1d16c74 100644 --- a/tidb-cloud/ticloud-serverless-audit-log-filter-rule-create.md +++ b/tidb-cloud/ticloud-serverless-audit-log-filter-rule-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log filter-rule create`. # ticloud serverless audit-log filter-rule create -Create an audit log filter rule for a {{{ .essential }}} cluster. +Create an audit log filter rule for a {{{ .essential }}} instance. ```shell ticloud serverless audit-log filter-rule create [flags] diff --git a/tidb-cloud/ticloud-serverless-audit-log-filter-rule-delete.md b/tidb-cloud/ticloud-serverless-audit-log-filter-rule-delete.md index 7f05bd9e70ddd..a4db3359afdfd 100644 --- a/tidb-cloud/ticloud-serverless-audit-log-filter-rule-delete.md +++ b/tidb-cloud/ticloud-serverless-audit-log-filter-rule-delete.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log filter-rule delete`. # ticloud serverless audit-log filter-rule delete -Delete an audit log filter rule for a {{{ .essential }}} cluster. +Delete an audit log filter rule for a {{{ .essential }}} instance. ```shell ticloud serverless audit-log filter-rule delete [flags] diff --git a/tidb-cloud/ticloud-serverless-audit-log-filter-rule-describe.md b/tidb-cloud/ticloud-serverless-audit-log-filter-rule-describe.md index e2936f22f1799..d6cefe34385c5 100644 --- a/tidb-cloud/ticloud-serverless-audit-log-filter-rule-describe.md +++ b/tidb-cloud/ticloud-serverless-audit-log-filter-rule-describe.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log filter-rule describe`. # ticloud serverless audit-log filter-rule describe -Describe an audit log filter rule for a {{{ .essential }}} cluster. +Describe an audit log filter rule for a {{{ .essential }}} instance. ```shell ticloud serverless audit-log filter-rule describe [flags] diff --git a/tidb-cloud/ticloud-serverless-audit-log-filter-rule-list.md b/tidb-cloud/ticloud-serverless-audit-log-filter-rule-list.md index f9e2403255aea..18ad3f7a7ef6f 100644 --- a/tidb-cloud/ticloud-serverless-audit-log-filter-rule-list.md +++ b/tidb-cloud/ticloud-serverless-audit-log-filter-rule-list.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log filter-rule list`. # ticloud serverless audit-log filter-rule list -List audit log filter rules for a {{{ .essential }}} cluster. +List audit log filter rules for a {{{ .essential }}} instance. ```shell ticloud serverless audit-log filter-rule list [flags] diff --git a/tidb-cloud/ticloud-serverless-audit-log-filter-rule-template.md b/tidb-cloud/ticloud-serverless-audit-log-filter-rule-template.md index ade5954bc4c40..d5a022b75b681 100644 --- a/tidb-cloud/ticloud-serverless-audit-log-filter-rule-template.md +++ b/tidb-cloud/ticloud-serverless-audit-log-filter-rule-template.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log filter-rule template`. # ticloud serverless audit-log filter-rule template -Show audit log filter rule templates for a {{{ .essential }}} cluster. +Show audit log filter rule templates for a {{{ .essential }}} instance. ```shell ticloud serverless audit-log filter-rule template [flags] diff --git a/tidb-cloud/ticloud-serverless-audit-log-filter-rule-update.md b/tidb-cloud/ticloud-serverless-audit-log-filter-rule-update.md index 9b90de008a1e3..41be88b0c2af7 100644 --- a/tidb-cloud/ticloud-serverless-audit-log-filter-rule-update.md +++ b/tidb-cloud/ticloud-serverless-audit-log-filter-rule-update.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log filter-rule update`. # ticloud serverless audit-log filter-rule update -Update an audit log filter rule for a {{{ .essential }}} cluster. +Update an audit log filter rule for a {{{ .essential }}} instance. ```shell ticloud serverless audit-log filter-rule update [flags] diff --git a/tidb-cloud/ticloud-serverless-capacity.md b/tidb-cloud/ticloud-serverless-capacity.md index d80f2f9584a6a..5d4cdb0cfabed 100644 --- a/tidb-cloud/ticloud-serverless-capacity.md +++ b/tidb-cloud/ticloud-serverless-capacity.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless capacity`. # ticloud serverless capacity -Set the capacity, in terms of maximum and minimum Request Capacity Units (RCUs), for a TiDB Cloud cluster. +Set the capacity, in terms of maximum and minimum Request Capacity Units (RCUs), for a {{{ .essential }}} instance. ```shell ticloud serverless capacity [flags] @@ -13,13 +13,13 @@ ticloud serverless capacity [flags] ## Examples -Set capacity for a TiDB Cloud cluster in interactive mode: +Set capacity for a {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless capacity ``` -Set capacity for a TiDB Cloud cluster in non-interactive mode: +Set capacity for a {{{ .essential }}} instance in non-interactive mode: ```shell ticloud serverless capacity -c --max-rcu --min-rcu @@ -32,8 +32,8 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |-------------------------|----------------------------------------------|----------|------------------------------------------------------| | -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | -| --max-rcu int32 | Specifies the maximum Request Capacity Units (RCUs) for the cluster, up to 100000. | No | Only works in non-interactive mode. | -| --min-rcu int32 | Specifies the minimum Request Capacity Units (RCUs) for the cluster, at least 2000. | No | Only works in non-interactive mode. | +| --max-rcu int32 | Specifies the maximum Request Capacity Units (RCUs) for the {{{ .essential }}} instance, up to 100000. | No | Only works in non-interactive mode. | +| --min-rcu int32 | Specifies the minimum Request Capacity Units (RCUs) for the {{{ .essential }}} instance, at least 2000. | No | Only works in non-interactive mode. | | -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags diff --git a/tidb-cloud/ticloud-serverless-export-create.md b/tidb-cloud/ticloud-serverless-export-create.md index 33c49a605a31b..233d3ddf40f91 100644 --- a/tidb-cloud/ticloud-serverless-export-create.md +++ b/tidb-cloud/ticloud-serverless-export-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export create`. # ticloud serverless export create -Export data from a {{{ .starter }}} or {{{ .essential }}} cluster: +Export data from a {{{ .starter }}} or {{{ .essential }}} instance: ```shell ticloud serverless export create [flags] @@ -13,37 +13,37 @@ ticloud serverless export create [flags] ## Examples -Export data from a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: +Export data from a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless export create ``` -Export data from a {{{ .starter }}} or {{{ .essential }}} cluster to a local file in non-interactive mode: +Export data from a {{{ .starter }}} or {{{ .essential }}} instance to a local file in non-interactive mode: ```shell ticloud serverless export create -c --filter ``` -Export data from a {{{ .starter }}} or {{{ .essential }}} cluster to Amazon S3 in non-interactive mode: +Export data from a {{{ .starter }}} or {{{ .essential }}} instance to Amazon S3 in non-interactive mode: ```shell ticloud serverless export create -c --s3.uri --s3.access-key-id --s3.secret-access-key --filter ``` -Export data from a {{{ .starter }}} or {{{ .essential }}} cluster to Google Cloud Storage in non-interactive mode: +Export data from a {{{ .starter }}} or {{{ .essential }}} instance to Google Cloud Storage in non-interactive mode: ```shell ticloud serverless export create -c --gcs.uri --gcs.service-account-key --filter ``` -Export data from a {{{ .starter }}} or {{{ .essential }}} cluster to Azure Blob Storage in non-interactive mode: +Export data from a {{{ .starter }}} or {{{ .essential }}} instance to Azure Blob Storage in non-interactive mode: ```shell ticloud serverless export create -c --azblob.uri --azblob.sas-token --filter ``` -Export data from a {{{ .starter }}} or {{{ .essential }}} cluster to Alibaba Cloud OSS in non-interactive mode: +Export data from a {{{ .starter }}} or {{{ .essential }}} instance to Alibaba Cloud OSS in non-interactive mode: ```shell ticloud serverless export create -c --oss.uri --oss.access-key-id --oss.access-key-secret --filter @@ -90,7 +90,7 @@ In non-interactive mode, you need to manually enter the required flags. In inter | --sql string | Filters the exported data with the `SQL SELECT` statement. | No | Only works in non-interactive mode. | | --where string | Filters the exported tables with the `WHERE` condition. Do not use it with --sql. | No | Only works in non-interactive mode. | | --compression string | Specifies the compression algorithm of the export file. The supported algorithms include `GZIP`, `SNAPPY`, `ZSTD`, and `NONE`. The default value is `GZIP`. | No | Only works in non-interactive mode. | -| --force | Creates the export task without confirmation. You need to confirm when you want to export the whole cluster in non-interactive mode. | No | Only works in non-interactive mode. | +| --force | Creates the export task without confirmation. You need to confirm when you want to export the whole {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode. | No | Only works in non-interactive mode. | | -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags diff --git a/tidb-cloud/ticloud-serverless-export-describe.md b/tidb-cloud/ticloud-serverless-export-describe.md index f707af6a057fa..d0b9863fa736b 100644 --- a/tidb-cloud/ticloud-serverless-export-describe.md +++ b/tidb-cloud/ticloud-serverless-export-describe.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export describe`. # ticloud serverless export describe -Get the export information of a {{{ .starter }}} or {{{ .essential }}} cluster: +Get the export information of a {{{ .starter }}} or {{{ .essential }}} instance: ```shell ticloud serverless export describe [flags] diff --git a/tidb-cloud/ticloud-serverless-export-download.md b/tidb-cloud/ticloud-serverless-export-download.md index 2b76002af71d9..6e1063aa8b92f 100644 --- a/tidb-cloud/ticloud-serverless-export-download.md +++ b/tidb-cloud/ticloud-serverless-export-download.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export download`. # ticloud serverless export download -Download the exported data from a {{{ .starter }}} or {{{ .essential }}} cluster to your local storage: +Download the exported data from a {{{ .starter }}} or {{{ .essential }}} instance to your local storage: ```shell ticloud serverless export download [flags] diff --git a/tidb-cloud/ticloud-serverless-export-list.md b/tidb-cloud/ticloud-serverless-export-list.md index c91b1d911ce8e..b2f36fb6a661e 100644 --- a/tidb-cloud/ticloud-serverless-export-list.md +++ b/tidb-cloud/ticloud-serverless-export-list.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export list`. # ticloud serverless export list -List data export tasks of {{{ .starter }}} and {{{ .essential }}} clusters: +List data export tasks of {{{ .starter }}} and {{{ .essential }}} instances: ```shell ticloud serverless export list [flags] @@ -25,13 +25,13 @@ List all export tasks in interactive mode: ticloud serverless export list ``` -List export tasks for a specified cluster in non-interactive mode: +List export tasks for a specified {{{ .starter }}} or Essential instance in non-interactive mode: ```shell ticloud serverless export list -c ``` -List export tasks for a specified cluster in the JSON format in non-interactive mode: +List export tasks for a specified {{{ .starter }}} or Essential instance in the JSON format in non-interactive mode: ```shell ticloud serverless export list -c -o json diff --git a/tidb-cloud/ticloud-serverless-shell.md b/tidb-cloud/ticloud-serverless-shell.md index 9a4581ca25eda..af5f512c1e145 100644 --- a/tidb-cloud/ticloud-serverless-shell.md +++ b/tidb-cloud/ticloud-serverless-shell.md @@ -6,7 +6,7 @@ aliases: ['/tidbcloud/ticloud-connect'] # ticloud serverless shell -Connect to a {{{ .starter }}} or {{{ .essential }}} cluster: +Connect to a {{{ .starter }}} or {{{ .essential }}} instance: ```shell ticloud serverless shell [flags] @@ -14,25 +14,25 @@ ticloud serverless shell [flags] ## Examples -Connect to a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: +Connect to a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless shell ``` -Connect to a {{{ .starter }}} or {{{ .essential }}} cluster with the default user in non-interactive mode: +Connect to a {{{ .starter }}} or {{{ .essential }}} instance with the default user in non-interactive mode: ```shell ticloud serverless shell -c ``` -Connect to a {{{ .starter }}} or {{{ .essential }}} cluster with the default user and password in non-interactive mode: +Connect to a {{{ .starter }}} or {{{ .essential }}} instance with the default user and password in non-interactive mode: ```shell ticloud serverless shell -c --password ``` -Connect to a {{{ .starter }}} or {{{ .essential }}} cluster with a specific user and password in non-interactive mode: +Connect to a {{{ .starter }}} or {{{ .essential }}} instance with a specific user and password in non-interactive mode: ```shell ticloud serverless shell -c -u --password diff --git a/tidb-cloud/ticloud-serverless-spending-limit.md b/tidb-cloud/ticloud-serverless-spending-limit.md index 4ca0b362e094e..833724b65fcf2 100644 --- a/tidb-cloud/ticloud-serverless-spending-limit.md +++ b/tidb-cloud/ticloud-serverless-spending-limit.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless spending-limit`. # ticloud serverless spending-limit -Set the maximum monthly [spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for a {{{ .starter }}} cluster: +Set the maximum monthly [spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for a {{{ .starter }}} instance: ```shell ticloud serverless spending-limit [flags] @@ -13,13 +13,13 @@ ticloud serverless spending-limit [flags] ## Examples -Set the spending limit for a {{{ .starter }}} cluster in interactive mode: +Set the spending limit for a {{{ .starter }}} instance in interactive mode: ```shell ticloud serverless spending-limit ``` -Set the spending limit for a {{{ .starter }}} cluster in non-interactive mode: +Set the spending limit for a {{{ .starter }}} instance in non-interactive mode: ```shell ticloud serverless spending-limit -c --monthly diff --git a/tidb-cloud/ticloud-serverless-sql-user-create.md b/tidb-cloud/ticloud-serverless-sql-user-create.md index 626b636625194..f9b68ddfca4c7 100644 --- a/tidb-cloud/ticloud-serverless-sql-user-create.md +++ b/tidb-cloud/ticloud-serverless-sql-user-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless sql-user create`. # ticloud serverless sql-user create -Create a SQL user in a {{{ .starter }}} or {{{ .essential }}} cluster: +Create a SQL user in a {{{ .starter }}} or {{{ .essential }}} instance: ```shell ticloud serverless sql-user create [flags] @@ -13,13 +13,13 @@ ticloud serverless sql-user create [flags] ## Examples -Create a SQL user in a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: +Create a SQL user in a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless sql-user create ``` -Create a SQL user in a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: +Create a SQL user in a {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode: ```shell ticloud serverless sql-user create --user --password --role --cluster-id diff --git a/tidb-cloud/ticloud-serverless-sql-user-delete.md b/tidb-cloud/ticloud-serverless-sql-user-delete.md index 02dd114f65a2a..5669ed88e1603 100644 --- a/tidb-cloud/ticloud-serverless-sql-user-delete.md +++ b/tidb-cloud/ticloud-serverless-sql-user-delete.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless sql-user delete`. # ticloud serverless sql-user delete -Delete a SQL user from a {{{ .starter }}} or {{{ .essential }}} cluster: +Delete a SQL user from a {{{ .starter }}} or {{{ .essential }}} instance: ```shell ticloud serverless sql-user delete [flags] @@ -13,13 +13,13 @@ ticloud serverless sql-user delete [flags] ## Examples -Delete a SQL user from a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: +Delete a SQL user from a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless sql-user delete ``` -Delete a SQL user from a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: +Delete a SQL user from a {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode: ```shell ticloud serverless sql-user delete -c --user diff --git a/tidb-cloud/ticloud-serverless-sql-user-list.md b/tidb-cloud/ticloud-serverless-sql-user-list.md index e93312072d1fe..6d48188af0b54 100644 --- a/tidb-cloud/ticloud-serverless-sql-user-list.md +++ b/tidb-cloud/ticloud-serverless-sql-user-list.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless sql-user list`. # ticloud serverless sql-user list -List SQL users in a {{{ .starter }}} or {{{ .essential }}} cluster: +List SQL users in a {{{ .starter }}} or {{{ .essential }}} instance: ```shell ticloud serverless sql-user list [flags] @@ -13,13 +13,13 @@ ticloud serverless sql-user list [flags] ## Examples -List SQL users in a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: +List SQL users in a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless sql-user list ``` -List SQL users in a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: +List SQL users in a {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode: ```shell ticloud serverless sql-user list -c diff --git a/tidb-cloud/ticloud-serverless-sql-user-update.md b/tidb-cloud/ticloud-serverless-sql-user-update.md index f38fd1a35808f..c238c037ac88f 100644 --- a/tidb-cloud/ticloud-serverless-sql-user-update.md +++ b/tidb-cloud/ticloud-serverless-sql-user-update.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless sql-user update`. # ticloud serverless sql-user update -Update a SQL user in a {{{ .starter }}} or {{{ .essential }}} cluster: +Update a SQL user in a {{{ .starter }}} or {{{ .essential }}} instance: ```shell ticloud serverless sql-user update [flags] @@ -13,13 +13,13 @@ ticloud serverless sql-user update [flags] ## Examples -Update a SQL user in a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: +Update a SQL user in a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless sql-user update ``` -Update a SQL user in a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: +Update a SQL user in a {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode: ```shell ticloud serverless sql-user update -c --user --password --role diff --git a/tidb-cloud/ticloud-serverless-update.md b/tidb-cloud/ticloud-serverless-update.md index 6c32109f6f806..a2d633d40758f 100644 --- a/tidb-cloud/ticloud-serverless-update.md +++ b/tidb-cloud/ticloud-serverless-update.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless update`. # ticloud serverless update -Update a {{{ .starter }}} or {{{ .essential }}} cluster: +Update a {{{ .starter }}} or {{{ .essential }}} instance: ```shell ticloud serverless update [flags] @@ -13,19 +13,19 @@ ticloud serverless update [flags] ## Examples -Update a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: +Update a {{{ .starter }}} or {{{ .essential }}} instance in interactive mode: ```shell ticloud serverless update ``` -Update the name of a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: +Update the name of a {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode: ```shell ticloud serverless update -c --display-name ``` -Update labels of a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode +Update labels of a {{{ .starter }}} or {{{ .essential }}} instance in non-interactive mode ```shell ticloud serverless update -c --labels "{\"label1\":\"value1\"}" @@ -38,9 +38,9 @@ In non-interactive mode, you need to manually enter the required flags. In inter | Flag | Description | Required | Note | |---------------------------|---------------------------------------------|----------|------------------------------------------------------| | -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | -| -n --display-name string | Specifies a new name for the cluster. | No | Only works in non-interactive mode. |. -| --labels string | Specifies new labels for the cluster. | No | Only works in non-interactive mode. | -| --disable-public-endpoint | Disables the public endpoint of the cluster. | No | Only works in non-interactive mode. | +| -n --display-name string | Specifies a new name for the {{{ .starter }}} or Essential instance. | No | Only works in non-interactive mode. |. +| --labels string | Specifies new labels for the {{{ .starter }}} or Essential instance. | No | Only works in non-interactive mode. | +| --disable-public-endpoint | Disables the public endpoint of the {{{ .starter }}} or Essential instance. | No | Only works in non-interactive mode. | | -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | ## Inherited flags diff --git a/tidb-cloud/tidb-cloud-auditing.md b/tidb-cloud/tidb-cloud-auditing.md index 48d57f029083a..4d60d9835e048 100644 --- a/tidb-cloud/tidb-cloud-auditing.md +++ b/tidb-cloud/tidb-cloud-auditing.md @@ -56,13 +56,13 @@ For more information, see [Creating a bucket](https://docs.aws.amazon.com/Amazon 1. Get the TiDB Cloud Account ID and the External ID of the TiDB cluster that you want to enable audit logging. - 1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. In the TiDB Cloud console, navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters. - 2. Click the name of your target cluster to go to its overview page, and then click **Settings** > **DB Audit Logging** in the left navigation pane. + 2. Click the name of your target TiDB Cloud Dedicated cluster to go to its overview page, and then click **Settings** > **DB Audit Logging** in the left navigation pane. 3. On the **DB Audit Logging** page, click **Enable** in the upper-right corner. 4. In the **Enable Database Audit Logging** dialog, locate the **AWS IAM Policy Settings** section, and record **TiDB Cloud Account ID** and **TiDB Cloud External ID** for later use. @@ -130,13 +130,13 @@ For more information, see [Creating storage buckets](https://cloud.google.com/st 1. Get the Google Cloud Service Account ID of the TiDB cluster that you want to enable audit logging. - 1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. In the TiDB Cloud console, navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters. - 2. Click the name of your target cluster to go to its overview page, and then click **Settings** > **DB Audit Logging** in the left navigation pane. + 2. Click the name of your target TiDB Cloud Dedicated cluster to go to its overview page, and then click **Settings** > **DB Audit Logging** in the left navigation pane. 3. On the **DB Audit Logging** page, click **Enable** in the upper-right corner. 4. In the **Enable Database Audit Logging** dialog, locate the **Google Cloud Server Account ID** section, and record **Service Account ID** for later use. @@ -227,13 +227,13 @@ For more information, see [Create an Azure storage account](https://learn.micros #### Step 3. Enable audit logging -1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. +1. In the TiDB Cloud console, navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters. -2. Click the name of your target cluster to go to its overview page, and then click **Settings** > **DB Audit Logging** in the left navigation pane. +2. Click the name of your target TiDB Cloud Dedicated cluster to go to its overview page, and then click **Settings** > **DB Audit Logging** in the left navigation pane. 3. On the **DB Audit Logging** page, click **Enable** in the upper-right corner. 4. In the **Enable Database Audit Logging** dialog, provide the blob URL and SAS token that you obtained from [Step 2. Configure Azure Blob access](#step-2-configure-azure-blob-storage-access): diff --git a/tidb-cloud/tidb-cloud-budget.md b/tidb-cloud/tidb-cloud-budget.md index 4439e7c024b65..2e8a957c074d2 100644 --- a/tidb-cloud/tidb-cloud-budget.md +++ b/tidb-cloud/tidb-cloud-budget.md @@ -60,7 +60,7 @@ To create a custom budget to monitor the spending of your organization or specif > **Note:** > -> The **Starter Spending Limit** budget cannot be edited because it is automatically created by TiDB Cloud to help you track the cost of a {{{ .starter }}} cluster against its [spending limit](/tidb-cloud/manage-serverless-spend-limit.md). +> The **Starter Spending Limit** budget cannot be edited because it is automatically created by TiDB Cloud to help you track the cost of a {{{ .starter }}} instance against its [spending limit](/tidb-cloud/manage-serverless-spend-limit.md). To edit a custom budget, take the following steps: @@ -81,7 +81,7 @@ To edit a custom budget, take the following steps: > **Note:** > > - Once a custom budget is deleted, you will no longer receive any alert emails related to it. -> - The **Starter Spending Limit** budget cannot be deleted because it is automatically created by TiDB Cloud to help you track the cost of a {{{ .starter }}} cluster against its [spending limit](/tidb-cloud/manage-serverless-spend-limit.md). +> - The **Starter Spending Limit** budget cannot be deleted because it is automatically created by TiDB Cloud to help you track the cost of a {{{ .starter }}} instance against its [spending limit](/tidb-cloud/manage-serverless-spend-limit.md). To delete a custom budget, take the following steps: diff --git a/tidb-cloud/tidb-cloud-connect-aws-dms.md b/tidb-cloud/tidb-cloud-connect-aws-dms.md index 5cca979f8c3cc..377512734f181 100644 --- a/tidb-cloud/tidb-cloud-connect-aws-dms.md +++ b/tidb-cloud/tidb-cloud-connect-aws-dms.md @@ -1,9 +1,9 @@ --- -title: Connect AWS DMS to TiDB Cloud clusters +title: Connect AWS DMS to TiDB Cloud Resources summary: Learn how to migrate data from or into TiDB Cloud using AWS Database Migration Service (AWS DMS). --- -# Connect AWS DMS to TiDB Cloud clusters +# Connect AWS DMS to TiDB Cloud Resources [AWS Database Migration Service (AWS DMS)](https://aws.amazon.com/dms/) is a cloud service that makes it possible to migrate relational databases, data warehouses, NoSQL databases, and other types of data stores. You can use AWS DMS to migrate your data from or into TiDB Cloud clusters. This document describes how to connect AWS DMS to a TiDB Cloud cluster. @@ -20,7 +20,7 @@ You are expected to have an AWS account with enough access to manage DMS-related You are expected to have a TiDB Cloud account and a {{{ .starter }}}, {{{ .essential }}}, or TiDB Cloud Dedicated cluster. If not, refer to the following documents to create one: -- [Create a {{{ .starter }}} or Essential cluster](/tidb-cloud/create-tidb-cluster-serverless.md) +- [Create a {{{ .starter }}} or Essential instance](/tidb-cloud/create-tidb-cluster-serverless.md) - [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md) ## Configure network @@ -35,13 +35,13 @@ For {{{ .starter }}} or {{{ .essential }}}, your clients can connect to clusters -- To [connect to a {{{ .starter }}} or Essential cluster via public endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md), do one of the following to make sure that the DMS replication instance can access the internet. +- To [connect to a {{{ .starter }}} or Essential instance via public endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md), do one of the following to make sure that the DMS replication instance can access the internet. - Deploy the replication instance in public subnets and enable **Public accessible**. For more information, see [Configuration for internet access](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html#vpc-igw-internet-access). - Deploy the replication instance in private subnets and route traffic in the private subnets to public subnets. In this case, you need at least three subnets, two private subnets, and one public subnet. The two private subnets form a subnet group where the replication instance lives. Then you need to create a NAT gateway in the public subnet and route traffic of the two private subnets to the NAT gateway. For more information, see [Access the internet from a private subnet](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-scenarios.html#public-nat-internet-access). -- To connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, refer to the following documents to set up a private endpoint first and deploy the replication instance in private subnets. +- To connect to a {{{ .starter }}} or {{{ .essential }}} instance via private endpoint, refer to the following documents to set up a private endpoint first and deploy the replication instance in private subnets. - [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) - [Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) @@ -50,13 +50,13 @@ For {{{ .starter }}} or {{{ .essential }}}, your clients can connect to clusters -- To [connect to a {{{ .starter }}} or Essential cluster via public endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md), do one of the following to make sure that the DMS replication instance can access the internet. +- To [connect to a {{{ .starter }}} or Essential instance via public endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md), do one of the following to make sure that the DMS replication instance can access the internet. - Deploy the replication instance in public subnets and enable **Public accessible**. For more information, see [Configuration for internet access](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html#vpc-igw-internet-access). - Deploy the replication instance in private subnets and route traffic in the private subnets to public subnets. In this case, you need at least three subnets, two private subnets, and one public subnet. The two private subnets form a subnet group where the replication instance lives. Then you need to create a NAT gateway in the public subnet and route traffic of the two private subnets to the NAT gateway. For more information, see [Access the internet from a private subnet](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-scenarios.html#public-nat-internet-access). -- To connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, refer to [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) to set up a private endpoint first and deploy the replication instance in private subnets. +- To connect to a {{{ .starter }}} or {{{ .essential }}} instance via private endpoint, refer to [Connect to {{{ .starter }}} or Essential via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) to set up a private endpoint first and deploy the replication instance in private subnets. diff --git a/tidb-cloud/tidb-cloud-console-auditing.md b/tidb-cloud/tidb-cloud-console-auditing.md index 58bbaa9c9cd95..16230052417c4 100644 --- a/tidb-cloud/tidb-cloud-console-auditing.md +++ b/tidb-cloud/tidb-cloud-console-auditing.md @@ -152,12 +152,12 @@ The console audit logs record various user activities on the TiDB Cloud console | BindSupportPlan | Bind a support plan | | CancelSupportPlan | Cancel a support plan | | UpdateOrganizationName | Update the organization name | -| SetSpendLimit | Edit the spending limit of a {{{ .starter }}} cluster | +| SetSpendLimit | Edit the spending limit of a {{{ .starter }}} instance | | UpdateMaintenanceWindow | Modify maintenance window start time | | DeferMaintenanceTask | Defer a maintenance task | -| CreateBranch | Create a branch for {{{ .starter }}} or {{{ .essential }}} cluster | -| DeleteBranch | Delete a branch for {{{ .starter }}} or {{{ .essential }}} cluster | -| SetBranchRootPassword | Set root password for a branch of your {{{ .starter }}} or {{{ .essential }}} cluster | +| CreateBranch | Create a branch for {{{ .starter }}} or {{{ .essential }}} instance | +| DeleteBranch | Delete a branch for {{{ .starter }}} or {{{ .essential }}} instance | +| SetBranchRootPassword | Set root password for a branch of your {{{ .starter }}} or {{{ .essential }}} instance | | ConnectBranchGitHub | Connect the cluster with a GitHub repository to enable branching integration | | DisconnectBranchGitHub | Disconnect the cluster from a GitHub repository to disable branching integration | | UpdateAuthenticationMethod | Update the authentication method for Cloud Organization SSO | diff --git a/tidb-cloud/tidb-cloud-events.md b/tidb-cloud/tidb-cloud-events.md index 614e2bc44a0dc..f041acc97e684 100644 --- a/tidb-cloud/tidb-cloud-events.md +++ b/tidb-cloud/tidb-cloud-events.md @@ -13,7 +13,7 @@ This document describes how to view the events for TiDB Cloud clusters using the To view the events on the **Events** page, take the following steps: -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target resource to go to its overview page. > **Tip:** > @@ -42,8 +42,8 @@ TiDB Cloud logs the following types of cluster events: | ScaleChangefeed | Scale the specification of a changefeed | | FailedChangefeed | Changefeed failures | | ImportData | Import data to a cluster | -| UpdateSpendingLimit | Update spending limit of a {{{ .starter }}} cluster | -| ResourceLimitation | Update resource limitation of a {{{ .starter }}} or {{{ .essential }}} cluster | +| UpdateSpendingLimit | Update spending limit of a {{{ .starter }}} instance | +| ResourceLimitation | Update resource limitation of a {{{ .starter }}} or {{{ .essential }}} instance | For each event, the following information is logged: diff --git a/tidb-cloud/tidb-cloud-faq.md b/tidb-cloud/tidb-cloud-faq.md index e763553c06519..82ba0c229c3eb 100644 --- a/tidb-cloud/tidb-cloud-faq.md +++ b/tidb-cloud/tidb-cloud-faq.md @@ -42,8 +42,8 @@ No. ### What versions of TiDB are supported on TiDB Cloud? - For new TiDB Cloud Dedicated clusters, the default TiDB version is [v8.5.5](https://docs.pingcap.com/tidb/v8.5/release-8.5.5) starting from January 15, 2026. -- For {{{ .starter }}} clusters, the TiDB version is [v8.5.3](https://docs.pingcap.com/tidb/stable/release-8.5.3) starting from February 10, 2026. -- For {{{ .essential }}} clusters, the TiDB version is [v7.5.2](https://docs.pingcap.com/tidb/stable/release-7.5.2) starting from April 22, 2025. +- For {{{ .starter }}} instances, the TiDB version is [v8.5.3](https://docs.pingcap.com/tidb/stable/release-8.5.3) starting from February 10, 2026. +- For {{{ .essential }}} instances, the TiDB version is [v7.5.2](https://docs.pingcap.com/tidb/stable/release-7.5.2) starting from April 22, 2025. For more information, see [TiDB Cloud Release Notes](/tidb-cloud/releases/tidb-cloud-release-notes.md). @@ -65,7 +65,7 @@ The best way to learn about TiDB Cloud is to follow our step-by-step tutorial. C - [TiDB Cloud Introduction](/tidb-cloud/tidb-cloud-intro.md) - [Get Started](/tidb-cloud/tidb-cloud-quickstart.md) -- [Create a {{{ .starter }}} or Essential Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) +- [Create a {{{ .starter }}} or Essential Instance](/tidb-cloud/create-tidb-cluster-serverless.md) ### What does `XXX's Org/default project/Cluster0` refer to when deleting a cluster? @@ -109,7 +109,7 @@ TiDB is highly compatible with MySQL. You can migrate data from any MySQL-compat ### Does TiDB Cloud support incremental backups? -No. If you need to restore data to any point in time within the cluster's backup retention, you can use PITR (Point-in-time Recovery). For more information, see [Use PITR in a TiDB Cloud Dedicated cluster](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup) or [Use PITR in a {{{ .essential }}} cluster](/tidb-cloud/backup-and-restore-serverless.md#restore). +No. If you need to restore data to any point in time within the cluster's backup retention, you can use PITR (Point-in-time Recovery). For more information, see [Use PITR in a TiDB Cloud Dedicated cluster](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup) or [Use PITR in a {{{ .essential }}} instance](/tidb-cloud/backup-and-restore-serverless.md#restore). ## HTAP FAQs @@ -154,7 +154,7 @@ No. TiDB Cloud is Database-as-a-Service (DBaaS) and runs only in the TiDB Cloud ### Is my TiDB cluster secure? -In TiDB Cloud, you can use a TiDB Cloud Dedicated cluster, a {{{ .starter }}} cluster, or a {{{ .essential }}} cluster according to your needs. +In TiDB Cloud, you can use a TiDB Cloud Dedicated cluster, a {{{ .starter }}} instance, or a {{{ .essential }}} instance according to your needs. For TiDB Cloud Dedicated clusters, TiDB Cloud ensures cluster security with the following measures: @@ -163,7 +163,7 @@ For TiDB Cloud Dedicated clusters, TiDB Cloud ensures cluster security with the - Creates server-side TLS certificates and component-level TLS certificates for each cluster to encrypt cluster data in transit. - Provide IP access rules for each cluster to ensure that only allowed source IP addresses can access your cluster. -For {{{ .starter }}} and {{{ .essential }}} clusters, TiDB Cloud ensures cluster security with the following measures: +For {{{ .starter }}} and {{{ .essential }}} instances, TiDB Cloud ensures cluster security with the following measures: - Creates independent sub-accounts for each cluster. - Sets up firewall rules to isolate external connections. @@ -187,7 +187,7 @@ For more information, see [Connect to Your TiDB Cloud Dedicated Cluster](/tidb-c
-For a {{{ .starter }}} or Essential cluster, the steps to connect to your cluster are simplified as follows: +For a {{{ .starter }}} or Essential instance, the steps to connect to your cluster are simplified as follows: 1. Set a database user and login credential. 2. Choose a SQL client, get an auto-generated connection string displayed on the TiDB Cloud UI, and then connect to your cluster through the SQL client using the string. diff --git a/tidb-cloud/tidb-cloud-glossary.md b/tidb-cloud/tidb-cloud-glossary.md index 83280669d6bc8..8b5bef502b5c6 100644 --- a/tidb-cloud/tidb-cloud-glossary.md +++ b/tidb-cloud/tidb-cloud-glossary.md @@ -27,7 +27,7 @@ ACID refers to the four key properties of a transaction: atomicity, consistency, Chat2Query is an AI-powered feature integrated into SQL Editor that assists users in generating, debugging, or rewriting SQL queries using natural language instructions. For more information, see [Explore your data with AI-assisted SQL Editor](/tidb-cloud/explore-data-with-chat2query.md). -In addition, TiDB Cloud provides a Chat2Query API for {{{ .starter }}} clusters hosted on AWS. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md). +In addition, TiDB Cloud provides a Chat2Query API for {{{ .starter }}} instances hosted on AWS. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md). ### Credit @@ -141,7 +141,7 @@ TiDB Cloud measures the capacity of [changefeeds](/tidb-cloud/changefeed-overvie ### Request Capacity Unit (RCU) -A Request Capacity Unit (RCU) is a unit of measure used to represent the provisioned compute capacity for your {{{ .essential }}} cluster. One RCU provides a fixed amount of compute resources that can process a certain number of RUs per second. The number of RCUs you provision determines your cluster's baseline performance and throughput capacity. For more information, see [{{{ .essential }}} Pricing Details](https://www.pingcap.com/tidb-cloud-essential-pricing-details/). +A Request Capacity Unit (RCU) is a unit of measure used to represent the provisioned compute capacity for your {{{ .essential }}} instance. One RCU provides a fixed amount of compute resources that can process a certain number of RUs per second. The number of RCUs you provision determines your cluster's baseline performance and throughput capacity. For more information, see [{{{ .essential }}} Pricing Details](https://www.pingcap.com/tidb-cloud-essential-pricing-details/). ### Request Unit (RU) @@ -156,7 +156,7 @@ For TiDB Cloud Dedicated and TiDB Self-Managed, a Request Unit (RU) is a resourc ### Spending limit -[Spending limit](/tidb-cloud/manage-serverless-spend-limit.md) refers to the maximum amount of money that you are willing to spend on a particular workload in a month. It is a cost-control mechanism that enables you to set a budget for your {{{ .starter }}} clusters. If the spending limit is set to 0, the cluster remains free. If the spending limit is greater than 0, you need to add a credit card. +[Spending limit](/tidb-cloud/manage-serverless-spend-limit.md) refers to the maximum amount of money that you are willing to spend on a particular workload in a month. It is a cost-control mechanism that enables you to set a budget for your {{{ .starter }}} instances. If the spending limit is set to 0, the cluster remains free. If the spending limit is greater than 0, you need to add a credit card. ## T diff --git a/tidb-cloud/tidb-cloud-htap-quickstart.md b/tidb-cloud/tidb-cloud-htap-quickstart.md index b66a712612f0b..339b85359e482 100644 --- a/tidb-cloud/tidb-cloud-htap-quickstart.md +++ b/tidb-cloud/tidb-cloud-htap-quickstart.md @@ -12,7 +12,7 @@ This tutorial guides you through an easy way to experience the Hybrid Transactio ## Before you begin -Before experiencing the HTAP feature, follow [TiDB Cloud Quick Start](/tidb-cloud/tidb-cloud-quickstart.md) to create a {{{ .starter }}} cluster and import the **Steam Game Stats** sample dataset to the cluster. +Before experiencing the HTAP feature, follow [TiDB Cloud Quick Start](/tidb-cloud/tidb-cloud-quickstart.md) to create a {{{ .starter }}} instance and import the **Steam Game Stats** sample dataset to the cluster. ## Steps diff --git a/tidb-cloud/tidb-cloud-import-local-files.md b/tidb-cloud/tidb-cloud-import-local-files.md index 20c0d9fb7129e..7a54b075aa94a 100644 --- a/tidb-cloud/tidb-cloud-import-local-files.md +++ b/tidb-cloud/tidb-cloud-import-local-files.md @@ -5,21 +5,21 @@ summary: Learn how to import local files to {{{ .starter }}} or {{{ .essential } # Import Local Files to {{{ .starter }}} or Essential -You can import local files to {{{ .starter }}} or {{{ .essential }}} directly. It only takes a few clicks to complete the task configuration, and then your local CSV data will be quickly imported to your TiDB cluster. Using this method, you do not need to provide the cloud storage and credentials. The whole importing process is quick and smooth. +You can import local files to {{{ .starter }}} or {{{ .essential }}} directly. It only takes a few clicks to complete the task configuration, and then your local CSV data will be quickly imported to your {{{ .starter }}} or Essential instance. Using this method, you do not need to provide the cloud storage and credentials. The whole importing process is quick and smooth. Currently, this method supports importing one CSV file for one task into either an existing empty table or a new table. ## Limitations - Currently, TiDB Cloud only supports importing a local file in CSV format within 250 MiB for one task. -- Importing local files is supported only for {{{ .starter }}} and {{{ .essential }}} clusters, not for TiDB Cloud Dedicated clusters. +- Importing local files is supported only for {{{ .starter }}} and {{{ .essential }}} instances, not for TiDB Cloud Dedicated clusters. - You cannot run more than one import task at the same time. ## Import local files -1. Open the **Import** page for your target cluster. +1. Open the **Import** page for your target {{{ .starter }}} or Essential instance. - 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. + 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page. > **Tip:** > @@ -87,7 +87,7 @@ Currently, this method supports importing one CSV file for one task into either No. Currently, you can only import all columns of a CSV file into an existing table when using the Import feature. -To import only some specified columns, you can use the MySQL client to connect your TiDB cluster, and then use [`LOAD DATA`](https://docs.pingcap.com/tidb/stable/sql-statement-load-data) to specify the columns to be imported. For example: +To import only some specified columns, you can use the MySQL client to connect your {{{ .starter }}} or Essential instance, and then use [`LOAD DATA`](https://docs.pingcap.com/tidb/stable/sql-statement-load-data) to specify the columns to be imported. For example: ```sql CREATE TABLE `import_test` ( diff --git a/tidb-cloud/tidb-cloud-log-redaction.md b/tidb-cloud/tidb-cloud-log-redaction.md index 4df13d28eb090..49ccf8fba8741 100644 --- a/tidb-cloud/tidb-cloud-log-redaction.md +++ b/tidb-cloud/tidb-cloud-log-redaction.md @@ -49,7 +49,7 @@ Log redaction is enabled by default, ensuring that sensitive information in runn To disable log redaction, do the following: 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/). -2. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters)[**TiDB Instances**](https://tidbcloud.com/tidbs) page, and then click the name of your target clusterinstance to go to its overview page. +2. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster{{{ .premium }}} instance to go to its overview page. @@ -96,7 +96,7 @@ To check the updated logs after log redaction is disabled, do the following: To maintain data security, **enable log redaction** as soon as you complete your diagnostic or maintenance task as follows. 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/). -2. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters)[**TiDB Instances**](https://tidbcloud.com/tidbs) page, and then click the name of your target clusterinstance to go to its overview page. +2. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster{{{ .premium }}} instance to go to its overview page. diff --git a/tidb-cloud/tidb-cloud-poc.md b/tidb-cloud/tidb-cloud-poc.md index a58bd22627146..468f4799bf1c8 100644 --- a/tidb-cloud/tidb-cloud-poc.md +++ b/tidb-cloud/tidb-cloud-poc.md @@ -95,7 +95,7 @@ For a newly created cluster, note the following configurations: Next, you can load your database schemas to the TiDB cluster, including tables and indexes. -Because the amount of PoC credits is limited, to maximize the value of credits, it is recommended that you create a [{{{ .starter }}} cluster](/tidb-cloud/select-cluster-tier.md#starter) for compatibility tests and preliminary analysis on TiDB Cloud. +Because the amount of PoC credits is limited, to maximize the value of credits, it is recommended that you create a [{{{ .starter }}} instance](/tidb-cloud/select-cluster-tier.md#starter) for compatibility tests and preliminary analysis on TiDB Cloud. TiDB Cloud is highly compatible with MySQL 8.0. You can directly import your data into TiDB if it is MySQL-compatible or can be adapted to be compatible with MySQL. diff --git a/tidb-cloud/tidb-cloud-quickstart.md b/tidb-cloud/tidb-cloud-quickstart.md index 60b4f5cf1d3b3..0a529873f1a1b 100644 --- a/tidb-cloud/tidb-cloud-quickstart.md +++ b/tidb-cloud/tidb-cloud-quickstart.md @@ -14,7 +14,7 @@ Additionally, you can try out TiDB features on [TiDB Playground](https://play.ti ## Step 1: Create a TiDB cluster -[TiDB Cloud Starter](/tidb-cloud/select-cluster-tier.md#starter) is the best way to get started with TiDB Cloud. To create a {{{ .starter }}} cluster, follow these steps: +[TiDB Cloud Starter](/tidb-cloud/select-cluster-tier.md#starter) is the best way to get started with TiDB Cloud. To create a {{{ .starter }}} instance, follow these steps: 1. If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/free-trial) to sign up. @@ -22,15 +22,15 @@ Additionally, you can try out TiDB features on [TiDB Playground](https://play.ti 2. [Log in](https://tidbcloud.com/) to your TiDB Cloud account. - The [**Clusters**](https://tidbcloud.com/project/clusters) page is displayed by default. + The [**My TiDB**](https://tidbcloud.com/tidbs) page is displayed by default. -3. For new sign-up users, TiDB Cloud automatically creates a default {{{ .starter }}} cluster named `Cluster0` for you. +3. For new sign-up users, TiDB Cloud automatically creates a default {{{ .starter }}} instance named `Cluster0` for you. - To instantly try out TiDB Cloud features with this default cluster, proceed to [Step 2: Try AI-assisted SQL Editor](#step-2-try-ai-assisted-sql-editor). - - To create a new {{{ .starter }}} cluster on your own, follow these steps: + - To create a new {{{ .starter }}} instance on your own, follow these steps: 1. Click **Create Cluster**. - 2. On the **Create Cluster** page, **Starter** is selected by default. Select the cloud provider and target region for your cluster, update the default cluster name if necessary, and then click **Create**. Your {{{ .starter }}} cluster will be created in approximately 30 seconds. + 2. On the **Create Cluster** page, **Starter** is selected by default. Select the cloud provider and target region for your cluster, update the default cluster name if necessary, and then click **Create**. Your {{{ .starter }}} instance will be created in approximately 30 seconds. @@ -50,9 +50,9 @@ Additionally, you can try out TiDB features on [TiDB Playground](https://play.ti ## Step 2: Try AI-assisted SQL Editor -For {{{ .starter }}} clusters hosted on AWS, you can use the built-in AI-assisted SQL Editor in the TiDB Cloud console to maximize your data value. This enables you to run SQL queries against databases without a local SQL client. You can intuitively view the query results in tables or charts and easily check the query logs. +For {{{ .starter }}} instances hosted on AWS, you can use the built-in AI-assisted SQL Editor in the TiDB Cloud console to maximize your data value. This enables you to run SQL queries against databases without a local SQL client. You can intuitively view the query results in tables or charts and easily check the query logs. -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page, click a cluster name to go to its overview page, and then click **SQL Editor** in the left navigation pane. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your {{{ .starter }}} instance to go to its overview page, and then click **SQL Editor** in the left navigation pane. 2. To try the AI capacity of TiDB Cloud, follow the on-screen instructions to allow PingCAP and AWS Bedrock to use your code snippets for research and service improvement, and then click **Save and Get Started**. @@ -123,15 +123,15 @@ FROM ## Step 3: Try guided tour on the console -TiDB Cloud offers an interactive tutorial with carefully crafted sample datasets to help you quickly get started with TiDB Cloud. For {{{ .starter }}} clusters hosted on AWS, you can try this tutorial to learn how to use TiDB Cloud for high-performance data analytics. +TiDB Cloud offers an interactive tutorial with carefully crafted sample datasets to help you quickly get started with TiDB Cloud. For {{{ .starter }}} instances hosted on AWS, you can try this tutorial to learn how to use TiDB Cloud for high-performance data analytics. 1. Click the **?** icon in the lower-right corner of the console and select **Guided tour of SQL Editor**. -2. Choose a {{{ .starter }}} cluster that you want to use for the tour, and click **Import Dataset**. The import process might take approximately one minute. +2. Choose a {{{ .starter }}} instance that you want to use for the tour, and click **Import Dataset**. The import process might take approximately one minute. 3. Once the sample data is imported, follow the on-screen instructions to complete the tour. ## What's next -- To learn how to connect to your cluster using different methods, see [Connect to a {{{ .starter }}} or Essential cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md). +- To learn how to connect to your cluster using different methods, see [Connect to a {{{ .starter }}} or Essential instance](/tidb-cloud/connect-to-tidb-cluster-serverless.md). - For more information about how to use SQL Editor and Chat2Query to explore your data, see [Explore your data with AI-assisted SQL Editor](/tidb-cloud/explore-data-with-chat2query.md). - For TiDB SQL usage, see [Explore SQL with TiDB](/basic-sql-operations.md). - For production use with the benefits of cross-zone high availability, horizontal scaling, and [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing), see [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). diff --git a/tidb-cloud/tidb-cloud-support.md b/tidb-cloud/tidb-cloud-support.md index cbc1255db1db1..74f3b2cde717d 100644 --- a/tidb-cloud/tidb-cloud-support.md +++ b/tidb-cloud/tidb-cloud-support.md @@ -43,8 +43,8 @@ You can access the PingCAP Help Center via **Note**: > -> The TiDB Node Group feature is **NOT** available for {{{ .starter }}} or {{{ .essential }}} clusters. +> The TiDB Node Group feature is **NOT** available for {{{ .starter }}} or {{{ .essential }}} instances. ## Terms @@ -33,7 +33,7 @@ This document describes how to manage TiDB node groups and their endpoints to is To create a TiDB node group, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page , and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the left navigation pane, click **Nodes**. 3. Click **Modify** in the upper-right corner. The **Modify Cluster** page is displayed. 4. On the **Modify Cluster** page, click **+** to add a new TiDB node group as follows. You can also use the default group directly. @@ -66,7 +66,7 @@ Public connection for the new TiDB node group is disabled by default. You need t To enable public connection, do the following: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the upper-right corner, click **Connect**. A connection dialog is displayed. 3. Select your TiDB node group from the **TiDB Node Group** list and **Public** from the **Connection Type** list. @@ -83,7 +83,7 @@ For more information, see [Connect to TiDB Cloud Dedicated via Public Connection ### Connect via private endpoint -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the upper-right corner, click **Connect**. A connection dialog is displayed. 3. Select your TiDB node group from the **TiDB Node Group** list and **Private Endpoint** from the **Connection Type** list. 4. In the left navigation pane, click **Settings** > **Networking**. @@ -104,7 +104,7 @@ For more information, see [Connect to TiDB Cloud Dedicated via Public Connection Because all TiDB node groups share the same VPC as the cluster, you only need to create one VPC peering connection to enable access for all groups. 1. Follow the instructions in [Connect to TiDB Cloud Dedicated via VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) to create a VPC peering for this cluster. -2. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +2. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 3. In the left navigation pane, click **Settings** > **Networking**. 4. In the upper-right corner of the **Networking** page, click **Connect** to get the connection string. @@ -112,7 +112,7 @@ Because all TiDB node groups share the same VPC as the cluster, you only need to To view the details of TiDB node groups, perform the following steps: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the left navigation pane, click **Nodes** to view the list of TiDB node groups. To switch to the table view, click . @@ -125,7 +125,7 @@ You can modify the group name and node configurations in the group. To change the group name, perform the following steps: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the left navigation pane, click **Nodes**. 3. Click and enter a new name for the TiDB node group. @@ -133,7 +133,7 @@ To change the group name, perform the following steps: To update TiDB, TiKV, or TiFlash node configurations in the group, perform the following steps: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the left navigation pane, click **Nodes**. 3. On the **Node Map** page, click **Modify** in the upper-right corner. The **Modify Cluster** page is displayed. 4. On the **Modify Cluster** page, you can: @@ -152,7 +152,7 @@ To update TiDB, TiKV, or TiFlash node configurations in the group, perform the f To delete a TiDB node group, perform the following steps: -1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. +1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the left navigation pane, click **Nodes**. 3. On the **Node Map** page, click **Modify** in the upper-right corner. The **Modify Cluster** page is displayed. 4. On the **Modify Cluster** page, click to delete the TiDB node group. diff --git a/tidb-cloud/tidb-node-group-overview.md b/tidb-cloud/tidb-node-group-overview.md index 8d66d90287b26..8b08f3bd72ba4 100644 --- a/tidb-cloud/tidb-node-group-overview.md +++ b/tidb-cloud/tidb-node-group-overview.md @@ -11,7 +11,7 @@ With TiDB node groups, you can divide computing nodes into multiple TiDB node gr > **Note**: > -> The TiDB Node Group feature is **NOT** available for {{{ .starter }}} and {{{ .essential }}} clusters. +> The TiDB Node Group feature is **NOT** available for {{{ .starter }}} and {{{ .essential }}} instances. ## Implementation diff --git a/tidb-cloud/tiproxy-management.md b/tidb-cloud/tiproxy-management.md index b91fe71e813d2..01fea2ddd576c 100644 --- a/tidb-cloud/tiproxy-management.md +++ b/tidb-cloud/tiproxy-management.md @@ -9,7 +9,7 @@ This document describes how to enable, disable, view, and modify TiProxy. > **Note:** > -> TiProxy is in beta and is currently available only for TiDB Cloud Dedicated clusters deployed on AWS. +> TiProxy is in beta and is currently available only for TiDB Cloud Dedicated clusters deployed on AWS. ## Enable TiProxy @@ -44,7 +44,7 @@ To enable TiProxy when creating a new cluster, click the TiProxy toggle and choo To enable TiProxy for an existing cluster, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **...** in the upper-right corner, and click **Modify** in the drop-down menu. The **Modify Cluster** page is displayed. 3. On the **Modify Cluster** page, click the TiProxy toggle and choose the TiProxy size and number. @@ -65,7 +65,7 @@ To enable TiProxy for an existing cluster, perform the following steps: To disable TiProxy, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **...** in the upper-right corner, and click **Modify** in the drop-down menu. The **Modify Cluster** page is displayed. 3. On the **Modify Cluster** page, click the TiProxy toggle to disable TiProxy. @@ -77,7 +77,7 @@ To disable TiProxy, perform the following steps: To view the TiProxy topology, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the left navigation pane, click **Monitoring > Nodes**. The **Node Map** page is displayed. 3. On the **Node Map** page, the TiProxy topology is displayed in the **TiDB** pane. @@ -87,7 +87,7 @@ To view the TiProxy topology, perform the following steps: To view TiProxy metrics, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. In the left navigation pane, click **Monitoring > Metrics**. The **Metrics** page is displayed. 3. On the **Metrics** page, click **Server** and scroll down to the TiProxy-related metrics. To view TiProxy metrics for a specific TiDB node group, click **TiDB Node Group View**, select your TiDB node group, and then scroll down to the TiProxy-related metrics. @@ -117,7 +117,7 @@ To view TiProxy bills, perform the following steps: To scale in or scale out TiProxy, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target TiDB Cloud Dedicated cluster to go to its overview page. 2. Click **...** in the upper-right corner, and click **Modify** in the drop-down menu. The **Modify Cluster** page is displayed. 3. On the **Modify Cluster** page, modify the number of the TiProxy nodes. diff --git a/tidb-cloud/tune-performance.md b/tidb-cloud/tune-performance.md index 3a26b51d0ce65..1f995d1e5dc9c 100644 --- a/tidb-cloud/tune-performance.md +++ b/tidb-cloud/tune-performance.md @@ -34,9 +34,7 @@ TiDB Cloud provides [Slow Query](#slow-query) and [SQL Statement](#sql-statement ## View the Diagnosis page - - -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, click the name of your target cluster to go to its overview page. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target resource to go to its overview page. > **Tip:** > @@ -44,20 +42,6 @@ TiDB Cloud provides [Slow Query](#slow-query) and [SQL Statement](#sql-statement 2. In the left navigation pane, click **Monitoring** > **Diagnosis**. - - - - -1. On the [**TiDB Instances**](https://tidbcloud.com/tidbs) page of your organization, click the name of your target instance to go to its overview page. - - > **Tip:** - > - > You can use the combo box in the upper-left corner to switch between organizations and instances. - -2. In the left navigation pane, click **Monitoring**. - - - ## Slow Query By default, SQL queries that take more than 300 milliseconds are considered as slow queries. diff --git a/tidb-cloud/use-chat2query-api.md b/tidb-cloud/use-chat2query-api.md index db50657f60c54..a0b7640ba02b1 100644 --- a/tidb-cloud/use-chat2query-api.md +++ b/tidb-cloud/use-chat2query-api.md @@ -11,7 +11,7 @@ Chat2Query API can only be accessed through HTTPS, ensuring that all data transm > **Note:** > -> Chat2Query API is only available for [TiDB Cloud Starter](/tidb-cloud/select-cluster-tier.md#starter) clusters hosted on AWS. To use the Chat2Query API on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md). +> Chat2Query API is only available for [TiDB Cloud Starter](/tidb-cloud/select-cluster-tier.md#starter) instances hosted on AWS. To use the Chat2Query API on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md). ## Before you begin diff --git a/tidb-cloud/use-chat2query-knowledge.md b/tidb-cloud/use-chat2query-knowledge.md index dd76573b3f73d..ab8d9844fe533 100644 --- a/tidb-cloud/use-chat2query-knowledge.md +++ b/tidb-cloud/use-chat2query-knowledge.md @@ -11,7 +11,7 @@ Starting from v3, the Chat2Query API enables you to add or modify knowledge base > **Note:** > -> Knowledge base related endpoints are only available for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) clusters hosted on AWS. To use knowledge base related endpoints on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md). +> Knowledge base related endpoints are only available for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#starter) instances hosted on AWS. To use knowledge base related endpoints on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md). ## Before you begin diff --git a/tidb-cloud/use-tidb-cloud-with-ai-tools.md b/tidb-cloud/use-tidb-cloud-with-ai-tools.md index e60899cefda3d..294fa7338ecec 100644 --- a/tidb-cloud/use-tidb-cloud-with-ai-tools.md +++ b/tidb-cloud/use-tidb-cloud-with-ai-tools.md @@ -1,19 +1,19 @@ --- title: Use {{{ .starter }}} with AI Tools -summary: Learn how to connect your {{{ .starter }}} cluster to AI-powered development tools that support the Model Context Protocol (MCP), such as Cursor, Claude Code, VS Code, and Windsurf. +summary: Learn how to connect your {{{ .starter }}} instance to AI-powered development tools that support the Model Context Protocol (MCP), such as Cursor, Claude Code, VS Code, and Windsurf. --- # Use {{{ .starter }}} with AI Tools -This document describes how to connect your {{{ .starter }}} cluster to AI-powered development tools that support the Model Context Protocol (MCP), such as Cursor, Claude Code, Visual Studio Code (VS Code), and Windsurf. +This document describes how to connect your {{{ .starter }}} instance to AI-powered development tools that support the Model Context Protocol (MCP), such as Cursor, Claude Code, Visual Studio Code (VS Code), and Windsurf. -By configuring your {{{ .starter }}} cluster as an MCP server, you can enable AI assistants in your development tools to query your database schema, understand your data model, and generate context-aware code suggestions. +By configuring your {{{ .starter }}} instance as an MCP server, you can enable AI assistants in your development tools to query your database schema, understand your data model, and generate context-aware code suggestions. ## Before you begin To complete this guide, you need the following: -- A {{{ .starter }}} cluster. If you don't have any, you can [create a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- A {{{ .starter }}} instance. If you don't have any, you can [create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). - [Python 3.11 or higher](https://www.python.org/downloads/) installed. - [uv](https://docs.astral.sh/uv/getting-started/installation/) installed. - An AI development tool that supports MCP, such as: @@ -25,9 +25,9 @@ To complete this guide, you need the following: ## Connect to AI tools -After you create a {{{ .starter }}} cluster in TiDB Cloud, perform the following steps to connect it to your AI tool. +After you create a {{{ .starter }}} instance in TiDB Cloud, perform the following steps to connect it to your AI tool. -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page, click the name of your target cluster to go to its overview page. Then, click **Use with AI Tools** in the upper-right corner. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} instance to go to its overview page. 2. In the **Access `your_cluster_name` with AI tools** dialog, select the **Branch** and **Database** that you want the AI tool to access. 3. Verify that you meet all the **Prerequisites** listed. If not, follow the on-screen instructions to install the required dependencies. 4. Configure the password: diff --git a/tidb-distributed-execution-framework.md b/tidb-distributed-execution-framework.md index 13966615eb748..2ceafdc4a917b 100644 --- a/tidb-distributed-execution-framework.md +++ b/tidb-distributed-execution-framework.md @@ -7,7 +7,7 @@ summary: Learn the use cases, limitations, usage, and implementation principles > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. TiDB adopts a computing-storage separation architecture with excellent scalability and elasticity. Starting from v7.1.0, TiDB introduces a **Distributed eXecution Framework (DXF)** to further leverage the resource advantages of the distributed architecture. The goal of the DXF is to implement unified scheduling and distributed execution of tasks, and to provide unified resource management capabilities for both overall and individual tasks, which better meets users' expectations for resource usage. diff --git a/tidb-global-sort.md b/tidb-global-sort.md index 1680681e94e17..12676391e9d97 100644 --- a/tidb-global-sort.md +++ b/tidb-global-sort.md @@ -15,7 +15,7 @@ summary: Learn the use cases, limitations, usage, and implementation principles > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. ## Overview diff --git a/tidb-resource-control-background-tasks.md b/tidb-resource-control-background-tasks.md index b7abbb156072e..04b39e06c281b 100644 --- a/tidb-resource-control-background-tasks.md +++ b/tidb-resource-control-background-tasks.md @@ -13,7 +13,7 @@ summary: Introduces how to control background tasks through Resource Control. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. Background tasks, such as data backup and automatic statistics collection, are low-priority but consume many resources. These tasks are usually triggered periodically or irregularly. During execution, they consume a lot of resources, thus affecting the performance of online high-priority tasks. diff --git a/tidb-resource-control-ru-groups.md b/tidb-resource-control-ru-groups.md index 4abbf46ef4227..ee239c1f5a1bd 100644 --- a/tidb-resource-control-ru-groups.md +++ b/tidb-resource-control-ru-groups.md @@ -8,7 +8,7 @@ aliases: ['/tidb/v8.5/tidb-resource-control/','/tidb/stable/tidb-resource-contro > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. As a cluster administrator, you can use the resource control feature to create resource groups, set quotas for resource groups, and bind users to those groups. diff --git a/tidb-resource-control-runaway-queries.md b/tidb-resource-control-runaway-queries.md index 51da0b16fefb8..80ff6b2b0a1e4 100644 --- a/tidb-resource-control-runaway-queries.md +++ b/tidb-resource-control-runaway-queries.md @@ -7,7 +7,7 @@ summary: Introduces how to control and degrade queries with excessive resource c > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) instances. A runaway query is a query that consumes more time or resources than expected. The term **runaway queries** is used in the following to describe the feature of managing the runaway query. diff --git a/tiflash/create-tiflash-replicas.md b/tiflash/create-tiflash-replicas.md index 4c6010754e9dd..0835dcd9e5eb6 100644 --- a/tiflash/create-tiflash-replicas.md +++ b/tiflash/create-tiflash-replicas.md @@ -21,7 +21,7 @@ The parameter of the above command is described as follows: > **Note:** > -> For a [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) cluster, the `count` of TiFlash replicas can only be `2`. If you set it to `1`, it will be automatically adjusted to `2` for execution. If you set it to a number larger than 2, you will get an error about the replica count. +> For a [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) instance, the `count` of TiFlash replicas can only be `2`. If you set it to `1`, it will be automatically adjusted to `2` for execution. If you set it to a number larger than 2, you will get an error about the replica count. If you execute multiple DDL statements on the same table, only the last statement is ensured to take effect. In the following example, two DDL statements are executed on the table `tpch50`, but only the second statement (to delete the replica) takes effect.