-
Notifications
You must be signed in to change notification settings - Fork 205
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document vitessio/vitess#13015 (#1540)
* Document vitessio/vitess#13015 Signed-off-by: Matt Lord <mattalord@gmail.com> * Update/correct workflow delete usage Signed-off-by: Matt Lord <mattalord@gmail.com> --------- Signed-off-by: Matt Lord <mattalord@gmail.com>
- Loading branch information
Showing
20 changed files
with
664 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
.../en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
38 changes: 38 additions & 0 deletions
38
...programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
40 changes: 40 additions & 0 deletions
40
...ograms/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 '_<tablename>_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. | ||
|
47 changes: 47 additions & 0 deletions
47
...programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_create.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
42 changes: 42 additions & 0 deletions
42
.../vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
36 changes: 36 additions & 0 deletions
36
...e/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
36 changes: 36 additions & 0 deletions
36
.../programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
36 changes: 36 additions & 0 deletions
36
...programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
36 changes: 36 additions & 0 deletions
36
...e/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
Oops, something went wrong.