Skip to content

Commit

Permalink
opts & fixs in cluster & branch & export commands (#241)
Browse files Browse the repository at this point in the history
Co-authored-by: shiyuhang <[email protected]>
  • Loading branch information
zhangyangyu and shiyuhang0 authored Sep 20, 2024
1 parent d8b7da5 commit 01fbbc6
Show file tree
Hide file tree
Showing 50 changed files with 203 additions and 160 deletions.
2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ ticloud is a CLI library for communicating with TiDB Cloud's API.
* [ticloud completion](ticloud_completion.md) - Generate the autocompletion script for the specified shell
* [ticloud config](ticloud_config.md) - Configure and manage your user profiles
* [ticloud project](ticloud_project.md) - Manage projects
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters
* [ticloud upgrade](ticloud_upgrade.md) - Upgrade the CLI to the latest version

24 changes: 12 additions & 12 deletions docs/generate_doc/ticloud_serverless.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ticloud serverless

Manage TiDB Serverless clusters
Manage TiDB Cloud Serverless clusters

### Options

Expand All @@ -19,16 +19,16 @@ Manage TiDB Serverless clusters
### SEE ALSO

* [ticloud](ticloud.md) - CLI tool to manage TiDB Cloud
* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Serverless branches
* [ticloud serverless create](ticloud_serverless_create.md) - Create a TiDB Serverless cluster
* [ticloud serverless delete](ticloud_serverless_delete.md) - Delete a TiDB Serverless cluster
* [ticloud serverless describe](ticloud_serverless_describe.md) - Describe a TiDB Serverless cluster
* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Serverless exports
* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Serverless data imports
* [ticloud serverless list](ticloud_serverless_list.md) - List all TiDB Serverless clusters
* [ticloud serverless region](ticloud_serverless_region.md) - List all available regions for TiDB Serverless
* [ticloud serverless shell](ticloud_serverless_shell.md) - Connect to a TiDB Serverless cluster
* [ticloud serverless spending-limit](ticloud_serverless_spending-limit.md) - Set spending limit for a TiDB Serverless cluster
* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Cloud Serverless branches
* [ticloud serverless create](ticloud_serverless_create.md) - Create a TiDB Cloud Serverless cluster
* [ticloud serverless delete](ticloud_serverless_delete.md) - Delete a TiDB Cloud Serverless cluster
* [ticloud serverless describe](ticloud_serverless_describe.md) - Describe a TiDB Cloud Serverless cluster
* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Cloud Serverless exports
* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Cloud Serverless data imports
* [ticloud serverless list](ticloud_serverless_list.md) - List all TiDB Cloud Serverless clusters
* [ticloud serverless region](ticloud_serverless_region.md) - List all available regions for TiDB Cloud Serverless
* [ticloud serverless shell](ticloud_serverless_shell.md) - Connect to a TiDB Cloud Serverless cluster
* [ticloud serverless spending-limit](ticloud_serverless_spending-limit.md) - Set spending limit for a TiDB Cloud Serverless cluster
* [ticloud serverless sql-user](ticloud_serverless_sql-user.md) - Manage cluster SQL users
* [ticloud serverless update](ticloud_serverless_update.md) - Update a TiDB Serverless cluster
* [ticloud serverless update](ticloud_serverless_update.md) - Update a TiDB Cloud Serverless cluster

4 changes: 2 additions & 2 deletions docs/generate_doc/ticloud_serverless_branch.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ticloud serverless branch

Manage TiDB Serverless branches
Manage TiDB Cloud Serverless branches

### Options

Expand All @@ -18,7 +18,7 @@ Manage TiDB Serverless branches

### SEE ALSO

* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters
* [ticloud serverless branch create](ticloud_serverless_branch_create.md) - Create a branch
* [ticloud serverless branch delete](ticloud_serverless_branch_delete.md) - Delete a branch
* [ticloud serverless branch describe](ticloud_serverless_branch_describe.md) - Describe a branch
Expand Down
2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_branch_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,5 @@ ticloud serverless branch create [flags]

### SEE ALSO

* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Serverless branches
* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Cloud Serverless branches

2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_branch_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ ticloud serverless branch delete [flags]

### SEE ALSO

* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Serverless branches
* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Cloud Serverless branches

2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_branch_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ ticloud serverless branch describe [flags]

### SEE ALSO

* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Serverless branches
* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Cloud Serverless branches

2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_branch_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@ ticloud serverless branch list [flags]

### SEE ALSO

* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Serverless branches
* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Cloud Serverless branches

2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_branch_shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ ticloud serverless branch shell [flags]

### SEE ALSO

* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Serverless branches
* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Cloud Serverless branches

10 changes: 5 additions & 5 deletions docs/generate_doc/ticloud_serverless_create.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ticloud serverless create

Create a TiDB Serverless cluster
Create a TiDB Cloud Serverless cluster

```
ticloud serverless create [flags]
Expand All @@ -9,13 +9,13 @@ ticloud serverless create [flags]
### Examples

```
Create a TiDB Serverless cluster in interactive mode:
Create a TiDB Cloud Serverless cluster in interactive mode:
$ ticloud serverless create
Create a TiDB Serverless cluster of the default ptoject in non-interactive mode:
Create a TiDB Cloud Serverless cluster of the default ptoject in non-interactive mode:
$ ticloud serverless create --display-name <cluster-name> --region <region>
Create a TiDB Serverless cluster in non-interactive mode:
Create a TiDB Cloud Serverless cluster in non-interactive mode:
$ ticloud serverless create --project-id <project-id> --display-name <cluster-name> --region <region>
```

Expand All @@ -41,5 +41,5 @@ ticloud serverless create [flags]

### SEE ALSO

* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters

8 changes: 4 additions & 4 deletions docs/generate_doc/ticloud_serverless_delete.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ticloud serverless delete

Delete a TiDB Serverless cluster
Delete a TiDB Cloud Serverless cluster

```
ticloud serverless delete [flags]
Expand All @@ -9,10 +9,10 @@ ticloud serverless delete [flags]
### Examples

```
Delete a TiDB Serverless cluster in interactive mode:
Delete a TiDB Cloud Serverless cluster in interactive mode:
$ ticloud serverless delete
Delete a TiDB Serverless cluster in non-interactive mode:
Delete a TiDB Cloud Serverless cluster in non-interactive mode:
$ ticloud serverless delete -c <cluster-id>
```

Expand All @@ -34,5 +34,5 @@ ticloud serverless delete [flags]

### SEE ALSO

* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters

8 changes: 4 additions & 4 deletions docs/generate_doc/ticloud_serverless_describe.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ticloud serverless describe

Describe a TiDB Serverless cluster
Describe a TiDB Cloud Serverless cluster

```
ticloud serverless describe [flags]
Expand All @@ -9,10 +9,10 @@ ticloud serverless describe [flags]
### Examples

```
Get a TiDB Serverless cluster in interactive mode:
Get a TiDB Cloud Serverless cluster in interactive mode:
$ ticloud serverless describe
Get a TiDB Serverless cluster in non-interactive mode:
Get a TiDB Cloud Serverless cluster in non-interactive mode:
$ ticloud serverless describe -c <cluster-id>
```

Expand All @@ -33,5 +33,5 @@ ticloud serverless describe [flags]

### SEE ALSO

* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters

6 changes: 3 additions & 3 deletions docs/generate_doc/ticloud_serverless_export.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ticloud serverless export

Manage TiDB Serverless exports
Manage TiDB Cloud Serverless exports

### Options

Expand All @@ -18,9 +18,9 @@ Manage TiDB Serverless exports

### SEE ALSO

* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters
* [ticloud serverless export cancel](ticloud_serverless_export_cancel.md) - Cancel an export task
* [ticloud serverless export create](ticloud_serverless_export_create.md) - Export data from a TiDB Serverless cluster
* [ticloud serverless export create](ticloud_serverless_export_create.md) - Export data from a TiDB Cloud Serverless cluster
* [ticloud serverless export describe](ticloud_serverless_export_describe.md) - Describe an export task
* [ticloud serverless export download](ticloud_serverless_export_download.md) - Download the exported data
* [ticloud serverless export list](ticloud_serverless_export_list.md) - List export tasks
Expand Down
2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_export_cancel.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ ticloud serverless export cancel [flags]

### SEE ALSO

* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Serverless exports
* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Cloud Serverless exports

4 changes: 2 additions & 2 deletions docs/generate_doc/ticloud_serverless_export_create.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ticloud serverless export create

Export data from a TiDB Serverless cluster
Export data from a TiDB Cloud Serverless cluster

```
ticloud serverless export create [flags]
Expand Down Expand Up @@ -66,5 +66,5 @@ ticloud serverless export create [flags]

### SEE ALSO

* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Serverless exports
* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Cloud Serverless exports

2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_export_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ ticloud serverless export describe [flags]

### SEE ALSO

* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Serverless exports
* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Cloud Serverless exports

2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_export_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@ ticloud serverless export download [flags]

### SEE ALSO

* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Serverless exports
* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Cloud Serverless exports

2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_export_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@ ticloud serverless export list [flags]

### SEE ALSO

* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Serverless exports
* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Cloud Serverless exports

4 changes: 2 additions & 2 deletions docs/generate_doc/ticloud_serverless_import.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ticloud serverless import

Manage TiDB Serverless data imports
Manage TiDB Cloud Serverless data imports

### Options

Expand All @@ -18,7 +18,7 @@ Manage TiDB Serverless data imports

### SEE ALSO

* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters
* [ticloud serverless import cancel](ticloud_serverless_import_cancel.md) - Cancel a data import task
* [ticloud serverless import describe](ticloud_serverless_import_describe.md) - Describe a data import task
* [ticloud serverless import list](ticloud_serverless_import_list.md) - List data import tasks
Expand Down
2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_import_cancel.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ ticloud serverless import cancel [flags]

### SEE ALSO

* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Serverless data imports
* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Cloud Serverless data imports

2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_import_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ ticloud serverless import describe [flags]

### SEE ALSO

* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Serverless data imports
* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Cloud Serverless data imports

2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_import_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@ ticloud serverless import list [flags]

### SEE ALSO

* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Serverless data imports
* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Cloud Serverless data imports

2 changes: 1 addition & 1 deletion docs/generate_doc/ticloud_serverless_import_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,5 @@ ticloud serverless import start [flags]

### SEE ALSO

* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Serverless data imports
* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Cloud Serverless data imports

10 changes: 5 additions & 5 deletions docs/generate_doc/ticloud_serverless_list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ticloud serverless list

List all TiDB Serverless clusters
List all TiDB Cloud Serverless clusters

```
ticloud serverless list [flags]
Expand All @@ -9,13 +9,13 @@ ticloud serverless list [flags]
### Examples

```
List all TiDB Serverless clusters in interactive mode):
List all TiDB Cloud Serverless clusters in interactive mode):
$ ticloud serverless list
List all TiDB Serverless clusters in non-interactive mode:
List all TiDB Cloud Serverless clusters in non-interactive mode:
$ ticloud serverless list -p <project-id>
List all TiDB Serverless clusters in non-interactive mode:
List all TiDB Cloud Serverless clusters in non-interactive mode:
$ ticloud serverless list -p <project-id> -o json
```

Expand All @@ -37,5 +37,5 @@ ticloud serverless list [flags]

### SEE ALSO

* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters

6 changes: 3 additions & 3 deletions docs/generate_doc/ticloud_serverless_region.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ticloud serverless region

List all available regions for TiDB Serverless
List all available regions for TiDB Cloud Serverless

```
ticloud serverless region [flags]
Expand All @@ -9,7 +9,7 @@ ticloud serverless region [flags]
### Examples

