From 4c720d545d3f21335b49b8769e1276107ce06222 Mon Sep 17 00:00:00 2001 From: Rohit Nayak Date: Wed, 13 Sep 2023 11:55:39 +0200 Subject: [PATCH] Reran go run ./tools/cobradocs/ --vitess-dir /Users/rohit/vitess --version-pairs rohit/reshard-vtctldclient:18.0 vtctldclient Signed-off-by: Rohit Nayak --- .../vtctldclient_MoveTables/_index.md | 24 ++++++------- .../vtctldclient_MoveTables_cancel.md | 12 +++---- .../vtctldclient_MoveTables_complete.md | 8 ++--- .../vtctldclient_MoveTables_create.md | 34 +++++++++---------- .../vtctldclient_MoveTables_reversetraffic.md | 22 ++++++------ .../vtctldclient_MoveTables_show.md | 12 +++---- .../vtctldclient_MoveTables_start.md | 12 +++---- .../vtctldclient_MoveTables_status.md | 12 +++---- .../vtctldclient_MoveTables_stop.md | 12 +++---- .../vtctldclient_MoveTables_switchtraffic.md | 22 ++++++------ .../vtctldclient_OnlineDDL/_index.md | 6 ++-- .../vtctldclient_OnlineDDL_cancel.md | 3 +- .../vtctldclient_OnlineDDL_complete.md | 3 +- .../vtctldclient_OnlineDDL_launch.md | 3 +- .../vtctldclient_Reshard/_index.md | 24 ++++++------- .../vtctldclient_Reshard_Cancel.md | 12 +++---- .../vtctldclient_Reshard_Complete.md | 8 ++--- .../vtctldclient_Reshard_Create.md | 26 +++++++------- .../vtctldclient_Reshard_ReverseTraffic.md | 22 ++++++------ .../vtctldclient_Reshard_Show.md | 12 +++---- .../vtctldclient_Reshard_Start.md | 12 +++---- .../vtctldclient_Reshard_Status.md | 12 +++---- .../vtctldclient_Reshard_Stop.md | 12 +++---- .../vtctldclient_Reshard_SwitchTraffic.md | 22 ++++++------ .../vtctldclient_Workflow/_index.md | 10 +++--- .../vtctldclient_Workflow_delete.md | 16 ++++----- .../vtctldclient_Workflow_list.md | 10 +++--- .../vtctldclient_Workflow_show.md | 4 +-- .../vtctldclient_Workflow_start.md | 10 +++--- .../vtctldclient_Workflow_stop.md | 2 +- .../vtctldclient_Workflow_update.md | 20 +++++------ 31 files changed, 208 insertions(+), 211 deletions(-) diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md index ef121ad49..3e382b40a 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md @@ -14,10 +14,10 @@ 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 Target keyspace for this 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 @@ -30,13 +30,13 @@ See the --help output for each command for more details. ### SEE ALSO * [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 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 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. +* [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 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 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. diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md index 263180a1d..ba89c0d85 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md @@ -1,25 +1,25 @@ --- -title: MoveTables Cancel +title: MoveTables cancel series: vtctldclient --- -## vtctldclient MoveTables Cancel +## vtctldclient MoveTables cancel -Cancel a moveTables VReplication workflow. +Cancel a MoveTables VReplication workflow. ``` -vtctldclient MoveTables Cancel +vtctldclient MoveTables cancel ``` ### Examples ``` -vtctldclient --server localhost:15999 moveTables --workflow cust2cust --target-keyspace customer cancel +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer cancel ``` ### Options ``` - -h, --help help for Cancel + -h, --help help for cancel ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md index ec6eabafe..288fd8649 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md @@ -1,13 +1,13 @@ --- -title: MoveTables Complete +title: MoveTables complete series: vtctldclient --- -## vtctldclient MoveTables Complete +## vtctldclient MoveTables complete Complete a MoveTables VReplication workflow. ``` -vtctldclient MoveTables Complete +vtctldclient MoveTables complete ``` ### Examples @@ -19,7 +19,7 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer -- ### Options ``` - -h, --help help for Complete + -h, --help help for complete ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_create.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_create.md index 2b16e83a9..08014bd81 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_create.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_create.md @@ -1,13 +1,13 @@ --- -title: MoveTables Create +title: MoveTables create series: vtctldclient --- -## vtctldclient MoveTables Create +## vtctldclient MoveTables create Create and optionally run a moveTables VReplication workflow. ``` -vtctldclient MoveTables Create +vtctldclient MoveTables create ``` ### Examples @@ -19,22 +19,22 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer -- ### Options ``` - --all-tables Copy all tables from the source + --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 + --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 diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md index 162e04088..5a9817e18 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md @@ -1,30 +1,30 @@ --- -title: MoveTables ReverseTraffic +title: MoveTables reversetraffic series: vtctldclient --- -## vtctldclient MoveTables ReverseTraffic +## vtctldclient MoveTables reversetraffic -Reverse traffic for a moveTables VReplication workflow. +Reverse traffic for a MoveTables VReplication workflow. ``` -vtctldclient MoveTables ReverseTraffic +vtctldclient MoveTables reversetraffic ``` ### Examples ``` -vtctldclient --server localhost:15999 moveTables --workflow cust2cust --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 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 + -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. --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) ``` diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md index a45cdca93..d5dd426fb 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md @@ -1,25 +1,25 @@ --- -title: MoveTables Show +title: MoveTables show series: vtctldclient --- -## vtctldclient MoveTables Show +## vtctldclient MoveTables show -Show the details for a moveTables VReplication workflow. +Show the details for a MoveTables VReplication workflow. ``` -vtctldclient MoveTables Show +vtctldclient MoveTables show ``` ### Examples ``` -vtctldclient --server localhost:15999 moveTables --workflow cust2cust --target-keyspace customer show +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer show ``` ### Options ``` - -h, --help help for Show + -h, --help help for show ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md index 3d428c944..93e85b4f7 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md @@ -1,25 +1,25 @@ --- -title: MoveTables Start +title: MoveTables start series: vtctldclient --- -## vtctldclient MoveTables Start +## vtctldclient MoveTables start -Start a moveTables workflow. +Start a MoveTables workflow. ``` -vtctldclient MoveTables Start +vtctldclient MoveTables start ``` ### Examples ``` -vtctldclient --server localhost:15999 moveTables --workflow cust2cust --target-keyspace customer start +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer start ``` ### Options ``` - -h, --help help for Start + -h, --help help for start ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md index 9ca998bdb..0f0bfa7aa 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md @@ -1,25 +1,25 @@ --- -title: MoveTables Status +title: MoveTables status series: vtctldclient --- -## vtctldclient MoveTables Status +## vtctldclient MoveTables status -Show the current status for a moveTables VReplication workflow. +Show the current status for a MoveTables VReplication workflow. ``` -vtctldclient MoveTables Status +vtctldclient MoveTables status ``` ### Examples ``` -vtctldclient --server localhost:15999 moveTables --workflow cust2cust --target-keyspace customer status +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer status ``` ### Options ``` - -h, --help help for Status + -h, --help help for status ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md index a55affc82..633cf5670 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md @@ -1,25 +1,25 @@ --- -title: MoveTables Stop +title: MoveTables stop series: vtctldclient --- -## vtctldclient MoveTables Stop +## vtctldclient MoveTables stop -Stop a moveTables workflow. +Stop a MoveTables workflow. ``` -vtctldclient MoveTables Stop +vtctldclient MoveTables stop ``` ### Examples ``` -vtctldclient --server localhost:15999 moveTables --workflow cust2cust --target-keyspace customer stop +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer stop ``` ### Options ``` - -h, --help help for Stop + -h, --help help for stop ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md index abb7c5176..99bf77506 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md @@ -1,31 +1,31 @@ --- -title: MoveTables SwitchTraffic +title: MoveTables switchtraffic series: vtctldclient --- -## vtctldclient MoveTables SwitchTraffic +## vtctldclient MoveTables switchtraffic -Switch traffic for a moveTables VReplication workflow. +Switch traffic for a MoveTables VReplication workflow. ``` -vtctldclient MoveTables SwitchTraffic +vtctldclient MoveTables switchtraffic ``` ### Examples ``` -vtctldclient --server localhost:15999 moveTables --workflow cust2cust --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) - -h, --help help for SwitchTraffic + -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) ``` diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md index bc7f7e013..3bb372295 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md @@ -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. diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md index bf3be78f1..407589f96 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md @@ -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 @@ -14,7 +14,6 @@ vtctldclient OnlineDDL cancel ``` OnlineDDL cancel test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 -OnlineDDL cancel test_keyspace all ``` ### Options diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md index 4a447d75f..0bf8da583 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md @@ -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 @@ -14,7 +14,6 @@ vtctldclient OnlineDDL complete ``` OnlineDDL complete test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 -OnlineDDL complete test_keyspace all ``` ### Options diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md index 3529ec063..f9e4d5b09 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md @@ -4,7 +4,7 @@ series: vtctldclient --- ## vtctldclient OnlineDDL launch -Launch one or all migrations executed with `--postpone-launch`. +launch one or all migrations executed with --postpone-launch ``` vtctldclient OnlineDDL launch @@ -14,7 +14,6 @@ vtctldclient OnlineDDL launch ``` OnlineDDL launch test_keyspace 82fa54ac_e83e_11ea_96b7_f875a4d24e90 -OnlineDDL launch test_keyspace all ``` ### Options diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/_index.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/_index.md index b458e1ccd..e84d14960 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/_index.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/_index.md @@ -14,10 +14,10 @@ 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 Reshard - --target-keyspace string Target keyspace for this 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 @@ -30,13 +30,13 @@ See the --help output for each command for more details. ### SEE ALSO * [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. -* [vtctldclient Reshard Cancel](./vtctldclient_reshard_cancel/) - Cancel a reshard VReplication workflow. -* [vtctldclient Reshard Complete](./vtctldclient_reshard_complete/) - Complete a MoveTables VReplication workflow. -* [vtctldclient Reshard Create](./vtctldclient_reshard_create/) - Create and optionally run a reshard VReplication workflow. -* [vtctldclient Reshard ReverseTraffic](./vtctldclient_reshard_reversetraffic/) - Reverse traffic for a reshard VReplication workflow. -* [vtctldclient Reshard Show](./vtctldclient_reshard_show/) - Show the details for a reshard VReplication workflow. -* [vtctldclient Reshard Start](./vtctldclient_reshard_start/) - Start a reshard workflow. -* [vtctldclient Reshard Status](./vtctldclient_reshard_status/) - Show the current status for a reshard VReplication workflow. -* [vtctldclient Reshard Stop](./vtctldclient_reshard_stop/) - Stop a reshard workflow. -* [vtctldclient Reshard SwitchTraffic](./vtctldclient_reshard_switchtraffic/) - Switch traffic for a reshard VReplication workflow. +* [vtctldclient Reshard cancel](./vtctldclient_reshard_cancel/) - Cancel a Reshard VReplication workflow. +* [vtctldclient Reshard complete](./vtctldclient_reshard_complete/) - Complete a MoveTables VReplication workflow. +* [vtctldclient Reshard create](./vtctldclient_reshard_create/) - Create and optionally run a reshard VReplication workflow. +* [vtctldclient Reshard reversetraffic](./vtctldclient_reshard_reversetraffic/) - Reverse traffic for a Reshard VReplication workflow. +* [vtctldclient Reshard show](./vtctldclient_reshard_show/) - Show the details for a Reshard VReplication workflow. +* [vtctldclient Reshard start](./vtctldclient_reshard_start/) - Start a Reshard workflow. +* [vtctldclient Reshard status](./vtctldclient_reshard_status/) - Show the current status for a Reshard VReplication workflow. +* [vtctldclient Reshard stop](./vtctldclient_reshard_stop/) - Stop a Reshard workflow. +* [vtctldclient Reshard switchtraffic](./vtctldclient_reshard_switchtraffic/) - Switch traffic for a Reshard VReplication workflow. diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Cancel.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Cancel.md index 376e514e2..c51744db9 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Cancel.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Cancel.md @@ -1,25 +1,25 @@ --- -title: Reshard Cancel +title: Reshard cancel series: vtctldclient --- -## vtctldclient Reshard Cancel +## vtctldclient Reshard cancel -Cancel a reshard VReplication workflow. +Cancel a Reshard VReplication workflow. ``` -vtctldclient Reshard Cancel +vtctldclient Reshard cancel ``` ### Examples ``` -vtctldclient --server localhost:15999 reshard --workflow cust2cust --target-keyspace customer cancel +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --target-keyspace customer cancel ``` ### Options ``` - -h, --help help for Cancel + -h, --help help for cancel ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Complete.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Complete.md index 4de73161a..708693a35 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Complete.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Complete.md @@ -1,13 +1,13 @@ --- -title: Reshard Complete +title: Reshard complete series: vtctldclient --- -## vtctldclient Reshard Complete +## vtctldclient Reshard complete Complete a MoveTables VReplication workflow. ``` -vtctldclient Reshard Complete +vtctldclient Reshard complete ``` ### Examples @@ -19,7 +19,7 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer -- ### Options ``` - -h, --help help for Complete + -h, --help help for complete ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Create.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Create.md index b4c067757..7101b950e 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Create.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Create.md @@ -1,13 +1,13 @@ --- -title: Reshard Create +title: Reshard create series: vtctldclient --- -## vtctldclient Reshard Create +## vtctldclient Reshard create Create and optionally run a reshard VReplication workflow. ``` -vtctldclient Reshard Create +vtctldclient Reshard create ``` ### Examples @@ -19,17 +19,17 @@ vtctldclient --server localhost:15999 reshard --workflow customer2customer --tar ### Options ``` - --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 - -h, --help help for Create - --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") + --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. + -h, --help help for create + --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") --skip-schema-copy Skip copying the schema from the source shards to the target shards. - --source-shards strings Comma-separated list of source shards. - --stop-after-copy Stop the MoveTables workflow after it's finished copying the existing rows and before it starts replicating changes - --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) - --target-shards strings Comma-separated list of target shards. + --source-shards strings Source shards. + --stop-after-copy Stop the MoveTables workflow after it's finished copying the existing rows and before it starts replicating changes. + --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) + --target-shards strings Target shards. ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_ReverseTraffic.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_ReverseTraffic.md index b9b42202a..999c39f86 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_ReverseTraffic.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_ReverseTraffic.md @@ -1,30 +1,30 @@ --- -title: Reshard ReverseTraffic +title: Reshard reversetraffic series: vtctldclient --- -## vtctldclient Reshard ReverseTraffic +## vtctldclient Reshard reversetraffic -Reverse traffic for a reshard VReplication workflow. +Reverse traffic for a Reshard VReplication workflow. ``` -vtctldclient Reshard ReverseTraffic +vtctldclient Reshard reversetraffic ``` ### Examples ``` -vtctldclient --server localhost:15999 reshard --workflow cust2cust --target-keyspace customer reversetraffic +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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 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 + -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. --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) ``` diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Show.md index aa3ee2f95..69345b2f6 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Show.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Show.md @@ -1,25 +1,25 @@ --- -title: Reshard Show +title: Reshard show series: vtctldclient --- -## vtctldclient Reshard Show +## vtctldclient Reshard show -Show the details for a reshard VReplication workflow. +Show the details for a Reshard VReplication workflow. ``` -vtctldclient Reshard Show +vtctldclient Reshard show ``` ### Examples ``` -vtctldclient --server localhost:15999 reshard --workflow cust2cust --target-keyspace customer show +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --target-keyspace customer show ``` ### Options ``` - -h, --help help for Show + -h, --help help for show ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Start.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Start.md index b96623a91..8cd6a4ca7 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Start.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Start.md @@ -1,25 +1,25 @@ --- -title: Reshard Start +title: Reshard start series: vtctldclient --- -## vtctldclient Reshard Start +## vtctldclient Reshard start -Start a reshard workflow. +Start a Reshard workflow. ``` -vtctldclient Reshard Start +vtctldclient Reshard start ``` ### Examples ``` -vtctldclient --server localhost:15999 reshard --workflow cust2cust --target-keyspace customer start +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --target-keyspace customer start ``` ### Options ``` - -h, --help help for Start + -h, --help help for start ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Status.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Status.md index 5dd20b001..911d64ef2 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Status.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Status.md @@ -1,25 +1,25 @@ --- -title: Reshard Status +title: Reshard status series: vtctldclient --- -## vtctldclient Reshard Status +## vtctldclient Reshard status -Show the current status for a reshard VReplication workflow. +Show the current status for a Reshard VReplication workflow. ``` -vtctldclient Reshard Status +vtctldclient Reshard status ``` ### Examples ``` -vtctldclient --server localhost:15999 reshard --workflow cust2cust --target-keyspace customer status +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --target-keyspace customer status ``` ### Options ``` - -h, --help help for Status + -h, --help help for status ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Stop.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Stop.md index c1203d476..9c73a8355 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Stop.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_Stop.md @@ -1,25 +1,25 @@ --- -title: Reshard Stop +title: Reshard stop series: vtctldclient --- -## vtctldclient Reshard Stop +## vtctldclient Reshard stop -Stop a reshard workflow. +Stop a Reshard workflow. ``` -vtctldclient Reshard Stop +vtctldclient Reshard stop ``` ### Examples ``` -vtctldclient --server localhost:15999 reshard --workflow cust2cust --target-keyspace customer stop +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --target-keyspace customer stop ``` ### Options ``` - -h, --help help for Stop + -h, --help help for stop ``` ### Options inherited from parent commands diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_SwitchTraffic.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_SwitchTraffic.md index 2cb3b5cac..ad6ec23b2 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_SwitchTraffic.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_SwitchTraffic.md @@ -1,30 +1,30 @@ --- -title: Reshard SwitchTraffic +title: Reshard switchtraffic series: vtctldclient --- -## vtctldclient Reshard SwitchTraffic +## vtctldclient Reshard switchtraffic -Switch traffic for a reshard VReplication workflow. +Switch traffic for a Reshard VReplication workflow. ``` -vtctldclient Reshard SwitchTraffic +vtctldclient Reshard switchtraffic ``` ### Examples ``` -vtctldclient --server localhost:15999 reshard --workflow cust2cust --target-keyspace customer switchtraffic --tablet-types "replica,rdonly" +vtctldclient --server localhost:15999 Reshard --workflow cust2cust --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) - -h, --help help for SwitchTraffic - --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 + -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 + --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) ``` diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/_index.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/_index.md index b1dd7c143..f10b8243d 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/_index.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/_index.md @@ -19,7 +19,7 @@ vtctldclient Workflow --keyspace [command] [command-flags] ``` -h, --help help for Workflow - -k, --keyspace string Keyspace context for the workflow (required) + -k, --keyspace string Keyspace context for the workflow (required). ``` ### Options inherited from parent commands @@ -32,10 +32,10 @@ vtctldclient Workflow --keyspace [command] [command-flags] ### SEE ALSO * [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. -* [vtctldclient Workflow Delete](./vtctldclient_workflow_delete/) - Delete a VReplication workflow. -* [vtctldclient Workflow List](./vtctldclient_workflow_list/) - List the VReplication workflows in the given keyspace. -* [vtctldclient Workflow Start](./vtctldclient_workflow_start/) - Start a VReplication workflow. -* [vtctldclient Workflow Update](./vtctldclient_workflow_update/) - Update the configuration parameters for a VReplication workflow. +* [vtctldclient Workflow delete](./vtctldclient_workflow_delete/) - Delete a VReplication workflow. +* [vtctldclient Workflow list](./vtctldclient_workflow_list/) - List the VReplication workflows in the given keyspace. * [vtctldclient Workflow show](./vtctldclient_workflow_show/) - Show the details for a VReplication workflow. +* [vtctldclient Workflow start](./vtctldclient_workflow_start/) - Start a VReplication workflow. * [vtctldclient Workflow stop](./vtctldclient_workflow_stop/) - Stop a VReplication workflow. +* [vtctldclient Workflow update](./vtctldclient_workflow_update/) - Update the configuration parameters for a VReplication workflow. diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_delete.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_delete.md index bf647151e..740620f8b 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_delete.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_delete.md @@ -1,13 +1,13 @@ --- -title: Workflow Delete +title: Workflow delete series: vtctldclient --- -## vtctldclient Workflow Delete +## vtctldclient Workflow delete Delete a VReplication workflow. ``` -vtctldclient Workflow Delete +vtctldclient Workflow delete ``` ### Examples @@ -19,17 +19,17 @@ vtctldclient --server localhost:15999 workflow --keyspace customer delete --work ### Options ``` - -h, --help help for Delete - --keep-data Keep the partially copied table data from the workflow in the target keyspace - --keep-routing-rules Keep the routing rules created for the workflow - -w, --workflow string The workflow you want to delete (required) + -h, --help help for delete + --keep-data Keep the partially copied table data from the workflow in the target keyspace. + --keep-routing-rules Keep the routing rules created for the workflow. + -w, --workflow string The workflow you want to delete (required). ``` ### Options inherited from parent commands ``` --action_timeout duration timeout for the total command (default 1h0m0s) - -k, --keyspace string Keyspace context for the workflow (required) + -k, --keyspace string Keyspace context for the workflow (required). --server string server to use for connection (required) ``` diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_list.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_list.md index 584892cf1..f320d0ec7 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_list.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_list.md @@ -1,13 +1,13 @@ --- -title: Workflow List +title: Workflow list series: vtctldclient --- -## vtctldclient Workflow List +## vtctldclient Workflow list List the VReplication workflows in the given keyspace. ``` -vtctldclient Workflow List +vtctldclient Workflow list ``` ### Examples @@ -19,14 +19,14 @@ vtctldclient --server localhost:15999 workflow --keyspace customer list ### Options ``` - -h, --help help for List + -h, --help help for list ``` ### Options inherited from parent commands ``` --action_timeout duration timeout for the total command (default 1h0m0s) - -k, --keyspace string Keyspace context for the workflow (required) + -k, --keyspace string Keyspace context for the workflow (required). --server string server to use for connection (required) ``` diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_show.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_show.md index 891ef0987..b932110c8 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_show.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_show.md @@ -20,14 +20,14 @@ vtctldclient --server localhost:15999 workflow --keyspace customer show --workfl ``` -h, --help help for show - -w, --workflow string The workflow you want the details for (required) + -w, --workflow string The workflow you want the details for (required). ``` ### Options inherited from parent commands ``` --action_timeout duration timeout for the total command (default 1h0m0s) - -k, --keyspace string Keyspace context for the workflow (required) + -k, --keyspace string Keyspace context for the workflow (required). --server string server to use for connection (required) ``` diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_start.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_start.md index 64e42d2d0..10f3678c7 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_start.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_start.md @@ -1,13 +1,13 @@ --- -title: Workflow Start +title: Workflow start series: vtctldclient --- -## vtctldclient Workflow Start +## vtctldclient Workflow start Start a VReplication workflow. ``` -vtctldclient Workflow Start +vtctldclient Workflow start ``` ### Examples @@ -19,14 +19,14 @@ vtctldclient --server localhost:15999 workflow --keyspace customer start --workf ### Options ``` - -h, --help help for Start + -h, --help help for start ``` ### Options inherited from parent commands ``` --action_timeout duration timeout for the total command (default 1h0m0s) - -k, --keyspace string Keyspace context for the workflow (required) + -k, --keyspace string Keyspace context for the workflow (required). --server string server to use for connection (required) ``` diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_stop.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_stop.md index 6e7acdc6e..309a0e0bf 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_stop.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_stop.md @@ -26,7 +26,7 @@ vtctldclient --server localhost:15999 workflow --keyspace customer stop --workfl ``` --action_timeout duration timeout for the total command (default 1h0m0s) - -k, --keyspace string Keyspace context for the workflow (required) + -k, --keyspace string Keyspace context for the workflow (required). --server string server to use for connection (required) ``` diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_update.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_update.md index f0098eedb..b7af017fa 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_update.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_update.md @@ -1,13 +1,13 @@ --- -title: Workflow Update +title: Workflow update series: vtctldclient --- -## vtctldclient Workflow Update +## vtctldclient Workflow update Update the configuration parameters for a VReplication workflow. ``` -vtctldclient Workflow Update +vtctldclient Workflow update ``` ### Examples @@ -19,19 +19,19 @@ vtctldclient --server localhost:15999 workflow --keyspace customer update --work ### Options ``` - -c, --cells strings New Cell(s) or CellAlias(es) (comma-separated) to replicate from - -h, --help help for Update - --on-ddl string New instruction on what to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE - -t, --tablet-types strings New source tablet types to replicate from (e.g. PRIMARY,REPLICA,RDONLY) - --tablet-types-in-order When performing source tablet selection, look for candidates in the type order as they are listed in the tablet-types flag (default true) - -w, --workflow string The workflow you want to update (required) + -c, --cells strings New Cell(s) or CellAlias(es) (comma-separated) to replicate from. + -h, --help help for update + --on-ddl string New instruction on what to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE. + -t, --tablet-types strings New source tablet types to replicate from (e.g. PRIMARY,REPLICA,RDONLY). + --tablet-types-in-order When performing source tablet selection, look for candidates in the type order as they are listed in the tablet-types flag. (default true) + -w, --workflow string The workflow you want to update (required). ``` ### Options inherited from parent commands ``` --action_timeout duration timeout for the total command (default 1h0m0s) - -k, --keyspace string Keyspace context for the workflow (required) + -k, --keyspace string Keyspace context for the workflow (required). --server string server to use for connection (required) ```