From 076508c5d52774d958ab75bb8f0a6f3cfae00e46 Mon Sep 17 00:00:00 2001 From: deepthi Date: Wed, 8 Jul 2020 16:01:25 -0700 Subject: [PATCH 1/4] change references to wait_slave_timeout -> wait_replicas_timeout Signed-off-by: deepthi --- content/zh/docs/reference/vtctl.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/content/zh/docs/reference/vtctl.md b/content/zh/docs/reference/vtctl.md index fe9f8689b..ecc788b39 100644 --- a/content/zh/docs/reference/vtctl.md +++ b/content/zh/docs/reference/vtctl.md @@ -1091,7 +1091,7 @@ Applies the schema change to the specified keyspace on every master, running in #### Example -
ApplySchema [-allow_long_unavailability] [-wait_slave_timeout=10s] {-sql=<sql> || -sql-file=<filename>} <keyspace>
+
ApplySchema [-allow_long_unavailability] [-wait_replicas_timeout=10s] {-sql=<sql> || -sql-file=<filename>} <keyspace>
#### Flags @@ -1100,7 +1100,7 @@ Applies the schema change to the specified keyspace on every master, running in | allow_long_unavailability | Boolean | Allow large schema changes which incur a longer unavailability of the database. | | sql | string | A list of semicolon-delimited SQL commands | | sql-file | string | Identifies the file that contains the SQL commands | -| wait_slave_timeout | Duration | The amount of time to wait for slaves to receive the schema change via replication. | +| wait_replicas_timeout | Duration | The amount of time to wait for slaves to receive the schema change via replication. | #### Arguments @@ -1146,7 +1146,7 @@ Copies the schema from a source shard's master (or a specific tablet) to a desti #### Example -
CopySchemaShard [-tables=<table1>,<table2>,...] [-exclude_tables=<table1>,<table2>,...] [-include-views] [-wait_slave_timeout=10s] {<source keyspace/shard> || <source tablet alias>} <destination keyspace/shard>
+
CopySchemaShard [-tables=<table1>,<table2>,...] [-exclude_tables=<table1>,<table2>,...] [-include-views] [-wait_replicas_timeout=10s] {<source keyspace/shard> || <source tablet alias>} <destination keyspace/shard>
#### Flags @@ -1155,7 +1155,7 @@ Copies the schema from a source shard's master (or a specific tablet) to a desti | exclude_tables | string | Specifies a comma-separated list of tables to exclude. Each is either an exact match, or a regular expression of the form /regexp/ | | include-views | Boolean | Includes views in the output | | tables | string | Specifies a comma-separated list of tables to copy. Each is either an exact match, or a regular expression of the form /regexp/ | -| wait_slave_timeout | Duration | The amount of time to wait for slaves to receive the schema change via replication. | +| wait_replicas_timeout | Duration | The amount of time to wait for slaves to receive the schema change via replication. | #### Arguments @@ -1578,7 +1578,7 @@ Reparents the shard to the new master. Assumes the old master is dead and not re | :-------- | :--------- | :--------- | | keyspace_shard | string | keyspace/shard of the shard that needs to be reparented | | new_master | string | alias of a tablet that should be the new master | -| wait_slave_timeout | Duration | time to wait for slaves to catch up in reparenting | +| wait_replicas_timeout | Duration | time to wait for slaves to catch up in reparenting | #### Errors @@ -1611,14 +1611,14 @@ Sets the initial master for a shard. Will make all other tablets in the shard sl #### Example -
InitShardMaster [-force] [-wait_slave_timeout=<duration>] <keyspace/shard> <tablet alias>
+
InitShardMaster [-force] [-wait_replicas_timeout=<duration>] <keyspace/shard> <tablet alias>
#### Flags | Name | Type | Definition | | :-------- | :--------- | :--------- | | force | Boolean | will force the reparent even if the provided tablet is not a master or the shard master | -| wait_slave_timeout | Duration | time to wait for slaves to catch up in reparenting | +| wait_replicas_timeout | Duration | time to wait for slaves to catch up in reparenting | #### Arguments @@ -1677,7 +1677,7 @@ Reparents the shard to the new master, or away from old master. Both old and new | avoid_master | string | alias of a tablet that should not be the master, i.e. reparent to any other tablet if this one is the master | | keyspace_shard | string | keyspace/shard of the shard that needs to be reparented | | new_master | string | alias of a tablet that should be the new master | -| wait_slave_timeout | Duration | time to wait for slaves to catch up in reparenting | +| wait_replicas_timeout | Duration | time to wait for slaves to catch up in reparenting | #### Errors From 3ef02e9d212c0a18898d4cdf69bd4cfa28d8ee33 Mon Sep 17 00:00:00 2001 From: deepthi Date: Sun, 12 Jul 2020 21:02:45 -0700 Subject: [PATCH 2/4] rename wait_slave_timeout flags to wait_replicas_timeout Signed-off-by: deepthi --- content/en/docs/reference/programs/vtctl.md | 8 ++++---- .../programs/vtctl/schema-version-permissions.md | 8 ++++---- content/en/docs/reference/programs/vtctl/shards.md | 8 ++++---- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/content/en/docs/reference/programs/vtctl.md b/content/en/docs/reference/programs/vtctl.md index d50295050..cf60b4a74 100644 --- a/content/en/docs/reference/programs/vtctl.md +++ b/content/en/docs/reference/programs/vtctl.md @@ -56,8 +56,8 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] | [ListBackups](../vtctl/shards#listbackups) | `ListBackups ` | | [BackupShard](../vtctl/shards#backupshard) | `BackupShard [-allow_master=false] ` | | [RemoveBackup](../vtctl/shards#removebackup) | `RemoveBackup ` | -| [InitShardMaster](../vtctl/shards#initshardmaster) | `InitShardMaster [-force] [-wait_slave_timeout=] ` | -| [PlannedReparentShard](../vtctl/shards#plannedreparentshard) | `PlannedReparentShard -keyspace_shard= [-new_master=] [-avoid_master=] [-wait_slave_timeout=]` | +| [InitShardMaster](../vtctl/shards#initshardmaster) | `InitShardMaster [-force] [-wait_replicas_timeout=] ` | +| [PlannedReparentShard](../vtctl/shards#plannedreparentshard) | `PlannedReparentShard -keyspace_shard= [-new_master=] [-avoid_master=] [-wait_replicas_timeout=]` | | [EmergencyReparentShard](../vtctl/shards#emergencyreparentshard) | `EmergencyReparentShard -keyspace_shard= -new_master=` | | [TabletExternallyReparented](../vtctl/shards#tabletexternallyreparented) | `TabletExternallyReparented ` | @@ -111,8 +111,8 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] | [ReloadSchemaKeyspace](../vtctl/schema-version-permissions#reloadschemakeyspace) | `ReloadSchemaKeyspace [-concurrency=10] [-include_master=false] ` | | [ValidateSchemaShard](../vtctl/schema-version-permissions#validateschemashard) | `ValidateSchemaShard [-exclude_tables=''] [-include-views] ` | | [ValidateSchemaKeyspace](../vtctl/schema-version-permissions#validateschemakeyspace) | `ValidateSchemaKeyspace [-exclude_tables=''] [-include-views] ` | -| [ApplySchema](../vtctl/schema-version-permissions#applyschema) | `ApplySchema [-allow_long_unavailability] [-wait_slave_timeout=10s] {-sql= || -sql-file=} ` | -| [CopySchemaShard](../vtctl/schema-version-permissions#copyschemashard) | `CopySchemaShard [-tables=,,...] [-exclude_tables=,,...] [-include-views] [-skip-verify] [-wait_slave_timeout=10s] { || } ` | +| [ApplySchema](../vtctl/schema-version-permissions#applyschema) | `ApplySchema [-allow_long_unavailability] [-wait_replicas_timeout=10s] {-sql= || -sql-file=} ` | +| [CopySchemaShard](../vtctl/schema-version-permissions#copyschemashard) | `CopySchemaShard [-tables=,,...] [-exclude_tables=,,...] [-include-views] [-skip-verify] [-wait_replicas_timeout=10s] { || } ` | | [ValidateVersionShard](../vtctl/schema-version-permissions#validateversionshard) | `ValidateVersionShard ` | | [ValidateVersionKeyspace](../vtctl/schema-version-permissions#validateversionkeyspace) | `ValidateVersionKeyspace ` | | [GetPermissions](../vtctl/schema-version-permissions#getpermissions) | `GetPermissions ` | diff --git a/content/en/docs/reference/programs/vtctl/schema-version-permissions.md b/content/en/docs/reference/programs/vtctl/schema-version-permissions.md index ced738ef3..0ff17ff59 100644 --- a/content/en/docs/reference/programs/vtctl/schema-version-permissions.md +++ b/content/en/docs/reference/programs/vtctl/schema-version-permissions.md @@ -152,7 +152,7 @@ Applies the schema change to the specified keyspace on every master, running in #### Example -
ApplySchema [-allow_long_unavailability] [-wait_slave_timeout=10s] {-sql=<sql> || -sql-file=<filename>} <keyspace>
+
ApplySchema [-allow_long_unavailability] [-wait_replicas_timeout=10s] {-sql=<sql> || -sql-file=<filename>} <keyspace>
#### Flags @@ -161,7 +161,7 @@ Applies the schema change to the specified keyspace on every master, running in | allow_long_unavailability | Boolean | Allow large schema changes which incur a longer unavailability of the database. | | sql | string | A list of semicolon-delimited SQL commands | | sql-file | string | Identifies the file that contains the SQL commands | -| wait_slave_timeout | Duration | The amount of time to wait for replicas to receive the schema change via replication. | +| wait_replicas_timeout | Duration | The amount of time to wait for replicas to receive the schema change via replication. | #### Arguments @@ -178,7 +178,7 @@ Copies the schema from a source shard's master (or a specific tablet) to a desti #### Example -
CopySchemaShard [-tables=<table1>,<table2>,...] [-exclude_tables=<table1>,<table2>,...] [-include-views] [-wait_slave_timeout=10s] {<source keyspace/shard> || <source tablet alias>} <destination keyspace/shard>
+
CopySchemaShard [-tables=<table1>,<table2>,...] [-exclude_tables=<table1>,<table2>,...] [-include-views] [-wait_replicas_timeout=10s] {<source keyspace/shard> || <source tablet alias>} <destination keyspace/shard>
#### Flags @@ -187,7 +187,7 @@ Copies the schema from a source shard's master (or a specific tablet) to a desti | exclude_tables | string | Specifies a comma-separated list of tables to exclude. Each is either an exact match, or a regular expression of the form /regexp/ | | include-views | Boolean | Includes views in the output | | tables | string | Specifies a comma-separated list of tables to copy. Each is either an exact match, or a regular expression of the form /regexp/ | -| wait_slave_timeout | Duration | The amount of time to wait for replicas to receive the schema change via replication. | +| wait_replicas_timeout | Duration | The amount of time to wait for replicas to receive the schema change via replication. | #### Arguments diff --git a/content/en/docs/reference/programs/vtctl/shards.md b/content/en/docs/reference/programs/vtctl/shards.md index 185fe83f2..c6a6937ab 100644 --- a/content/en/docs/reference/programs/vtctl/shards.md +++ b/content/en/docs/reference/programs/vtctl/shards.md @@ -318,14 +318,14 @@ Sets the initial master for a shard. Will make all other tablets in the shard re #### Example -
InitShardMaster [-force] [-wait_slave_timeout=<duration>] <keyspace/shard> <tablet alias>
+
InitShardMaster [-force] [-wait_replicas_timeout=<duration>] <keyspace/shard> <tablet alias>
#### Flags | Name | Type | Definition | | :-------- | :--------- | :--------- | | force | Boolean | will force the reparent even if the provided tablet is not a master or the shard master | -| wait_slave_timeout | Duration | time to wait for replicas to catch up in reparenting | +| wait_replicas_timeout | Duration | time to wait for replicas to catch up in reparenting | #### Arguments @@ -353,7 +353,7 @@ Reparents the shard to the new master, or away from old master. Both old and new | avoid_master | string | alias of a tablet that should not be the master, i.e. reparent to any other tablet if this one is the master | | keyspace_shard | string | keyspace/shard of the shard that needs to be reparented | | new_master | string | alias of a tablet that should be the new master | -| wait_slave_timeout | Duration | time to wait for replicas to catch up in reparenting | +| wait_replicas_timeout | Duration | time to wait for replicas to catch up in reparenting | #### Errors @@ -376,7 +376,7 @@ Reparents the shard to the new master. Assumes the old master is dead and not re | :-------- | :--------- | :--------- | | keyspace_shard | string | keyspace/shard of the shard that needs to be reparented | | new_master | string | alias of a tablet that should be the new master | -| wait_slave_timeout | Duration | time to wait for replicas to catch up in reparenting | +| wait_replicas_timeout | Duration | time to wait for replicas to catch up in reparenting | #### Errors From b841f112089cbcdc5b14d399a153ab8d6191abac Mon Sep 17 00:00:00 2001 From: deepthi Date: Mon, 13 Jul 2020 21:04:03 -0700 Subject: [PATCH 3/4] Deprecated and new vtctl commands Signed-off-by: deepthi --- content/en/docs/reference/programs/vtctl.md | 9 ++++++--- .../docs/reference/programs/vtctl/tablets.md | 18 +++++++++--------- content/en/docs/user-guides/reparenting.md | 2 +- wip-docs/user-guides/reparenting.md | 2 +- 4 files changed, 17 insertions(+), 14 deletions(-) diff --git a/content/en/docs/reference/programs/vtctl.md b/content/en/docs/reference/programs/vtctl.md index cf60b4a74..1f2cf287d 100644 --- a/content/en/docs/reference/programs/vtctl.md +++ b/content/en/docs/reference/programs/vtctl.md @@ -18,9 +18,12 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] | [DeleteTablet](../vtctl/tablets#deletetablet) | `DeleteTablet [-allow_master] ...` | | [SetReadOnly](../vtctl/tablets#setreadonly) | `SetReadOnly ` | | [SetReadWrite](../vtctl/tablets#setreadwrite) | `SetReadWrite ` | -| [StartSlave](../vtctl/tablets#startslave) | `StartSlave ` | -| [StopSlave](../vtctl/tablets#stopslave) | `StopSlave ` | -| [ChangeSlaveType](../vtctl/tablets#changeslavetype) | `ChangeSlaveType [-dry-run] ` | +| [StartReplication](../vtctl/tablets#startreplication) `StartReplication ` | +| [StartSlave](../vtctl/tablets#startreplication) | `DEPRECATED -- Use StartReplication ` | +| [StopReplication](../vtctl/tablets#stopreplication) `StopReplication ` | +| [StopSlave](../vtctl/tablets#stopreplication) | `DEPRECATED -- Use StopReplication ` | +| [ChangeTabletType](../vtctl/tablets#changetablettype) `ChangeTabletType [-dry-run] ` | +| [ChangeSlaveType](../vtctl/tablets#changetablettype) | `DEPRECATED -- Use ChangeTabletType [-dry-run] ` | | [Ping](../vtctl/tablets#ping) | `Ping ` | | [RefreshState](../vtctl/tablets#refreshstate) | `RefreshState ` | | [RefreshStateByShard](../vtctl/tablets#refreshstatebyshard) | `RefreshStateByShard [-cells=c1,c2,...] ` | diff --git a/content/en/docs/reference/programs/vtctl/tablets.md b/content/en/docs/reference/programs/vtctl/tablets.md index 26819569c..4aa7c7070 100644 --- a/content/en/docs/reference/programs/vtctl/tablets.md +++ b/content/en/docs/reference/programs/vtctl/tablets.md @@ -172,13 +172,13 @@ Sets the tablet as read-write. * the <tablet alias> argument is required for the <SetReadWrite> command This error occurs if the command is not called with exactly one argument. * failed reading tablet %v: %v -### StartSlave +### StartReplication Starts replication on the specified tablet. #### Example -
StartSlave <tablet alias>
+
StartReplication <tablet alias>
#### Arguments @@ -186,16 +186,16 @@ Starts replication on the specified tablet. #### Errors -* action <StartSlave> requires <tablet alias> This error occurs if the command is not called with exactly one argument. +* action <StartReplication> requires <tablet alias> This error occurs if the command is not called with exactly one argument. * failed reading tablet %v: %v -### StopSlave +### StopReplication Stops replication on the specified tablet. #### Example -
StopSlave <tablet alias>
+
StopReplication <tablet alias>
#### Arguments @@ -203,16 +203,16 @@ Stops replication on the specified tablet. #### Errors -* action <StopSlave> requires <tablet alias> This error occurs if the command is not called with exactly one argument. +* action <StopReplication> requires <tablet alias> This error occurs if the command is not called with exactly one argument. * failed reading tablet %v: %v -### ChangeSlaveType +### ChangeTabletType Changes the db type for the specified tablet, if possible. This command is used primarily to arrange replicas, and it will not convert a master.

