From 16b576680d3841786356f41955f1e943092d5494 Mon Sep 17 00:00:00 2001 From: qiancai Date: Wed, 22 Apr 2026 12:37:19 +0800 Subject: [PATCH 1/4] cloud: update docs for one console (cherry-picked from #22744) --- TOC-develop.md | 2 +- ai/_index.md | 2 +- ai/examples/auto-embedding-with-pytidb.md | 4 +- ai/examples/basic-with-pytidb.md | 4 +- ai/examples/fulltext-search-with-pytidb.md | 4 +- ai/examples/hybrid-search-with-pytidb.md | 4 +- ai/examples/image-search-with-pytidb.md | 4 +- ai/examples/memory-with-pytidb.md | 4 +- ai/examples/rag-with-pytidb.md | 4 +- ai/examples/text2sql-with-pytidb.md | 2 +- ai/examples/vector-search-with-pytidb.md | 4 +- ai/guides/connect.md | 10 +- .../vector-search-full-text-search-python.md | 6 +- .../vector-search-full-text-search-sql.md | 2 +- ai/guides/vector-search-hybrid-search.md | 6 +- .../embedding-openai-compatible.md | 2 +- ai/integrations/tidb-mcp-claude-code.md | 6 +- ai/integrations/tidb-mcp-claude-desktop.md | 4 +- ai/integrations/tidb-mcp-cursor.md | 8 +- ai/integrations/tidb-mcp-server.md | 12 +- ai/integrations/tidb-mcp-vscode.md | 6 +- ai/integrations/tidb-mcp-windsurf.md | 6 +- ...ctor-search-auto-embedding-amazon-titan.md | 2 +- .../vector-search-auto-embedding-cohere.md | 2 +- .../vector-search-auto-embedding-gemini.md | 2 +- ...ector-search-auto-embedding-huggingface.md | 2 +- .../vector-search-auto-embedding-jina-ai.md | 2 +- ...vector-search-auto-embedding-nvidia-nim.md | 2 +- .../vector-search-auto-embedding-openai.md | 2 +- .../vector-search-auto-embedding-overview.md | 2 +- ...or-search-integrate-with-amazon-bedrock.md | 8 +- ...vector-search-integrate-with-django-orm.md | 24 ++-- ...-search-integrate-with-jinaai-embedding.md | 16 +-- .../vector-search-integrate-with-langchain.md | 12 +- ...vector-search-integrate-with-llamaindex.md | 12 +- .../vector-search-integrate-with-peewee.md | 26 ++--- ...vector-search-integrate-with-sqlalchemy.md | 14 +-- ai/quickstart-via-python.md | 10 +- ai/quickstart-via-sql.md | 14 +-- ai/reference/vector-search-limitations.md | 2 +- ai/vector-search-get-started-using-python.md | 24 ++-- develop/dev-guide-aws-appflow-integration.md | 6 +- develop/dev-guide-bookshop-schema-design.md | 10 +- develop/dev-guide-build-cluster-in-cloud.md | 32 +++--- develop/dev-guide-connect-to-tidb.md | 2 +- develop/dev-guide-create-database.md | 4 +- develop/dev-guide-create-secondary-indexes.md | 4 +- develop/dev-guide-create-table.md | 8 +- develop/dev-guide-delete-data.md | 2 +- .../dev-guide-get-data-from-single-table.md | 2 +- develop/dev-guide-gui-datagrip.md | 14 +-- develop/dev-guide-gui-dbeaver.md | 14 +-- develop/dev-guide-gui-mysql-workbench.md | 18 +-- develop/dev-guide-gui-navicat.md | 16 +-- develop/dev-guide-gui-vscode-sqltools.md | 14 +-- develop/dev-guide-insert-data.md | 8 +- develop/dev-guide-proxysql-integration.md | 58 +++++----- ...dev-guide-sample-application-aws-lambda.md | 10 +- develop/dev-guide-sample-application-cs.md | 2 +- ...ev-guide-sample-application-golang-gorm.md | 14 +-- ...de-sample-application-golang-sql-driver.md | 14 +-- ...guide-sample-application-java-hibernate.md | 14 +-- .../dev-guide-sample-application-java-jdbc.md | 14 +-- ...v-guide-sample-application-java-mybatis.md | 14 +-- ...ide-sample-application-java-spring-boot.md | 14 +-- .../dev-guide-sample-application-nextjs.md | 10 +- ...-guide-sample-application-nodejs-mysql2.md | 16 +-- ...guide-sample-application-nodejs-mysqljs.md | 18 +-- ...-guide-sample-application-nodejs-prisma.md | 16 +-- ...ide-sample-application-nodejs-sequelize.md | 12 +- ...guide-sample-application-nodejs-typeorm.md | 18 +-- ...-guide-sample-application-python-django.md | 16 +-- ...mple-application-python-mysql-connector.md | 16 +-- ...e-sample-application-python-mysqlclient.md | 14 +-- ...-guide-sample-application-python-peewee.md | 16 +-- ...guide-sample-application-python-pymysql.md | 16 +-- ...de-sample-application-python-sqlalchemy.md | 18 +-- ...ev-guide-sample-application-ruby-mysql2.md | 14 +-- ...dev-guide-sample-application-ruby-rails.md | 14 +-- develop/dev-guide-schema-design-overview.md | 2 +- develop/dev-guide-tidb-crud-sql.md | 4 +- develop/dev-guide-transaction-restraints.md | 2 +- develop/dev-guide-update-data.md | 2 +- develop/dev-guide-wordpress.md | 14 +-- develop/java-app-best-practices.md | 2 +- develop/serverless-driver-drizzle-example.md | 16 ++- develop/serverless-driver-kysely-example.md | 12 +- develop/serverless-driver-node-example.md | 8 +- develop/serverless-driver-prisma-example.md | 12 +- develop/serverless-driver.md | 22 ++-- .../json-functions/json-functions-validate.md | 2 +- .../miscellaneous-functions.md | 2 +- index-advisor.md | 2 +- .../information-schema-cluster-info.md | 2 +- .../information-schema-placement-policies.md | 2 +- .../information-schema-resource-groups.md | 2 +- .../information-schema-runaway-watches.md | 2 +- .../information-schema-slow-query.md | 4 +- ...rmation-schema-tidb-hot-regions-history.md | 2 +- .../information-schema-tidb-servers-info.md | 2 +- .../information-schema-tikv-region-peers.md | 2 +- .../information-schema-tikv-region-status.md | 2 +- .../information-schema-tikv-store-status.md | 2 +- information-schema/information-schema.md | 32 +++--- mysql-compatibility.md | 2 +- placement-rules-in-sql.md | 2 +- quick-start-with-tidb.md | 2 +- schema-cache.md | 2 +- sql-statements/sql-statement-add-index.md | 2 +- .../sql-statement-admin-alter-ddl.md | 2 +- sql-statements/sql-statement-admin.md | 4 +- .../sql-statement-alter-instance.md | 2 +- .../sql-statement-alter-placement-policy.md | 2 +- sql-statements/sql-statement-alter-range.md | 2 +- .../sql-statement-alter-resource-group.md | 2 +- sql-statements/sql-statement-backup.md | 2 +- .../sql-statement-cancel-distribution-job.md | 2 +- sql-statements/sql-statement-create-index.md | 2 +- .../sql-statement-create-placement-policy.md | 2 +- .../sql-statement-create-resource-group.md | 2 +- sql-statements/sql-statement-create-table.md | 2 +- .../sql-statement-distribute-table.md | 2 +- .../sql-statement-drop-placement-policy.md | 2 +- .../sql-statement-drop-resource-group.md | 2 +- .../sql-statement-flashback-cluster.md | 2 +- sql-statements/sql-statement-import-into.md | 2 +- sql-statements/sql-statement-load-stats.md | 2 +- sql-statements/sql-statement-query-watch.md | 2 +- sql-statements/sql-statement-restore.md | 2 +- .../sql-statement-set-resource-group.md | 2 +- sql-statements/sql-statement-show-backups.md | 2 +- ...-statement-show-create-placement-policy.md | 2 +- ...ql-statement-show-create-resource-group.md | 2 +- .../sql-statement-show-distribution-jobs.md | 2 +- .../sql-statement-show-placement-for.md | 2 +- .../sql-statement-show-placement-labels.md | 2 +- .../sql-statement-show-placement.md | 2 +- sql-statements/sql-statement-show-plugins.md | 2 +- .../sql-statement-show-table-distribution.md | 2 +- .../sql-statement-show-table-regions.md | 2 +- sql-statements/sql-statement-split-region.md | 2 +- statement-summary-tables.md | 2 +- statistics.md | 2 +- system-variables.md | 103 ++++++++++-------- tidb-cloud/get-started-with-cli.md | 4 - tidb-cloud/manage-user-access.md | 6 +- tidb-distributed-execution-framework.md | 2 +- tidb-global-sort.md | 2 +- tidb-resource-control-background-tasks.md | 2 +- tidb-resource-control-ru-groups.md | 2 +- tidb-resource-control-runaway-queries.md | 2 +- tiflash/create-tiflash-replicas.md | 2 +- 152 files changed, 594 insertions(+), 573 deletions(-) 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/ai/_index.md b/ai/_index.md index c2d36b2690fb7..85ff6652f63f0 100644 --- a/ai/_index.md +++ b/ai/_index.md @@ -30,7 +30,7 @@ Step-by-step guides for building AI applications with TiDB using the [`pytidb`]( | Document | Description | | --- | --- | -| [Connect to TiDB](/ai/guides/connect.md) | Connect to TiDB Cloud or self-managed clusters using `pytidb`. | +| [Connect to TiDB](/ai/guides/connect.md) | Connect to TiDB Cloud or TiDB Self-Managed using `pytidb`. | | [Working with Tables](/ai/guides/tables.md) | Create, query, and manage tables with vector fields. | | [Vector Search](/ai/guides/vector-search.md) | Perform semantic similarity searches using `pytidb`. | | [Full-Text Search](/ai/guides/vector-search-full-text-search-python.md) | Keyword-based text search with BM25 ranking. | diff --git a/ai/examples/auto-embedding-with-pytidb.md b/ai/examples/auto-embedding-with-pytidb.md index 3f963ff0eac4c..cfefafe7bfb02 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance 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..32d47d39341d3 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance 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..63eef8f2b9a2d 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance 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..6245dcb5573d1 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance 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..ef76da479f9dd 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance 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..be32a8a3d112d 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance 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..57c4e23453a98 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance 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..9fe1a2bbb59b9 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance 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..f1e8b78413ac7 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance 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..c220845233e4b 100644 --- a/ai/guides/connect.md +++ b/ai/guides/connect.md @@ -24,9 +24,9 @@ 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. +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, with connection parameters listed. 3. Copy the connection parameters to your code or environment variables. @@ -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,9 +83,9 @@ 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. +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, with the connection parameters listed. 3. Copy the connection parameters and construct a connection string in the following format: diff --git a/ai/guides/vector-search-full-text-search-python.md b/ai/guides/vector-search-full-text-search-python.md index 2fd549326047e..ef1cf13edee39 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 - TiDB Cloud Serverless: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)` -To complete this tutorial, make sure you have a TiDB Cloud Serverless cluster in a supported region. If you don't have one, follow [Creating a TiDB Cloud Serverless 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 TiDB Cloud Serverless 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 6622f1a7b11b2..917539373cc57 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 - TiDB Cloud Serverless: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)` -Before using full-text search, make sure your TiDB Cloud Serverless cluster is created in a supported region. If you don't have one, follow [Creating a TiDB Cloud Serverless 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 af91b9bfbf6c7..f58e740bb677a 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 - TiDB Cloud Serverless: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)` -To complete this tutorial, make sure you have a TiDB Cloud Serverless cluster in a supported region. If you don't have one, follow [Creating a TiDB Cloud Serverless 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 TiDB Cloud Serverless 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..8aff7cc0bc72f 100644 --- a/ai/integrations/tidb-mcp-claude-code.md +++ b/ai/integrations/tidb-mcp-claude-code.md @@ -13,14 +13,14 @@ 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial). ## Connect to TiDB Cloud Starter (recommended) Use the TiDB Cloud console to generate a ready-to-run Claude Code command. -1. Go to the [Clusters](https://tidbcloud.com/console/clusters) page, select your cluster, and then click **Use with AI Tools** in the upper-right corner. -2. In the **Access `your_cluster_name` with AI tools** dialog, select the **Branch** and **Database** that Claude Code should access. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} instance to go to its overview page, and then click **Use with AI Tools** in the upper-right corner. +2. In the displayed dialog, select the **Branch** and **Database** that Claude Code should access. 3. Review the **Prerequisites** list in the dialog and install any missing dependencies. 4. Configure the root password: diff --git a/ai/integrations/tidb-mcp-claude-desktop.md b/ai/integrations/tidb-mcp-claude-desktop.md index 5845b7b67bd5b..2da89b7e5003b 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial). ## Setup steps @@ -41,7 +41,7 @@ Follow the steps below to set up the TiDB MCP Server in Claude Desktop: } ``` -5. Go to the [TiDB Cloud cluster page](https://tidbcloud.com/console/clusters) and navigate to the cluster you want to connect to. +5. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} instance to go to its overview page. 6. Click **Connect** in the upper-right corner to get the connection parameters, and replace the `TIDB_HOST`, `TIDB_PORT`, `TIDB_USERNAME`, `TIDB_PASSWORD`, and `TIDB_DATABASE` values with your own. 7. Restart Claude Desktop. diff --git a/ai/integrations/tidb-mcp-cursor.md b/ai/integrations/tidb-mcp-cursor.md index ad27fe67ffb08..41c83f67280ce 100644 --- a/ai/integrations/tidb-mcp-cursor.md +++ b/ai/integrations/tidb-mcp-cursor.md @@ -17,14 +17,14 @@ 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial). ## Connect to TiDB Cloud Starter (recommended) -Use the TiDB Cloud console to create a Cursor configuration with your cluster credentials. +Use the TiDB Cloud console to create a Cursor configuration with your {{{ .starter }}} instance credentials. -1. Go to the [Clusters](https://tidbcloud.com/console/clusters) page, select your cluster, and then click **Use with AI Tools** in the upper-right corner. -2. In the **Access `your_cluster_name` with AI tools** dialog, select the **Branch** and **Database** that Cursor should access. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} instance to go to its overview page, and then click **Use with AI Tools** in the upper-right corner. +2. In the displayed dialog, select the **Branch** and **Database** that Cursor should access. 3. Review the **Prerequisites** list in the dialog and install any missing dependencies. 4. Configure the root password: diff --git a/ai/integrations/tidb-mcp-server.md b/ai/integrations/tidb-mcp-server.md index 241d8b48aea7d..881f82c2a3555 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial). ## Supported MCP Clients @@ -55,9 +55,9 @@ To set up the TiDB MCP Server in your MCP client using STDIO mode, take the foll 1. Refer to your MCP client documentation to learn how to configure your MCP server. -2. Go to your [TiDB Cloud clusters](https://tidbcloud.com/console/clusters) page and navigate to the overview page of your cluster. +2. In the TiDB Cloud console, 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. -3. Click **Connect** on the cluster overview page to get the connection parameters. +3. Click **Connect** in the upper-right corner to get the connection parameters. 4. Configure the TiDB MCP Server with your connection parameters in the `mcpServers` section of your AI application’s configuration file. @@ -86,9 +86,9 @@ To set up the TiDB MCP Server in your MCP client using SSE mode, take the follow 1. Refer to your MCP client documentation to learn how to configure an MCP server. -2. Go to your [TiDB Cloud clusters](https://tidbcloud.com/console/clusters) page and select your cluster. +2. In the TiDB Cloud console, 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. -3. Click **Connect** on the cluster page to get the connection parameters. +3. Click **Connect** in the upper-right corner to get the connection parameters. 4. Create a `.env` file with your connection parameters. @@ -128,7 +128,7 @@ The TiDB MCP Server provides the following actions (tools) to MCP clients. You c **Database Management** -- `show_databases` - Show all databases in the TiDB cluster +- `show_databases` - Show all databases in the {{{ .starter }}} instance * `username`: Database username (string, optional) * `password`: Database password (string, optional) diff --git a/ai/integrations/tidb-mcp-vscode.md b/ai/integrations/tidb-mcp-vscode.md index eabf765d86a62..e1c01d1a79ffb 100644 --- a/ai/integrations/tidb-mcp-vscode.md +++ b/ai/integrations/tidb-mcp-vscode.md @@ -13,14 +13,14 @@ 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial). ## Connect to TiDB Cloud Starter (recommended) Use the TiDB Cloud console to generate a VS Code configuration. -1. Go to the [Clusters](https://tidbcloud.com/console/clusters) page, select your cluster, and then click **Use with AI Tools** in the upper-right corner. -2. In the **Access `your_cluster_name` with AI tools** dialog, select the **Branch** and **Database** that VS Code should access. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} instance to go to its overview page, and then click **Use with AI Tools** in the upper-right corner. +2. In the displayed dialog, select the **Branch** and **Database** that VS Code should access. 3. Review the **Prerequisites** list in the dialog and install any missing dependencies. 4. Configure the root password: diff --git a/ai/integrations/tidb-mcp-windsurf.md b/ai/integrations/tidb-mcp-windsurf.md index d7eeaa8e713a3..22faf0f02a4ad 100644 --- a/ai/integrations/tidb-mcp-windsurf.md +++ b/ai/integrations/tidb-mcp-windsurf.md @@ -13,14 +13,14 @@ 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 {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial). ## Connect to TiDB Cloud Starter (recommended) Use the TiDB Cloud console to gather the connection details, then update Windsurf's MCP configuration. -1. Go to the [Clusters](https://tidbcloud.com/console/clusters) page, select your cluster, and then click **Use with AI Tools** in the upper-right corner. -2. In the **Access `your_cluster_name` with AI tools** dialog, select the **Branch** and **Database** that Windsurf should access. +1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} instance to go to its overview page, and then click **Use with AI Tools** in the upper-right corner. +2. In the displayed dialog, select the **Branch** and **Database** that Windsurf should access. 3. Review the **Prerequisites** list in the dialog and install any missing dependencies. 4. Configure the root password: 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 5329e26758c5d..2bcb920f43e24 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 TiDB Cloud Serverless 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. + [Create a {{{ .starter }}} instance](/tidb-cloud/select-cluster-tier.md#starter) 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 TiDB Cloud Serverless -In `demo.py`, add the following code to save the vector data to your TiDB Cloud Serverless 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..89cda58f38495 100644 --- a/ai/integrations/vector-search-integrate-with-django-orm.md +++ b/ai/integrations/vector-search-integrate-with-django-orm.md @@ -23,8 +23,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## 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 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. @@ -106,8 +106,8 @@ For a {{{ .starter }}} cluster, take the following steps to obtain the cluster c - `TIDB_HOST`: The host of the TiDB cluster. - `TIDB_PORT`: The port of the TiDB cluster. - - `TIDB_USERNAME`: The username to connect to the TiDB cluster. - - `TIDB_PASSWORD`: The password to connect to the TiDB cluster. + - `TIDB_USERNAME`: The username to connect to TiDB. + - `TIDB_PASSWORD`: The password to connect to TiDB. - `TIDB_DATABASE`: The database name to connect to. - `TIDB_CA_PATH`: The path to the root certificate file. @@ -139,10 +139,10 @@ If you are running TiDB on your local machine, `TIDB_HOST` is `127.0.0.1` by def The following are descriptions for each parameter: -- `TIDB_HOST`: The host of the TiDB cluster. -- `TIDB_PORT`: The port of the TiDB cluster. -- `TIDB_USERNAME`: The username to connect to the TiDB cluster. -- `TIDB_PASSWORD`: The password to connect to the TiDB cluster. +- `TIDB_HOST`: The host of the TiDB Self-Managed cluster. +- `TIDB_PORT`: The port of the TiDB Self-Managed cluster. +- `TIDB_USERNAME`: The username to connect to the TiDB Self-Managed cluster. +- `TIDB_PASSWORD`: The password to connect to the TiDB Self-Managed cluster. - `TIDB_DATABASE`: The name of the database you want to connect to.
@@ -175,7 +175,7 @@ Open your browser and visit `http://127.0.0.1:8000` to try the demo application. You can refer to the following sample code snippets to complete your own application development. -### Connect to the TiDB cluster +### Connect to TiDB In the file `sample_project/settings.py`, add the following configurations: @@ -205,7 +205,7 @@ if TIDB_CA_PATH: } ``` -You can create a `.env` file in the root directory of your project and set up the environment variables `TIDB_HOST`, `TIDB_PORT`, `TIDB_USERNAME`, `TIDB_PASSWORD`, `TIDB_DATABASE`, and `TIDB_CA_PATH` with the actual values of your TiDB cluster. +You can create a `.env` file in the root directory of your project and set up the environment variables `TIDB_HOST`, `TIDB_PORT`, `TIDB_USERNAME`, `TIDB_PASSWORD`, `TIDB_DATABASE`, and `TIDB_CA_PATH` with the actual values of your TiDB. ### Create vector tables diff --git a/ai/integrations/vector-search-integrate-with-jinaai-embedding.md b/ai/integrations/vector-search-integrate-with-jinaai-embedding.md index 2dafff89ce87f..d687b526c6885 100644 --- a/ai/integrations/vector-search-integrate-with-jinaai-embedding.md +++ b/ai/integrations/vector-search-integrate-with-jinaai-embedding.md @@ -23,8 +23,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## 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 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. @@ -114,8 +114,8 @@ You need to replace parameters in the preceding command according to your TiDB c The following are descriptions for each parameter: -- ``: The username to connect to the TiDB cluster. -- ``: The password to connect to the TiDB cluster. +- ``: The username to connect to TiDB. +- ``: The password to connect to TiDB. - ``: The host of the TiDB cluster. - ``: The port of the TiDB cluster. - ``: The name of the database you want to connect to. @@ -175,9 +175,9 @@ def generate_embeddings(text: str): return response.json()['data'][0]['embedding'] ``` -### Connect to the TiDB cluster +### Connect to TiDB -Connect to the TiDB cluster through SQLAlchemy: +Connect to TiDB through SQLAlchemy: ```python import os diff --git a/ai/integrations/vector-search-integrate-with-langchain.md b/ai/integrations/vector-search-integrate-with-langchain.md index db3df119d99b1..b66cc877e9a8f 100644 --- a/ai/integrations/vector-search-integrate-with-langchain.md +++ b/ai/integrations/vector-search-integrate-with-langchain.md @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## 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 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. @@ -134,8 +134,8 @@ You need to modify the values of the connection parameters according to your TiD The following are descriptions for each parameter: -- ``: The username to connect to the TiDB cluster. -- ``: The password to connect to the TiDB cluster. +- ``: The username to connect to TiDB. +- ``: The password to connect to TiDB. - ``: The host of the TiDB cluster. - ``: The port of the TiDB cluster. - ``: The name of the database you want to connect to. diff --git a/ai/integrations/vector-search-integrate-with-llamaindex.md b/ai/integrations/vector-search-integrate-with-llamaindex.md index 617705e49873e..a2aa701aee73e 100644 --- a/ai/integrations/vector-search-integrate-with-llamaindex.md +++ b/ai/integrations/vector-search-integrate-with-llamaindex.md @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## 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 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. @@ -133,8 +133,8 @@ You need to modify the parameters in the connection string according to your TiD The following are descriptions for each parameter: -- ``: The username to connect to the TiDB cluster. -- ``: The password to connect to the TiDB cluster. +- ``: The username to connect to TiDB. +- ``: The password to connect to TiDB. - ``: The host of the TiDB cluster. - ``: The port of the TiDB cluster. - ``: The name of the database you want to connect to. diff --git a/ai/integrations/vector-search-integrate-with-peewee.md b/ai/integrations/vector-search-integrate-with-peewee.md index d30fa1effc5a8..e4aa72c3b038f 100644 --- a/ai/integrations/vector-search-integrate-with-peewee.md +++ b/ai/integrations/vector-search-integrate-with-peewee.md @@ -23,8 +23,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## 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 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. @@ -94,10 +94,10 @@ For a {{{ .starter }}} cluster, take the following steps to obtain the cluster c 5. In the root directory of your Python project, create a `.env` file and paste the connection parameters to the corresponding environment variables. - - `TIDB_HOST`: The host of the TiDB cluster. - - `TIDB_PORT`: The port of the TiDB cluster. - - `TIDB_USERNAME`: The username to connect to the TiDB cluster. - - `TIDB_PASSWORD`: The password to connect to the TiDB cluster. + - `TIDB_HOST`: The host of the {{{ .starter }}} or Essential instance. + - `TIDB_PORT`: The port of the {{{ .starter }}} or Essential instance. + - `TIDB_USERNAME`: The username to connect to TiDB. + - `TIDB_PASSWORD`: The password to connect to TiDB. - `TIDB_DATABASE`: The database name to connect to. - `TIDB_CA_PATH`: The path to the root certificate file. @@ -129,10 +129,10 @@ If you are running TiDB on your local machine, `TIDB_HOST` is `127.0.0.1` by def The following are descriptions for each parameter: -- `TIDB_HOST`: The host of the TiDB cluster. -- `TIDB_PORT`: The port of the TiDB cluster. -- `TIDB_USERNAME`: The username to connect to the TiDB cluster. -- `TIDB_PASSWORD`: The password to connect to the TiDB cluster. +- `TIDB_HOST`: The host of the TiDB Self-Managed cluster. +- `TIDB_PORT`: The port of the TiDB Self-Managed cluster. +- `TIDB_USERNAME`: The username to connect to the TiDB Self-Managed cluster. +- `TIDB_PASSWORD`: The password to connect to the TiDB Self-Managed cluster. - `TIDB_DATABASE`: The name of the database you want to connect to.
@@ -168,7 +168,7 @@ You can refer to the following sample code snippets to develop your application. ### Create vector tables -#### Connect to a TiDB cluster +#### Connect to TiDB ```python import os diff --git a/ai/integrations/vector-search-integrate-with-sqlalchemy.md b/ai/integrations/vector-search-integrate-with-sqlalchemy.md index 0432a3d9b844b..5176ab60232be 100644 --- a/ai/integrations/vector-search-integrate-with-sqlalchemy.md +++ b/ai/integrations/vector-search-integrate-with-sqlalchemy.md @@ -23,8 +23,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## 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 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. @@ -114,8 +114,8 @@ If you are running TiDB on your local machine, `` is `127.0.0.1` by defaul The following are descriptions for each parameter: -- ``: The username to connect to the TiDB cluster. -- ``: The password to connect to the TiDB cluster. +- ``: The username to connect to TiDB. +- ``: The password to connect to TiDB. - ``: The host of the TiDB cluster. - ``: The port of the TiDB cluster. - ``: The name of the database you want to connect to. @@ -153,7 +153,7 @@ You can refer to the following sample code snippets to develop your application. ### Create vector tables -#### Connect to a TiDB cluster +#### Connect to TiDB ```python import os diff --git a/ai/quickstart-via-python.md b/ai/quickstart-via-python.md index a6edc20cdca37..28f9a70587839 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 @@ -45,9 +45,9 @@ pip install "pytidb[models]"
-You can get these connection parameters from the [TiDB Cloud console](https://tidbcloud.com/clusters): +You can get these connection parameters from the [TiDB Cloud console](https://tidbcloud.com/tidbs): -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. +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, with connection parameters listed. For example, if the connection parameters are displayed as follows: @@ -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 @@ -82,7 +82,7 @@ client = TiDBClient.connect(
-Here is a basic example for connecting to a self-managed TiDB cluster: +Here is a basic example for connecting to a TiDB Self-Managed cluster: ```python from pytidb import TiDBClient diff --git a/ai/quickstart-via-sql.md b/ai/quickstart-via-sql.md index eefe644429ead..04247d7dfffbd 100644 --- a/ai/quickstart-via-sql.md +++ b/ai/quickstart-via-sql.md @@ -10,7 +10,7 @@ TiDB extends MySQL syntax to support [Vector Search](/ai/concepts/vector-search- This document demonstrates how to get started with TiDB Vector Search just using SQL statements. You will learn how to use the [MySQL command-line client](https://dev.mysql.com/doc/refman/8.4/en/mysql.html) to complete the following operations: -- Connect to your TiDB cluster. +- Connect to TiDB. - Create a vector table. - Store vector embeddings. - Perform vector search queries. @@ -29,19 +29,19 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Get started -### Step 1. Connect to the TiDB cluster +### Step 1. Connect to TiDB -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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/reference/vector-search-limitations.md b/ai/reference/vector-search-limitations.md index 56b6873318f73..fea4ea704c58c 100644 --- a/ai/reference/vector-search-limitations.md +++ b/ai/reference/vector-search-limitations.md @@ -37,7 +37,7 @@ When using vector search, note the following compatibility issues: - TiDB Self-Managed tools: - - Make sure that you are using v8.4.0 or a later version of [BR](/br/backup-and-restore-overview.md) to back up and restore data. Restoring tables with vector data types to TiDB clusters earlier than v8.4.0 is not supported. + - Make sure that you are using v8.4.0 or a later version of [BR](/br/backup-and-restore-overview.md) to back up and restore data. Restoring tables with vector data types to TiDB versions earlier than v8.4.0 is not supported. - [TiDB Data Migration (DM)](/dm/dm-overview.md) does not support migrating or replicating MySQL vector data types to TiDB. - When [TiCDC](/ticdc/ticdc-overview.md) replicates vector data to a downstream that does not support vector data types, it will change the vector data types to another type. For more information, see [Compatibility with vector data types](/ticdc/ticdc-compatibility.md#compatibility-with-vector-data-types). diff --git a/ai/vector-search-get-started-using-python.md b/ai/vector-search-get-started-using-python.md index df34d7b755107..587d24e845bf9 100644 --- a/ai/vector-search-get-started-using-python.md +++ b/ai/vector-search-get-started-using-python.md @@ -25,8 +25,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Get started @@ -53,16 +53,16 @@ pip install sqlalchemy pymysql sentence-transformers tidb-vector python-dotenv - `tidb-vector`: the Python client for interacting with TiDB vector search. - [`sentence-transformers`](https://sbert.net): a Python library that provides pre-trained models for generating [vector embeddings](/ai/concepts/vector-search-overview.md#vector-embedding) from text. -### Step 3. Configure the connection string to the TiDB cluster +### Step 3. Configure the TiDB connection string -Configure the cluster connection string depending on the TiDB deployment option you've selected. +Configure the 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 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. @@ -105,8 +105,8 @@ If you are running TiDB on your local machine, `` is `127.0.0.1` by defaul The following are descriptions for each parameter: -- ``: The username to connect to the TiDB cluster. -- ``: The password to connect to the TiDB cluster. +- ``: The username to connect to TiDB. +- ``: The password to connect to TiDB. - ``: The host of the TiDB cluster. - ``: The port of the TiDB cluster. - ``: The name of the database you want to connect to. @@ -134,9 +134,9 @@ def text_to_embedding(text): return embedding.tolist() ``` -### Step 5. Connect to the TiDB cluster +### Step 5. Connect to TiDB -Use the `TiDBVectorClient` class to connect to your TiDB cluster and create a table `embedded_documents` with a vector column. +Use the `TiDBVectorClient` class to connect to TiDB and create a table `embedded_documents` with a vector column. > **Note** > @@ -153,7 +153,7 @@ load_dotenv() vector_store = TiDBVectorClient( # The 'embedded_documents' table will store the vector data. table_name='embedded_documents', - # The connection string to the TiDB cluster. + # The TiDB connection string. connection_string=os.environ.get('TIDB_DATABASE_URL'), # The dimension of the vector generated by the embedding model. vector_dimension=embed_model_dims, diff --git a/develop/dev-guide-aws-appflow-integration.md b/develop/dev-guide-aws-appflow-integration.md index a826da95e3a69..40d1054304721 100644 --- a/develop/dev-guide-aws-appflow-integration.md +++ b/develop/dev-guide-aws-appflow-integration.md @@ -8,9 +8,9 @@ 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. +If you do not have a {{{ .starter }}} instance, you can follow [TiDB Cloud Quick Start](/tidb-cloud/tidb-cloud-quickstart.md) to create one, which is free and can be created in approximately 30 seconds. ## Prerequisites @@ -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 {{{ .starter }}} instance. For {{{ .starter }}}, 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..f01803533ccd0 100644 --- a/develop/dev-guide-bookshop-schema-design.md +++ b/develop/dev-guide-bookshop-schema-design.md @@ -19,7 +19,7 @@ To import table structures and data of the Bookshop application, choose one of t ### TiDB Self-Managed: via `tiup demo` -If your TiDB cluster is deployed using [TiUP](/tiup/tiup-reference.md#tiup-reference) or you can connect to your TiDB server, you can quickly generate and import sample data for the Bookshop application by running the following command: +If your TiDB Self-Managed cluster is deployed using [TiUP](/tiup/tiup-reference.md#tiup-reference) or you can connect to your TiDB server, you can quickly generate and import sample data for the Bookshop application by running the following command: ```shell tiup demo bookshop prepare @@ -73,15 +73,15 @@ You can delete the original table structure through the `--drop-tables` paramete ### TiDB Cloud: via the Import feature -1. Open the **Import** page for your target cluster. +1. Open the **Import** page for your target TiDB Cloud resource. - 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:** > - > If you have multiple projects, you can click in the lower-left corner and switch to another project. + > If you are in multiple organizations, use the combo box in the upper-left corner to switch to your target organization first. - 2. Click the name of your target cluster to go to its overview page, and then click **Import** in the left navigation pane. + 2. Click the name of your target resource to go to its overview page, and then click **Import** in the left navigation pane. 2. Select **Import data from Cloud Storage**, and then click **Amazon S3**. diff --git a/develop/dev-guide-build-cluster-in-cloud.md b/develop/dev-guide-build-cluster-in-cloud.md index d4f98b7415855..6d987904240a1 100644 --- a/develop/dev-guide-build-cluster-in-cloud.md +++ b/develop/dev-guide-build-cluster-in-cloud.md @@ -1,42 +1,42 @@ --- -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-starter-instance} 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 Resource** page, **Starter** is selected by default. Enter a name for your {{{ .starter }}} instance, and then select the cloud provider and region where you want to create it. -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. + Your {{{ .starter }}} instance will be created in approximately 30 seconds. -6. After your TiDB Cloud cluster is created, click your cluster name to go to the cluster overview page, and then click **Connect** in the upper-right corner. A connection dialog box is displayed. +6. After your {{{ .starter }}} instance is created, click your instance name to go to its overview page, and then click **Connect** in the upper-right corner. A connection dialog is displayed. 7. In the dialog, select your preferred connection method and operating system to get the corresponding connection string. This document uses MySQL client as an example. -8. Click **Generate Password** to generate a random password. The generated password will not show again, so save your password in a secure location. If you do not set a root password, you cannot connect to the cluster. +8. Click **Generate Password** to generate a random password. The generated password will not show again, so save your password in a secure location. If you do not set a root password, you cannot connect to the {{{ .starter }}} instance. > **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). +> When you connect to a {{{ .starter }}} instance, you must include the prefix for your instance 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 +## Step 2. Connect to a {{{ .starter }}} instance {#step-2-connect-to-a-starter-instance} 1. If the MySQL client is not installed, select your operating system and follow the steps below to install it. @@ -109,7 +109,7 @@ mysql Ver 15.1 Distrib 5.5.68-MariaDB, for Linux (x86_64) using readline 5.1 -2. Run the connection string obtained in [Step 1](#step-1-create-a-tidb-cloud-cluster). +2. Run the connection string obtained in [Step 1](#step-1-create-a-starter-instance). {{< copyable "shell-regular" >}} @@ -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..2f5780b41cef2 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 @@ -44,7 +44,7 @@ mysql ## View databases -To view the databases in a cluster, use the [`SHOW DATABASES`](/sql-statements/sql-statement-show-databases.md) statement. +To view the databases, use the [`SHOW DATABASES`](/sql-statements/sql-statement-show-databases.md) statement. For example: diff --git a/develop/dev-guide-create-secondary-indexes.md b/develop/dev-guide-create-secondary-indexes.md index d6ffb927eab37..a824caa19d68a 100644 --- a/develop/dev-guide-create-secondary-indexes.md +++ b/develop/dev-guide-create-secondary-indexes.md @@ -12,14 +12,14 @@ 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). ## What is secondary index -A secondary index is a logical object in a TiDB cluster. You can simply regard it as a sorting type of data that TiDB uses to improve the query performance. In TiDB, creating a secondary index is an online operation, which does not block any data read and write operations on a table. For each index, TiDB creates references for each row in a table and sorts the references by selected columns instead of by data directly. +A secondary index is a logical object in TiDB. You can simply regard it as a sorting type of data that TiDB uses to improve the query performance. In TiDB, creating a secondary index is an online operation, which does not block any data read and write operations on a table. For each index, TiDB creates references for each row in a table and sorts the references by selected columns instead of by data directly. For more information about secondary indexes, see [Secondary Indexes](/best-practices/tidb-best-practices.md#secondary-index). diff --git a/develop/dev-guide-create-table.md b/develop/dev-guide-create-table.md index 5d66ed9af5b1f..ea69e69ea595b 100644 --- a/develop/dev-guide-create-table.md +++ b/develop/dev-guide-create-table.md @@ -12,13 +12,13 @@ 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). ## What is a table -A [table](/develop/dev-guide-schema-design-overview.md#table) is a logical object in TiDB cluster that is subordinate to the [database](/develop/dev-guide-schema-design-overview.md#database). It is used to store the data sent from SQL statements. Tables save data records in the form of rows and columns. A table has at least one column. If you have defined `n` columns, each row of data has exactly the same fields as the `n` columns. +A [table](/develop/dev-guide-schema-design-overview.md#table) is a logical object in TiDB that is subordinate to the [database](/develop/dev-guide-schema-design-overview.md#database). It is used to store the data sent from SQL statements. Tables save data records in the form of rows and columns. A table has at least one column. If you have defined `n` columns, each row of data has exactly the same fields as the `n` columns. ## Name a table @@ -168,7 +168,7 @@ In addition to [primary key constraints](#select-primary-key), TiDB also support To set a default value on a column, use the `DEFAULT` constraint. The default value allows you to insert data without specifying a value for each column. -You can use `DEFAULT` together with [supported SQL functions](/functions-and-operators/functions-and-operators-overview.md) to move the calculation of defaults out of the application layer, thus saving resources of the application layer. The resources consumed by the calculation do not disappear and are moved to the TiDB cluster. Commonly, you can insert data with the default time. The following exemplifies setting the default value in the `ratings` table: +You can use `DEFAULT` together with [supported SQL functions](/functions-and-operators/functions-and-operators-overview.md) to move the calculation of defaults out of the application layer, thus saving resources of the application layer. The resources consumed by the calculation do not disappear and are instead handled by the database. Commonly, you can insert data with the default time. The following exemplifies setting the default value in the `ratings` table: ```sql CREATE TABLE `bookshop`.`ratings` ( @@ -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-starter-instance) 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-get-data-from-single-table.md b/develop/dev-guide-get-data-from-single-table.md index 843840f3af4c7..9c87aba362a8f 100644 --- a/develop/dev-guide-get-data-from-single-table.md +++ b/develop/dev-guide-get-data-from-single-table.md @@ -19,7 +19,7 @@ Before querying data, make sure that you have completed the following steps:
-1. [Create a TiDB Cloud cluster](/develop/dev-guide-build-cluster-in-cloud.md). +1. [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). 2. [Import table schema and sample data of the Bookshop application](/develop/dev-guide-bookshop-schema-design.md#import-table-structures-and-data). 3. [Connect to TiDB](/develop/dev-guide-connect-to-tidb.md). diff --git a/develop/dev-guide-gui-datagrip.md b/develop/dev-guide-gui-datagrip.md index c2822821a5285..cab767e4b3dbd 100644 --- a/develop/dev-guide-gui-datagrip.md +++ b/develop/dev-guide-gui-datagrip.md @@ -28,17 +28,17 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Connect to TiDB -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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 your target {{{ .starter }}} or Essential 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..f0bfe56720eda 100644 --- a/develop/dev-guide-gui-dbeaver.md +++ b/develop/dev-guide-gui-dbeaver.md @@ -8,7 +8,7 @@ aliases: ['/tidb/stable/dev-guide-gui-dbeaver/','/tidb/dev/dev-guide-gui-dbeaver TiDB is a MySQL-compatible database, and [DBeaver Community](https://dbeaver.io/download/) is a free cross-platform database tool for developers, database administrators, analysts, and everyone working with data. -In this tutorial, you can learn how to connect to your TiDB cluster using DBeaver Community. +In this tutorial, you can learn how to connect to TiDB using DBeaver Community. > **Note:** > @@ -23,8 +23,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). 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. @@ -42,12 +42,12 @@ In addition, to connect to a {{{ .starter }}} or {{{ .essential }}} public endpo ## Connect to TiDB -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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 your target {{{ .starter }}} or Essential 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..ea93a8f5d0116 100644 --- a/develop/dev-guide-gui-mysql-workbench.md +++ b/develop/dev-guide-gui-mysql-workbench.md @@ -13,7 +13,7 @@ TiDB is a MySQL-compatible database, and [MySQL Workbench](https://www.mysql.com > - Although you can use MySQL Workbench to connect to TiDB due to its MySQL compatibility, MySQL Workbench does not fully support TiDB. You might encounter some issues during usage as it treats TiDB as MySQL. > - It is recommended to use other GUI tools that officially support TiDB, such as [DataGrip](/develop/dev-guide-gui-datagrip.md), [DBeaver](/develop/dev-guide-gui-dbeaver.md), and [VS Code SQLTools](/develop/dev-guide-gui-vscode-sqltools.md). For a complete list of GUI tools that fully supported by TiDB, see [Third-party tools supported by TiDB](/develop/dev-guide-third-party-support.md#gui). -In this tutorial, you can learn how to connect to your TiDB cluster using MySQL Workbench. +In this tutorial, you can learn how to connect to TiDB using MySQL Workbench. > **Note:** > @@ -28,17 +28,17 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Connect to TiDB -Connect to your TiDB cluster depending on the TiDB deployment option you have selected. +Connect to TiDB depending on the TiDB deployment option you have 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 }}} 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 you created in step 4, 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 your target {{{ .starter }}} or Essential 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. @@ -125,7 +125,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you have se - **Hostname**: enter the IP address or domain name of your TiDB Self-Managed cluster. - **Port**: enter the port number of your TiDB Self-Managed cluster. - **Username**: enter the username to use to connect to your TiDB. - - **Password**: click **Store in Keychain ...**, enter the password to use to connect to your TiDB cluster, and then click **OK** to store the password. + - **Password**: click **Store in Keychain ...**, enter the password to use to connect to your TiDB Self-Managed cluster, and then click **OK** to store the password. ![MySQL Workbench: store the password of TiDB Self-Managed in keychain](/media/develop/mysql-workbench-store-self-hosted-password-in-keychain.png) diff --git a/develop/dev-guide-gui-navicat.md b/develop/dev-guide-gui-navicat.md index ce548b7c7efea..20701071e3ac1 100644 --- a/develop/dev-guide-gui-navicat.md +++ b/develop/dev-guide-gui-navicat.md @@ -8,7 +8,7 @@ aliases: ['/tidb/stable/dev-guide-gui-navicat/','/tidb/dev/dev-guide-gui-navicat TiDB is a MySQL-compatible database, and [Navicat](https://www.navicat.com) is a GUI tool set for database users. This tutorial uses the [Navicat Premium](https://www.navicat.com/en/products/navicat-premium) tool to connect to TiDB. -In this tutorial, you can learn how to connect to your TiDB cluster using Navicat. +In this tutorial, you can learn how to connect to TiDB using Navicat. > **Note:** > @@ -24,17 +24,17 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Connect to TiDB -Connect to your TiDB cluster depending on the TiDB deployment option you have selected. +Connect to TiDB depending on the TiDB deployment option you have 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 }}} 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 you created in step 4. ![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 your target {{{ .starter }}} or Essential 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..0e1a459fa770a 100644 --- a/develop/dev-guide-gui-vscode-sqltools.md +++ b/develop/dev-guide-gui-vscode-sqltools.md @@ -8,7 +8,7 @@ aliases: ['/tidb/stable/dev-guide-gui-vscode-sqltools/','/tidb/dev/dev-guide-gui TiDB is a MySQL-compatible database, and [Visual Studio Code (VS Code)](https://code.visualstudio.com/) is a lightweight but powerful source code editor. This tutorial uses the [SQLTools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools) extension which supports TiDB as an [official driver](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools-driver-mysql). -In this tutorial, you can learn how to connect to your TiDB cluster using Visual Studio Code. +In this tutorial, you can learn how to connect to TiDB using Visual Studio Code. > **Note:** > @@ -28,17 +28,17 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Connect to TiDB -Connect to your TiDB cluster depending on the TiDB deployment option you have selected. +Connect to TiDB depending on the TiDB deployment option you have 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 }}} 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 your target {{{ .starter }}} or Essential 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..b1e956f00c9d5 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 @@ -49,7 +49,7 @@ CREATE TABLE `player` (`id` INT, `coins` INT, `goods` INT); INSERT INTO `player` (`id`, `coins`, `goods`) VALUES (1, 1000, 1), (2, 230, 2); ``` -For more information on how to use this SQL, see [Connecting to a TiDB Cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-2-connect-to-a-cluster) and follow the steps to enter the SQL statement after connecting to a TiDB cluster using a client. +For more information on how to use this SQL, see [Connect to a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md#step-2-connect-to-a-starter-instance) and follow the steps to enter the SQL statement after connecting to a {{{ .starter }}} instance using a client.
@@ -231,14 +231,14 @@ For complete examples in Python, see: ## Bulk-Insert -If you need to quickly import a large amount of data into a TiDB cluster, it is recommended that you use a range of tools provided by **PingCAP** for data migration. Using the `INSERT` statement is not the best way, because it is not efficient and requires to handle exceptions and other issues on your own. +If you need to quickly import a large amount of data into TiDB, it is recommended that you use a range of tools provided by **PingCAP** for data migration. Using the `INSERT` statement is not the best way, because it is not efficient and requires to handle exceptions and other issues on your own. The following are the recommended tools for bulk-insert:
-- Data export: use [Dumpling](/dumpling-overview.md) to export MySQL or TiDB data to local or your cloud storage. For a TiDB Cloud Starter or Essential cluster, you can also use the [Export](/tidb-cloud/serverless-export.md) feature in the [TiDB Cloud console](https://tidbcloud.com/) to export data more efficiently. +- Data export: use [Dumpling](/dumpling-overview.md) to export MySQL or TiDB data to local or your cloud storage. For a {{{ .starter }}} or Essential instance, you can also use the [Export](/tidb-cloud/serverless-export.md) feature in the [TiDB Cloud console](https://tidbcloud.com/) to export data more efficiently. - Data import: use the [Import](/tidb-cloud/import-sample-data.md) feature in the [TiDB Cloud console](https://tidbcloud.com/). You can import Dumpling exported data, import a local CSV file, or [import CSV files from cloud storage into TiDB Cloud](/tidb-cloud/import-csv-files.md). - Data replication: use the [TiDB Data Migration](/tidb-cloud/migrate-from-mysql-using-data-migration.md) feature in the [TiDB Cloud console](https://tidbcloud.com/). You can replicate MySQL-compatible databases to TiDB. It also supports merging and migrating the sharded instances and tables from the source databases. - Data backup and restore: use the [Backup](/tidb-cloud/backup-and-restore.md) feature in the [TiDB Cloud console](https://tidbcloud.com/). Compared to Dumpling, backup and restore is more suitable for big data scenario. diff --git a/develop/dev-guide-proxysql-integration.md b/develop/dev-guide-proxysql-integration.md index ab316d81e3631..184fe0cb6326a 100644 --- a/develop/dev-guide-proxysql-integration.md +++ b/develop/dev-guide-proxysql-integration.md @@ -38,10 +38,10 @@ The most obvious way to deploy ProxySQL with TiDB is to add ProxySQL as a standa ## Development environment -This section describes how to integrate TiDB with ProxySQL in a development environment. To get started with the ProxySQL integration, you can choose either of the following options depending on your TiDB cluster type after you have all the [prerequisites](#prerequisite) in place. +This section describes how to integrate TiDB with ProxySQL in a development environment. To get started with the ProxySQL integration, you can choose either of the following options depending on your TiDB deployment option after you have all the [prerequisites](#prerequisite) in place. - Option 1: [Integrate TiDB Cloud with ProxySQL](#option-1-integrate-tidb-cloud-with-proxysql) -- Option 2: [Integrate TiDB (self-hosted) with ProxySQL](#option-2-integrate-tidb-self-hosted-with-proxysql) +- Option 2: [Integrate TiDB Self-Managed with ProxySQL](#option-2-integrate-tidb-self-managed-with-proxysql) ### Prerequisites @@ -120,15 +120,15 @@ 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. -2. Get your cluster hostname, port, and username for later use. +1. [Create a free {{{ .starter }}} instance](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart#step-1-create-a-starter-instance). Remember the root password that you set for your {{{ .starter }}} instance. +2. Get the hostname, port, and username of your {{{ .starter }}} instance for later use. - 1. On the [Clusters](https://tidbcloud.com/console/clusters) page, click your cluster name to go to the cluster overview page. - 2. On the cluster overview page, locate the **Connection** pane, and then copy the `Endpoint`, `Port`, and `User` fields, where the `Endpoint` is your cluster hostname. + 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. On the overview page, locate the **Connection** pane, and then copy the `Endpoint`, `Port`, and `User` fields, where the `Endpoint` is the hostname of your {{{ .starter }}} instance. #### Step 2. Generate ProxySQL configuration files @@ -222,7 +222,7 @@ For this integration, you will be using the [ProxySQL Docker image](https://hub. - When prompted, enter the endpoint of your cluster for `Serverless Tier Host`, and then enter the username and the password of your cluster. + When prompted, enter the endpoint of your {{{ .starter }}} instance for `Serverless Tier Host`, and then enter the username and the password of your {{{ .starter }}} instance. The following is an example output. You will see that three configuration files are generated under the current `tidb-cloud-connect` folder. @@ -326,14 +326,14 @@ For this integration, you will be using the [ProxySQL Docker image](https://hub. > > The `proxysql-prepare.sql` script does the following: > - > 1. Adds a user using the username and password of your cluster. + > 1. Adds a user using the username and password of your {{{ .starter }}} instance. > 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 {{{ .starter }}} instance is shown in the output, which means that the connectivity between ProxySQL and the {{{ .starter }}} instance is established. ``` *************************** 1. row *************************** @@ -351,9 +351,9 @@ For this integration, you will be using the [ProxySQL Docker image](https://hub. comment: ``` -#### Step 4. Connect to your TiDB cluster through ProxySQL +#### Step 4. Connect to TiDB through ProxySQL -1. To connect to your TiDB cluster, run `proxysql-connect.py`. The script will automatically launch the MySQL client and use the username and password you specified in [Step 2](#step-2-generate-proxysql-configuration-files) for connection. +1. To connect to your {{{ .starter }}} instance, run `proxysql-connect.py`. The script will automatically launch the MySQL client and use the username and password you specified in [Step 2](#step-2-generate-proxysql-configuration-files) for connection. @@ -383,17 +383,17 @@ For this integration, you will be using the [ProxySQL Docker image](https://hub. -2. After connecting to your TiDB cluster, you can use the following SQL statement to validate the connection: +2. After connecting to your {{{ .starter }}} instance, you can use the following SQL statement to validate the connection: ```sql 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:** > - > ***For Debugging:*** If you are unable to connect to the cluster, check the files `tidb-cloud-connect.cnf`, `proxysql-prepare.sql`, and `proxysql-connect.py`. Make sure that the server information you provided is available and correct. + > ***For Debugging:*** If you are unable to connect to the {{{ .starter }}} instance, check the files `tidb-cloud-connect.cnf`, `proxysql-prepare.sql`, and `proxysql-connect.py`. Make sure that the server information you provided is available and correct. 3. To stop and remove containers, and go to the previous directory, run the following command: @@ -428,9 +428,9 @@ For this integration, you will be using the [ProxySQL Docker image](https://hub. -### Option 2: Integrate TiDB (self-hosted) with ProxySQL +### Option 2: Integrate TiDB Self-Managed with ProxySQL -For this integration, you will set up an environment using Docker images of [TiDB](https://hub.docker.com/r/pingcap/tidb) and [ProxySQL](https://hub.docker.com/r/proxysql/proxysql). You are encouraged to try [other ways of installing TiDB (self-hosted)](https://docs.pingcap.com/tidb/stable/quick-start-with-tidb) in your own interest. +For this integration, you will set up an environment using Docker images of [TiDB](https://hub.docker.com/r/pingcap/tidb) and [ProxySQL](https://hub.docker.com/r/proxysql/proxysql). You are encouraged to try [other ways of installing TiDB Self-Managed](/quick-start-with-tidb.md) in your own interest. The following steps will set up ProxySQL and TiDB on ports `6033` and `4000` respectively, so make sure these ports are available. @@ -582,7 +582,7 @@ The following steps will set up ProxySQL and TiDB on ports `6033` and `4000` res -6. After connecting to your TiDB cluster, you can use the following SQL statement to validate the connection: +6. After connecting to your TiDB Self-Managed cluster, you can use the following SQL statement to validate the connection: ```sql SELECT VERSION(); @@ -639,7 +639,7 @@ For a full list of supported platforms and the corresponding version requirement #### Step 1. Create a TiDB Cloud Dedicated cluster -For detailed steps, see [Create a TiDB Cluster](https://docs.pingcap.com/tidbcloud/create-tidb-cluster). +For detailed steps, see [Create a TiDB Cloud Dedicated cluster](https://docs.pingcap.com/tidbcloud/create-tidb-cluster). #### Step 2. Install ProxySQL @@ -688,7 +688,7 @@ To use ProxySQL as a proxy for TiDB, you need to configure ProxySQL. To do so, y The above step will take you to the ProxySQL admin prompt. -2. Configure the TiDB clusters to be used, where you can add one or multiple TiDB clusters to ProxySQL. The following statement will add one TiDB Cloud Dedicated cluster for example. You need to replace `` and `` with your TiDB Cloud endpoint and port (the default port is `4000`). +2. Configure the TiDB Cloud Dedicated clusters to be used, where you can add one or multiple TiDB Cloud Dedicated clusters to ProxySQL. The following statement will add one TiDB Cloud Dedicated cluster for example. You need to replace `` and `` with your TiDB Cloud Dedicated endpoint and port (the default port is `4000`). ```sql INSERT INTO mysql_servers(hostgroup_id, hostname, port) @@ -705,10 +705,10 @@ To use ProxySQL as a proxy for TiDB, you need to configure ProxySQL. To do so, y > **Note:** > > - `hostgroup_id`: specify an ID of the hostgroup. ProxySQL manages clusters using hostgroup. To distribute SQL traffic to these clusters evenly, you can configure several clusters that need load balancing to the same hostgroup. To distinguish the clusters, such as for read and write purposes, you can configure them to use different hostgroups. - > - `hostname`: the endpoint of the TiDB cluster. - > - `port`: the port of the TiDB cluster. + > - `hostname`: the endpoint of the TiDB Cloud Dedicated cluster. + > - `port`: the port of the TiDB Cloud Dedicated cluster. -3. Configure Proxy login users to make sure that the users have appropriate permissions on the TiDB cluster. In the following statements, you need to replace '*tidb cloud dedicated cluster username*' and '*tidb cloud dedicated cluster password*' with the actual username and password of your cluster. +3. Configure Proxy login users to make sure that the users have appropriate permissions on the TiDB Cloud Dedicated cluster. In the following statements, you need to replace '*tidb cloud dedicated cluster username*' and '*tidb cloud dedicated cluster password*' with the actual username and password of your TiDB Cloud Dedicated cluster. ```sql INSERT INTO mysql_users( @@ -776,8 +776,8 @@ This option should only be considered as an alternate method for configuring Pro In the preceding example: - - `address` and `port`: specify the endpoint and port of your TiDB Cloud cluster. - - `username` and `password`: specify the username and password of your TiDB Cloud cluster. + - `address` and `port`: specify the endpoint and port of your TiDB Cloud Dedicated cluster. + - `username` and `password`: specify the username and password of your TiDB Cloud Dedicated cluster. 3. Restart ProxySQL: @@ -803,7 +803,7 @@ Databases can be overloaded by high traffic, faulty code, or malicious spam. Wit > **Note:** > -> In the following steps, you will be using the container images of TiDB and ProxySQL to configure query rules. If you have not pulled them, you can check the [integration section](#option-2-integrate-tidb-self-hosted-with-proxysql) for detailed steps. +> In the following steps, you will be using the container images of TiDB and ProxySQL to configure query rules. If you have not pulled them, you can check the [integration section](#option-2-integrate-tidb-self-managed-with-proxysql) for detailed steps. 1. Clone the [integration example code repository](https://github.com/pingcap-inc/tidb-proxysql-integration) for TiDB and ProxySQL. Skip this step if you have already cloned it in the previous steps. diff --git a/develop/dev-guide-sample-application-aws-lambda.md b/develop/dev-guide-sample-application-aws-lambda.md index e3aad2705f354..a7652332d4138 100644 --- a/develop/dev-guide-sample-application-aws-lambda.md +++ b/develop/dev-guide-sample-application-aws-lambda.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, [AWS Lambda Function](https://aws.amazon.co In this tutorial, you can learn how to use TiDB and mysql2 in AWS Lambda Function to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using mysql2. +- Connect to TiDB using mysql2. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. - Deploy your AWS Lambda Function. @@ -32,8 +32,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). 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. @@ -64,13 +64,13 @@ npm install ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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-cs.md b/develop/dev-guide-sample-application-cs.md index 59e185143bdf8..93348c1a3a22c 100644 --- a/develop/dev-guide-sample-application-cs.md +++ b/develop/dev-guide-sample-application-cs.md @@ -14,7 +14,7 @@ While .NET is commonly used on Windows, it is also available for macOS and Linux - Download the [.NET 9.0 SDK](https://dotnet.microsoft.com/en-us/download). - This tutorial uses the `dotnet` command-line tool. Alternatively, you can use the Visual Studio Code IDE to work with C# code. -- To complete this tutorial, you need access to a TiDB instance. You can use a [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) or [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#tidb-cloud-dedicated) cluster on TiDB Cloud, or a TiDB Self-Managed cluster, such as one started using `tiup playground`. +- To complete this tutorial, you need access to a TiDB instance. You can use a [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#starter) instance or [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#tidb-cloud-dedicated) cluster on TiDB Cloud, or a TiDB Self-Managed cluster, such as one started using `tiup playground`. ## Step 1. Set up a console project diff --git a/develop/dev-guide-sample-application-golang-gorm.md b/develop/dev-guide-sample-application-golang-gorm.md index d247595afec84..db36328af1fa7 100644 --- a/develop/dev-guide-sample-application-golang-gorm.md +++ b/develop/dev-guide-sample-application-golang-gorm.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [GORM](https://gorm.io/index.html) is a In this tutorial, you can learn how to use TiDB and GORM to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using GORM. +- Connect to TiDB using GORM. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note:** @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -46,12 +46,12 @@ cd tidb-golang-gorm-quickstart ### Step 2: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -190,7 +190,7 @@ func createDB() *gorm.DB { } ``` -When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, and `${tidb_db_name}` with the actual values of your TiDB cluster. {{{ .starter }}} requires a secure connection. Therefore, you need to set the value of `${use_ssl}` to `true`. +When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, and `${tidb_db_name}` with the actual values of your TiDB. {{{ .starter }}} requires a secure connection. Therefore, you need to set the value of `${use_ssl}` to `true`. ### Insert data diff --git a/develop/dev-guide-sample-application-golang-sql-driver.md b/develop/dev-guide-sample-application-golang-sql-driver.md index 81cc97967f4c4..fe5b55ef56fb2 100644 --- a/develop/dev-guide-sample-application-golang-sql-driver.md +++ b/develop/dev-guide-sample-application-golang-sql-driver.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [Go-MySQL-Driver](https://github.com/go In this tutorial, you can learn how to use TiDB and Go-MySQL-Driver to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using Go-MySQL-Driver. +- Connect to TiDB using Go-MySQL-Driver. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note:** @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -46,12 +46,12 @@ cd tidb-golang-sql-driver-quickstart ### Step 2: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -188,7 +188,7 @@ func openDB(driverName string, runnable func(db *sql.DB)) { } ``` -When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, and `${tidb_db_name}` with the actual values of your TiDB cluster. {{{ .starter }}} and {{{ .essential }}} require a secure connection. Therefore, you need to set the value of `${use_ssl}` to `true`. +When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, and `${tidb_db_name}` with the actual values of your TiDB. {{{ .starter }}} and {{{ .essential }}} require a secure connection. Therefore, you need to set the value of `${use_ssl}` to `true`. ### Insert data diff --git a/develop/dev-guide-sample-application-java-hibernate.md b/develop/dev-guide-sample-application-java-hibernate.md index 52dc0b2a75687..d92dbc46b1e45 100644 --- a/develop/dev-guide-sample-application-java-hibernate.md +++ b/develop/dev-guide-sample-application-java-hibernate.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [Hibernate](https://hibernate.org/orm/) In this tutorial, you can learn how to use TiDB and Hibernate to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using Hibernate. +- Connect to TiDB using Hibernate. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note:** @@ -29,8 +29,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -47,12 +47,12 @@ cd tidb-java-hibernate-quickstart ### Step 2: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -203,7 +203,7 @@ Edit the Hibernate configuration file `hibernate.cfg.xml`: ``` -Be sure to replace `${tidb_jdbc_url}`, `${tidb_user}`, and `${tidb_password}` with the actual values of your TiDB cluster. Then, define the following function: +Be sure to replace `${tidb_jdbc_url}`, `${tidb_user}`, and `${tidb_password}` with the actual values of your TiDB. Then, define the following function: ```java public SessionFactory getSessionFactory() { diff --git a/develop/dev-guide-sample-application-java-jdbc.md b/develop/dev-guide-sample-application-java-jdbc.md index e9376409062a5..fd29e4c7b50fc 100644 --- a/develop/dev-guide-sample-application-java-jdbc.md +++ b/develop/dev-guide-sample-application-java-jdbc.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and JDBC (Java Database Connectivity) is th In this tutorial, you can learn how to use TiDB and JDBC to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using JDBC. +- Connect to TiDB using JDBC. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note:** @@ -30,8 +30,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -48,12 +48,12 @@ cd tidb-java-jdbc-quickstart ### Step 2: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -194,7 +194,7 @@ public MysqlDataSource getMysqlDataSource() throws SQLException { } ``` -When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, and `${tidb_db_name}` with the actual values of your TiDB cluster. +When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, and `${tidb_db_name}` with the actual values of your TiDB. ### Insert data diff --git a/develop/dev-guide-sample-application-java-mybatis.md b/develop/dev-guide-sample-application-java-mybatis.md index bbbb47c91c5ae..b4c5d4d0f02b0 100644 --- a/develop/dev-guide-sample-application-java-mybatis.md +++ b/develop/dev-guide-sample-application-java-mybatis.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [MyBatis](https://mybatis.org/mybatis-3 In this tutorial, you can learn how to use TiDB and MyBatis to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using MyBatis. +- Connect to TiDB using MyBatis. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note:** @@ -29,8 +29,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -47,12 +47,12 @@ cd tidb-java-mybatis-quickstart ### Step 2: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -209,7 +209,7 @@ Edit the MyBatis configuration file `mybatis-config.xml`: ``` -Be sure to replace `${tidb_jdbc_url}`, `${tidb_user}`, and `${tidb_password}` with the actual values of your TiDB cluster. Also, replace `${mapper_location}` with the path of your mapper XML configuration file. For multiple mapper XML configuration files, you need to add a `` tag for each. Then, define the following function: +Be sure to replace `${tidb_jdbc_url}`, `${tidb_user}`, and `${tidb_password}` with the actual values of your TiDB. Also, replace `${mapper_location}` with the path of your mapper XML configuration file. For multiple mapper XML configuration files, you need to add a `` tag for each. Then, define the following function: ```java public SqlSessionFactory getSessionFactory() { diff --git a/develop/dev-guide-sample-application-java-spring-boot.md b/develop/dev-guide-sample-application-java-spring-boot.md index 3fa4d7221027a..66e969fe95b6d 100644 --- a/develop/dev-guide-sample-application-java-spring-boot.md +++ b/develop/dev-guide-sample-application-java-spring-boot.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [Spring](https://spring.io/) is a popul In this tutorial, you can learn how to use TiDB along with [Spring Data JPA](https://spring.io/projects/spring-data-jpa) and [Hibernate](https://hibernate.org/orm/) as the JPA provider to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using Hibernate and Spring Data JPA. +- Connect to TiDB using Hibernate and Spring Data JPA. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note:** @@ -29,8 +29,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -47,12 +47,12 @@ cd tidb-java-springboot-jpa-quickstart ### Step 2: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -197,7 +197,7 @@ spring: ddl-auto: create-drop ``` -After configuration, set the environment variables `TIDB_JDBC_URL`, `TIDB_USER`, and `TIDB_PASSWORD` to the actual values of your TiDB cluster. The configuration file provides default settings for these environment variables. If you do not configure the environment variables, the default values are as follows: +After configuration, set the environment variables `TIDB_JDBC_URL`, `TIDB_USER`, and `TIDB_PASSWORD` to the actual values of your TiDB. The configuration file provides default settings for these environment variables. If you do not configure the environment variables, the default values are as follows: - `TIDB_JDBC_URL`: `"jdbc:mysql://localhost:4000/test"` - `TIDB_USER`: `"root"` diff --git a/develop/dev-guide-sample-application-nextjs.md b/develop/dev-guide-sample-application-nextjs.md index 00b0590b56a78..11281058e62cd 100644 --- a/develop/dev-guide-sample-application-nextjs.md +++ b/develop/dev-guide-sample-application-nextjs.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [mysql2](https://github.com/sidorares/n In this tutorial, you can learn how to use TiDB and mysql2 in Next.js to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using mysql2. +- Connect to TiDB using mysql2. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note** @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -58,13 +58,13 @@ npm install ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB depending on the TiDB deployment option you've selected.
-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 802703940c40a..a3bec1e6f3f46 100644 --- a/develop/dev-guide-sample-application-nodejs-mysql2.md +++ b/develop/dev-guide-sample-application-nodejs-mysql2.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [node-mysql2](https://github.com/sidora In this tutorial, you can learn how to use TiDB and node-mysql2 to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using node-mysql2. +- Connect to TiDB using node-mysql2. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note:** @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -65,12 +65,12 @@ npm install mysql2 dotenv --save ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -179,7 +179,7 @@ Run the following command to execute the sample code: npm start ``` -If the connection is successful, the console will output the version of the TiDB cluster as follows: +If the connection is successful, the console will output the TiDB version as follows: ``` 🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-{{{ .tidb-version }}}) @@ -212,7 +212,7 @@ import * as fs from "fs"; dotenv.config(); async function main() { - // Step 3. Create a connection to the TiDB cluster. + // Step 3. Create a connection to TiDB. const options = { host: process.env.TIDB_HOST || '127.0.0.1', port: process.env.TIDB_PORT || 4000, diff --git a/develop/dev-guide-sample-application-nodejs-mysqljs.md b/develop/dev-guide-sample-application-nodejs-mysqljs.md index c945a789127b0..804e5b60a8995 100644 --- a/develop/dev-guide-sample-application-nodejs-mysqljs.md +++ b/develop/dev-guide-sample-application-nodejs-mysqljs.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [mysql.js](https://github.com/mysqljs/m In this tutorial, you can learn how to use TiDB and mysql.js driver to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using mysql.js driver. +- Connect to TiDB using mysql.js driver. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note:** @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -65,12 +65,12 @@ npm install mysql dotenv --save ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -154,7 +154,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele cp .env.example .env ``` -2. Edit the `.env` file, replace the corresponding placeholders `{}` with connection parameters of your cluster. The example configuration is as follows: +2. Edit the `.env` file, replace the corresponding placeholders `{}` with connection parameters of your TiDB. The example configuration is as follows: ```dotenv TIDB_HOST={host} @@ -179,7 +179,7 @@ Run the following command to execute the sample code: npm start ``` -If the connection is successful, the console will output the version of the TiDB cluster as follows: +If the connection is successful, the console will output the TiDB version as follows: ``` 🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.5.0) @@ -211,7 +211,7 @@ import * as fs from "fs"; // Step 2. Load environment variables from .env file to process.env. dotenv.config(); -// Step 3. Create a connection to the TiDB cluster. +// Step 3. Create a connection to TiDB. const options = { host: process.env.TIDB_HOST || '127.0.0.1', port: process.env.TIDB_PORT || 4000, diff --git a/develop/dev-guide-sample-application-nodejs-prisma.md b/develop/dev-guide-sample-application-nodejs-prisma.md index 570227bc4fe23..5ffcdd9af295f 100644 --- a/develop/dev-guide-sample-application-nodejs-prisma.md +++ b/develop/dev-guide-sample-application-nodejs-prisma.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [Prisma](https://github.com/prisma/pris In this tutorial, you can learn how to use TiDB and Prisma to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using Prisma. +- Connect to TiDB using Prisma. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note:** @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -65,12 +65,12 @@ npm install prisma typescript ts-node @types/node --save-dev ### Step 3: Provide connection Parameters -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -157,7 +157,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele cp .env.example .env ``` -2. Edit the `.env` file, set up the environment variable `DATABASE_URL` as follows, replace the corresponding placeholders `{}` with connection parameters of your TiDB cluster: +2. Edit the `.env` file, set up the environment variable `DATABASE_URL` as follows, replace the corresponding placeholders `{}` with connection parameters of your TiDB: ```dotenv DATABASE_URL='mysql://{user}:{password}@{host}:4000/test' @@ -258,7 +258,7 @@ void main(); **Expected execution output:** -If the connection is successful, the terminal will output the version of the TiDB cluster as follows: +If the connection is successful, the terminal will output the TiDB version as follows: ``` 🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.5.0) diff --git a/develop/dev-guide-sample-application-nodejs-sequelize.md b/develop/dev-guide-sample-application-nodejs-sequelize.md index 389bda7918c3e..e2bff8202e02f 100644 --- a/develop/dev-guide-sample-application-nodejs-sequelize.md +++ b/develop/dev-guide-sample-application-nodejs-sequelize.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [Sequelize](https://sequelize.org/) is In this tutorial, you can learn how to use TiDB and Sequelize to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using Sequelize. +- Connect to TiDB using Sequelize. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note** @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -58,13 +58,13 @@ npm install ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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 5ee36cbec3364..f030081a9f546 100644 --- a/develop/dev-guide-sample-application-nodejs-typeorm.md +++ b/develop/dev-guide-sample-application-nodejs-typeorm.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [TypeORM](https://github.com/TypeORM/Ty In this tutorial, you can learn how to use TiDB and TypeORM to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using TypeORM. +- Connect to TiDB using TypeORM. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note** @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -73,12 +73,12 @@ npm install @types/node ts-node typescript --save-dev ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -160,7 +160,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele cp .env.example .env ``` -2. Edit the `.env` file, set up the environment variables as follows, replace the corresponding placeholders `{}` with connection parameters of your TiDB cluster: +2. Edit the `.env` file, set up the environment variables as follows, replace the corresponding placeholders `{}` with connection parameters of your TiDB: ```dotenv TIDB_HOST={host} @@ -221,7 +221,7 @@ npm start **Expected execution output:** -If the connection is successful, the terminal will output the version of the TiDB cluster as follows: +If the connection is successful, the terminal will output the TiDB version as follows: ``` 🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.5.0) @@ -322,7 +322,7 @@ For more information, refer to [Delete data](/develop/dev-guide-delete-data.md). ### Execute raw SQL queries -The following query executes a raw SQL statement (`SELECT VERSION() AS tidb_version;`) and returns the version of the TiDB cluster: +The following query executes a raw SQL statement (`SELECT VERSION() AS tidb_version;`) and returns the TiDB version: ```typescript const rows = await dataSource.query('SELECT VERSION() AS tidb_version;'); diff --git a/develop/dev-guide-sample-application-python-django.md b/develop/dev-guide-sample-application-python-django.md index 64152b3c84e9c..8b2a9859d0f53 100644 --- a/develop/dev-guide-sample-application-python-django.md +++ b/develop/dev-guide-sample-application-python-django.md @@ -11,12 +11,12 @@ TiDB is a MySQL-compatible database, and [Django](https://www.djangoproject.com) In this tutorial, you can learn how to use TiDB and Django to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using Django. +- Connect to TiDB using Django. - Build and run your application. Optionally, you can find sample code snippets for basic CRUD operations. > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -64,12 +64,12 @@ For more information, refer to [django-tidb repository](https://github.com/pingc ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -237,7 +237,7 @@ if TIDB_CA_PATH: } ``` -You need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, `${tidb_db_name}`, and `${ca_path}` with the actual values of your TiDB cluster. +You need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, `${tidb_db_name}`, and `${ca_path}` with the actual values of your TiDB. ### Define the data model diff --git a/develop/dev-guide-sample-application-python-mysql-connector.md b/develop/dev-guide-sample-application-python-mysql-connector.md index e52f95719432d..3e80a5dfdef9c 100644 --- a/develop/dev-guide-sample-application-python-mysql-connector.md +++ b/develop/dev-guide-sample-application-python-mysql-connector.md @@ -11,12 +11,12 @@ TiDB is a MySQL-compatible database, and [MySQL Connector/Python](https://dev.my In this tutorial, you can learn how to use TiDB and MySQL Connector/Python to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using MySQL Connector/Python. +- Connect to TiDB using MySQL Connector/Python. - Build and run your application. Optionally, you can find sample code snippets for basic CRUD operations. > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -54,12 +54,12 @@ pip install -r requirements.txt ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -199,7 +199,7 @@ def get_connection(autocommit: bool = True) -> MySQLConnection: return mysql.connector.connect(**db_conf) ``` -When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, `${tidb_db_name}` and `${ca_path}` with the actual values of your TiDB cluster. +When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, `${tidb_db_name}` and `${ca_path}` with the actual values of your TiDB. ### Insert data diff --git a/develop/dev-guide-sample-application-python-mysqlclient.md b/develop/dev-guide-sample-application-python-mysqlclient.md index a750fff3fab01..5b838effdf0c7 100644 --- a/develop/dev-guide-sample-application-python-mysqlclient.md +++ b/develop/dev-guide-sample-application-python-mysqlclient.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [mysqlclient](https://github.com/PyMySQ In this tutorial, you can learn how to use TiDB and mysqlclient to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using mysqlclient. +- Connect to TiDB using mysqlclient. - Build and run your application. Optionally, you can find sample code snippets for basic CRUD operations. > **Note:** @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -56,12 +56,12 @@ If you encounter installation issues, refer to the [mysqlclient official documen ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -201,7 +201,7 @@ def get_mysqlclient_connection(autocommit:bool=True) -> MySQLdb.Connection: return MySQLdb.connect(**db_conf) ``` -When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, `${tidb_db_name}` and `${ca_path}` with the actual values of your TiDB cluster. +When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, `${tidb_db_name}` and `${ca_path}` with the actual values of your TiDB. ### Insert data diff --git a/develop/dev-guide-sample-application-python-peewee.md b/develop/dev-guide-sample-application-python-peewee.md index b8975396bec9e..9980a0d889bee 100644 --- a/develop/dev-guide-sample-application-python-peewee.md +++ b/develop/dev-guide-sample-application-python-peewee.md @@ -11,12 +11,12 @@ TiDB is a MySQL-compatible database, and [peewee](https://docs.peewee-orm.com/) In this tutorial, you can learn how to use TiDB and peewee to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using peewee. +- Connect to TiDB using peewee. - Build and run your application. Optionally, you can find sample code snippets for basic CRUD operations. > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -58,12 +58,12 @@ peewee is an ORM library that works with multiple databases. It provides a high- ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB depending on the TiDB deployment option you've selected.
-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. @@ -205,7 +205,7 @@ def get_db_engine(): ) ``` -When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, `${tidb_db_name}` and `${ca_path}` with the actual values of your TiDB cluster. +When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, `${tidb_db_name}` and `${ca_path}` with the actual values of your TiDB. ### Define a table diff --git a/develop/dev-guide-sample-application-python-pymysql.md b/develop/dev-guide-sample-application-python-pymysql.md index 29a112ae97dde..557573019af08 100644 --- a/develop/dev-guide-sample-application-python-pymysql.md +++ b/develop/dev-guide-sample-application-python-pymysql.md @@ -11,12 +11,12 @@ TiDB is a MySQL-compatible database, and [PyMySQL](https://github.com/PyMySQL/Py In this tutorial, you can learn how to use TiDB and PyMySQL to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using PyMySQL. +- Connect to TiDB using PyMySQL. - Build and run your application. Optionally, you can find sample code snippets for basic CRUD operations. > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -54,12 +54,12 @@ pip install -r requirements.txt ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -204,7 +204,7 @@ def get_connection(autocommit: bool = True) -> Connection: return pymysql.connect(**db_conf) ``` -When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, `${tidb_db_name}` and `${ca_path}` with the actual values of your TiDB cluster. +When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, `${tidb_db_name}` and `${ca_path}` with the actual values of your TiDB. ### Insert data diff --git a/develop/dev-guide-sample-application-python-sqlalchemy.md b/develop/dev-guide-sample-application-python-sqlalchemy.md index 4dfd249d35701..38c219e02ff98 100644 --- a/develop/dev-guide-sample-application-python-sqlalchemy.md +++ b/develop/dev-guide-sample-application-python-sqlalchemy.md @@ -11,12 +11,12 @@ TiDB is a MySQL-compatible database, and [SQLAlchemy](https://www.sqlalchemy.org In this tutorial, you can learn how to use TiDB and SQLAlchemy to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using SQLAlchemy. +- Connect to TiDB using SQLAlchemy. - Build and run your application. Optionally, you can find sample code snippets for basic CRUD operations. > **Note:** > -> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -28,8 +28,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -60,16 +60,16 @@ You can also use other database drivers, such as [mysqlclient](https://github.co ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB depending on the TiDB deployment option you've selected.
> **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. @@ -217,7 +217,7 @@ engine = get_db_engine() Session = sessionmaker(bind=engine) ``` -When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, `${tidb_db_name}` and `${ca_path}` with the actual values of your TiDB cluster. +When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, `${tidb_db_name}` and `${ca_path}` with the actual values of your TiDB. ### Define a table diff --git a/develop/dev-guide-sample-application-ruby-mysql2.md b/develop/dev-guide-sample-application-ruby-mysql2.md index 729bef4e323d0..b4a9f0bbf31d9 100644 --- a/develop/dev-guide-sample-application-ruby-mysql2.md +++ b/develop/dev-guide-sample-application-ruby-mysql2.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, and [mysql2](https://github.com/brianmario/ In this tutorial, you can learn how to use TiDB and mysql2 to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using mysql2. +- Connect to TiDB using mysql2. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations. > **Note:** @@ -29,8 +29,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -66,12 +66,12 @@ bundle add mysql2 dotenv ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -180,7 +180,7 @@ Run the following command to execute the sample code: ruby app.rb ``` -If the connection is successful, the console will output the version of the TiDB cluster as follows: +If the connection is successful, the console will output the TiDB version as follows: ``` 🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.5.0) diff --git a/develop/dev-guide-sample-application-ruby-rails.md b/develop/dev-guide-sample-application-ruby-rails.md index 4f50604bb8677..4ea0afcc3e7c9 100644 --- a/develop/dev-guide-sample-application-ruby-rails.md +++ b/develop/dev-guide-sample-application-ruby-rails.md @@ -11,7 +11,7 @@ TiDB is a MySQL-compatible database, [Rails](https://github.com/rails/rails) is In this tutorial, you can learn how to use TiDB and Rails to accomplish the following tasks: - Set up your environment. -- Connect to your TiDB cluster using Rails. +- Connect to TiDB using Rails. - Build and run your application. Optionally, you can find [sample code snippets](#sample-code-snippets) for basic CRUD operations using ActiveRecord ORM. > **Note:** @@ -29,8 +29,8 @@ 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. -- 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. +- (Recommended) [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md). +- [Deploy a local test TiDB Self-Managed cluster](/quick-start-with-tidb.md#deploy-a-local-test-cluster) or [Deploy a production TiDB Self-Managed cluster](/production-deployment-using-tiup.md). ## Run the sample app to connect to TiDB @@ -66,12 +66,12 @@ bundle add mysql2 dotenv ### Step 3: Configure connection information -Connect to your TiDB cluster depending on the TiDB deployment option you've selected. +Connect to TiDB 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 }}} 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. @@ -173,7 +173,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele bundle exec rails runner ./quickstart.rb ``` -If the connection is successful, the console will output the version of the TiDB cluster as follows: +If the connection is successful, the console will output the TiDB version as follows: ``` 🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.5.0) diff --git a/develop/dev-guide-schema-design-overview.md b/develop/dev-guide-schema-design-overview.md index 7a116f99da6e4..7703bed843217 100644 --- a/develop/dev-guide-schema-design-overview.md +++ b/develop/dev-guide-schema-design-overview.md @@ -14,7 +14,7 @@ In the subsequent documents, [Bookshop](/develop/dev-guide-bookshop-schema-desig To distinguish some general terms, here is a brief agreement on the terms used in TiDB: -- To avoid confusion with the generic term [database](https://en.wikipedia.org/wiki/Database), **database** in this document refers to a logical object, **TiDB** refers to TiDB itself, and **cluster** refers to a deployed instance of TiDB. +- To avoid confusion with the generic term [database](https://en.wikipedia.org/wiki/Database), **database** in this document refers to a logical object, **TiDB** refers to TiDB itself, and **cluster** refers to a running deployment of TiDB. - TiDB uses MySQL-compatible syntax, in which **schema** means the generic term [schema](https://en.wiktionary.org/wiki/schema) instead of a logical object in a database. For more information, see [MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/create-database.html). Make sure that you note this difference if you are migrating from databases that have schemas as logical objects (for example, [PostgreSQL](https://www.postgresql.org/docs/current/ddl-schemas.html), [Oracle](https://docs.oracle.com/en/database/oracle/oracle-database/21/tdddg/creating-managing-schema-objects.html), and [Microsoft SQL Server](https://docs.microsoft.com/en-us/sql/relational-databases/security/authentication-access/create-a-database-schema?view=sql-server-ver15)). diff --git a/develop/dev-guide-tidb-crud-sql.md b/develop/dev-guide-tidb-crud-sql.md index 01e9aafb708b2..b0087c566c801 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 TiDB. If not, [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-starter-instance) and connect to it first. ## Explore SQL with TiDB @@ -20,7 +20,7 @@ Please make sure you are connected to a TiDB cluster. If not, refer to [Create a TiDB is compatible with MySQL, you can use MySQL statements directly in most cases. For unsupported features, see [Compatibility with MySQL](/mysql-compatibility.md#unsupported-features). -To experiment with SQL and test out TiDB compatibility with MySQL queries, you can try [TiDB Playground](https://play.tidbcloud.com/?utm_source=docs&utm_medium=basic-sql-operations). You can also first deploy a TiDB cluster and then run SQL statements in it. +To experiment with SQL and test out TiDB compatibility with MySQL queries, you can try [TiDB Playground](https://play.tidbcloud.com/?utm_source=docs&utm_medium=basic-sql-operations). You can also first [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-starter-instance) and then run SQL statements in it. This page walks you through the basic TiDB SQL statements such as DDL, DML, and CRUD operations. For a complete list of TiDB statements, see [SQL Statement Overview](/sql-statements/sql-statement-overview.md). diff --git a/develop/dev-guide-transaction-restraints.md b/develop/dev-guide-transaction-restraints.md index f4e043ff46191..bae81b685ea0a 100644 --- a/develop/dev-guide-transaction-restraints.md +++ b/develop/dev-guide-transaction-restraints.md @@ -684,7 +684,7 @@ mysql> SELECT * FROM doctors; > **Note:** > -> Starting from v6.2.0, TiDB supports the [`savepoint`](/sql-statements/sql-statement-savepoint.md) feature. If your TiDB cluster is earlier than v6.2.0, your TiDB cluster does not support the `PROPAGATION_NESTED` behavior. It is recommended to upgrade to v6.2.0 or a later version. If upgrading TiDB is not possible, and your applications are based on the **Java Spring** framework that uses the `PROPAGATION_NESTED` propagation behavior, you need to adapt it on the application side to remove the logic for nested transactions. +> Starting from v6.2.0, TiDB supports the [`savepoint`](/sql-statements/sql-statement-savepoint.md) feature. If your TiDB version is earlier than v6.2.0, it does not support the `PROPAGATION_NESTED` behavior. It is recommended to upgrade to v6.2.0 or a later version. If upgrading TiDB is not possible, and your applications are based on the **Java Spring** framework that uses the `PROPAGATION_NESTED` propagation behavior, you need to adapt it on the application side to remove the logic for nested transactions. The `PROPAGATION_NESTED` propagation behavior supported by **Spring** triggers a nested transaction, which is a child transaction that is started independently of the current transaction. A `savepoint` is recorded when the nested transaction starts. If the nested transaction fails, the transaction will roll back to the `savepoint` state. The nested transaction is part of the outer transaction and will be committed together with the outer transaction. 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 4c3a55a5f13a1..96af2a19972f0 100644 --- a/develop/dev-guide-wordpress.md +++ b/develop/dev-guide-wordpress.md @@ -12,13 +12,13 @@ In this tutorial, you can learn how to use TiDB Cloud Serverless to run WordPres > **Note:** > -> In addition to TiDB Cloud Serverless, this tutorial works with TiDB Cloud Dedicated and TiDB Self-Managed clusters as well. However, it is highly recommended to run WordPress with TiDB Cloud Serverless for cost efficiency. +> In addition to {{{ .starter }}}, this tutorial works with {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed as well. However, it is highly recommended to run WordPress with {{{ .starter }}} for cost efficiency. ## Prerequisites To complete this tutorial, you need: -- A TiDB Cloud Serverless cluster. Follow [creating a TiDB Cloud Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create your own TiDB Cloud cluster if you don't have one. +- [Create a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) if you don't have one. ## Run WordPress with TiDB Cloud Serverless @@ -51,7 +51,7 @@ cd wordpress-tidb-docker Configure the WordPress database connection to TiDB Cloud Serverless. -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 TiDB Cloud Serverless. TIDB_DB_NAME='test' ``` - Be sure to replace the placeholders `{}` with the connection parameters obtained from the connection dialog. By default, your TiDB Cloud Serverless comes with a `test` database. If you have already created another database in your TiDB Cloud Serverless 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. @@ -100,9 +100,9 @@ Configure the WordPress database connection to TiDB Cloud Serverless. ### Step 5: Confirm the database connection -1. Close the connection dialog for your cluster on the TiDB Cloud console, and open the **SQL Editor** page. -2. Under the **Schemas** tab on the left, click the database you connected to Wordpress. -3. Confirm that you now see the Wordpress tables (such as `wp_posts` and `wp_comments`) in the list of tables for that database. +1. Close the connection dialog for your {{{ .starter }}} instance in the TiDB Cloud console, and open the **SQL Editor** page. +2. Under the **Schemas** tab on the left, click the database you connected to WordPress. +3. Confirm that you now see the WordPress tables (such as `wp_posts` and `wp_comments`) in the list of tables for that database. ## Need help? diff --git a/develop/java-app-best-practices.md b/develop/java-app-best-practices.md index 528ab72858d7e..02eb296206243 100644 --- a/develop/java-app-best-practices.md +++ b/develop/java-app-best-practices.md @@ -190,7 +190,7 @@ In addition, because of a [client bug](https://bugs.mysql.com/bug.php?id=96623), #### Integrate parameters -Through monitoring, you might notice that although the application only performs `INSERT` operations to the TiDB cluster, there are a lot of redundant `SELECT` statements. Usually this happens because JDBC sends some SQL statements to query the settings, for example, `select @@session.transaction_read_only`. These SQL statements are useless for TiDB, so it is recommended that you configure `useConfigs=maxPerformance` to avoid extra overhead. +Through monitoring, you might notice that although the application only performs `INSERT` operations to TiDB, there are a lot of redundant `SELECT` statements. Usually this happens because JDBC sends some SQL statements to query the settings, for example, `select @@session.transaction_read_only`. These SQL statements are useless for TiDB, so it is recommended that you configure `useConfigs=maxPerformance` to avoid extra overhead. `useConfigs=maxPerformance` includes a group of configurations. To get the detailed configurations in MySQL Connector/J 8.0 and those in MySQL Connector/J 5.1, see [mysql-connector-j 8.0](https://github.com/mysql/mysql-connector-j/blob/release/8.0/src/main/resources/com/mysql/cj/configurations/maxPerformance.properties) and [mysql-connector-j 5.1](https://github.com/mysql/mysql-connector-j/blob/release/5.1/src/com/mysql/jdbc/configs/maxPerformance.properties) respectively. diff --git a/develop/serverless-driver-drizzle-example.md b/develop/serverless-driver-drizzle-example.md index 714f440d1733b..0d90faf4810ec 100644 --- a/develop/serverless-driver-drizzle-example.md +++ b/develop/serverless-driver-drizzle-example.md @@ -10,6 +10,10 @@ aliases: ['/tidbcloud/serverless-driver-drizzle-example/'] This tutorial describes how to use TiDB Cloud serverless driver with Drizzle in Node.js environments and edge environments. +> **Tip:** +> +> 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 This section describes how to use TiDB Cloud serverless driver with Drizzle in Node.js environments. @@ -20,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 TiDB Cloud Serverless cluster. If you don't have any, you can [create a TiDB Cloud Serverless 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 @@ -70,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 TiDB Cloud Serverless 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. @@ -92,7 +96,7 @@ To complete this tutorial, you need the following: ### Step 3. Use Drizzle to query data -1. Create a table in your TiDB Cloud Serverless 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: @@ -156,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 TiDB Cloud Serverless cluster. If you don't have any, you can [create a TiDB Cloud Serverless 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 @@ -186,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 TiDB Cloud Serverless 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. @@ -202,7 +206,7 @@ To complete this tutorial, you need the following: ### Step 3. Create an edge function -1. Create a table in your TiDB Cloud Serverless 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 15cc345a95d46..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 TiDB Cloud Serverless cluster. If you don't have any, you can [create a TiDB Cloud Serverless 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 TiDB Cloud Serverless 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 TiDB Cloud Serverless 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 TiDB Cloud Serverless cluster. If you don't have any, you can [create a TiDB Cloud Serverless 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 TiDB Cloud Serverless 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 TiDB Cloud Serverless 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 5fc4d9b27012b..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:** > -> - This tutorial is applicable to TiDB Cloud Serverless clusters only. +> - 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 TiDB Cloud Serverless cluster. If you don't have any, you can [create a TiDB Cloud Serverless 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 TiDB Cloud Serverless 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 TiDB Cloud Serverless 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 00a845ac42e07..81dd09de642ba 100644 --- a/develop/serverless-driver-prisma-example.md +++ b/develop/serverless-driver-prisma-example.md @@ -13,6 +13,10 @@ aliases: ['/tidbcloud/serverless-driver-prisma-example/'] This tutorial describes how to use [@tidbcloud/prisma-adapter](https://github.com/tidbcloud/prisma-adapter) in serverless environments and edge environments. +> **Tip:** +> +> In addition to {{{ .starter }}} instances, the steps in this document also work with {{{ .essential }}} instances. + ## Install You need to install both [@tidbcloud/prisma-adapter](https://github.com/tidbcloud/prisma-adapter) and [TiDB Cloud serverless driver](/develop/serverless-driver.md). You can install them using [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) or your preferred package manager. @@ -80,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 TiDB Cloud Serverless cluster. If you don't have any, you can [create a TiDB Cloud Serverless 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 @@ -119,7 +123,7 @@ To complete this tutorial, you need the following: ### Step 2. Set the environment -1. On the overview page of your TiDB Cloud Serverless 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 @@ -180,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 TiDB Cloud Serverless 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 TiDB Cloud Serverless 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 9245d4681f843..69b8ba4ffd17b 100644 --- a/develop/serverless-driver.md +++ b/develop/serverless-driver.md @@ -6,11 +6,15 @@ aliases: ['/tidbcloud/serverless-driver-config/','/tidbcloud/serverless-driver/' # TiDB Cloud Serverless Driver (Beta) +> **Note:** +> +> 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 allows you to connect to your TiDB Cloud Serverless cluster over HTTP, which is generally supported by serverless environments. With it, it is now possible to connect to TiDB Cloud Serverless 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:** > @@ -26,11 +30,11 @@ npm install @tidbcloud/serverless ## Use the serverless driver -You can use the serverless driver to query data of a TiDB Cloud Serverless 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 TiDB Cloud Serverless 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' @@ -154,10 +158,10 @@ At the connection level, you can make the following configurations: | Name | Type | Default value | Description | |--------------|----------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `username` | string | N/A | Username of TiDB Cloud Serverless | -| `password` | string | N/A | Password of TiDB Cloud Serverless | -| `host` | string | N/A | Hostname of TiDB Cloud Serverless | -| `database` | string | `test` | Database of TiDB Cloud Serverless | +| `username` | string | N/A | Username of the {{{ .starter }}} or {{{ .essential }}} instance. | +| `password` | string | N/A | Password of the {{{ .starter }}} or {{{ .essential }}} instance. | +| `host` | string | N/A | Hostname of the {{{ .starter }}} or {{{ .essential }}} instance. | +| `database` | string | `test` | Database of the {{{ .starter }}} or {{{ .essential }}} instance. | | `url` | string | N/A | The URL for the database, in the `mysql://[username]:[password]@[host]/[database]` format, where `database` can be skipped if you intend to connect to the default database. | | `fetch` | function | global fetch | Custom fetch function. For example, you can use the `undici` fetch in node.js. | | `arrayMode` | bool | `false` | Whether to return results as arrays instead of objects. To get better performance, set it to `true`. | @@ -329,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 57e46f65d6f09..e6db01e85b97b 100644 --- a/functions-and-operators/miscellaneous-functions.md +++ b/functions-and-operators/miscellaneous-functions.md @@ -26,7 +26,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 1a1a24d79e003..87b828fce8f84 100644 --- a/information-schema/information-schema-cluster-info.md +++ b/information-schema/information-schema-cluster-info.md @@ -10,7 +10,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 3b20462c7f10e..34b8d6c4adfc1 100644 --- a/information-schema/information-schema-placement-policies.md +++ b/information-schema/information-schema-placement-policies.md @@ -10,7 +10,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 db00ca039c2d5..cd52cd8db794b 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 9b3de52791dac..54e2d740e3cdb 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. @@ -142,7 +142,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 6fc0102474140..829008694be46 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 32e0ee288e3d8..f29c323c177f4 100644 --- a/information-schema/information-schema.md +++ b/information-schema/information-schema.md @@ -114,15 +114,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. | @@ -137,11 +137,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. | @@ -170,15 +170,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. | @@ -192,11 +192,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 deb85071aa1bb..2afe58f5dc6ad 100644 --- a/mysql-compatibility.md +++ b/mysql-compatibility.md @@ -49,7 +49,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`, `gbk`, and `gb18030`. diff --git a/placement-rules-in-sql.md b/placement-rules-in-sql.md index d593821b5154a..dafd4caf9f089 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 a1e01172ce1b3..eeedf8a1d9f31 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -494,7 +494,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 9fdffc984f56d..07e6afcc199bf 100644 --- a/sql-statements/sql-statement-add-index.md +++ b/sql-statements/sql-statement-add-index.md @@ -101,7 +101,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 f651724e97f71..42960381328f5 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 7af6c44239142..4fc3815848c4d 100644 --- a/sql-statements/sql-statement-admin.md +++ b/sql-statements/sql-statement-admin.md @@ -60,7 +60,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] ...; @@ -134,7 +134,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 62f25adc6e75f..c1d427c118111 100644 --- a/sql-statements/sql-statement-alter-instance.md +++ b/sql-statements/sql-statement-alter-instance.md @@ -10,7 +10,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 3224829929d56..48d3355111455 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 8aba7ad8252e3..e7577fb409c9c 100644 --- a/sql-statements/sql-statement-backup.md +++ b/sql-statements/sql-statement-backup.md @@ -11,7 +11,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 1038371452003..06be1adf28a73 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#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. diff --git a/sql-statements/sql-statement-create-index.md b/sql-statements/sql-statement-create-index.md index ae37ca6f15550..79c3af8771011 100644 --- a/sql-statements/sql-statement-create-index.md +++ b/sql-statements/sql-statement-create-index.md @@ -389,7 +389,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 3c0d7897ab615..84907d06ebe01 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 3050ee43ee1f5..dd3ae1ad9ed9a 100644 --- a/sql-statements/sql-statement-create-table.md +++ b/sql-statements/sql-statement-create-table.md @@ -283,7 +283,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 9bd4b6c3884bf..e9ea874f271df 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#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. 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 229f88062f964..0451ea6836472 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 47f2e1f5144e4..7b2af5a2a1277 100644 --- a/sql-statements/sql-statement-flashback-cluster.md +++ b/sql-statements/sql-statement-flashback-cluster.md @@ -12,7 +12,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 1145cc4238efb..da4ed9a2afc97 100644 --- a/sql-statements/sql-statement-import-into.md +++ b/sql-statements/sql-statement-import-into.md @@ -203,7 +203,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 27f529906d0c8..fc8a81717ab46 100644 --- a/sql-statements/sql-statement-load-stats.md +++ b/sql-statements/sql-statement-load-stats.md @@ -10,7 +10,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 ff6c10a9ebad3..f0d7fee56d235 100644 --- a/sql-statements/sql-statement-restore.md +++ b/sql-statements/sql-statement-restore.md @@ -11,7 +11,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 d725dd9b6cb23..9a350ff632736 100644 --- a/sql-statements/sql-statement-show-backups.md +++ b/sql-statements/sql-statement-show-backups.md @@ -14,7 +14,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 757f983d9cfd5..cf88c60d54722 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#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. 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 cf2922187c256..9cc2e19155b8d 100644 --- a/sql-statements/sql-statement-show-plugins.md +++ b/sql-statements/sql-statement-show-plugins.md @@ -10,7 +10,7 @@ aliases: ['/docs/dev/sql-statements/sql-statement-show-plugins/'] > **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 7815873f4f172..6fbf66b9b2f92 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#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. diff --git a/sql-statements/sql-statement-show-table-regions.md b/sql-statements/sql-statement-show-table-regions.md index e45816c2117e6..b31edd323b41e 100644 --- a/sql-statements/sql-statement-show-table-regions.md +++ b/sql-statements/sql-statement-show-table-regions.md @@ -10,7 +10,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 990f63fc5df9f..ca48b7c651888 100644 --- a/sql-statements/sql-statement-split-region.md +++ b/sql-statements/sql-statement-split-region.md @@ -14,7 +14,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 37941f2fa5152..db190136c129c 100644 --- a/statement-summary-tables.md +++ b/statement-summary-tables.md @@ -18,7 +18,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 30265ab448f73..fb470e2e132a3 100644 --- a/statistics.md +++ b/statistics.md @@ -461,7 +461,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 89cee140d97d2..82b43fb49f615 100644 --- a/system-variables.md +++ b/system-variables.md @@ -1678,7 +1678,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 @@ -2370,7 +2370,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 @@ -2452,7 +2452,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 @@ -2784,7 +2784,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 @@ -2848,7 +2848,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 @@ -2960,7 +2960,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 @@ -3192,7 +3192,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 @@ -3212,7 +3212,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 @@ -3242,7 +3242,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 @@ -3257,7 +3257,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 @@ -3275,7 +3275,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 @@ -3370,7 +3370,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 @@ -3405,7 +3405,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 @@ -3418,7 +3418,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 @@ -3693,7 +3693,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 @@ -3793,7 +3793,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. @@ -4798,10 +4798,10 @@ mysql> desc select count(distinct a) from test.t; - Type: Enum - Default value: `DISABLE` - Possible values: `DISABLE`, `COST` -- Controls whether the optimizer can leverage the partial order of an index to optimize TopN computation when a query contains `ORDER BY ... LIMIT`. When the sort column matches the index order (for example, the sort column is an index column or has a prefix index), the data returned by the index scan is already partially ordered on that column. In this case, the optimizer can incrementally build the TopN result during the scan and stop early once the `LIMIT` is satisfied, thereby reducing sorting overhead. +- Controls whether the optimizer can leverage the partial order of an index to optimize TopN computation when a query contains `ORDER BY ... LIMIT`. When the sort column matches the index order (for example, the sort column is an index column or has a prefix index), the data returned by the index scan is already partially ordered on that column. In this case, the optimizer can incrementally build the TopN result during the scan and stop early once the `LIMIT` is satisfied, thereby reducing sorting overhead. - Usage scenarios: When the sort column in an `ORDER BY ... LIMIT` clause is a long string with only a prefix index, to reduce the TopN sorting overhead, you can set this variable to `COST` and specify a `USE INDEX` or `FORCE INDEX` hint in the query to enable the partial order TopN optimization. - - The default value is `DISABLE`, which means the partial order TopN optimization is disabled. In this case, the optimizer uses the standard global sorting approach for TopN. + - The default value is `DISABLE`, which means the partial order TopN optimization is disabled. In this case, the optimizer uses the standard global sorting approach for TopN. - To force the use of the partial order TopN optimization, set this variable to `COST` and specify a qualifying index in the query using `USE INDEX` or `FORCE INDEX`. If the specified index does not meet the prerequisites for this optimization (for example, the `ORDER BY` clause does not match the index prefix, or the query contains unsupported ordering patterns), the optimization might not be applied even when the variable is set to `COST`, and the execution plan falls back to the standard TopN approach. > **Note:** @@ -5449,7 +5449,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 @@ -5782,7 +5782,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 @@ -5823,7 +5823,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 @@ -5841,7 +5841,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 @@ -5854,7 +5854,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 @@ -5920,7 +5920,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 @@ -6105,7 +6105,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 @@ -6252,7 +6252,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 @@ -6266,7 +6266,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 @@ -6279,7 +6279,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 @@ -6305,7 +6305,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 @@ -6327,7 +6327,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 @@ -6503,7 +6503,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 @@ -6567,7 +6567,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 @@ -6580,7 +6580,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 @@ -6593,7 +6593,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 @@ -6606,7 +6606,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 @@ -6619,7 +6619,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 @@ -6632,7 +6632,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 @@ -6645,7 +6645,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 @@ -6658,7 +6658,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 @@ -6671,7 +6671,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 @@ -6749,7 +6749,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 @@ -6774,7 +6774,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 @@ -6789,7 +6789,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 @@ -7089,6 +7089,19 @@ Internally, the TiDB parser transforms the `SET TRANSACTION ISOLATION LEVEL [REA - In the Stale Read scenarios, this session variable is used to help record the Stable Read timestamp value. - This variable is used for the internal operation of TiDB. It is **NOT recommended** to set this variable. +### txn_scope + +> **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) instances. + +- Scope: SESSION +- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No +- Default value: `global` +- Value options: `global` and `local` +- This variable is used to set whether the current session transaction is a global transaction or a local transaction. +- This variable is used for the internal operation of TiDB. It is **NOT recommended** to set this variable. + ### validate_password.check_user_name New in v6.5.0 - Scope: GLOBAL @@ -7213,7 +7226,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/get-started-with-cli.md b/tidb-cloud/get-started-with-cli.md index a0d93b7cd1f13..5cde21205a533 100644 --- a/tidb-cloud/get-started-with-cli.md +++ b/tidb-cloud/get-started-with-cli.md @@ -87,10 +87,6 @@ Install the MySQL command-line client if you do not have it. You can refer to th ## Quick start -> **Note:** -> -> If you use TiUP, you can use `tiup cloud` instead of `ticloud`. - [{{{ .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 diff --git a/tidb-cloud/manage-user-access.md b/tidb-cloud/manage-user-access.md index 165ef498bf28d..8bf0108fa158b 100644 --- a/tidb-cloud/manage-user-access.md +++ b/tidb-cloud/manage-user-access.md @@ -72,15 +72,15 @@ In TiDB Cloud, there are three types of projects: - **TiDB Dedicated project**: This project type is used only for {{{ .dedicated }}} clusters. It helps you manage settings for {{{ .dedicated }}} clusters separately by project, such as RBAC, networks, maintenance, alert subscriptions, and encryption access. - **TiDB X project**: This project type is used only for TiDB X instances ({{{ .starter }}} and {{{ .essential }}}). It helps you manage RBAC for TiDB X instances by project. A TiDB X project is the default project type when you create a project on the [**My TiDB**](https://tidbcloud.com/tidbs) page. -- **TiDB X virtual project**: This project is virtual and does not provide any management capabilities. It acts as a virtual container for TiDB X instances ({{{ .starter }}} and {{{ .essential }}}) that do not belong to any project, so these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. You can get this ID from the [List all accessible projects](https://docs.pingcap.com/tidbcloud/api/v1beta/#tag/Project/operation/ListProjects) endpoint of the TiDB Cloud API. +- **TiDB X virtual project**: This project is virtual and does not provide any management capabilities. It acts as a virtual container for TiDB X instances ({{{ .starter }}} and {{{ .essential }}}) that do not belong to any project, so these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. You can get this ID from the project view on the [**My TiDB**](https://tidbcloud.com/tidbs) page. The following table lists the differences between these project types: | Feature | TiDB Dedicated Project | TiDB X Project | TiDB X Virtual Project | |---|---|---|---| -| Project icon in the project view of the [**My TiDB**](https://tidbcloud.com/tidbs) page |
(Folder icon with the letter D inside) |
(Regular folder icon) | The project view displays TiDB X instances that are not assigned to any project in the **Out of project** list. | +| Project icon in the TiDB Cloud console | |
| N/A | | Resource type in the project | {{{ .dedicated}}} clusters only | TiDB X instances only | TiDB X instances only | -| Project is optional | ❌
(Each {{{ .dedicated }}} cluster must belong to a Dedicated project) | ✅
(You can either group a TiDB X instance in a TiDB X project or keep it at the organization level) | TiDB X instances that are not assigned to any project are automatically grouped into the TiDB X virtual project. | +| Project is optional | ❌
(Each {{{ .dedicated }}} cluster must belong to a Dedicated project) | ✅
(You can either group a TiDB X instance in a TiDB X project or keep it at the organization level) | N/A
(TiDB X instances not grouped in any TiDB X project are automatically grouped in the TiDB X virtual project) | | Project settings | ✅ | ❌ | ❌ | | Infrastructure binding | ✅
(Strong binding) | ❌ | ❌ | | RBAC model | Organization -> Project | Organization -> Project -> Instance | Organization -> Project -> Instance | 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 35a310ad52207..199786dd28fe9 100644 --- a/tidb-resource-control-background-tasks.md +++ b/tidb-resource-control-background-tasks.md @@ -7,7 +7,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 6c94521fc4d20..ab2a925dbdb87 100644 --- a/tidb-resource-control-ru-groups.md +++ b/tidb-resource-control-ru-groups.md @@ -8,7 +8,7 @@ aliases: ['/tidb/dev/tidb-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. 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 cc37cd579dd7c..2b8fee7852b3c 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 f62904d0d8cee..00065759cc39d 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. From 90ef29c91d2ddcbe7825e8ecf7b52598a6434c8a Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Wed, 22 Apr 2026 12:41:36 +0800 Subject: [PATCH 2/4] Discard changes to tidb-cloud/manage-user-access.md --- tidb-cloud/manage-user-access.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tidb-cloud/manage-user-access.md b/tidb-cloud/manage-user-access.md index 8bf0108fa158b..165ef498bf28d 100644 --- a/tidb-cloud/manage-user-access.md +++ b/tidb-cloud/manage-user-access.md @@ -72,15 +72,15 @@ In TiDB Cloud, there are three types of projects: - **TiDB Dedicated project**: This project type is used only for {{{ .dedicated }}} clusters. It helps you manage settings for {{{ .dedicated }}} clusters separately by project, such as RBAC, networks, maintenance, alert subscriptions, and encryption access. - **TiDB X project**: This project type is used only for TiDB X instances ({{{ .starter }}} and {{{ .essential }}}). It helps you manage RBAC for TiDB X instances by project. A TiDB X project is the default project type when you create a project on the [**My TiDB**](https://tidbcloud.com/tidbs) page. -- **TiDB X virtual project**: This project is virtual and does not provide any management capabilities. It acts as a virtual container for TiDB X instances ({{{ .starter }}} and {{{ .essential }}}) that do not belong to any project, so these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. You can get this ID from the project view on the [**My TiDB**](https://tidbcloud.com/tidbs) page. +- **TiDB X virtual project**: This project is virtual and does not provide any management capabilities. It acts as a virtual container for TiDB X instances ({{{ .starter }}} and {{{ .essential }}}) that do not belong to any project, so these instances can be accessed through the TiDB Cloud API by using a project ID. Each organization has a unique virtual project ID. You can get this ID from the [List all accessible projects](https://docs.pingcap.com/tidbcloud/api/v1beta/#tag/Project/operation/ListProjects) endpoint of the TiDB Cloud API. The following table lists the differences between these project types: | Feature | TiDB Dedicated Project | TiDB X Project | TiDB X Virtual Project | |---|---|---|---| -| Project icon in the TiDB Cloud console | |
| N/A | +| Project icon in the project view of the [**My TiDB**](https://tidbcloud.com/tidbs) page |
(Folder icon with the letter D inside) |
(Regular folder icon) | The project view displays TiDB X instances that are not assigned to any project in the **Out of project** list. | | Resource type in the project | {{{ .dedicated}}} clusters only | TiDB X instances only | TiDB X instances only | -| Project is optional | ❌
(Each {{{ .dedicated }}} cluster must belong to a Dedicated project) | ✅
(You can either group a TiDB X instance in a TiDB X project or keep it at the organization level) | N/A
(TiDB X instances not grouped in any TiDB X project are automatically grouped in the TiDB X virtual project) | +| Project is optional | ❌
(Each {{{ .dedicated }}} cluster must belong to a Dedicated project) | ✅
(You can either group a TiDB X instance in a TiDB X project or keep it at the organization level) | TiDB X instances that are not assigned to any project are automatically grouped into the TiDB X virtual project. | | Project settings | ✅ | ❌ | ❌ | | Infrastructure binding | ✅
(Strong binding) | ❌ | ❌ | | RBAC model | Organization -> Project | Organization -> Project -> Instance | Organization -> Project -> Instance | From 1b046827306f82919da5f14dd7430696814bd829 Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Wed, 22 Apr 2026 12:42:32 +0800 Subject: [PATCH 3/4] Discard changes to tidb-cloud/get-started-with-cli.md --- tidb-cloud/get-started-with-cli.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tidb-cloud/get-started-with-cli.md b/tidb-cloud/get-started-with-cli.md index 5cde21205a533..a0d93b7cd1f13 100644 --- a/tidb-cloud/get-started-with-cli.md +++ b/tidb-cloud/get-started-with-cli.md @@ -87,6 +87,10 @@ Install the MySQL command-line client if you do not have it. You can refer to th ## Quick start +> **Note:** +> +> If you use TiUP, you can use `tiup cloud` instead of `ticloud`. + [{{{ .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 From 2b605ecb3bac78aa4e5b9d75b378e7f3471b2a19 Mon Sep 17 00:00:00 2001 From: qiancai Date: Wed, 22 Apr 2026 13:03:33 +0800 Subject: [PATCH 4/4] remove "txn_scope" which was added by mistake during conflict handling --- system-variables.md | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/system-variables.md b/system-variables.md index 82b43fb49f615..b1da2affba61a 100644 --- a/system-variables.md +++ b/system-variables.md @@ -7089,19 +7089,6 @@ Internally, the TiDB parser transforms the `SET TRANSACTION ISOLATION LEVEL [REA - In the Stale Read scenarios, this session variable is used to help record the Stable Read timestamp value. - This variable is used for the internal operation of TiDB. It is **NOT recommended** to set this variable. -### txn_scope - -> **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) instances. - -- Scope: SESSION -- Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No -- Default value: `global` -- Value options: `global` and `local` -- This variable is used to set whether the current session transaction is a global transaction or a local transaction. -- This variable is used for the internal operation of TiDB. It is **NOT recommended** to set this variable. - ### validate_password.check_user_name New in v6.5.0 - Scope: GLOBAL