Skip to content

*: clarify feature availability on Starter and Essential clusters #20730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions develop/dev-guide-gui-mysql-workbench.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[MySQL Workbench](https://www.mysql.co

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand All @@ -35,7 +35,7 @@ TiDB 是一个兼容 MySQL 的数据库。[MySQL Workbench](https://www.mysql.co
根据你选择的 TiDB 部署方式连接到 TiDB 集群。

<SimpleTab>
<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,点击你目标集群的名字,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-gui-navicat.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Navicat](https://www.navicat.com) 是

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand All @@ -31,7 +31,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Navicat](https://www.navicat.com) 是
根据你选择的 TiDB 部署方式连接到 TiDB 集群。

<SimpleTab>
<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,点击你目标集群的名字,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-aws-lambda.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[AWS Lambda 函数](https://aws.amazon

> **Note**
>
> 本文档适用于 {{{ .starter }}} 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}} 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -67,7 +67,7 @@ npm install

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-golang-gorm.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[GORM](https://gorm.io/index.html) 是

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -44,7 +44,7 @@ cd tidb-golang-gorm-quickstart

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-golang-sql-driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Go-MySQL-Driver](https://github.com/g

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -45,7 +45,7 @@ cd tidb-golang-sql-driver-quickstart

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-java-hibernate.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Hibernate](https://hibernate.org/orm/

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -45,7 +45,7 @@ cd tidb-java-hibernate-quickstart

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-java-jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。JDBC 是 Java 的数据访问 API。[M

> **注意**
>
> - 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> - 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> - 从 TiDB v7.4 起,如果 JDBC URL 中未配置 `connectionCollation`,且 `characterEncoding` 未配置或配置为 `UTF-8`,JDBC 连接所使用的排序规则取决于 JDBC 驱动版本。详情请参考 [JDBC 连接所使用的排序规则](/faq/sql-faq.md#jdbc-连接所使用的排序规则)。

## 前置需求
Expand Down Expand Up @@ -47,7 +47,7 @@ cd tidb-java-jdbc-quickstart

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-java-mybatis.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[MyBatis](https://mybatis.org/mybatis-

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -45,7 +45,7 @@ cd tidb-java-mybatis-quickstart

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-java-spring-boot.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Spring](https://spring.io/) 是当前

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -46,7 +46,7 @@ cd tidb-java-springboot-jpa-quickstart

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-nextjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库,[mysql2](https://github.com/sidorares/

> **Note**
>
> 本文档适用于 {{{ .starter }}} 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}} 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -61,7 +61,7 @@ npm install

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-nodejs-mysql2.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[node-mysql2](https://github.com/sidor

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -63,7 +63,7 @@ npm install mysql2 dotenv --save

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-nodejs-mysqljs.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[mysql.js](https://github.com/mysqljs/

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -63,7 +63,7 @@ npm install mysql dotenv --save

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-nodejs-prisma.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Prisma](https://www.prisma.io/) 是

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -63,7 +63,7 @@ npm install prisma typescript ts-node @types/node --save-dev

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-nodejs-sequelize.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Sequelize](https://sequelize.org/)

> **Note**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -61,7 +61,7 @@ npm install

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-nodejs-typeorm.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[TypeORM](https://typeorm.io/) 是当

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -76,7 +76,7 @@ npm install @types/node ts-node typescript --save-dev

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-python-django.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Django](https://www.djangoproject.com

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -63,7 +63,7 @@ pip install -r requirements.txt

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[MySQL Connector/Python](https://dev.m

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -53,7 +53,7 @@ pip install -r requirements.txt

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-python-mysqlclient.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[mysqlclient](https://github.com/PyMyS

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -54,7 +54,7 @@ pip install -r requirements.txt

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-python-peewee.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[peewee](https://github.com/coleifer/p

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -56,7 +56,7 @@ peewee 是一个支持多种数据库的 ORM 库。它是对数据库的高层

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://{{{.console-url}}}/project/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-python-pymysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[PyMySQL](https://github.com/PyMySQL/P

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -52,7 +52,7 @@ pip install -r requirements.txt

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,选择你的 {{{ .starter }}} 集群,进入集群的 **Overview** 页面。

Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-python-sqlalchemy.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[SQLAlchemy](https://www.sqlalchemy.or

> **注意**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -58,7 +58,7 @@ SQLAlchemy 是一个支持多种数据库的 ORM 库。它是对数据库的高

<SimpleTab>

<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

> **注意:**
>
Expand Down
4 changes: 2 additions & 2 deletions develop/dev-guide-sample-application-ruby-mysql2.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TiDB 是一个兼容 MySQL 的数据库。[mysql2](https://github.com/brianmario

> **注意:**
>
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 以及本地部署的 TiDB。
> 本文档适用于 {{{ .starter }}}、{{{ .essential }}}、TiDB Cloud Dedicated 以及本地部署的 TiDB。

## 前置需求

Expand Down Expand Up @@ -68,7 +68,7 @@ bundle add mysql2 dotenv
根据不同的 TiDB 部署方式,使用不同的方法连接到 TiDB 集群。

<SimpleTab>
<div label="{{{ .starter }}}">
<div label="{{{ .starter }}} 或 Essential">

1. 在 TiDB Cloud 的 [**Clusters**](https://tidbcloud.com/console/clusters) 页面中,点击你的目标集群的名称,进入集群的 **Overview** 页面。

Expand Down
Loading
Loading