Skip to content

Name the CLI subcommand vtctl #1438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rcrowley merged 1 commit into from
Sep 21, 2026
Merged

Name the CLI subcommand vtctl #1438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ Caveats:

## Vitess database throttler

Database-level default for future deploy request migrations (not per-DR, not tablet/vtctld):
Database-level default for future deploy request migrations (not per-DR, not tablet/vtctl):

```bash
pscale database throttler show <database> --org <org> --format json
Expand Down
2 changes: 1 addition & 1 deletion internal/cmd/branch/vtctld/planned_reparent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ func PlannedReparentShardCmd(ch *cmdutil.Helper) *cobra.Command {
Both the old and new primaries must be up and running.

To check on an existing operation, use the "status" subcommand:
pscale branch vtctld planned-reparent-shard status <db> <branch> <operation-id>`,
pscale branch vtctl planned-reparent-shard status <db> <branch> <operation-id>`,
Args: cmdutil.RequiredArgs("database", "branch"),
RunE: func(cmd *cobra.Command, args []string) error {
ctx := cmd.Context()
Expand Down
4 changes: 2 additions & 2 deletions internal/cmd/branch/vtctld/throttler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ func ThrottlerStatusCmd(ch *cmdutil.Helper) *cobra.Command {
Use: "status <database> <branch>",
Short: "Get the throttler status for a single tablet",
Long: "Get the throttler status for a single tablet, identified by its alias. " +
"Discover tablet aliases with `pscale branch vtctld list-tablets`.",
"Discover tablet aliases with `pscale branch vtctl list-tablets`.",
Args: cmdutil.RequiredArgs("database", "branch"),
RunE: func(cmd *cobra.Command, args []string) error {
ctx := cmd.Context()
Expand Down Expand Up @@ -87,7 +87,7 @@ func ThrottlerCheckCmd(ch *cmdutil.Helper) *cobra.Command {
Use: "check <database> <branch>",
Short: "Issue a throttler check against a single tablet",
Long: "Issue a throttler check against a single tablet, identified by its alias. " +
"Discover tablet aliases with `pscale branch vtctld list-tablets`.",
"Discover tablet aliases with `pscale branch vtctl list-tablets`.",
Args: cmdutil.RequiredArgs("database", "branch"),
RunE: func(cmd *cobra.Command, args []string) error {
ctx := cmd.Context()
Expand Down
9 changes: 5 additions & 4 deletions internal/cmd/branch/vtctld/vtctld.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import (

func VtctldCmd(ch *cmdutil.Helper) *cobra.Command {
cmd := &cobra.Command{
Use: "vtctld <command>",
Short: "Run vtctld commands against a branch",
Long: "Run vtctld commands against a branch. This command is only supported for Vitess databases.",
Hidden: true,
Use: "vtctl <command>",
Aliases: []string{"vtctld"},
Short: "Run vtctl commands against a branch",
Long: "Run vtctl commands against a branch. This command is only supported for Vitess databases.",
Hidden: true,
}

cmd.AddCommand(MaterializeCmd(ch))
Expand Down
2 changes: 1 addition & 1 deletion internal/cmd/database/throttler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ func ThrottlerCmd(ch *cmdutil.Helper) *cobra.Command {

This sets the default throttler for future deploy requests on the database.
It is not the per-deploy-request throttler (pscale deploy-request throttler)
and not the tablet/vtctld throttler (pscale branch vtctld throttler).`,
and not the tablet/vtctl throttler (pscale branch vtctl throttler).`,
}

cmd.AddCommand(ThrottlerShowCmd(ch))
Expand Down
Loading