vtctldclient docs regen

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
vitessio · Sep 7, 2023 · c897c51 · c897c51
1 parent 553a9ce
commit c897c51
Show file tree

Hide file tree

Showing 27 changed files with 466 additions and 102 deletions.
diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/_index.md b/content/en/docs/18.0/reference/programs/vtctldclient/_index.md
@@ -81,6 +81,7 @@ vtctldclient [flags]
 * [vtctldclient RemoveKeyspaceCell](./vtctldclient_removekeyspacecell/)	 - Removes the specified cell from the Cells list for all shards in the specified keyspace (by calling RemoveShardCell on every shard). It also removes the SrvKeyspace for that keyspace in that cell.
 * [vtctldclient RemoveShardCell](./vtctldclient_removeshardcell/)	 - Remove the specified cell from the specified shard's Cells list.
 * [vtctldclient ReparentTablet](./vtctldclient_reparenttablet/)	 - Reparent a tablet to the current primary in the shard.
+* [vtctldclient Reshard](./vtctldclient_reshard/)	 - Perform commands related to resharding a keyspace.
 * [vtctldclient RestoreFromBackup](./vtctldclient_restorefrombackup/)	 - Stops mysqld on the specified tablet and restores the data from either the latest backup or closest before `backup-timestamp`.
 * [vtctldclient RunHealthCheck](./vtctldclient_runhealthcheck/)	 - Runs a healthcheck on the remote tablet.
 * [vtctldclient SetKeyspaceDurabilityPolicy](./vtctldclient_setkeyspacedurabilitypolicy/)	 - Sets the durability-policy used by the specified keyspace.

diff --git a/.../en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md b/.../en/docs/18.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md
@@ -8,15 +8,15 @@ Perform commands related to moving tables from a source keyspace to a target key
 
 ### Synopsis
 
-MoveTables commands: Create, Show, Status, SwitchTraffic, ReverseTraffic, Stop, Start, Cancel, and Delete.
+moveTables commands: Create, Show, Status, SwitchTraffic, ReverseTraffic, Stop, Start, Cancel, and Delete.
 See the --help output for each command for more details.
 
 ### Options
 
 ```
       --format string            The format of the output; supported formats are: text,json (default "text")
   -h, --help                     help for MoveTables
-      --target-keyspace string   Keyspace where the tables are being moved to and where the workflow exists (required)
+      --target-keyspace string   Target keyspace for this workflow exists (required)
   -w, --workflow string          The workflow you want to perform the command on (required)
 ```
 
@@ -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 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.
+* [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/...programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md b/...programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md
@@ -1,35 +1,32 @@
 ---
-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 commerce2customer --target-keyspace customer cancel
+vtctldclient --server localhost:15999 moveTables --workflow cust2cust --target-keyspace customer cancel
 ```
 
 ### Options
 
 ```
-  -h, --help                 help for cancel
-      --keep-data            Keep the partially copied table data from the MoveTables workflow in the target keyspace
-      --keep-routing-rules   Keep the routing rules created for the MoveTables workflow
+  -h, --help   help for Cancel
 ```
 
 ### Options inherited from parent commands
 
 ```
       --action_timeout duration   timeout for the total command (default 1h0m0s)
       --server string             server to use for connection (required)
-      --target-keyspace string    Keyspace where the tables are being moved to and where the workflow exists (required)
 ```
 
 ### SEE ALSO

diff --git a/...ograms/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md b/...ograms/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,19 +19,14 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
 ### Options
 
 ```
-      --dry-run              Print the actions that would be taken and report any known errors that would have occurred
-  -h, --help                 help for complete
-      --keep-data            Keep the original source table data that was copied by the MoveTables workflow
-      --keep-routing-rules   Keep the routing rules in place that direct table traffic from the source keyspace to the target keyspace of the MoveTables workflow
-      --rename-tables        Keep the original source table data that was copied by the MoveTables workflow, but rename each table to '_<tablename>_old'
+  -h, --help   help for Complete
 ```
 
 ### Options inherited from parent commands
 
 ```
       --action_timeout duration   timeout for the total command (default 1h0m0s)
       --server string             server to use for connection (required)
-      --target-keyspace string    Keyspace where the tables are being moved to and where the workflow exists (required)
 ```
 
 ### SEE ALSO

diff --git a/...programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_create.md b/...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.
+Create and optionally run a moveTables VReplication workflow.
 
 ```
-vtctldclient MoveTables create
+vtctldclient MoveTables Create
 ```
 
 ### Examples
@@ -20,15 +20,16 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
 
 ```
       --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
+  -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-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
@@ -41,7 +42,6 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
 ```
       --action_timeout duration   timeout for the total command (default 1h0m0s)
       --server string             server to use for connection (required)
-      --target-keyspace string    Keyspace where the tables are being moved to and where the workflow exists (required)
 ```
 
 ### SEE ALSO

diff --git a/.../vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md b/.../vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md
@@ -1,28 +1,28 @@
 ---
-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 commerce2customer --target-keyspace customer reversetraffic
+vtctldclient --server localhost:15999 moveTables --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 target keyspace to support switching traffic again (default true)
-  -h, --help                                   help for reversetraffic
+      --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)
@@ -33,7 +33,6 @@ vtctldclient --server localhost:15999 movetables --workflow commerce2customer --
 ```
       --action_timeout duration   timeout for the total command (default 1h0m0s)
       --server string             server to use for connection (required)
-      --target-keyspace string    Keyspace where the tables are being moved to and where the workflow exists (required)
 ```
 
 ### SEE ALSO

diff --git a/...e/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md b/...e/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md
@@ -1,33 +1,32 @@
 ---
-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 commerce2customer --target-keyspace customer show
+vtctldclient --server localhost:15999 moveTables --workflow cust2cust --target-keyspace customer show
 ```
 
 ### Options
 
 ```
-  -h, --help   help for show
+  -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

diff --git a/.../programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md b/.../programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md
@@ -1,33 +1,32 @@
 ---
-title: MoveTables start
+title: MoveTables Start
 series: vtctldclient
 ---
-## vtctldclient MoveTables start
+## vtctldclient MoveTables Start
 
-Start the MoveTables workflow.
+Start a moveTables workflow.
 
 ```
-vtctldclient MoveTables start
+vtctldclient MoveTables Start
 ```
 
 ### Examples
 
 ```
-vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer start
+vtctldclient --server localhost:15999 moveTables --workflow cust2cust --target-keyspace customer start
 ```
 
 ### 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)
       --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

diff --git a/...programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md b/...programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md
@@ -1,33 +1,32 @@
 ---
-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 commerce2customer --target-keyspace customer status
+vtctldclient --server localhost:15999 moveTables --workflow cust2cust --target-keyspace customer status
 ```
 
 ### Options
 
 ```
-  -h, --help   help for status
+  -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

diff --git a/...e/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md b/...e/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md
@@ -1,33 +1,32 @@
 ---
-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 commerce2customer --target-keyspace customer stop
+vtctldclient --server localhost:15999 moveTables --workflow cust2cust --target-keyspace customer stop
 ```
 
 ### Options
 
 ```
-  -h, --help   help for stop
+  -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