Skip to content

Commit 4439573

Browse files
authored
v8.1: use a variable to refer to TiDB Cloud Serverless (pingcap#20587)
1 parent 6b418b1 commit 4439573

36 files changed

+149
-149
lines changed

TOC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
- 应用开发
1919
- [概览](/develop/dev-guide-overview.md)
2020
- 快速开始
21-
- [使用 TiDB Cloud Serverless 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
21+
- [使用 {{{ .starter }}} 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
2222
- [使用 TiDB 的增删改查 SQL](/develop/dev-guide-tidb-crud-sql.md)
2323
- 示例程序
2424
- Java

develop/dev-guide-bookshop-schema-design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ tiup demo bookshop prepare --users=200000 --books=500000 --authors=100000 --rati
7777

7878
3.**Import Data from Amazon S3** 页面,配置以下源数据信息:
7979

80-
- **Import File Count**:对于 TiDB Cloud Serverless,选择 **Multiple files**。TiDB Cloud Dedicated 中没有该字段。
80+
- **Import File Count**:对于 {{{ .starter }}},选择 **Multiple files**。TiDB Cloud Dedicated 中没有该字段。
8181
- **Included Schema Files**:选择 **Yes**
8282
- **Data Format**:选择 **SQL**
8383
- **Folder URI**:输入 `s3://developer.pingcap.com/bookshop/`

develop/dev-guide-build-cluster-in-cloud.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
---
2-
title: 使用 TiDB Cloud Serverless 构建 TiDB 集群
3-
summary: 使用 TiDB Cloud Serverless 构建 TiDB 集群,并连接 TiDB Cloud Serverless 集群。
2+
title: 使用 {{{ .starter }}} 构建 TiDB 集群
3+
summary: 使用 {{{ .starter }}} 构建 TiDB 集群,并连接 {{{ .starter }}} 集群。
44
---
55

66
<!-- markdownlint-disable MD029 -->
77

8-
# 使用 TiDB Cloud Serverless 构建 TiDB 集群
8+
# 使用 {{{ .starter }}} 构建 TiDB 集群
99

10-
本文将介绍如何以最快的方式开始使用 TiDB。你将创建并启动一个 [TiDB Cloud Serverless](https://www.pingcap.com/tidb-serverless/) 集群,使用 TiDB SQL 客户端,插入数据。随后将从示例程序读取出数据。
10+
本文将介绍如何以最快的方式开始使用 TiDB。你将创建并启动一个 [{{{ .starter }}}](https://www.pingcap.com/tidb-serverless/) 集群,使用 TiDB SQL 客户端,插入数据。随后将从示例程序读取出数据。
1111

1212
若你需要在本地计算机上启动 TiDB,请参阅[本地启动 TiDB](/quick-start-with-tidb.md)
1313

14-
## 第 1 步:创建 TiDB Cloud Serverless 集群
14+
## 第 1 步:创建 {{{ .starter }}} 集群 {#step-1-create-a-tidb-cloud-cluster}
1515

1616
1. 如果你还未拥有 TiDB Cloud 账号,请先在此[注册](https://tidbcloud.com/free-trial)
1717
2. 使用你的 TiDB Cloud 账号[登录](https://tidbcloud.com/)
1818

1919
登录后,默认进入 [**Clusters**](https://tidbcloud.com/console/clusters) 页面。
2020

21-
3. 对于新注册的用户,TiDB Cloud 会自动为你创建一个 TiDB Cloud Serverless 集群 `Cluster0`。你可以使用这个默认集群进行后续操作,也可以自行创建一个新的 TiDB Cloud Serverless 集群。
21+
3. 对于新注册的用户,TiDB Cloud 会自动为你创建一个 {{{ .starter }}} 集群 `Cluster0`。你可以使用这个默认集群进行后续操作,也可以自行创建一个新的 {{{ .starter }}} 集群。
2222

23-
如果你想创建一个新的 TiDB Cloud Serverless 集群,请进行以下操作:
23+
如果你想创建一个新的 {{{ .starter }}} 集群,请进行以下操作:
2424

2525
1. 点击 **Create Cluster**
26-
2. **Create Cluster** 页面默认选择 **Serverless**。你可以根据需要修改集群名称、选择可用区,然后点击 **Create**。你的 TiDB Cloud Serverless 集群将于 30 秒后创建完毕。
26+
2. **Create Cluster** 页面默认选择 **Serverless**。你可以根据需要修改集群名称、选择可用区,然后点击 **Create**。你的 {{{ .starter }}} 集群将于 30 秒后创建完毕。
2727

2828
4. 点击目标集群名称,进入集群概览页面,然后点击右上角的 **Connect** 按钮,弹出连接对话框。
2929

@@ -33,7 +33,7 @@ summary: 使用 TiDB Cloud Serverless 构建 TiDB 集群,并连接 TiDB Cloud
3333

3434
> **注意:**
3535
>
36-
> 在连接到 [TiDB Cloud Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) 集群时,你需要给用户名加上前缀并使用单引号包裹用户名。你可以在 [TiDB Cloud Serverless 用户名前缀](https://docs.pingcap.com/tidbcloud/select-cluster-tier#user-name-prefix) 中获得更多信息。
36+
> 在连接到 [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) 集群时,你需要给用户名加上前缀并使用单引号包裹用户名。你可以在 [{{{ .starter }}} 用户名前缀](https://docs.pingcap.com/tidbcloud/select-cluster-tier#user-name-prefix) 中获得更多信息。
3737
3838
## 第 2 步:连接到集群
3939

@@ -116,8 +116,8 @@ summary: 使用 TiDB Cloud Serverless 构建 TiDB 集群,并连接 TiDB Cloud
116116

117117
> **注意:**
118118
>
119-
> - 在连接 TiDB Cloud Serverless 集群时,[必须使用 TLS 连接](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters)。
120-
> - 如果你在连接时遇到问题,可阅读 [TiDB Cloud Serverless 集群安全连接](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters) 来获得更多信息。
119+
> - 在连接 {{{ .starter }}} 集群时,[必须使用 TLS 连接](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters)。
120+
> - 如果你在连接时遇到问题,可阅读 [{{{ .starter }}} 集群安全连接](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters) 来获得更多信息。
121121

122122
3. 填写密码,完成登录。
123123

develop/dev-guide-create-database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ summary: 创建数据库的方法、规范及例子。
1515

1616
在阅读本页面之前,你需要准备以下事项:
1717

18-
- [使用 TiDB Cloud Serverless 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
18+
- [使用 {{{ .starter }}} 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
1919
- 阅读[数据库模式概览](/develop/dev-guide-schema-design-overview.md)
2020

2121
## 什么是数据库

develop/dev-guide-create-secondary-indexes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ summary: 创建二级索引的方法、规范及例子。
1111

1212
在阅读本页面之前,你需要准备以下事项:
1313

14-
- [使用 TiDB Cloud Serverless 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
14+
- [使用 {{{ .starter }}} 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
1515
- 阅读[数据库模式概览](/develop/dev-guide-schema-design-overview.md)
1616
- [创建一个数据库](/develop/dev-guide-create-database.md)
1717
- [创建表](/develop/dev-guide-create-table.md)

develop/dev-guide-create-table.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ summary: 创建表的方法、规范及例子。
1515

1616
在阅读本页面之前,你需要准备以下事项:
1717

18-
- [使用 TiDB Cloud Serverless 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
18+
- [使用 {{{ .starter }}} 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
1919
- 阅读[数据库模式概览](/develop/dev-guide-schema-design-overview.md)
2020
- [创建一个数据库](/develop/dev-guide-create-database.md)
2121

@@ -264,7 +264,7 @@ ALTER TABLE `bookshop`.`ratings` SET TIFLASH REPLICA 1;
264264

265265
> **注意:**
266266
>
267-
> 如果你的集群,不包含 TiFlash 节点,此 SQL 语句将会报错:`1105 - the tiflash replica count: 1 should be less than the total tiflash server count: 0` 你可以[使用 TiDB Cloud Serverless 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md#-1-步创建-tidb-cloud-serverless-集群) 来创建一个含有 TiFlash 的集群。
267+
> 如果你的集群,不包含 TiFlash 节点,此 SQL 语句将会报错:`1105 - the tiflash replica count: 1 should be less than the total tiflash server count: 0` 你可以[使用 {{{ .starter }}} 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-cloud-cluster) 来创建一个含有 TiFlash 的集群。
268268
269269
随后正常进行查询即可:
270270

develop/dev-guide-delete-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ summary: 删除数据、批量删除数据的方法、最佳实践及例子。
1111

1212
在阅读本页面之前,你需要准备以下事项:
1313

14-
- [使用 TiDB Cloud Serverless 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
14+
- [使用 {{{ .starter }}} 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
1515
- 阅读[数据库模式概览](/develop/dev-guide-schema-design-overview.md),并[创建数据库](/develop/dev-guide-create-database.md)[创建表](/develop/dev-guide-create-table.md)[创建二级索引](/develop/dev-guide-create-secondary-indexes.md)
1616
- 需先[插入数据](/develop/dev-guide-insert-data.md)才可删除。
1717

develop/dev-guide-gui-mysql-workbench.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ TiDB 是一个兼容 MySQL 的数据库。[MySQL Workbench](https://www.mysql.co
1616

1717
> **注意**
1818
>
19-
> 本文档适用于 TiDB Cloud Serverless、TiDB Cloud Dedicated 和本地部署的 TiDB。
19+
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
2020
2121
## 前置需求
2222

@@ -27,15 +27,15 @@ TiDB 是一个兼容 MySQL 的数据库。[MySQL Workbench](https://www.mysql.co
2727

2828
**如果你还没有 TiDB 集群,可以按如下方式创建一个:**
2929

30-
- (推荐方式)参考[创建 TiDB Cloud Serverless 集群](/develop/dev-guide-build-cluster-in-cloud.md),创建一个 TiDB Cloud 集群。
30+
- (推荐方式)参考[创建 {{{ .starter }}} 集群](/develop/dev-guide-build-cluster-in-cloud.md),创建一个 TiDB Cloud 集群。
3131
- 参考[部署本地测试 TiDB 集群](/quick-start-with-tidb.md#部署本地测试集群)[部署正式 TiDB 集群](/production-deployment-using-tiup.md),创建一个本地集群。
3232

3333
## 连接到 TiDB
3434

3535
根据你选择的 TiDB 部署方式连接到 TiDB 集群。
3636

3737
<SimpleTab>
38-
<div label="TiDB Cloud Serverless">
38+
<div label="{{{ .starter }}}">
3939

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

@@ -64,15 +64,15 @@ TiDB 是一个兼容 MySQL 的数据库。[MySQL Workbench](https://www.mysql.co
6464
- **Hostname**:输入从 TiDB Cloud 连接对话框中的得到的 `HOST` 参数。
6565
- **Port**:输入从 TiDB Cloud 连接对话框中的得到的 `PORT` 参数。
6666
- **Username**:输入从 TiDB Cloud 连接对话框中的得到的 `USERNAME` 参数。
67-
- **Password**:点击 **Store in Keychain ...****Store in Vault**,输入 TiDB Cloud Serverless 集群的密码,然后点击 **OK** 保存密码。
67+
- **Password**:点击 **Store in Keychain ...****Store in Vault**,输入 {{{ .starter }}} 集群的密码,然后点击 **OK** 保存密码。
6868

69-
![MySQL Workbench: store the password of TiDB Cloud Serverless in keychain](/media/develop/mysql-workbench-store-password-in-keychain.png)
69+
![MySQL Workbench: store the password of {{{ .starter }}} in keychain](/media/develop/mysql-workbench-store-password-in-keychain.png)
7070

7171
下图显示了连接参数的示例:
7272

73-
![MySQL Workbench: configure connection settings for TiDB Cloud Serverless](/media/develop/mysql-workbench-connection-config-serverless-parameters.png)
73+
![MySQL Workbench: configure connection settings for {{{ .starter }}}](/media/develop/mysql-workbench-connection-config-serverless-parameters.png)
7474

75-
7. 点击 **Test Connection** 以验证与 TiDB Cloud Serverless 集群的连接。
75+
7. 点击 **Test Connection** 以验证与 {{{ .starter }}} 集群的连接。
7676

7777
8. 如果连接测试成功,你可以看到 **Successfully made the MySQL connection** 信息。点击 **OK** 保存连接配置。
7878

develop/dev-guide-gui-navicat.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ TiDB 是一个兼容 MySQL 的数据库。[Navicat](https://www.navicat.com) 是
1111

1212
> **注意**
1313
>
14-
> 本文档适用于 TiDB Cloud Serverless、TiDB Cloud Dedicated 和本地部署的 TiDB。
14+
> 本文档适用于 {{{ .starter }}}、TiDB Cloud Dedicated 和本地部署的 TiDB。
1515
1616
## 前置需求
1717

@@ -23,15 +23,15 @@ TiDB 是一个兼容 MySQL 的数据库。[Navicat](https://www.navicat.com) 是
2323

2424
**如果你还没有 TiDB 集群,可以按如下方式创建一个:**
2525

26-
- (推荐方式)参考[创建 TiDB Cloud Serverless 集群](/develop/dev-guide-build-cluster-in-cloud.md),创建一个 TiDB Cloud 集群。
26+
- (推荐方式)参考[创建 {{{ .starter }}} 集群](/develop/dev-guide-build-cluster-in-cloud.md),创建一个 TiDB Cloud 集群。
2727
- 参考[部署本地测试 TiDB 集群](/quick-start-with-tidb.md#部署本地测试集群)[部署正式 TiDB 集群](/production-deployment-using-tiup.md),创建一个本地集群。
2828

2929
## 连接到 TiDB
3030

3131
根据你选择的 TiDB 部署方式连接到 TiDB 集群。
3232

3333
<SimpleTab>
34-
<div label="TiDB Cloud Serverless">
34+
<div label="{{{ .starter }}}">
3535

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

@@ -60,15 +60,15 @@ TiDB 是一个兼容 MySQL 的数据库。[Navicat](https://www.navicat.com) 是
6060
- **Host**:输入从 TiDB Cloud 连接对话框中的得到的 `HOST` 参数。
6161
- **Port**:输入从 TiDB Cloud 连接对话框中的得到的 `PORT` 参数。
6262
- **User Name**:输入从 TiDB Cloud 连接对话框中的得到的 `USERNAME` 参数。
63-
- **Password**:输入 TiDB Cloud Serverless 集群的密码。
63+
- **Password**:输入 {{{ .starter }}} 集群的密码。
6464

65-
![Navicat: configure connection general panel for TiDB Cloud Serverless](/media/develop/navicat-premium-connection-config-serverless-general.png)
65+
![Navicat: configure connection general panel for {{{ .starter }}}](/media/develop/navicat-premium-connection-config-serverless-general.png)
6666

6767
7. 点击 **SSL** 选项卡,选择 **Use SSL****Use authentication** 以及 **Verify server certificate against CA** 复选框。并在 **CA Certificate** 字段中填入从 TiDB Cloud 连接对话框中获取的 `CA` 文件路径。
6868

69-
![Navicat: configure connection SSL panel for TiDB Cloud Serverless](/media/develop/navicat-premium-connection-config-serverless-ssl.png)
69+
![Navicat: configure connection SSL panel for {{{ .starter }}}](/media/develop/navicat-premium-connection-config-serverless-ssl.png)
7070

71-
8. 点击 **Test Connection** 以验证与 TiDB Cloud Serverless 集群的连接。
71+
8. 点击 **Test Connection** 以验证与 {{{ .starter }}} 集群的连接。
7272

7373
9. 如果连接测试成功,你可以看到 **Connection Successful** 信息。点击 **OK** 完成连接配置。
7474

develop/dev-guide-insert-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ summary: 插入数据、批量导入数据的方法、最佳实践及例子。
1313

1414
在阅读本页面之前,你需要准备以下事项:
1515

16-
- [使用 TiDB Cloud Serverless 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
16+
- [使用 {{{ .starter }}} 构建 TiDB 集群](/develop/dev-guide-build-cluster-in-cloud.md)
1717
- 阅读[数据库模式概览](/develop/dev-guide-schema-design-overview.md),并[创建数据库](/develop/dev-guide-create-database.md)[创建表](/develop/dev-guide-create-table.md)[创建二级索引](/develop/dev-guide-create-secondary-indexes.md)
1818

1919
## 插入行

0 commit comments

Comments
 (0)