Skip to content

Commit

Permalink
Reran go run ./tools/cobradocs/ --vitess-dir /Users/rohit/vitess --ve…
Browse files Browse the repository at this point in the history
…rsion-pairs rohit/reshard-vtctldclient:18.0 vtctldclient

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
  • Loading branch information
rohit-nayak-ps committed Sep 13, 2023
1 parent c897c51 commit 4c720d5
Show file tree
Hide file tree
Showing 31 changed files with 208 additions and 211 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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)
```

Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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)
```

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

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

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

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

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

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

### Options
Expand Down
Loading

0 comments on commit 4c720d5

Please sign in to comment.