Add docs for MoveTables auto increment handling (#1859)

* Update reference docs for vitessio/vitess#16860 Signed-off-by: Matt Lord <[email protected]> * Add new section to the movetables reference page Signed-off-by: Matt Lord <[email protected]> * Add keyspace concept link Signed-off-by: Matt Lord <[email protected]> * Changes from self review Signed-off-by: Matt Lord <[email protected]> * Correct keyspace concept link Signed-off-by: Matt Lord <[email protected]> * Minor tweak Signed-off-by: Matt Lord <[email protected]> * Unify formatting Signed-off-by: Matt Lord <[email protected]> --------- Signed-off-by: Matt Lord <[email protected]>
vitessio · Oct 4, 2024 · 6249485 · 6249485
1 parent 8eb5625
commit 6249485
Show file tree

Hide file tree

Showing 159 changed files with 251 additions and 224 deletions.
diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/_index.md b/content/en/docs/21.0/reference/programs/vtctldclient/_index.md
@@ -1,7 +1,7 @@
 ---
 title: vtctldclient
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md
@@ -1,7 +1,7 @@
 ---
 title: AddCellInfo
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient AddCellInfo
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md
@@ -1,7 +1,7 @@
 ---
 title: AddCellsAlias
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient AddCellsAlias
 

diff --git a/.../21.0/reference/programs/vtctldclient/vtctldclient_ApplyKeyspaceRoutingRules.md b/.../21.0/reference/programs/vtctldclient/vtctldclient_ApplyKeyspaceRoutingRules.md
@@ -1,7 +1,7 @@
 ---
 title: ApplyKeyspaceRoutingRules
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient ApplyKeyspaceRoutingRules
 

diff --git a/.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md b/.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md
@@ -1,7 +1,7 @@
 ---
 title: ApplyRoutingRules
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient ApplyRoutingRules
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md
@@ -1,7 +1,7 @@
 ---
 title: ApplySchema
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient ApplySchema
 

diff --git a/...ocs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md b/...ocs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md
@@ -1,7 +1,7 @@
 ---
 title: ApplyShardRoutingRules
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient ApplyShardRoutingRules
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md
@@ -1,7 +1,7 @@
 ---
 title: ApplyVSchema
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient ApplyVSchema
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_Backup.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_Backup.md
@@ -1,20 +1,21 @@
 ---
 title: Backup
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient Backup
 
 Uses the BackupStorage service on the given tablet to create and store a new backup.
 
 ```
-vtctldclient Backup [--concurrency <concurrency>] [--allow-primary] [--incremental-from-pos=<pos>|<backup-name>|auto] [--upgrade-safe] <tablet_alias>
+vtctldclient Backup [--concurrency <concurrency>] [--allow-primary] [--incremental-from-pos=<pos>|<backup-name>|auto] [--upgrade-safe] [--backup-engine=enginename] <tablet_alias>
 ```
 
 ### Options
 
 ```
       --allow-primary                 Allow the primary of a shard to be used for the backup. WARNING: If using the builtin backup engine, this will shutdown mysqld on the primary and stop writes for the duration of the backup.
+      --backup-engine string          Request a specific backup engine for this backup request. Defaults to the preferred backup engine of the target vttablet
       --concurrency int32             Specifies the number of compression/checksum jobs to run simultaneously. (default 4)
   -h, --help                          help for Backup
       --incremental-from-pos string   Position, or name of backup from which to create an incremental backup. Default: empty. If given, then this backup becomes an incremental backup from given position or given backup. If value is 'auto', this backup will be taken from the last successful backup position.

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md
@@ -1,7 +1,7 @@
 ---
 title: BackupShard
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient BackupShard
 

diff --git a/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md b/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md
@@ -1,7 +1,7 @@
 ---
 title: ChangeTabletType
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient ChangeTabletType
 

diff --git a/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CheckThrottler.md b/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CheckThrottler.md
@@ -1,7 +1,7 @@
 ---
 title: CheckThrottler
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient CheckThrottler
 

diff --git a/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md b/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md
@@ -1,7 +1,7 @@
 ---
 title: CreateKeyspace
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient CreateKeyspace
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md
@@ -1,7 +1,7 @@
 ---
 title: CreateShard
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient CreateShard
 

diff --git a/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md b/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md
@@ -1,7 +1,7 @@
 ---
 title: DeleteCellInfo
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient DeleteCellInfo
 

diff --git a/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md b/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md
@@ -1,7 +1,7 @@
 ---
 title: DeleteCellsAlias
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient DeleteCellsAlias
 

diff --git a/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md b/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md
@@ -1,7 +1,7 @@
 ---
 title: DeleteKeyspace
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient DeleteKeyspace
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md
@@ -1,7 +1,7 @@
 ---
 title: DeleteShards
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient DeleteShards
 

diff --git a/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteSrvVSchema.md b/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteSrvVSchema.md
@@ -1,7 +1,7 @@
 ---
 title: DeleteSrvVSchema
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient DeleteSrvVSchema
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md
@@ -1,7 +1,7 @@
 ---
 title: DeleteTablets
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient DeleteTablets
 

diff --git a/...0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/_index.md b/...0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/_index.md
@@ -1,7 +1,7 @@
 ---
 title: DistributedTransaction
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient DistributedTransaction
 
@@ -28,5 +28,5 @@ Perform commands on distributed transaction
 
 * [vtctldclient](../)	 - Executes a cluster management command on the remote vtctld server.
 * [vtctldclient DistributedTransaction conclude](./vtctldclient_distributedtransaction_conclude/)	 - Concludes the unresolved transaction by rolling back the prepared transaction on each participating shard and removing the transaction metadata record.
-* [vtctldclient DistributedTransaction list](./vtctldclient_distributedtransaction_list/)	 - Retrieves unresolved transactions for the given keyspace.
+* [vtctldclient DistributedTransaction unresolved-list](./vtctldclient_distributedtransaction_unresolved-list/)	 - Retrieves unresolved transactions for the given keyspace.
 
diff --git a/...ldclient_DistributedTransaction/vtctldclient_DistributedTransaction_conclude.md b/...ldclient_DistributedTransaction/vtctldclient_DistributedTransaction_conclude.md
@@ -1,20 +1,21 @@
 ---
 title: DistributedTransaction conclude
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient DistributedTransaction conclude
 
 Concludes the unresolved transaction by rolling back the prepared transaction on each participating shard and removing the transaction metadata record.
 
 ```
-vtctldclient DistributedTransaction conclude <dtid> [<keyspace/shard> ...]
+vtctldclient DistributedTransaction conclude --dtid <dtid>
 ```
 
 ### Options
 
 ```
-  -h, --help   help for conclude
+  -d, --dtid string   conclude transaction for the given distributed transaction ID.
+  -h, --help          help for conclude
 ```
 
 ### Options inherited from parent commands

diff --git a/...ocs/21.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md b/...ocs/21.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md
@@ -1,7 +1,7 @@
 ---
 title: EmergencyReparentShard
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient EmergencyReparentShard
 

diff --git a/.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsApp.md b/.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsApp.md
@@ -1,7 +1,7 @@
 ---
 title: ExecuteFetchAsApp
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient ExecuteFetchAsApp
 

diff --git a/.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsDBA.md b/.../en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsDBA.md
@@ -1,7 +1,7 @@
 ---
 title: ExecuteFetchAsDBA
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient ExecuteFetchAsDBA
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteHook.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteHook.md
@@ -1,7 +1,7 @@
 ---
 title: ExecuteHook
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient ExecuteHook
 

diff --git a/...ocs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteMultiFetchAsDBA.md b/...ocs/21.0/reference/programs/vtctldclient/vtctldclient_ExecuteMultiFetchAsDBA.md
@@ -1,7 +1,7 @@
 ---
 title: ExecuteMultiFetchAsDBA
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient ExecuteMultiFetchAsDBA
 

diff --git a/...cs/21.0/reference/programs/vtctldclient/vtctldclient_FindAllShardsInKeyspace.md b/...cs/21.0/reference/programs/vtctldclient/vtctldclient_FindAllShardsInKeyspace.md
@@ -1,7 +1,7 @@
 ---
 title: FindAllShardsInKeyspace
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient FindAllShardsInKeyspace
 

diff --git a/...n/docs/21.0/reference/programs/vtctldclient/vtctldclient_GenerateShardRanges.md b/...n/docs/21.0/reference/programs/vtctldclient/vtctldclient_GenerateShardRanges.md
@@ -1,7 +1,7 @@
 ---
 title: GenerateShardRanges
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient GenerateShardRanges
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetBackups.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetBackups.md
@@ -1,7 +1,7 @@
 ---
 title: GetBackups
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient GetBackups
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellInfo.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellInfo.md
@@ -1,7 +1,7 @@
 ---
 title: GetCellInfo
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient GetCellInfo
 

diff --git a/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellInfoNames.md b/...t/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellInfoNames.md
@@ -1,7 +1,7 @@
 ---
 title: GetCellInfoNames
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient GetCellInfoNames
 

diff --git a/...nt/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellsAliases.md b/...nt/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetCellsAliases.md
@@ -1,7 +1,7 @@
 ---
 title: GetCellsAliases
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient GetCellsAliases
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetFullStatus.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetFullStatus.md
@@ -1,7 +1,7 @@
 ---
 title: GetFullStatus
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient GetFullStatus
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetKeyspace.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetKeyspace.md
@@ -1,7 +1,7 @@
 ---
 title: GetKeyspace
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient GetKeyspace
 

diff --git a/...cs/21.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaceRoutingRules.md b/...cs/21.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaceRoutingRules.md
@@ -1,7 +1,7 @@
 ---
 title: GetKeyspaceRoutingRules
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient GetKeyspaceRoutingRules
 

diff --git a/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaces.md b/content/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaces.md
@@ -1,7 +1,7 @@
 ---
 title: GetKeyspaces
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient GetKeyspaces
 

diff --git a/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetMirrorRules.md b/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetMirrorRules.md
@@ -1,7 +1,7 @@
 ---
 title: GetMirrorRules
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient GetMirrorRules
 

diff --git a/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetPermissions.md b/...ent/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetPermissions.md
@@ -1,7 +1,7 @@
 ---
 title: GetPermissions
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient GetPermissions
 

diff --git a/...nt/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetRoutingRules.md b/...nt/en/docs/21.0/reference/programs/vtctldclient/vtctldclient_GetRoutingRules.md
@@ -1,7 +1,7 @@
 ---
 title: GetRoutingRules
 series: vtctldclient
-commit: 069651aed3c06088dc00f8f699a276665056e3d0
+commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
 ---
 ## vtctldclient GetRoutingRules