Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update VReplication Reference Pages #1267

Merged
merged 17 commits into from
Dec 22, 2022
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/en/docs/13.0/reference/vreplication/v1/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ description: v1 MoveTables and Reshard vtctld commands (**Deprecated**)
weight: 1000
---

{{< info >}}
Starting with Vitess 11.0 you should use the [VReplication v2 commands](../../vreplication)
{{< /info >}}
{{< warning >}}
The v1 commands were deprecated in Vitess 11.0 and have been **removed** in Vitess 16.0. You should begin using the [VReplication v2 commands](../../vreplication)
{{< /warning >}}
6 changes: 3 additions & 3 deletions content/en/docs/14.0/reference/vreplication/v1/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ description: v1 MoveTables and Reshard vtctld commands (**Deprecated**)
weight: 1000
---

{{< info >}}
Starting with Vitess 11.0 you should use the [VReplication v2 commands](../../vreplication)
{{< /info >}}
{{< warning >}}
The v1 commands were deprecated in Vitess 11.0 and have been **removed** in Vitess 16.0. You should begin using the [VReplication v2 commands](../../vreplication)
{{< /warning >}}
6 changes: 3 additions & 3 deletions content/en/docs/15.0/reference/vreplication/v1/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ description: v1 MoveTables and Reshard vtctld commands (**Deprecated**)
weight: 1000
---

{{< info >}}
Starting with Vitess 11.0 you should use the [VReplication v2 commands](../../vreplication)
{{< /info >}}
{{< warning >}}
The v1 commands were deprecated in Vitess 11.0 and have been **removed** in Vitess 16.0. You should begin using the [VReplication v2 commands](../../vreplication)
{{< /warning >}}
9 changes: 2 additions & 7 deletions content/en/docs/16.0/reference/programs/vtctl/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,17 +74,12 @@ Note that wherever `vtctl` commands produced master or MASTER for tablet type, t
| [GetKeyspaces](../vtctl/keyspaces#getkeyspaces) | `GetKeyspaces ` |
| [RebuildKeyspaceGraph](../vtctl/keyspaces#rebuildkeyspacegraph) | `RebuildKeyspaceGraph -- [--cells=c1,c2,...] <keyspace> ...` |
| [ValidateKeyspace](../vtctl/keyspaces#validatekeyspace) | `ValidateKeyspace -- [--ping-tablets] <keyspace name>` |
| [Reshard (v1)](../../vreplication/v1/reshard) | `Reshard -- --v1 [--skip_schema_copy] <keyspace.workflow> <source_shards> <target_shards>` |
| [Reshard (v2)](../../vreplication/reshard) | `Reshard <options> <action> <workflow identifier>` |
| [MoveTables (v1)](../../vreplication/v1/movetables) | `MoveTables -- --v1 [--cell=<cell>] [--tablet_types=<source_tablet_types>] --workflow=<workflow> <source_keyspace> <target_keyspace> <table_specs>` |
| [MoveTables (v2)](../../vreplication/movetables) | `MoveTables <options> <action> <workflow identifier>` |
| [DropSources](../../vreplication/v1/dropsources) | `DropSources -- [--dry_run] <keyspace.workflow>` |
| [Reshard](../../vreplication/reshard) | `Reshard <options> <action> <workflow identifier>` |
| [MoveTables](../../vreplication/movetables) | `MoveTables <options> <action> <workflow identifier>` |
| [CreateLookupVindex](../vtctl/keyspaces#createLookupvindex) | `CreateLookupVindex -- [--cell=<cell>] [--tablet_types=<source_tablet_types>] <keyspace> <json_spec>` |
| [ExternalizeVindex](../vtctl/keyspaces#externalizevindex) | `ExternalizeVindex <keyspace>.<vindex>` |
| [Materialize](../vtctl/keyspaces#materialize) | `Materialize <json_spec>, example : '{"workflow": "aaa", "source_keyspace": "source", "target_keyspace": "target", "table_settings": [{"target_table": "customer", "source_expression": "select * from customer", "create_ddl": "copy"}]}'` |
| [VDiff](../vtctl/keyspaces#VDiff) | `VDiff -- [--source_cell=<cell>] [--target_cell=<cell>] [--tablet_types=<source_tablet_types>] [--filtered_replication_wait_time=30s] [--max_extra_rows_to_compare=1000] <keyspace.workflow>` |
| [SwitchReads](../../vreplication/v1/switchreads) | `SwitchReads -- [--cells=c1,c2,...] [--reverse] -tablet_type={replica\|rdonly} [--dry-run] <keyspace.workflow>` |
| [SwitchWrites](../../vreplication/v1/switchwrites) | `SwitchWrites -- [--filtered_replication_wait_time=30s] [--cancel] [--reverse_replication=false] [--dry-run] <keyspace.workflow>` |
| [FindAllShardsInKeyspace](../vtctl/keyspaces#findallshardsinkeyspace) | `FindAllShardsInKeyspace <keyspace>` |

### Generic
Expand Down
60 changes: 2 additions & 58 deletions content/en/docs/16.0/reference/programs/vtctl/keyspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,52 +156,18 @@ Validates that all nodes reachable from the specified keyspace are consistent.</

* the <code>&lt;keyspace name&gt;</code> argument is required for the <code>&lt;ValidateKeyspace&gt;</code> command This error occurs if the command is not called with exactly one argument.


### Reshard (v1)

```shell
Reshard -- --v1 [--skip_schema_copy] <keyspace.workflow> <source_shards> <target_shards>
Start a Resharding process. Example: Reshard -- --cells='zone1,alias1' --tablet_types='primary,replica,rdonly' ks.workflow001 '0' '-80,80-'.
```
#### Notes

* The <code>v1</code> argument is required in Vitess 11.0 and later
* This command is part of the [VReplication v1 workflow](../../../vreplication/v1) -- we recommend that you use the [v2 workflow](../../../vreplication/reshard) in Vitess 11.0 and later

### Reshard (v2)
### Reshard

```shell
Reshard <options> <action> <workflow identifier>
```

### MoveTables (v1)

```shell
MoveTables -- --v1 [--cell=<cell>] [--tablet_types=<source_tablet_types>] --workflow=<workflow> <source_keyspace> <target_keyspace> <table_specs>
Move table(s) to another keyspace, table_specs is a list of tables or the tables section of the vschema for the target keyspace. Example: '{"t1":{"column_vindexes": [{"column": "id1", "name": "hash"}]}, "t2":{"column_vindexes": [{"column": "id2", "name": "hash"}]}}'. In the case of an unsharded target keyspace the vschema for each table may be empty. Example: '{"t1":{}, "t2":{}}'.
```
#### Notes

* The <code>v1</code> argument is required in Vitess 11.0 and later
* This command is part of the [VReplication v1 workflow](../../../vreplication/v1) -- we recommend that you use the [v2 workflow](../../../vreplication/movetables) in Vitess 11.0 and later

## MoveTables (v2)
## MoveTables

```shell
MoveTables <options> <action> <workflow identifier>
```

### DropSources

```shell
DropSources -- [--dry_run] [--rename_tables] <keyspace.workflow>
After a MoveTables or Resharding workflow cleanup unused artifacts like source tables, source shards and blacklists.
```

#### Notes

* This command is part of the [VReplication v1 workflow](../../../vreplication/v1) -- we recommend that you use the [v2 workflow](../../../vreplication/complete) in Vitess 11.0 and later

### CreateLookupVindex

```shell
Expand Down Expand Up @@ -233,28 +199,6 @@ VDiff -- [--source_cell=<cell>] [--target_cell=<cell>] [--tablet_types=<source_
Perform a diff of all tables in the workflow
```

### SwitchReads

```shell
SwitchReads -- [--cells=c1,c2,...] [--reverse] -tablet_types={replica|rdonly} [--dry-run] <keyspace.workflow>
Switch read traffic for the specified workflow.
```

#### Notes

* This command is part of the [VReplication v1 workflow](../../../vreplication/v1) -- we recommend that you use the [v2 workflow](../../../vreplication/switchtraffic) in Vitess 11.0 and later

### SwitchWrites

```shell
SwitchWrites -- [--timeout=30s] [--cancel] [--reverse] [--reverse_replication=false] -tablet_types={replica|rdonly} [--dry-run] <keyspace.workflow>
Switch write traffic for the specified workflow.
```

#### Notes

* This command is part of the [VReplication v1 workflow](../../../vreplication/v1) -- we recommend that you use the [v2 workflow](../../../vreplication/switchtraffic) in Vitess 11.0 and later

### FindAllShardsInKeyspace

Displays all of the shards in the specified keyspace.
Expand Down
42 changes: 0 additions & 42 deletions content/en/docs/16.0/reference/vreplication/cancel.md

This file was deleted.

65 changes: 0 additions & 65 deletions content/en/docs/16.0/reference/vreplication/complete.md

This file was deleted.

Loading