NOTE: This command automatically updates the serving graph.

#### Example -
ChangeSlaveType [-dry-run] <tablet alias> <tablet type>
+
ChangeTabletType [-dry-run] <tablet alias> <tablet type>
#### Flags @@ -238,7 +238,7 @@ Changes the db type for the specified tablet, if possible. This command is used #### Errors -* the <tablet alias> and <db type> arguments are required for the <ChangeSlaveType> command This error occurs if the command is not called with exactly 2 arguments. +* the <tablet alias> and <db type> arguments are required for the <ChangeTabletType> command This error occurs if the command is not called with exactly 2 arguments. * failed reading tablet %v: %v * invalid type transition %v: %v -> %v diff --git a/content/en/docs/user-guides/reparenting.md b/content/en/docs/user-guides/reparenting.md index a8e84d22d..b9dab738c 100644 --- a/content/en/docs/user-guides/reparenting.md +++ b/content/en/docs/user-guides/reparenting.md @@ -90,4 +90,4 @@ Active reparenting might be a dangerous practice in any system that depends on e ## Fixing Replication -A tablet can be orphaned after a reparenting if it is unavailable when the reparent operation is running but then recovers later on. In that case, you can manually reset the tablet's master to the current shard master using the `vtctl ReparentTablet` command. You can then restart replication on the tablet if it was stopped by calling the `vtctl StartSlave` command. +A tablet can be orphaned after a reparenting if it is unavailable when the reparent operation is running but then recovers later on. In that case, you can manually reset the tablet's master to the current shard master using the `vtctl ReparentTablet` command. You can then restart replication on the tablet if it was stopped by calling the `vtctl StartReplication` command. diff --git a/wip-docs/user-guides/reparenting.md b/wip-docs/user-guides/reparenting.md index d1f9e22af..7a125edcc 100644 --- a/wip-docs/user-guides/reparenting.md +++ b/wip-docs/user-guides/reparenting.md @@ -185,6 +185,6 @@ In that case, you can manually reset the tablet's master to the current shard master using the [vtctl ReparentTablet]({% link reference/vtctl.md %}#reparenttablet) command. You can then restart replication on the tablet if it was stopped -by calling the [vtctl StartSlave]({% link reference/vtctl.md %}#startslave) +by calling the [vtctl StartReplication]({% link reference/vtctl.md %}#startreplication) command. From 0cf8c75aa2dbbbdb051683c4eb2251d9c00a0161 Mon Sep 17 00:00:00 2001 From: deepthi Date: Mon, 13 Jul 2020 21:08:25 -0700 Subject: [PATCH 4/4] Fix formatting Signed-off-by: deepthi --- content/en/docs/reference/programs/vtctl.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en/docs/reference/programs/vtctl.md b/content/en/docs/reference/programs/vtctl.md index 1f2cf287d..837a81d2a 100644 --- a/content/en/docs/reference/programs/vtctl.md +++ b/content/en/docs/reference/programs/vtctl.md @@ -18,11 +18,11 @@ aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] | [DeleteTablet](../vtctl/tablets#deletetablet) | `DeleteTablet [-allow_master] ...` | | [SetReadOnly](../vtctl/tablets#setreadonly) | `SetReadOnly ` | | [SetReadWrite](../vtctl/tablets#setreadwrite) | `SetReadWrite ` | -| [StartReplication](../vtctl/tablets#startreplication) `StartReplication ` | +| [StartReplication](../vtctl/tablets#startreplication) | `StartReplication ` | | [StartSlave](../vtctl/tablets#startreplication) | `DEPRECATED -- Use StartReplication ` | -| [StopReplication](../vtctl/tablets#stopreplication) `StopReplication ` | +| [StopReplication](../vtctl/tablets#stopreplication) | `StopReplication ` | | [StopSlave](../vtctl/tablets#stopreplication) | `DEPRECATED -- Use StopReplication ` | -| [ChangeTabletType](../vtctl/tablets#changetablettype) `ChangeTabletType [-dry-run] ` | +| [ChangeTabletType](../vtctl/tablets#changetablettype) | `ChangeTabletType [-dry-run] ` | | [ChangeSlaveType](../vtctl/tablets#changetablettype) | `DEPRECATED -- Use ChangeTabletType [-dry-run] ` | | [Ping](../vtctl/tablets#ping) | `Ping ` | | [RefreshState](../vtctl/tablets#refreshstate) | `RefreshState ` |