Skip to content
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.

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

vtctldclient Reshard + refactor: regenerate docs #1579

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ vtctldclient [flags]
* [vtctldclient RemoveKeyspaceCell](./vtctldclient_removekeyspacecell/) - Removes the specified cell from the Cells list for all shards in the specified keyspace (by calling RemoveShardCell on every shard). It also removes the SrvKeyspace for that keyspace in that cell.
* [vtctldclient RemoveShardCell](./vtctldclient_removeshardcell/) - Remove the specified cell from the specified shard's Cells list.
* [vtctldclient ReparentTablet](./vtctldclient_reparenttablet/) - Reparent a tablet to the current primary in the shard.
* [vtctldclient Reshard](./vtctldclient_reshard/) - Perform commands related to resharding a keyspace.
* [vtctldclient RestoreFromBackup](./vtctldclient_restorefrombackup/) - Stops mysqld on the specified tablet and restores the data from either the latest backup or closest before `backup-timestamp`.
* [vtctldclient RunHealthCheck](./vtctldclient_runhealthcheck/) - Runs a healthcheck on the remote tablet.
* [vtctldclient SetKeyspaceDurabilityPolicy](./vtctldclient_setkeyspacedurabilitypolicy/) - Sets the durability-policy used by the specified keyspace.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ Perform commands related to moving tables from a source keyspace to a target key

### Synopsis

MoveTables commands: Create, Show, Status, SwitchTraffic, ReverseTraffic, Stop, Start, Cancel, and Delete.
moveTables commands: Create, Show, Status, SwitchTraffic, ReverseTraffic, Stop, Start, Cancel, and Delete.
See the --help output for each command for more details.

### Options

```
--format string The format of the output; supported formats are: text,json (default "text")
--format string The format of the output; supported formats are: text,json. (default "text")
-h, --help help for MoveTables
--target-keyspace string Keyspace where the tables are being moved to and where the workflow exists (required)
-w, --workflow string The workflow you want to perform the command on (required)
--target-keyspace string Target keyspace for this workflow exists (required).
-w, --workflow string The workflow you want to perform the command on (required).
```

### Options inherited from parent commands
Expand All @@ -32,10 +32,10 @@ See the --help output for each command for more details.
* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server.
* [vtctldclient MoveTables cancel](./vtctldclient_movetables_cancel/) - Cancel a MoveTables VReplication workflow.
* [vtctldclient MoveTables complete](./vtctldclient_movetables_complete/) - Complete a MoveTables VReplication workflow.
* [vtctldclient MoveTables create](./vtctldclient_movetables_create/) - Create and optionally run a MoveTables VReplication workflow.
* [vtctldclient MoveTables create](./vtctldclient_movetables_create/) - Create and optionally run a moveTables VReplication workflow.
* [vtctldclient MoveTables reversetraffic](./vtctldclient_movetables_reversetraffic/) - Reverse traffic for a MoveTables VReplication workflow.
* [vtctldclient MoveTables show](./vtctldclient_movetables_show/) - Show the details for a MoveTables VReplication workflow.
* [vtctldclient MoveTables start](./vtctldclient_movetables_start/) - Start the MoveTables workflow.
* [vtctldclient MoveTables start](./vtctldclient_movetables_start/) - Start a MoveTables workflow.
* [vtctldclient MoveTables status](./vtctldclient_movetables_status/) - Show the current status for a MoveTables VReplication workflow.
* [vtctldclient MoveTables stop](./vtctldclient_movetables_stop/) - Stop a MoveTables workflow.
* [vtctldclient MoveTables switchtraffic](./vtctldclient_movetables_switchtraffic/) - Switch traffic for a MoveTables VReplication workflow.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,20 @@ vtctldclient MoveTables cancel
### Examples

```
vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer cancel
vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer cancel
```

### Options

```
-h, --help help for cancel
--keep-data Keep the partially copied table data from the MoveTables workflow in the target keyspace
--keep-routing-rules Keep the routing rules created for the MoveTables workflow
-h, --help help for cancel
```

### Options inherited from parent commands

```
--action_timeout duration timeout for the total command (default 1h0m0s)
--server string server to use for connection (required)
--target-keyspace string Keyspace where the tables are being moved to and where the workflow exists (required)
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,14 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
### Options

```
--dry-run Print the actions that would be taken and report any known errors that would have occurred
-h, --help help for complete
--keep-data Keep the original source table data that was copied by the MoveTables workflow
--keep-routing-rules Keep the routing rules in place that direct table traffic from the source keyspace to the target keyspace of the MoveTables workflow
--rename-tables Keep the original source table data that was copied by the MoveTables workflow, but rename each table to '_<tablename>_old'
-h, --help help for complete
```

### Options inherited from parent commands

```
--action_timeout duration timeout for the total command (default 1h0m0s)
--server string server to use for connection (required)
--target-keyspace string Keyspace where the tables are being moved to and where the workflow exists (required)
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ series: vtctldclient
---
## vtctldclient MoveTables create

