From 5ad313e39738ed16fb2c01deebd6537a76fc602a Mon Sep 17 00:00:00 2001 From: Matt Lord Date: Tue, 18 Jul 2023 13:46:18 -0400 Subject: [PATCH] Document https://github.com/vitessio/vitess/pull/13015 Signed-off-by: Matt Lord --- .../reference/programs/vtctldclient/_index.md | 3 +- .../vtctldclient/vtctldclient_ApplySchema.md | 3 +- .../vtctldclient/vtctldclient_Backup.md | 3 +- .../vtctldclient/vtctldclient_BackupShard.md | 3 +- .../vtctldclient_MoveTables/_index.md | 42 +++++++++++++++++ .../vtctldclient_MoveTables_cancel.md | 38 +++++++++++++++ .../vtctldclient_MoveTables_complete.md | 40 ++++++++++++++++ .../vtctldclient_MoveTables_create.md | 47 +++++++++++++++++++ .../vtctldclient_MoveTables_reversetraffic.md | 42 +++++++++++++++++ .../vtctldclient_MoveTables_show.md | 36 ++++++++++++++ .../vtctldclient_MoveTables_start.md | 36 ++++++++++++++ .../vtctldclient_MoveTables_status.md | 36 ++++++++++++++ .../vtctldclient_MoveTables_stop.md | 36 ++++++++++++++ .../vtctldclient_MoveTables_switchtraffic.md | 41 ++++++++++++++++ .../vtctldclient_UpdateThrottlerConfig.md | 20 ++++---- .../vtctldclient_Workflow/_index.md | 41 ++++++++++++++++ .../vtctldclient_Workflow_delete.md | 39 +++++++++++++++ .../vtctldclient_Workflow_list.md | 36 ++++++++++++++ .../vtctldclient_Workflow_show.md | 37 +++++++++++++++ .../vtctldclient_Workflow_start.md | 37 +++++++++++++++ .../vtctldclient_Workflow_stop.md | 37 +++++++++++++++ .../vtctldclient_Workflow_update.md | 41 ++++++++++++++++ .../vtctldclient/vtctldclient_workflow.md | 31 ------------ .../vtctldclient_workflow_update.md | 40 ---------------- 24 files changed, 677 insertions(+), 88 deletions(-) create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_create.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/_index.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_delete.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_list.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_show.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_start.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_stop.md create mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_update.md delete mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_workflow.md delete mode 100644 content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_workflow_update.md diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/_index.md b/content/en/docs/18.0/reference/programs/vtctldclient/_index.md index 2f6fe5c9d..1f283e23b 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/_index.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/_index.md @@ -66,6 +66,7 @@ vtctldclient [flags] * [vtctldclient GetVSchema](./vtctldclient_getvschema/) - Prints a JSON representation of a keyspace's topo record. * [vtctldclient GetWorkflows](./vtctldclient_getworkflows/) - Gets all vreplication workflows (Reshard, MoveTables, etc) in the given keyspace. * [vtctldclient LegacyVtctlCommand](./vtctldclient_legacyvtctlcommand/) - Invoke a legacy vtctlclient command. Flag parsing is best effort. +* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace. * [vtctldclient PingTablet](./vtctldclient_pingtablet/) - Checks that the specified tablet is awake and responding to RPCs. This command can be blocked by other in-flight operations. * [vtctldclient PlannedReparentShard](./vtctldclient_plannedreparentshard/) - Reparents the shard to a new primary, or away from an old primary. Both the old and new primaries must be up and running. * [vtctldclient RebuildKeyspaceGraph](./vtctldclient_rebuildkeyspacegraph/) - Rebuilds the serving data for the keyspace(s). This command may trigger an update to all connected clients. @@ -102,5 +103,5 @@ vtctldclient [flags] * [vtctldclient ValidateShard](./vtctldclient_validateshard/) - Validates that all nodes reachable from the specified shard are consistent. * [vtctldclient ValidateVersionKeyspace](./vtctldclient_validateversionkeyspace/) - Validates that the version on the primary tablet of shard 0 matches all of the other tablets in the keyspace. * [vtctldclient ValidateVersionShard](./vtctldclient_validateversionshard/) - Validates that the version on the primary matches all of the replicas. -* [vtctldclient workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace +* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md index 237b4b0ef..52127eb9d 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md @@ -23,13 +23,12 @@ For --sql, semi-colons and repeated values may be mixed, for example: ApplySchema --sql "CREATE TABLE my_table" --sql "CREATE TABLE my_other_table" ``` -vtctldclient ApplySchema [--allow-long-unavailability] [--ddl-strategy ] [--uuid ...] [--migration-context ] [--wait-replicas-timeout ] [--caller-id ] {--sql-file | --sql } +vtctldclient ApplySchema [--ddl-strategy ] [--uuid ...] [--migration-context ] [--wait-replicas-timeout ] [--caller-id ] {--sql-file | --sql } ``` ### Options ``` - --allow-long-unavailability Allow large schema changes which incur a longer unavailability of the database. --caller-id string Effective caller ID used for the operation and should map to an ACL name which grants this identity the necessary permissions to perform the operation (this is only necessary when strict table ACLs are used). --ddl-strategy string Online DDL strategy, compatible with @@ddl_strategy session variable (examples: 'gh-ost', 'pt-osc', 'gh-ost --max-load=Threads_running=100'. (default "direct") -h, --help help for ApplySchema diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Backup.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Backup.md index 9053049d3..6f3048a73 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Backup.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Backup.md @@ -7,7 +7,7 @@ series: vtctldclient Uses the BackupStorage service on the given tablet to create and store a new backup. ``` -vtctldclient Backup [--concurrency ] [--allow-primary] [--upgrade_safe] +vtctldclient Backup [--concurrency ] [--allow-primary] ``` ### Options @@ -15,7 +15,6 @@ vtctldclient Backup [--concurrency ] [--allow-primary] [--upgrade_s ``` --allow-primary Allow the primary of a shard to be used for the backup. WARNING: If using the builtin backup engine, this will shutdown mysqld on the primary and stop writes for the duration of the backup. --concurrency uint Specifies the number of compression/checksum jobs to run simultaneously. (default 4) - --upgrade_safe Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades. -h, --help help for Backup ``` diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md index 005ec5d1a..93ae5e7ed 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md @@ -13,7 +13,7 @@ Finds the most up-to-date REPLICA, RDONLY, or SPARE tablet in the given shard an If no replica-type tablet can be found, the backup can be taken on the primary if --allow-primary is specified. ``` -vtctldclient BackupShard [--concurrency ] [--allow-primary] [--upgrade_safe] +vtctldclient BackupShard [--concurrency ] [--allow-primary] ``` ### Options @@ -21,7 +21,6 @@ vtctldclient BackupShard [--concurrency ] [--allow-primary] [--upgr ``` --allow-primary Allow the primary of a shard to be used for the backup. WARNING: If using the builtin backup engine, this will shutdown mysqld on the primary and stop writes for the duration of the backup. --concurrency uint Specifies the number of compression/checksum jobs to run simultaneously. (default 4) - --upgrade_safe Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades. -h, --help help for BackupShard ``` 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 new file mode 100644 index 000000000..73dfa1791 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md @@ -0,0 +1,42 @@ +--- +title: MoveTables +series: vtctldclient +--- +## vtctldclient MoveTables + +Perform commands related to moving tables from a source keyspace to a target keyspace. + +### Synopsis + +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") + -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) +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout for the total command (default 1h0m0s) + --server string server to use for connection (required) +``` + +### 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 the 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 new file mode 100644 index 000000000..92962ae16 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md @@ -0,0 +1,38 @@ +--- +title: MoveTables cancel +series: vtctldclient +--- +## vtctldclient MoveTables cancel + +Cancel a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables cancel +``` + +### Examples + +``` +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 +``` + +### 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 + +* [vtctldclient MoveTables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace. + 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 new file mode 100644 index 000000000..cbc708191 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md @@ -0,0 +1,40 @@ +--- +title: MoveTables complete +series: vtctldclient +--- +## vtctldclient MoveTables complete + +Complete a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables complete +``` + +### Examples + +``` +vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer complete +``` + +### 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 '__old' +``` + +### 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 + +* [vtctldclient MoveTables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace. + 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 new file mode 100644 index 000000000..4a9aa52a5 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_create.md @@ -0,0 +1,47 @@ +--- +title: MoveTables create +series: vtctldclient +--- +## vtctldclient MoveTables create + +Create and optionally run a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables create +``` + +### Examples + +``` +vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer create --source-keyspace commerce --cells zone1 --cells zone2 --tablet-types replica +``` + +### 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 + --exclude-tables strings Source tables to exclude from copying + -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") + --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) + --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 + +* [vtctldclient MoveTables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace. + 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 new file mode 100644 index 000000000..d608be3e1 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md @@ -0,0 +1,42 @@ +--- +title: MoveTables reversetraffic +series: vtctldclient +--- +## vtctldclient MoveTables reversetraffic + +Reverse traffic for a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables reversetraffic +``` + +### Examples + +``` +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 + --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) +``` + +### 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 + +* [vtctldclient MoveTables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace. + 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 new file mode 100644 index 000000000..2f6598cbc --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md @@ -0,0 +1,36 @@ +--- +title: MoveTables show +series: vtctldclient +--- +## vtctldclient MoveTables show + +Show the details for a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables show +``` + +### Examples + +``` +vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer show +``` + +### Options + +``` + -h, --help help for show +``` + +### 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 + +* [vtctldclient MoveTables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace. + 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 new file mode 100644 index 000000000..139ef73ee --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md @@ -0,0 +1,36 @@ +--- +title: MoveTables start +series: vtctldclient +--- +## vtctldclient MoveTables start + +Start the MoveTables workflow. + +``` +vtctldclient MoveTables start +``` + +### Examples + +``` +vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer start +``` + +### Options + +``` + -h, --help help for start +``` + +### 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 + +* [vtctldclient MoveTables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace. + 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 new file mode 100644 index 000000000..e94b350fb --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md @@ -0,0 +1,36 @@ +--- +title: MoveTables status +series: vtctldclient +--- +## vtctldclient MoveTables status + +Show the current status for a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables status +``` + +### Examples + +``` +vtctldclient --server localhost:15999 MoveTables --workflow commerce2customer --target-keyspace customer status +``` + +### Options + +``` + -h, --help help for status +``` + +### 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 + +* [vtctldclient MoveTables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace. + 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 new file mode 100644 index 000000000..9dfff8b29 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md @@ -0,0 +1,36 @@ +--- +title: MoveTables stop +series: vtctldclient +--- +## vtctldclient MoveTables stop + +Stop a MoveTables workflow. + +``` +vtctldclient MoveTables stop +``` + +### Examples + +``` +vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer stop +``` + +### Options + +``` + -h, --help help for stop +``` + +### 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 + +* [vtctldclient MoveTables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace. + 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 new file mode 100644 index 000000000..b8bb22ce7 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md @@ -0,0 +1,41 @@ +--- +title: MoveTables switchtraffic +series: vtctldclient +--- +## vtctldclient MoveTables switchtraffic + +Switch traffic for a MoveTables VReplication workflow. + +``` +vtctldclient MoveTables switchtraffic +``` + +### Examples + +``` +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 + -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) +``` + +### 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 + +* [vtctldclient MoveTables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md index 7a2f22fc8..dc8e6974c 100644 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md @@ -13,16 +13,16 @@ vtctldclient UpdateThrottlerConfig [--enable|--disable] [--threshold=] ### Options ``` - --check-as-check-self /throttler/check requests behave as is /throttler/check-self was called - --check-as-check-shard use standard behavior for /throttler/check requests - --custom-query string custom throttler check query - --disable Disable the throttler - --enable Enable the throttler - -h, --help help for UpdateThrottlerConfig - --threshold float threshold for the either default check (replication lag seconds) or custom check - --throttle-app string set a specific throttling rule for the given app - --throttle-app-ratio float set a throttling ratio for app indicated by --throttle-app. 0 means not throttled, 1.0 means fully throttled. - --throttle-app-duration duration time limit after which throttling rule expires. Set as 0 to cancel an existing rule + --check-as-check-self /throttler/check requests behave as is /throttler/check-self was called + --check-as-check-shard use standard behavior for /throttler/check requests + --custom-query string custom throttler check query + --disable Disable the throttler + --enable Enable the throttler + -h, --help help for UpdateThrottlerConfig + --threshold float threshold for the either default check (replication lag seconds) or custom check + --throttle-app string an app name to throttle + --throttle-app-duration duration duration after which throttled app rule expires (app specififed in --throttled-app) (default 1h0m0s) + --throttle-app-ratio float ratio to throttle app (app specififed in --throttled-app) (default 1) ``` ### Options inherited from parent commands 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 new file mode 100644 index 000000000..292d2489c --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/_index.md @@ -0,0 +1,41 @@ +--- +title: Workflow +series: vtctldclient +--- +## vtctldclient Workflow + +Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + +### Synopsis + +Workflow commands: List, Show, Start, Stop, Update, and Delete. +See the --help output for each command for more details. + +``` +vtctldclient Workflow --keyspace [command] [command-flags] +``` + +### Options + +``` + -h, --help help for Workflow + -k, --keyspace string Keyspace context for the workflow (required) +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout for the total command (default 1h0m0s) + --server string server to use for connection (required) +``` + +### 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 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 new file mode 100644 index 000000000..2b46e389b --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_delete.md @@ -0,0 +1,39 @@ +--- +title: Workflow delete +series: vtctldclient +--- +## vtctldclient Workflow delete + +Delete a VReplication workflow. + +``` +vtctldclient Workflow delete +``` + +### Examples + +``` +vtctldclient --server localhost:15999 workflow --keyspace customer delete --workflow commerce2customer +``` + +### 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 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) + --server string server to use for connection (required) +``` + +### SEE ALSO + +* [vtctldclient Workflow](../) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + 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 new file mode 100644 index 000000000..b298632f3 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_list.md @@ -0,0 +1,36 @@ +--- +title: Workflow list +series: vtctldclient +--- +## vtctldclient Workflow list + +List the VReplication workflows in the given keyspace. + +``` +vtctldclient Workflow list +``` + +### Examples + +``` +vtctldclient --server localhost:15999 workflow --keyspace customer list +``` + +### Options + +``` + -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) + --server string server to use for connection (required) +``` + +### SEE ALSO + +* [vtctldclient Workflow](../) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + 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 new file mode 100644 index 000000000..891ef0987 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_show.md @@ -0,0 +1,37 @@ +--- +title: Workflow show +series: vtctldclient +--- +## vtctldclient Workflow show + +Show the details for a VReplication workflow. + +``` +vtctldclient Workflow show +``` + +### Examples + +``` +vtctldclient --server localhost:15999 workflow --keyspace customer show --workflow commerce2customer +``` + +### Options + +``` + -h, --help help for show + -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) + --server string server to use for connection (required) +``` + +### SEE ALSO + +* [vtctldclient Workflow](../) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + 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 new file mode 100644 index 000000000..eca3a0002 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_start.md @@ -0,0 +1,37 @@ +--- +title: Workflow start +series: vtctldclient +--- +## vtctldclient Workflow start + +Start a VReplication workflow. + +``` +vtctldclient Workflow start +``` + +### Examples + +``` +vtctldclient --server localhost:15999 workflow --keyspace customer start --workflow commerce2customer +``` + +### Options + +``` + -h, --help help for start + -w, --workflow string The workflow you want to start (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) + --server string server to use for connection (required) +``` + +### SEE ALSO + +* [vtctldclient Workflow](../) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + 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 new file mode 100644 index 000000000..f6ff45342 --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_stop.md @@ -0,0 +1,37 @@ +--- +title: Workflow stop +series: vtctldclient +--- +## vtctldclient Workflow stop + +Stop a VReplication workflow. + +``` +vtctldclient Workflow stop +``` + +### Examples + +``` +vtctldclient --server localhost:15999 workflow --keyspace customer stop --workflow commerce2customer +``` + +### Options + +``` + -h, --help help for stop + -w, --workflow string The workflow you want to stop (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) + --server string server to use for connection (required) +``` + +### SEE ALSO + +* [vtctldclient Workflow](../) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + 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 new file mode 100644 index 000000000..7c72a82aa --- /dev/null +++ b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_update.md @@ -0,0 +1,41 @@ +--- +title: Workflow update +series: vtctldclient +--- +## vtctldclient Workflow update + +Update the configuration parameters for a VReplication workflow. + +``` +vtctldclient Workflow update +``` + +### Examples + +``` +vtctldclient --server localhost:15999 workflow --keyspace customer update --workflow commerce2customer --cells zone1 --cells zone2 -c "zone3,zone4" -c zone5 +``` + +### 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) +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout for the total command (default 1h0m0s) + -k, --keyspace string Keyspace context for the workflow (required) + --server string server to use for connection (required) +``` + +### SEE ALSO + +* [vtctldclient Workflow](../) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace. + diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_workflow.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_workflow.md deleted file mode 100644 index 32ef15409..000000000 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_workflow.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: workflow -series: vtctldclient ---- -## vtctldclient workflow - -Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace - -``` -vtctldclient workflow -``` - -### Options - -``` - -h, --help help for workflow - -k, --keyspace string Keyspace context for the workflow (required) -``` - -### Options inherited from parent commands - -``` - --action_timeout duration timeout for the total command (default 1h0m0s) - --server string server to use for connection (required) -``` - -### SEE ALSO - -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. -* [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_update.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_workflow_update.md deleted file mode 100644 index cfb35bc0d..000000000 --- a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_workflow_update.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: workflow_update -series: vtctldclient ---- -## vtctldclient workflow update - -Update the configuration parameters for a VReplication workflow - -``` -vtctldclient workflow update -``` - -### Examples - -``` -vtctldclient --server=localhost:15999 workflow --keyspace=customer update --workflow=commerce2customer --cells "zone1" --cells "zone2" -c "zone3,zone4" -c "zone5" -``` - -### 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) - -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) - --server string server to use for connection (required) -``` - -### SEE ALSO - -* [vtctldclient workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace -