ticloud serverless sql-user update

November 21, 2024 ยท View on GitHub

Update a TiDB Cloud Serverless SQL user:

ticloud serverless sql-user update [flags]

Examples

Update a TiDB Cloud Serverless SQL user in interactive mode:

ticloud serverless sql-user update

Update a TiDB Cloud Serverless SQL user in non-interactive mode:

ticloud serverless sql-user update -c <cluster-id> --user <user-name> --password <password> --role <role>

Flags

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.

FlagDescriptionRequiredNote
-c, --cluster-id stringSpecifies the ID of the cluster.YesOnly works in non-interactive mode.
--password stringSpecifies the new password of the SQL user.NoOnly works in non-interactive mode.
--role stringsSpecifies the new roles of the SQL user. Passing this flag replaces existing roles.NoOnly works in non-interactive mode.
--add-role stringsSpecifies the roles to be added to the SQL user.NoOnly works in non-interactive mode.
--delete-role stringsSpecifies the roles to be deleted from the SQL user.NoOnly works in non-interactive mode.
-u, --user stringSpecifies the name of the SQL user to be updated.NoOnly works in non-interactive mode.
-h, --helpShows help information for this command.NoWorks in both non-interactive and interactive modes.

Inherited flags

FlagDescriptionRequiredNote
--no-colorDisables color in output.NoOnly works in non-interactive mode. In interactive mode, disabling color might not work with some UI components.
-P, --profile stringSpecifies the active user profile used in this command.NoWorks in both non-interactive and interactive modes.
-D, --debugEnables debug mode.NoWorks in both non-interactive and interactive modes.

Feedback

If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an issue. Also, we welcome any contributions.