Create and optionally run a MoveTables VReplication workflow.
Create and optionally run a moveTables VReplication workflow.

```
vtctldclient MoveTables create
Expand All @@ -19,29 +19,29 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
### Options

```
--all-tables Copy all tables from the source
--auto-start Start the MoveTables workflow after creating it (default true)
-c, --cells strings Cells and/or CellAliases to copy table data from
--defer-secondary-keys Defer secondary index creation for a table until after it has been copied
--exclude-tables strings Source tables to exclude from copying
--all-tables Copy all tables from the source.
--atomic-copy (EXPERIMENTAL) A single copy phase is run for all tables from the source. Use this, for example, if your source keyspace has tables which use foreign key constraints.
--auto-start Start the MoveTables workflow after creating it. (default true)
-c, --cells strings Cells and/or CellAliases to copy table data from.
--defer-secondary-keys Defer secondary index creation for a table until after it has been copied.
--exclude-tables strings Source tables to exclude from copying.
-h, --help help for create
--no-routing-rules (Advanced) Do not create routing rules while creating the workflow. See the reference documentation for limitations if you use this flag.
--on-ddl string What to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE (default "IGNORE")
--source-keyspace string Keyspace where the tables are being moved from (required)
--source-shards strings Source shards to copy data from when performing a partial MoveTables (experimental)
--source-time-zone string Specifying this causes any DATETIME fields to be converted from the given time zone into UTC
--stop-after-copy Stop the MoveTables workflow after it's finished copying the existing rows and before it starts replicating changes
--tables strings Source tables to copy
--tablet-types strings Source tablet types to replicate table data from (e.g. PRIMARY,REPLICA,RDONLY)
--tablet-types-in-preference-order When performing source tablet selection, look for candidates in the type order as they are listed in the tablet-types flag (default true)
--on-ddl string What to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE. (default "IGNORE")
--source-keyspace string Keyspace where the tables are being moved from (required).
--source-shards strings Source shards to copy data from when performing a partial moveTables (experimental).
--source-time-zone string Specifying this causes any DATETIME fields to be converted from the given time zone into UTC.
--stop-after-copy Stop the MoveTables workflow after it's finished copying the existing rows and before it starts replicating changes.
--tables strings Source tables to copy.
--tablet-types strings Source tablet types to replicate table data from (e.g. PRIMARY,REPLICA,RDONLY).
--tablet-types-in-preference-order When performing source tablet selection, look for candidates in the type order as they are listed in the tablet-types flag. (default true)
```

### Options inherited from parent commands

```
--action_timeout duration timeout for the total command (default 1h0m0s)
--server string server to use for connection (required)
--target-keyspace string Keyspace where the tables are being moved to and where the workflow exists (required)
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ vtctldclient MoveTables reversetraffic
### Examples

```
vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer reversetraffic
vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer reversetraffic
```

### Options

```
-c, --cells strings Cells and/or CellAliases to switch traffic in
--dry-run Print the actions that would be taken and report any known errors that would have occurred
--enable-reverse-replication Setup replication going back to the original target keyspace to support switching traffic again (default true)
-c, --cells strings Cells and/or CellAliases to switch traffic in.
--dry-run Print the actions that would be taken and report any known errors that would have occurred.
--enable-reverse-replication Setup replication going back to the original source keyspace to support rolling back the traffic cutover. (default true)
-h, --help help for reversetraffic
--max-replication-lag-allowed duration Allow traffic to be switched only if VReplication lag is below this (default 30s)
--tablet-types strings Tablet types to switch traffic for
--max-replication-lag-allowed duration Allow traffic to be switched only if VReplication lag is below this. (default 30s)
--tablet-types strings Tablet types to switch traffic for.
--timeout duration Specifies the maximum time to wait, in seconds, for VReplication to catch up on primary tablets. The traffic switch will be cancelled on timeout. (default 30s)
```

Expand All @@ -33,7 +33,6 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
```
--action_timeout duration timeout for the total command (default 1h0m0s)
--server string server to use for connection (required)
--target-keyspace string Keyspace where the tables are being moved to and where the workflow exists (required)
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ vtctldclient MoveTables show
### Examples

```
vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer show
vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer show
```

### Options
Expand All @@ -27,7 +27,6 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
```
--action_timeout duration timeout for the total command (default 1h0m0s)
--server string server to use for connection (required)
--target-keyspace string Keyspace where the tables are being moved to and where the workflow exists (required)
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ series: vtctldclient
---
## vtctldclient MoveTables start

Start the MoveTables workflow.
Start a MoveTables workflow.

