Skip to content

Commit

Permalink
Align and unify commands and examples
Browse files Browse the repository at this point in the history
Signed-off-by: Matt Lord <[email protected]>
  • Loading branch information
mattlord committed Jul 18, 2023
1 parent 0788b04 commit b091145
Show file tree
Hide file tree
Showing 33 changed files with 179 additions and 174 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -102,6 +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 movetables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.
* [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

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: movetables
title: MoveTables
series: vtctldclient
---
## vtctldclient movetables
## vtctldclient MoveTables

Perform commands related to moving tables from a source keyspace to a target keyspace.

Expand All @@ -15,7 +15,7 @@ See the --help output for each command for more details.

```
--format string The format of the output; supported formats are: text,json (default "text")
-h, --help help for movetables
-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)
```
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 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 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

Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: movetables cancel
title: MoveTables cancel
series: vtctldclient
---
## vtctldclient movetables cancel
## vtctldclient MoveTables cancel

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 commerce2customer --target-keyspace customer cancel
```

### Options
Expand All @@ -34,5 +34,5 @@ vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer"

### SEE ALSO

* [vtctldclient movetables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace.
* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.

Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: movetables cancel
title: MoveTables cancel
series: vtctldclient
---
## vtctldclient movetables cancel
## vtctldclient MoveTables cancel

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 commerce2customer --target-keyspace customer cancel
```

### Options
Expand All @@ -34,5 +34,5 @@ vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer"

### SEE ALSO

* [vtctldclient movetables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.
* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.

Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
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

```
vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer" --target-keyspace "customer" complete
vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer complete
```

### Options
Expand All @@ -36,5 +36,5 @@ vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer"

### SEE ALSO

* [vtctldclient movetables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace.
* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.

Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
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

```
vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer" --target-keyspace "customer" complete
vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer complete
```

### Options
Expand All @@ -36,5 +36,5 @@ vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer"

### SEE ALSO

* [vtctldclient movetables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.
* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.

Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
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

```
vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer" --target-keyspace "customer" create --source-keyspace "commerce" --cells "zone1" --cells "zone2" --tablet-types "replica"
vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer create --source-keyspace commerce --cells zone1 --cells zone2 --tablet-types replica
```

### Options
Expand Down Expand Up @@ -43,5 +43,5 @@ vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer"

### SEE ALSO

* [vtctldclient movetables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace.
* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.

Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
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

```
vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer" --target-keyspace "customer" create --source-keyspace "commerce" --cells "zone1" --cells "zone2" --tablet-types "replica"
vtctldclient --server localhost:15999 movetables --workflow commerce2customer --target-keyspace customer create --source-keyspace commerce --cells zone1 --cells zone2 --tablet-types replica
```

### Options
Expand Down Expand Up @@ -43,5 +43,5 @@ vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer"

### SEE ALSO

* [vtctldclient movetables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.
* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.

Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: movetables reversetraffic
title: MoveTables reversetraffic
series: vtctldclient
---
## vtctldclient movetables reversetraffic
## vtctldclient MoveTables reversetraffic

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 commerce2customer --target-keyspace customer reversetraffic
```

### Options
Expand All @@ -38,5 +38,5 @@ vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer"

### SEE ALSO

* [vtctldclient movetables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace.
* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.

Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: movetables reversetraffic
title: MoveTables reversetraffic
series: vtctldclient
---
## vtctldclient movetables reversetraffic
## vtctldclient MoveTables reversetraffic

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 commerce2customer --target-keyspace customer reversetraffic
```

### Options
Expand All @@ -38,5 +38,5 @@ vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer"

### SEE ALSO

* [vtctldclient movetables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.
* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.

Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: movetables show
title: MoveTables show
series: vtctldclient
---
## vtctldclient movetables show
## vtctldclient MoveTables show

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 commerce2customer --target-keyspace customer show
```

### Options
Expand All @@ -32,5 +32,5 @@ vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer"

### SEE ALSO

* [vtctldclient movetables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace.
* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.

Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: movetables show
title: MoveTables show
series: vtctldclient
---
## vtctldclient movetables show
## vtctldclient MoveTables show

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 commerce2customer --target-keyspace customer show
```

### Options
Expand All @@ -32,5 +32,5 @@ vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer"

### SEE ALSO

* [vtctldclient movetables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.
* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.

Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: movetables start
title: MoveTables start
series: vtctldclient
---
## vtctldclient movetables start
## vtctldclient MoveTables start

Start the 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 commerce2customer --target-keyspace customer start
```

### Options
Expand All @@ -32,5 +32,5 @@ vtctldclient --server=localhost:15999 MoveTables --workflow "commerce2customer"

### SEE ALSO

* [vtctldclient movetables](../) - Perform commands related to moving tables from a source keyspace to a target keyspace.
* [vtctldclient MoveTables](./vtctldclient_movetables/) - Perform commands related to moving tables from a source keyspace to a target keyspace.

Loading

0 comments on commit b091145

Please sign in to comment.