From ed7be7e8cd350a7067cae47a53fe7a843d2c3232 Mon Sep 17 00:00:00 2001 From: Xiang Zhang Date: Tue, 16 Apr 2024 18:59:24 +0800 Subject: [PATCH] fix password flag (#162) --- docs/generate_doc/ticloud.md | 2 +- docs/generate_doc/ticloud_ai.md | 2 +- docs/generate_doc/ticloud_auth.md | 2 +- docs/generate_doc/ticloud_auth_login.md | 4 +-- docs/generate_doc/ticloud_auth_logout.md | 2 +- docs/generate_doc/ticloud_config.md | 2 +- docs/generate_doc/ticloud_config_create.md | 2 +- docs/generate_doc/ticloud_config_delete.md | 2 +- docs/generate_doc/ticloud_config_describe.md | 2 +- docs/generate_doc/ticloud_config_edit.md | 2 +- docs/generate_doc/ticloud_config_list.md | 2 +- docs/generate_doc/ticloud_config_set.md | 2 +- docs/generate_doc/ticloud_config_use.md | 2 +- docs/generate_doc/ticloud_project.md | 2 +- docs/generate_doc/ticloud_project_list.md | 2 +- docs/generate_doc/ticloud_serverless.md | 28 +++++++++---------- .../generate_doc/ticloud_serverless_branch.md | 4 +-- .../ticloud_serverless_branch_create.md | 4 +-- .../ticloud_serverless_branch_delete.md | 4 +-- .../ticloud_serverless_branch_describe.md | 4 +-- .../ticloud_serverless_branch_list.md | 4 +-- .../ticloud_serverless_branch_shell.md | 16 +++++------ .../generate_doc/ticloud_serverless_create.md | 10 +++---- .../generate_doc/ticloud_serverless_delete.md | 8 +++--- .../ticloud_serverless_describe.md | 8 +++--- .../generate_doc/ticloud_serverless_export.md | 14 +++++----- .../ticloud_serverless_export_cancel.md | 6 ++-- .../ticloud_serverless_export_create.md | 6 ++-- .../ticloud_serverless_export_describe.md | 6 ++-- .../ticloud_serverless_export_download.md | 8 +++--- .../ticloud_serverless_export_list.md | 6 ++-- .../generate_doc/ticloud_serverless_import.md | 4 +-- .../ticloud_serverless_import_cancel.md | 4 +-- .../ticloud_serverless_import_describe.md | 4 +-- .../ticloud_serverless_import_list.md | 4 +-- .../ticloud_serverless_import_start.md | 10 +++---- docs/generate_doc/ticloud_serverless_list.md | 10 +++---- .../generate_doc/ticloud_serverless_region.md | 6 ++-- docs/generate_doc/ticloud_serverless_shell.md | 18 ++++++------ .../ticloud_serverless_spending-limit.md | 8 +++--- .../generate_doc/ticloud_serverless_update.md | 10 +++---- docs/generate_doc/ticloud_upgrade.md | 2 +- internal/flag/flag.go | 2 +- 43 files changed, 124 insertions(+), 126 deletions(-) diff --git a/docs/generate_doc/ticloud.md b/docs/generate_doc/ticloud.md index 070b70d5..85461cd3 100644 --- a/docs/generate_doc/ticloud.md +++ b/docs/generate_doc/ticloud.md @@ -24,4 +24,4 @@ ticloud is a CLI library for communicating with TiDB Cloud's API. * [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters * [ticloud upgrade](ticloud_upgrade.md) - Upgrade the CLI to the latest version -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_ai.md b/docs/generate_doc/ticloud_ai.md index c8b9aba8..c29d9ede 100644 --- a/docs/generate_doc/ticloud_ai.md +++ b/docs/generate_doc/ticloud_ai.md @@ -35,4 +35,4 @@ ticloud ai [flags] * [ticloud](ticloud.md) - CLI tool to manage TiDB Cloud -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_auth.md b/docs/generate_doc/ticloud_auth.md index 4de69ff1..cf9e5925 100644 --- a/docs/generate_doc/ticloud_auth.md +++ b/docs/generate_doc/ticloud_auth.md @@ -22,4 +22,4 @@ Login and logout via TiDB Cloud API * [ticloud auth login](ticloud_auth_login.md) - Authenticate with TiDB Cloud * [ticloud auth logout](ticloud_auth_logout.md) - Log out of TiDB Cloud -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_auth_login.md b/docs/generate_doc/ticloud_auth_login.md index 9d7e7abc..904b43de 100644 --- a/docs/generate_doc/ticloud_auth_login.md +++ b/docs/generate_doc/ticloud_auth_login.md @@ -9,7 +9,7 @@ ticloud auth login [flags] ### Examples ``` - To start the login for your account: + To log into TiDB Cloud:: $ ticloud auth login ``` @@ -32,4 +32,4 @@ ticloud auth login [flags] * [ticloud auth](ticloud_auth.md) - Login and logout via TiDB Cloud API -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_auth_logout.md b/docs/generate_doc/ticloud_auth_logout.md index 621c44ea..25455788 100644 --- a/docs/generate_doc/ticloud_auth_logout.md +++ b/docs/generate_doc/ticloud_auth_logout.md @@ -31,4 +31,4 @@ ticloud auth logout [flags] * [ticloud auth](ticloud_auth.md) - Login and logout via TiDB Cloud API -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_config.md b/docs/generate_doc/ticloud_config.md index 49dc9654..d38bf6ab 100644 --- a/docs/generate_doc/ticloud_config.md +++ b/docs/generate_doc/ticloud_config.md @@ -27,4 +27,4 @@ Configure and manage your user profiles * [ticloud config set](ticloud_config_set.md) - Configure specific properties of the active profile * [ticloud config use](ticloud_config_use.md) - Use the specified profile as the active profile -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_config_create.md b/docs/generate_doc/ticloud_config_create.md index 795096f0..4ee80a91 100644 --- a/docs/generate_doc/ticloud_config_create.md +++ b/docs/generate_doc/ticloud_config_create.md @@ -44,4 +44,4 @@ ticloud config create [flags] * [ticloud config](ticloud_config.md) - Configure and manage your user profiles -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_config_delete.md b/docs/generate_doc/ticloud_config_delete.md index a1f9e746..139435b4 100644 --- a/docs/generate_doc/ticloud_config_delete.md +++ b/docs/generate_doc/ticloud_config_delete.md @@ -32,4 +32,4 @@ ticloud config delete [flags] * [ticloud config](ticloud_config.md) - Configure and manage your user profiles -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_config_describe.md b/docs/generate_doc/ticloud_config_describe.md index 804647fc..a100c038 100644 --- a/docs/generate_doc/ticloud_config_describe.md +++ b/docs/generate_doc/ticloud_config_describe.md @@ -31,4 +31,4 @@ ticloud config describe [flags] * [ticloud config](ticloud_config.md) - Configure and manage your user profiles -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_config_edit.md b/docs/generate_doc/ticloud_config_edit.md index dd8e2a9c..9b820974 100644 --- a/docs/generate_doc/ticloud_config_edit.md +++ b/docs/generate_doc/ticloud_config_edit.md @@ -31,4 +31,4 @@ ticloud config edit [flags] * [ticloud config](ticloud_config.md) - Configure and manage your user profiles -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_config_list.md b/docs/generate_doc/ticloud_config_list.md index e2f17af1..00143d91 100644 --- a/docs/generate_doc/ticloud_config_list.md +++ b/docs/generate_doc/ticloud_config_list.md @@ -31,4 +31,4 @@ ticloud config list [flags] * [ticloud config](ticloud_config.md) - Configure and manage your user profiles -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_config_set.md b/docs/generate_doc/ticloud_config_set.md index 697a0b1c..4146a444 100644 --- a/docs/generate_doc/ticloud_config_set.md +++ b/docs/generate_doc/ticloud_config_set.md @@ -42,4 +42,4 @@ ticloud config set [flags] * [ticloud config](ticloud_config.md) - Configure and manage your user profiles -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_config_use.md b/docs/generate_doc/ticloud_config_use.md index e84caf2b..48ac517d 100644 --- a/docs/generate_doc/ticloud_config_use.md +++ b/docs/generate_doc/ticloud_config_use.md @@ -31,4 +31,4 @@ ticloud config use [flags] * [ticloud config](ticloud_config.md) - Configure and manage your user profiles -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_project.md b/docs/generate_doc/ticloud_project.md index c442988d..a8c6db09 100644 --- a/docs/generate_doc/ticloud_project.md +++ b/docs/generate_doc/ticloud_project.md @@ -21,4 +21,4 @@ Manage projects * [ticloud](ticloud.md) - CLI tool to manage TiDB Cloud * [ticloud project list](ticloud_project_list.md) - List all accessible projects -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_project_list.md b/docs/generate_doc/ticloud_project_list.md index f34b8b19..679b8523 100644 --- a/docs/generate_doc/ticloud_project_list.md +++ b/docs/generate_doc/ticloud_project_list.md @@ -35,4 +35,4 @@ ticloud project list [flags] * [ticloud project](ticloud_project.md) - Manage projects -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless.md b/docs/generate_doc/ticloud_serverless.md index f4c04042..aa99daba 100644 --- a/docs/generate_doc/ticloud_serverless.md +++ b/docs/generate_doc/ticloud_serverless.md @@ -19,18 +19,16 @@ Manage TiDB Serverless clusters ### SEE ALSO * [ticloud](ticloud.md) - CLI tool to manage TiDB Cloud -* [ticloud serverless backup](ticloud_serverless_backup.md) - Manage serverless cluster backups -* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage serverless cluster branches -* [ticloud serverless create](ticloud_serverless_create.md) - Create a serverless cluster -* [ticloud serverless delete](ticloud_serverless_delete.md) - Delete a serverless cluster -* [ticloud serverless describe](ticloud_serverless_describe.md) - Describe a serverless cluster -* [ticloud serverless export](ticloud_serverless_export.md) - Manage serverless cluster exports -* [ticloud serverless import](ticloud_serverless_import.md) - Import data into serverless cluster -* [ticloud serverless list](ticloud_serverless_list.md) - List all serverless clusters -* [ticloud serverless region](ticloud_serverless_region.md) - List all available regions for serverless clusters -* [ticloud serverless restore](ticloud_serverless_restore.md) - Restore a serverless cluster -* [ticloud serverless shell](ticloud_serverless_shell.md) - Connect to a serverless cluster -* [ticloud serverless spending-limit](ticloud_serverless_spending-limit.md) - Set spending limit for a serverless cluster -* [ticloud serverless update](ticloud_serverless_update.md) - Update a serverless cluster - -###### Auto generated by spf13/cobra on 15-Apr-2024 +* [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 update](ticloud_serverless_update.md) - Update a TiDB Serverless cluster + +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_branch.md b/docs/generate_doc/ticloud_serverless_branch.md index 2e33345e..be06a577 100644 --- a/docs/generate_doc/ticloud_serverless_branch.md +++ b/docs/generate_doc/ticloud_serverless_branch.md @@ -1,6 +1,6 @@ ## ticloud serverless branch -Manage serverless cluster branches +Manage TiDB Serverless branches ### Options @@ -25,4 +25,4 @@ Manage serverless cluster branches * [ticloud serverless branch list](ticloud_serverless_branch_list.md) - List branches * [ticloud serverless branch shell](ticloud_serverless_branch_shell.md) - Connect to a branch -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_branch_create.md b/docs/generate_doc/ticloud_serverless_branch_create.md index 8bbc5423..ddb073ff 100644 --- a/docs/generate_doc/ticloud_serverless_branch_create.md +++ b/docs/generate_doc/ticloud_serverless_branch_create.md @@ -34,6 +34,6 @@ ticloud serverless branch create [flags] ### SEE ALSO -* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage serverless cluster branches +* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Serverless branches -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_branch_delete.md b/docs/generate_doc/ticloud_serverless_branch_delete.md index cb83112f..b40413de 100644 --- a/docs/generate_doc/ticloud_serverless_branch_delete.md +++ b/docs/generate_doc/ticloud_serverless_branch_delete.md @@ -35,6 +35,6 @@ ticloud serverless branch delete [flags] ### SEE ALSO -* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage serverless cluster branches +* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Serverless branches -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_branch_describe.md b/docs/generate_doc/ticloud_serverless_branch_describe.md index 5343a880..88b4cfba 100644 --- a/docs/generate_doc/ticloud_serverless_branch_describe.md +++ b/docs/generate_doc/ticloud_serverless_branch_describe.md @@ -34,6 +34,6 @@ ticloud serverless branch describe [flags] ### SEE ALSO -* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage serverless cluster branches +* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Serverless branches -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_branch_list.md b/docs/generate_doc/ticloud_serverless_branch_list.md index d85966df..a98efb62 100644 --- a/docs/generate_doc/ticloud_serverless_branch_list.md +++ b/docs/generate_doc/ticloud_serverless_branch_list.md @@ -37,6 +37,6 @@ ticloud serverless branch list [flags] ### SEE ALSO -* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage serverless cluster branches +* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Serverless branches -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_branch_shell.md b/docs/generate_doc/ticloud_serverless_branch_shell.md index 6f8271aa..e5c21f76 100644 --- a/docs/generate_doc/ticloud_serverless_branch_shell.md +++ b/docs/generate_doc/ticloud_serverless_branch_shell.md @@ -5,7 +5,7 @@ Connect to a branch ### Synopsis Connect to a branch. -the connection forces the [ANSI SQL mode](https://dev.mysql.com/doc/refman/8.0/en/sql-mode.html#sqlmode_ansi) for the session. +The connection forces the [ANSI SQL mode](https://dev.mysql.com/doc/refman/8.0/en/sql-mode.html#sqlmode_ansi) for the session. ``` ticloud serverless branch shell [flags] @@ -30,11 +30,11 @@ ticloud serverless branch shell [flags] ### Options ``` - -b, --branch-id string The ID of the branch. - -c, --cluster-id string The ID of the cluster. - -h, --help help for shell - --local.password string The password of the user. - -u, --user string A specific user for login if not using the default user. + -b, --branch-id string The ID of the branch. + -c, --cluster-id string The ID of the cluster. + -h, --help help for shell + --password string The password of the user. + -u, --user string A specific user for login if not using the default user. ``` ### Options inherited from parent commands @@ -47,6 +47,6 @@ ticloud serverless branch shell [flags] ### SEE ALSO -* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage serverless cluster branches +* [ticloud serverless branch](ticloud_serverless_branch.md) - Manage TiDB Serverless branches -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_create.md b/docs/generate_doc/ticloud_serverless_create.md index 4673e7a5..4589a1eb 100644 --- a/docs/generate_doc/ticloud_serverless_create.md +++ b/docs/generate_doc/ticloud_serverless_create.md @@ -1,6 +1,6 @@ ## ticloud serverless create -Create a serverless cluster +Create a TiDB Serverless cluster ``` ticloud serverless create [flags] @@ -9,13 +9,13 @@ ticloud serverless create [flags] ### Examples ``` - Create a serverless cluster in interactive mode: + Create a TiDB Serverless cluster in interactive mode: $ ticloud serverless create - Create a serverless cluster of the default ptoject in non-interactive mode: + Create a TiDB Serverless cluster of the default ptoject in non-interactive mode: $ ticloud serverless create --display-name --region - Create a serverless cluster in non-interactive mode: + Create a TiDB Serverless cluster in non-interactive mode: $ ticloud serverless create --project-id --display-name --region ``` @@ -42,4 +42,4 @@ ticloud serverless create [flags] * [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_delete.md b/docs/generate_doc/ticloud_serverless_delete.md index 0d53ddf2..bc1e6dcd 100644 --- a/docs/generate_doc/ticloud_serverless_delete.md +++ b/docs/generate_doc/ticloud_serverless_delete.md @@ -1,6 +1,6 @@ ## ticloud serverless delete -Delete a serverless cluster +Delete a TiDB Serverless cluster ``` ticloud serverless delete [flags] @@ -9,10 +9,10 @@ ticloud serverless delete [flags] ### Examples ``` - Delete a serverless cluster in interactive mode: + Delete a TiDB Serverless cluster in interactive mode: $ ticloud serverless delete - Delete a serverless cluster in non-interactive mode: + Delete a TiDB Serverless cluster in non-interactive mode: $ ticloud serverless delete -c ``` @@ -36,4 +36,4 @@ ticloud serverless delete [flags] * [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_describe.md b/docs/generate_doc/ticloud_serverless_describe.md index 88781b17..efcbd16b 100644 --- a/docs/generate_doc/ticloud_serverless_describe.md +++ b/docs/generate_doc/ticloud_serverless_describe.md @@ -1,6 +1,6 @@ ## ticloud serverless describe -Describe a serverless cluster +Describe a TiDB Serverless cluster ``` ticloud serverless describe [flags] @@ -9,10 +9,10 @@ ticloud serverless describe [flags] ### Examples ``` - Get a serverless cluster in interactive mode: + Get a TiDB Serverless cluster in interactive mode: $ ticloud serverless describe - Get a serverless cluster in non-interactive mode: + Get a TiDB Serverless cluster in non-interactive mode: $ ticloud serverless describe -c ``` @@ -35,4 +35,4 @@ ticloud serverless describe [flags] * [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_export.md b/docs/generate_doc/ticloud_serverless_export.md index 5b7e8d60..fe0aad07 100644 --- a/docs/generate_doc/ticloud_serverless_export.md +++ b/docs/generate_doc/ticloud_serverless_export.md @@ -1,6 +1,6 @@ ## ticloud serverless export -Manage serverless cluster exports +Manage TiDB Serverless exports ### Options @@ -19,10 +19,10 @@ Manage serverless cluster exports ### SEE ALSO * [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters -* [ticloud serverless export cancel](ticloud_serverless_export_cancel.md) - Cancel a serverless cluster export -* [ticloud serverless export create](ticloud_serverless_export_create.md) - Create a serverless cluster export -* [ticloud serverless export describe](ticloud_serverless_export_describe.md) - Describe a serverless cluster export -* [ticloud serverless export download](ticloud_serverless_export_download.md) - Download the local type export -* [ticloud serverless export list](ticloud_serverless_export_list.md) - List serverless cluster exports +* [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 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 -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_export_cancel.md b/docs/generate_doc/ticloud_serverless_export_cancel.md index 29bc0857..350c5221 100644 --- a/docs/generate_doc/ticloud_serverless_export_cancel.md +++ b/docs/generate_doc/ticloud_serverless_export_cancel.md @@ -1,6 +1,6 @@ ## ticloud serverless export cancel -Cancel a serverless cluster export +Cancel an export task ``` ticloud serverless export cancel [flags] @@ -35,6 +35,6 @@ ticloud serverless export cancel [flags] ### SEE ALSO -* [ticloud serverless export](ticloud_serverless_export.md) - Manage serverless cluster exports +* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Serverless exports -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_export_create.md b/docs/generate_doc/ticloud_serverless_export_create.md index 39b9db87..d25c6529 100644 --- a/docs/generate_doc/ticloud_serverless_export_create.md +++ b/docs/generate_doc/ticloud_serverless_export_create.md @@ -1,6 +1,6 @@ ## ticloud serverless export create -Create a serverless cluster export +Export data from a TiDB Serverless cluster ``` ticloud serverless export create [flags] @@ -44,6 +44,6 @@ ticloud serverless export create [flags] ### SEE ALSO -* [ticloud serverless export](ticloud_serverless_export.md) - Manage serverless cluster exports +* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Serverless exports -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_export_describe.md b/docs/generate_doc/ticloud_serverless_export_describe.md index d4a4d4b2..50bcdd0d 100644 --- a/docs/generate_doc/ticloud_serverless_export_describe.md +++ b/docs/generate_doc/ticloud_serverless_export_describe.md @@ -1,6 +1,6 @@ ## ticloud serverless export describe -Describe a serverless cluster export +Describe an export task ``` ticloud serverless export describe [flags] @@ -34,6 +34,6 @@ ticloud serverless export describe [flags] ### SEE ALSO -* [ticloud serverless export](ticloud_serverless_export.md) - Manage serverless cluster exports +* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Serverless exports -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_export_download.md b/docs/generate_doc/ticloud_serverless_export_download.md index 4d80ffd6..6ccf1e3c 100644 --- a/docs/generate_doc/ticloud_serverless_export_download.md +++ b/docs/generate_doc/ticloud_serverless_export_download.md @@ -1,6 +1,6 @@ ## ticloud serverless export download -Download the local type export +Download the exported data ``` ticloud serverless export download [flags] @@ -19,9 +19,9 @@ ticloud serverless export download [flags] ### Options ``` - --auto-approve Download without confirmation. -c, --cluster-id string The cluster ID of the export. -e, --export-id string The ID of the export. + --force Download without confirmation. -h, --help help for download --output-path string Where you want to download to. If not specified, download to the current directory. ``` @@ -36,6 +36,6 @@ ticloud serverless export download [flags] ### SEE ALSO -* [ticloud serverless export](ticloud_serverless_export.md) - Manage serverless cluster exports +* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Serverless exports -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_export_list.md b/docs/generate_doc/ticloud_serverless_export_list.md index c7c6ad07..9199febf 100644 --- a/docs/generate_doc/ticloud_serverless_export_list.md +++ b/docs/generate_doc/ticloud_serverless_export_list.md @@ -1,6 +1,6 @@ ## ticloud serverless export list -List serverless cluster exports +List export tasks ``` ticloud serverless export list [flags] @@ -37,6 +37,6 @@ ticloud serverless export list [flags] ### SEE ALSO -* [ticloud serverless export](ticloud_serverless_export.md) - Manage serverless cluster exports +* [ticloud serverless export](ticloud_serverless_export.md) - Manage TiDB Serverless exports -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_import.md b/docs/generate_doc/ticloud_serverless_import.md index 88f71460..689aa869 100644 --- a/docs/generate_doc/ticloud_serverless_import.md +++ b/docs/generate_doc/ticloud_serverless_import.md @@ -1,6 +1,6 @@ ## ticloud serverless import -Import data into serverless cluster +Manage TiDB Serverless data imports ### Options @@ -24,4 +24,4 @@ Import data into serverless cluster * [ticloud serverless import list](ticloud_serverless_import_list.md) - List data import tasks * [ticloud serverless import start](ticloud_serverless_import_start.md) - Start a data import task -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_import_cancel.md b/docs/generate_doc/ticloud_serverless_import_cancel.md index 1e61ca07..975f2058 100644 --- a/docs/generate_doc/ticloud_serverless_import_cancel.md +++ b/docs/generate_doc/ticloud_serverless_import_cancel.md @@ -35,6 +35,6 @@ ticloud serverless import cancel [flags] ### SEE ALSO -* [ticloud serverless import](ticloud_serverless_import.md) - Import data into serverless cluster +* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Serverless data imports -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_import_describe.md b/docs/generate_doc/ticloud_serverless_import_describe.md index 88c4f8dc..9119a49e 100644 --- a/docs/generate_doc/ticloud_serverless_import_describe.md +++ b/docs/generate_doc/ticloud_serverless_import_describe.md @@ -34,6 +34,6 @@ ticloud serverless import describe [flags] ### SEE ALSO -* [ticloud serverless import](ticloud_serverless_import.md) - Import data into serverless cluster +* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Serverless data imports -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_import_list.md b/docs/generate_doc/ticloud_serverless_import_list.md index 1639a1a2..4cfe6c33 100644 --- a/docs/generate_doc/ticloud_serverless_import_list.md +++ b/docs/generate_doc/ticloud_serverless_import_list.md @@ -37,6 +37,6 @@ ticloud serverless import list [flags] ### SEE ALSO -* [ticloud serverless import](ticloud_serverless_import.md) - Import data into serverless cluster +* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Serverless data imports -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_import_start.md b/docs/generate_doc/ticloud_serverless_import_start.md index c2fba9da..9d1b58ed 100644 --- a/docs/generate_doc/ticloud_serverless_import_start.md +++ b/docs/generate_doc/ticloud_serverless_import_start.md @@ -12,13 +12,13 @@ ticloud serverless import start [flags] Start an import task in interactive mode: $ ticloud serverless import start - Start an local import task in non-interactive mode: + Start a local import task in non-interactive mode: $ ticloud serverless import start --local.file-path --cluster-id --file-type --local.target-database --local.target-table - Start an local import task with custom upload concurrency: + Start a local import task with custom upload concurrency: $ ticloud serverless import start --local.file-path --cluster-id --file-type --local.target-database --local.target-table --local.concurrency 10 - Start an local import task with custom CSV format: + Start a local import task with custom CSV format: $ ticloud serverless import start --local.file-path --cluster-id --file-type CSV --local.target-database --local.target-table --csv.separator \" --csv.delimiter \' --csv.backslash-escape=false --csv.trim-last-separator=true ``` @@ -50,6 +50,6 @@ ticloud serverless import start [flags] ### SEE ALSO -* [ticloud serverless import](ticloud_serverless_import.md) - Import data into serverless cluster +* [ticloud serverless import](ticloud_serverless_import.md) - Manage TiDB Serverless data imports -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_list.md b/docs/generate_doc/ticloud_serverless_list.md index 1c957008..2e8abb4a 100644 --- a/docs/generate_doc/ticloud_serverless_list.md +++ b/docs/generate_doc/ticloud_serverless_list.md @@ -1,6 +1,6 @@ ## ticloud serverless list -List all serverless clusters +List all TiDB Serverless clusters ``` ticloud serverless list [flags] @@ -9,13 +9,13 @@ ticloud serverless list [flags] ### Examples ``` - List all serverless clusters in interactive mode): + List all TiDB Serverless clusters in interactive mode): $ ticloud serverless list - List all serverless clusters in non-interactive mode: + List all TiDB Serverless clusters in non-interactive mode: $ ticloud serverless list -p - List all serverless clusters in non-interactive mode: + List all TiDB Serverless clusters in non-interactive mode: $ ticloud serverless list -p -o json ``` @@ -39,4 +39,4 @@ ticloud serverless list [flags] * [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_region.md b/docs/generate_doc/ticloud_serverless_region.md index 8db19996..f94a3636 100644 --- a/docs/generate_doc/ticloud_serverless_region.md +++ b/docs/generate_doc/ticloud_serverless_region.md @@ -1,6 +1,6 @@ ## ticloud serverless region -List all available regions for serverless clusters +List all available regions for TiDB Serverless ``` ticloud serverless region [flags] @@ -9,7 +9,7 @@ ticloud serverless region [flags] ### Examples ``` - List all available regions for serverless clusters: + List all available regions for TiDB Serverless: $ ticloud serverless region ``` @@ -32,4 +32,4 @@ ticloud serverless region [flags] * [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_shell.md b/docs/generate_doc/ticloud_serverless_shell.md index 09926875..e8293f71 100644 --- a/docs/generate_doc/ticloud_serverless_shell.md +++ b/docs/generate_doc/ticloud_serverless_shell.md @@ -1,10 +1,10 @@ ## ticloud serverless shell -Connect to a serverless cluster +Connect to a TiDB Serverless cluster ### Synopsis -Connect to a serverless cluster +Connect to a TiDB 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. ``` @@ -14,10 +14,10 @@ ticloud serverless shell [flags] ### Examples ``` - Connect to a serverless cluster in interactive mode: + Connect to a TiDB Serverless cluster in interactive mode: $ ticloud serverless shell - Connect to a serverless cluster with default user in non-interactive mode: + Connect to a TiDB Serverless cluster with default user in non-interactive mode: $ ticloud serverless shell -c Connect to a serverless cluster with default user and password in non-interactive mode: @@ -30,10 +30,10 @@ ticloud serverless shell [flags] ### Options ``` - -c, --cluster-id string The ID of the cluster. - -h, --help help for shell - --local.password string The password of the user. - -u, --user string A specific user for login if not using the default user. + -c, --cluster-id string The ID of the cluster. + -h, --help help for shell + --password string The password of the user. + -u, --user string A specific user for login if not using the default user. ``` ### Options inherited from parent commands @@ -48,4 +48,4 @@ ticloud serverless shell [flags] * [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_spending-limit.md b/docs/generate_doc/ticloud_serverless_spending-limit.md index 0de6fbe1..47d8a8b0 100644 --- a/docs/generate_doc/ticloud_serverless_spending-limit.md +++ b/docs/generate_doc/ticloud_serverless_spending-limit.md @@ -1,6 +1,6 @@ ## ticloud serverless spending-limit -Set spending limit for a serverless cluster +Set spending limit for a TiDB Serverless cluster ``` ticloud serverless spending-limit [flags] @@ -9,10 +9,10 @@ ticloud serverless spending-limit [flags] ### Examples ``` - Set spending limit for serverless clusters in interactive mode: + Set spending limit for a TiDB Serverless cluster in interactive mode: $ ticloud serverless spending-limit - Set spending limit for serverless clusters in non-interactive mode: + Set spending limit for a TiDB Serverless cluster in non-interactive mode: $ ticloud serverless spending-limit -c --monthly ``` @@ -36,4 +36,4 @@ ticloud serverless spending-limit [flags] * [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_serverless_update.md b/docs/generate_doc/ticloud_serverless_update.md index 1ab32e73..30c63792 100644 --- a/docs/generate_doc/ticloud_serverless_update.md +++ b/docs/generate_doc/ticloud_serverless_update.md @@ -1,6 +1,6 @@ ## ticloud serverless update -Update a serverless cluster +Update a TiDB Serverless cluster ``` ticloud serverless update [flags] @@ -9,13 +9,13 @@ ticloud serverless update [flags] ### Examples ``` - Update a serverless cluster in interactive mode: + Update a TiDB Serverless cluster in interactive mode: $ ticloud serverless update - Update displayName of serverless cluster in non-interactive mode: + Update displayName of a TiDB Serverless cluster in non-interactive mode: $ ticloud serverless update -c --display-name - Update labels of serverless cluster in non-interactive mode: + Update labels of a TiDB Serverless cluster in non-interactive mode: $ ticloud serverless update -c --labels "{\"label1\":\"value1\"}" ``` @@ -45,4 +45,4 @@ ticloud serverless update [flags] * [ticloud serverless](ticloud_serverless.md) - Manage TiDB Serverless clusters -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/docs/generate_doc/ticloud_upgrade.md b/docs/generate_doc/ticloud_upgrade.md index c3c1bc91..d62b168b 100644 --- a/docs/generate_doc/ticloud_upgrade.md +++ b/docs/generate_doc/ticloud_upgrade.md @@ -24,4 +24,4 @@ ticloud upgrade [flags] * [ticloud](ticloud.md) - CLI tool to manage TiDB Cloud -###### Auto generated by spf13/cobra on 15-Apr-2024 +###### Auto generated by spf13/cobra on 16-Apr-2024 diff --git a/internal/flag/flag.go b/internal/flag/flag.go index eed63e5a..4482da8a 100644 --- a/internal/flag/flag.go +++ b/internal/flag/flag.go @@ -36,7 +36,7 @@ const ( NoColor string = "no-color" Output string = "output" OutputShort string = "o" - Password string = "local.password" + Password string = "password" ProjectID string = "project-id" ProjectIDShort string = "p" ProfileName string = "profile-name"