```
List all available regions for TiDB Serverless:
List all available regions for TiDB Cloud Serverless:
$ ticloud serverless region
```

Expand All @@ -30,5 +30,5 @@ ticloud serverless region [flags]

### SEE ALSO

* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters

10 changes: 5 additions & 5 deletions docs/generate_doc/ticloud_serverless_shell.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## ticloud serverless shell

Connect to a TiDB Serverless cluster
Connect to a TiDB Cloud Serverless cluster

### Synopsis

Connect to a TiDB Serverless cluster.
Connect to a TiDB Cloud Serverless cluster.
The connection forces the [ANSI SQL mode](https://dev.mysql.com/doc/refman/8.0/en/sql-mode.html#sqlmode_ansi) for the session.

```
Expand All @@ -14,10 +14,10 @@ ticloud serverless shell [flags]
### Examples

```
Connect to a TiDB Serverless cluster in interactive mode:
Connect to a TiDB Cloud Serverless cluster in interactive mode:
$ ticloud serverless shell
Connect to a TiDB Serverless cluster with default user in non-interactive mode:
Connect to a TiDB Cloud Serverless cluster with default user in non-interactive mode:
$ ticloud serverless shell -c <cluster-id>
Connect to a serverless cluster with default user and password in non-interactive mode:
Expand Down Expand Up @@ -46,5 +46,5 @@ ticloud serverless shell [flags]

### SEE ALSO

* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters
* [ticloud serverless](ticloud_serverless.md) - Manage TiDB Cloud Serverless clusters

Loading

0 comments on commit 01fbbc6

Please sign in to comment.