Skip to content

Commit e7001dc

Browse files
authored
fix ticloud plan description on tidb.io (pingcap#20710)
1 parent f7536e9 commit e7001dc

21 files changed

+73
-67
lines changed

tidb-cloud/ticloud-branch-create.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ summary: The reference of `ticloud serverless branch create`.
55

66
# ticloud serverless branch create
77

8-
Create a [branch](/tidb-cloud/branch-overview.md) for a TiDB Cloud Starter cluster:
8+
Create a [branch](/tidb-cloud/branch-overview.md) for a TiDB Cloud cluster:
99

1010
```shell
1111
ticloud serverless branch create [flags]
1212
```
1313

1414
## Examples
1515

16-
Create a branch for a TiDB Cloud Starter cluster in interactive mode:
16+
Create a branch for a TiDB Cloud cluster in interactive mode:
1717

1818
```shell
1919
ticloud serverless branch create
2020
```
2121

22-
Create a branch for a TiDB Cloud Starter cluster in non-interactive mode:
22+
Create a branch for a TiDB Cloud cluster in non-interactive mode:
2323

2424
```shell
2525
ticloud serverless branch create --cluster-id <cluster-id> --display-name <branch-name>

tidb-cloud/ticloud-branch-delete.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless branch delete`.
55

66
# ticloud serverless branch delete
77

8-
Delete a branch from your TiDB Cloud Starter cluster:
8+
Delete a branch from your TiDB Cloud cluster:
99

1010
```shell
1111
ticloud serverless branch delete [flags]
@@ -19,13 +19,13 @@ ticloud serverless branch rm [flags]
1919

2020
## Examples
2121

22-
Delete a TiDB Cloud Starter branch in interactive mode:
22+
Delete a TiDB Cloud branch in interactive mode:
2323

2424
```shell
2525
ticloud serverless branch delete
2626
```
2727

28-
Delete a TiDB Cloud Starter branch in non-interactive mode:
28+
Delete a TiDB Cloud branch in non-interactive mode:
2929

3030
```shell
3131
ticloud branch delete --branch-id <branch-id> --cluster-id <cluster-id>

tidb-cloud/ticloud-branch-describe.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ ticloud serverless branch get [flags]
1919

2020
## Examples
2121

22-
Get branch information of a TiDB Cloud Starter cluster in interactive mode:
22+
Get branch information of a TiDB Cloud cluster in interactive mode:
2323

2424
```shell
2525
ticloud serverless branch describe
2626
```
2727

28-
Get branch information of a TiDB Cloud Starter cluster in non-interactive mode:
28+
Get branch information of a TiDB Cloud cluster in non-interactive mode:
2929

3030
```shell
3131
ticloud serverless branch describe --branch-id <branch-id> --cluster-id <cluster-id>

tidb-cloud/ticloud-branch-list.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless branch list`.
55

66
# ticloud serverless branch list
77

8-
List all branches for a TiDB Cloud Starter cluster:
8+
List all branches for a TiDB Cloud cluster:
99

1010
```shell
1111
ticloud serverless branch list <cluster-id> [flags]
@@ -19,19 +19,19 @@ ticloud serverless branch ls <cluster-id> [flags]
1919

2020
## Examples
2121

22-
List all branches for a TiDB Cloud Starter cluster in interactive mode:
22+
List all branches for a TiDB Cloud cluster in interactive mode:
2323

2424
```shell
2525
ticloud serverless branch list
2626
```
2727

28-
List all branches for a specific TiDB Cloud Starter cluster in non-interactive mode:
28+
List all branches for a specific TiDB Cloud cluster in non-interactive mode:
2929

3030
```shell
3131
ticloud serverless branch list -c <cluster-id>
3232
```
3333

34-
List all branches for a specific TiDB Cloud Starter cluster in the JSON format:
34+
List all branches for a specific TiDB Cloud cluster in the JSON format:
3535

3636
```shell
3737
ticloud serverless branch list <cluster-id> -o json

tidb-cloud/ticloud-branch-shell.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,33 @@ summary: The reference of `ticloud serverless branch shell`.
55

66
# ticloud serverless branch shell
77

8-
Connect to a branch of a TiDB Cloud Starter cluster:
8+
Connect to a branch of a TiDB Cloud cluster:
99

1010
```shell
1111
ticloud serverless branch shell [flags]
1212
```
1313

1414
## Examples
1515

16-
Connect to a TiDB Cloud Starter branch in interactive mode:
16+
Connect to a TiDB Cloud branch in interactive mode:
1717

1818
```shell
1919
ticloud serverless branch shell
2020
```
2121

22-
Connect to a TiDB Cloud Starter branch with the default user in non-interactive mode:
22+
Connect to a TiDB Cloud branch with the default user in non-interactive mode:
2323

2424
```shell
2525
ticloud serverless branch shell -c <cluster-id> -b <branch-id>
2626
```
2727

28-
Connect to a TiDB Cloud Starter branch with the default user and password in non-interactive mode:
28+
Connect to a TiDB Cloud branch with the default user and password in non-interactive mode:
2929

3030
```shell
3131
ticloud serverless branch shell -c <cluster-id> -b <branch-id> --password <password>
3232
```
3333

34-
Connect to a TiDB Cloud Starter branch with a specific user and password in non-interactive mode:
34+
Connect to a TiDB Cloud branch with a specific user and password in non-interactive mode:
3535

3636
```shell
3737
ticloud serverless branch shell -c <cluster-id> -b <branch-id> -u <user-name> --password <password>

tidb-cloud/ticloud-cluster-create.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ summary: The reference of `ticloud serverless create`.
55

66
# ticloud serverless create
77

8-
Create a TiDB Cloud Starter cluster:
8+
Create a TiDB Cloud cluster:
99

1010
```shell
1111
ticloud serverless create [flags]
1212
```
1313

1414
## Examples
1515

16-
Create a TiDB Cloud Starter cluster in interactive mode:
16+
Create a TiDB Cloud cluster in interactive mode:
1717

1818
```shell
1919
ticloud serverless create
2020
```
2121

22-
Create a TiDB Cloud Starter cluster in non-interactive mode:
22+
Create a TiDB Cloud cluster in non-interactive mode:
2323

2424
```shell
2525
ticloud serverless create --display-name <display-name> --region <region>
@@ -31,6 +31,12 @@ Create a TiDB Cloud Starter cluster with a spending limit in non-interactive mod
3131
ticloud serverless create --display-name <display-name> --region <region> --spending-limit-monthly <spending-limit-monthly>
3232
```
3333

34+
Create a TiDB Cloud Essential cluster in non-interactive mode:
35+
36+
```shell
37+
ticloud serverless create --display-name <display-name> --region <region> --max-rcu <maximum-rcu> --min-rcu <minimum-rcu>
38+
```
39+
3440
## Flags
3541

3642
In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in.

tidb-cloud/ticloud-cluster-delete.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless delete`.
55

66
# ticloud serverless delete
77

8-
Delete a TiDB Cloud Starter cluster from your project:
8+
Delete a TiDB Cloud cluster from your project:
99

1010
```shell
1111
ticloud serverless delete [flags]
@@ -19,13 +19,13 @@ ticloud serverless rm [flags]
1919

2020
## Examples
2121

22-
Delete a TiDB Cloud Starter cluster in interactive mode:
22+
Delete a TiDB Cloud cluster in interactive mode:
2323

2424
```shell
2525
ticloud serverless delete
2626
```
2727

28-
Delete a TiDB Cloud Starter cluster in non-interactive mode:
28+
Delete a TiDB Cloud cluster in non-interactive mode:
2929

3030
```shell
3131
ticloud serverless delete --cluster-id <cluster-id>

tidb-cloud/ticloud-cluster-describe.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless describe`.
55

66
# ticloud serverless describe
77

8-
Get information about a TiDB Cloud Starter cluster (such as the cluster configurations and cluster status):
8+
Get information about a TiDB Cloud cluster (such as the cluster configurations and cluster status):
99

1010
```shell
1111
ticloud serverless describe [flags]
@@ -19,13 +19,13 @@ ticloud serverless get [flags]
1919

2020
## Examples
2121

22-
Get information about a TiDB Cloud Starter cluster in interactive mode:
22+
Get information about a TiDB Cloud cluster in interactive mode:
2323

2424
```shell
2525
ticloud serverless describe
2626
```
2727

28-
Get information about a TiDB Cloud Starter cluster in non-interactive mode:
28+
Get information about a TiDB Cloud cluster in non-interactive mode:
2929

3030
```shell
3131
ticloud serverless describe --cluster-id <cluster-id>

tidb-cloud/ticloud-cluster-list.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless list`.
55

66
# ticloud serverless list
77

8-
List all TiDB Cloud Starter clusters in a project:
8+
List all TiDB Cloud clusters in a project:
99

1010
```shell
1111
ticloud serverless list [flags]
@@ -19,19 +19,19 @@ ticloud serverless ls [flags]
1919

2020
## Examples
2121

22-
List all TiDB Cloud Starter clusters in interactive mode:
22+
List all TiDB Cloud clusters in interactive mode:
2323

2424
```shell
2525
ticloud serverless list
2626
```
2727

28-
List all TiDB Cloud Starter clusters in a specified project in non-interactive mode:
28+
List all TiDB Cloud clusters in a specified project in non-interactive mode:
2929

3030
```shell
3131
ticloud serverless list -p <project-id>
3232
```
3333

34-
List all TiDB Cloud Starter clusters in a specified project with the JSON format in non-interactive mode:
34+
List all TiDB Cloud clusters in a specified project with the JSON format in non-interactive mode:
3535

3636
```shell
3737
ticloud serverless list -p <project-id> -o json

tidb-cloud/ticloud-serverless-capacity.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ summary: The reference of `ticloud serverless capacity`.
55

66
# ticloud serverless capacity
77

8-
Set the capacity, in terms of maximum and minimum Request Capacity Units (RCUs), for a TiDB Cloud Starter cluster.
8+
Set the capacity, in terms of maximum and minimum Request Capacity Units (RCUs), for a TiDB Cloud cluster.
99

1010
```shell
1111
ticloud serverless capacity [flags]
1212
```
1313

1414
## Examples
1515

16-
Set capacity for a TiDB Cloud Starter cluster in interactive mode:
16+
Set capacity for a TiDB Cloud cluster in interactive mode:
1717

1818
```shell
1919
ticloud serverless capacity
2020
```
2121

22-
Set capacity for a TiDB Cloud Starter cluster in non-interactive mode:
22+
Set capacity for a TiDB Cloud cluster in non-interactive mode:
2323

2424
```shell
2525
ticloud serverless capacity -c <cluster-id> --max-rcu <maximum-rcu> --min-rcu <minimum-rcu>

tidb-cloud/ticloud-serverless-export-create.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,39 @@ summary: The reference of `ticloud serverless export create`.
55

66
# ticloud serverless export create
77

8-
Export data from a TiDB Cloud Starter cluster:
8+
Export data from a TiDB Cloud cluster:
99

1010
```shell
1111
ticloud serverless export create [flags]
1212
```
1313

1414
## Examples
1515

16-
Export data from a TiDB Cloud Starter cluster in interactive mode:
16+
Export data from a TiDB Cloud cluster in interactive mode:
1717

1818
```shell
1919
ticloud serverless export create
2020
```
2121

22-
Export data from a TiDB Cloud Starter cluster to a local file in non-interactive mode:
22+
Export data from a TiDB Cloud cluster to a local file in non-interactive mode:
2323

2424
```shell
2525
ticloud serverless export create -c <cluster-id> --filter <database.table>
2626
```
2727

28-
Export data from a TiDB Cloud Starter cluster to Amazon S3 in non-interactive mode:
28+
Export data from a TiDB Cloud cluster to Amazon S3 in non-interactive mode:
2929

3030
```shell
3131
ticloud serverless export create -c <cluster-id> --s3.uri <uri> --s3.access-key-id <access-key-id> --s3.secret-access-key <secret-access-key> --filter <database.table>
3232
```
3333

34-
Export data from a TiDB Cloud Starter cluster to Google Cloud Storage in non-interactive mode:
34+
Export data from a TiDB Cloud cluster to Google Cloud Storage in non-interactive mode:
3535

3636
```shell
3737
ticloud serverless export create -c <cluster-id> --gcs.uri <uri> --gcs.service-account-key <service-account-key> --filter <database.table>
3838
```
3939

40-
Export data from a TiDB Cloud Starter cluster to Azure Blob Storage in non-interactive mode:
40+
Export data from a TiDB Cloud cluster to Azure Blob Storage in non-interactive mode:
4141

4242
```shell
4343
ticloud serverless export create -c <cluster-id> --azblob.uri <uri> --azblob.sas-token <sas-token> --filter <database.table>

tidb-cloud/ticloud-serverless-export-describe.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export describe`.
55

66
# ticloud serverless export describe
77

8-
Get the export information of a TiDB Cloud Starter cluster:
8+
Get the export information of a TiDB Cloud cluster:
99

1010
```shell
1111
ticloud serverless export describe [flags]

tidb-cloud/ticloud-serverless-export-download.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export download`.
55

66
# ticloud serverless export download
77

8-
Download the exported data from a TiDB Cloud Starter cluster to your local storage:
8+
Download the exported data from a TiDB Cloud cluster to your local storage:
99

1010
```shell
1111
ticloud serverless export download [flags]

tidb-cloud/ticloud-serverless-export-list.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export list`.
55

66
# ticloud serverless export list
77

8-
List data export tasks of TiDB Cloud Starter clusters:
8+
List data export tasks of TiDB Cloud clusters:
99

1010
```shell
1111
ticloud serverless export list [flags]

tidb-cloud/ticloud-serverless-region.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ summary: The reference of `ticloud serverless region`.
55

66
# ticloud serverless region
77

8-
List all available regions for TiDB Cloud Starter:
8+
List all available regions for TiDB Cloud clusters:
99

1010
```shell
1111
ticloud serverless region [flags]
1212
```
1313

1414
## Examples
1515

16-
List all available regions for TiDB Cloud Starter:
16+
List all available regions for TiDB Cloud clusters:
1717

1818
```shell
1919
ticloud serverless region
2020
```
2121

22-
List all available regions for TiDB Cloud Starter clusters in the JSON format:
22+
List all available regions for TiDB Cloud clusters in the JSON format:
2323

2424
```shell
2525
ticloud serverless region -o json

0 commit comments

Comments
 (0)