```
vtctldclient MoveTables start
Expand All @@ -13,7 +13,7 @@ vtctldclient MoveTables start
### Examples

```
vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer start
vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer start
```

### Options
Expand All @@ -27,7 +27,6 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
```
--action_timeout duration timeout for the total command (default 1h0m0s)
--server string server to use for connection (required)
--target-keyspace string Keyspace where the tables are being moved to and where the workflow exists (required)
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --
```
--action_timeout duration timeout for the total command (default 1h0m0s)
--server string server to use for connection (required)
--target-keyspace string Keyspace where the tables are being moved to and where the workflow exists (required)
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ vtctldclient MoveTables stop
### Examples

```
vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer stop
vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer stop
```

### Options
Expand All @@ -27,7 +27,6 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
```
--action_timeout duration timeout for the total command (default 1h0m0s)
--server string server to use for connection (required)
--target-keyspace string Keyspace where the tables are being moved to and where the workflow exists (required)
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ vtctldclient MoveTables switchtraffic
### Examples

```
vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer switchtraffic --tablet-types "replica,rdonly"
vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer switchtraffic --tablet-types "replica,rdonly"
```

### Options

```
-c, --cells strings Cells and/or CellAliases to switch traffic in
--dry-run Print the actions that would be taken and report any known errors that would have occurred
--enable-reverse-replication Setup replication going back to the original source keyspace to support rolling back the traffic cutover (default true)
-c, --cells strings Cells and/or CellAliases to switch traffic in.
--dry-run Print the actions that would be taken and report any known errors that would have occurred.
--enable-reverse-replication Setup replication going back to the original source keyspace to support rolling back the traffic cutover. (default true)
-h, --help help for switchtraffic
--initialize-target-sequences When moving tables from an unsharded keyspace to a sharded keyspace, initialize any sequences that are being used on the target when switching writes.
--max-replication-lag-allowed duration Allow traffic to be switched only if VReplication lag is below this (default 30s)
--tablet-types strings Tablet types to switch traffic for
--max-replication-lag-allowed duration Allow traffic to be switched only if VReplication lag is below this. (default 30s)
--tablet-types strings Tablet types to switch traffic for.
--timeout duration Specifies the maximum time to wait, in seconds, for VReplication to catch up on primary tablets. The traffic switch will be cancelled on timeout. (default 30s)
```

Expand All @@ -34,7 +34,6 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
```
--action_timeout duration timeout for the total command (default 1h0m0s)
--server string server to use for connection (required)
--target-keyspace string Keyspace where the tables are being moved to and where the workflow exists (required)
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Operates on online DDL (schema migrations).
### SEE ALSO

* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server.
* [vtctldclient OnlineDDL cancel](./vtctldclient_onlineddl_cancel/) - Cancel one or all pending migrations, terminating any actively running ones.
* [vtctldclient OnlineDDL cancel](./vtctldclient_onlineddl_cancel/) - cancel one or all migrations, terminating any running ones as needed.
* [vtctldclient OnlineDDL cleanup](./vtctldclient_onlineddl_cleanup/) - Mark a given schema migration ready for artifact cleanup.
* [vtctldclient OnlineDDL complete](./vtctldclient_onlineddl_complete/) - Complete one or all migrations executed with `--postpone-completion`.
* [vtctldclient OnlineDDL launch](./vtctldclient_onlineddl_launch/) - Launch one or all migrations executed with `--postpone-launch`.
* [vtctldclient OnlineDDL complete](./vtctldclient_onlineddl_complete/) - complete one or all migrations executed with --postpone-completion
* [vtctldclient OnlineDDL launch](./vtctldclient_onlineddl_launch/) - launch one or all migrations executed with --postpone-launch
* [vtctldclient OnlineDDL retry](./vtctldclient_onlineddl_retry/) - Mark a given schema migration for retry.
* [vtctldclient OnlineDDL show](./vtctldclient_onlineddl_show/) - Display information about online DDL operations.

Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ series: vtctldclient
---
## vtctldclient OnlineDDL cancel

Cancel one or all pending migrations, terminating any actively running ones.
cancel one or all migrations, terminating any running ones as needed.

```
vtctldclient OnlineDDL cancel <keyspace> <uuid|all>
Expand All @@ -14,7 +14,6 @@ vtctldclient OnlineDDL cancel <keyspace> <uuid|all>

```
OnlineDDL cancel test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90
OnlineDDL cancel test_keyspace all
```

### Options
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ series: vtctldclient
---
## vtctldclient OnlineDDL complete

Complete one or all migrations executed with `--postpone-completion`.
complete one or all migrations executed with --postpone-completion

```
vtctldclient OnlineDDL complete <keyspace> <uuid|all>
Expand All @@ -14,7 +14,6 @@ vtctldclient OnlineDDL complete <keyspace> <uuid|all>

```
OnlineDDL complete test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90
OnlineDDL complete test_keyspace all
```

### Options
Expand Down
Loading