Manual rebuild of vtctldclient reference docs (#1620)

Signed-off-by: Matt Lord <mattalord@gmail.com>
vitessio · Oct 16, 2023 · 66fb422 · 66fb422
1 parent b01f6ac
commit 66fb422
Show file tree

Hide file tree

Showing 294 changed files with 2,718 additions and 665 deletions.
diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/_index.md b/content/en/docs/18.0/reference/programs/vtctldclient/_index.md
@@ -1,7 +1,7 @@
 ---
 title: vtctldclient
 series: vtctldclient
-commit: b089f78945653f6acd17c66f896820e36df49437
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient
 
@@ -14,9 +14,10 @@ vtctldclient [flags]
 ### Options
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
   -h, --help                      help for vtctldclient
-      --server string             server to use for connection (required)
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO
@@ -67,6 +68,10 @@ 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 LookupVindex](./vtctldclient_lookupvindex/)	 - Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows.
+* [vtctldclient Materialize](./vtctldclient_materialize/)	 - Perform commands related to materializing query results from the source keyspace into tables in the target keyspace.
+* [vtctldclient Migrate](./vtctldclient_migrate/)	 - Migrate is used to import data from an external cluster into the current cluster.
+* [vtctldclient Mount](./vtctldclient_mount/)	 - Mount is used to link an external Vitess cluster in order to migrate data from it.
 * [vtctldclient MoveTables](./vtctldclient_movetables/)	 - Perform commands related to moving tables from a source keyspace to a target keyspace.
 * [vtctldclient OnlineDDL](./vtctldclient_onlineddl/)	 - Operates on online DDL (schema migrations).
 * [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.

diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md
@@ -1,6 +1,7 @@
 ---
 title: AddCellInfo
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient AddCellInfo
 
@@ -29,8 +30,9 @@ vtctldclient AddCellInfo --root <root> [--server-address <addr>] <cell>
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md
@@ -1,6 +1,7 @@
 ---
 title: AddCellsAlias
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient AddCellsAlias
 
@@ -28,8 +29,9 @@ vtctldclient AddCellsAlias --cells <cell1,cell2,...> [--cells <cell3> ...] <alia
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/.../en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md b/.../en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplyRoutingRules.md
@@ -1,6 +1,7 @@
 ---
 title: ApplyRoutingRules
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient ApplyRoutingRules
 
@@ -24,8 +25,9 @@ vtctldclient ApplyRoutingRules {--rules RULES | --rules-file RULES_FILE} [--cell
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplySchema.md
@@ -1,7 +1,7 @@
 ---
 title: ApplySchema
 series: vtctldclient
-commit: b2d7604e4e0728329314500c182c3192cee74510
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient ApplySchema
 
@@ -45,8 +45,9 @@ vtctldclient ApplySchema [--ddl-strategy <strategy>] [--uuid <uuid> ...] [--migr
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/...ocs/18.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md b/...ocs/18.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md
@@ -1,6 +1,7 @@
 ---
 title: ApplyShardRoutingRules
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient ApplyShardRoutingRules
 
@@ -24,8 +25,9 @@ vtctldclient ApplyShardRoutingRules {--rules RULES | --rules-file RULES_FILE} [-
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md
@@ -1,6 +1,7 @@
 ---
 title: ApplyVSchema
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient ApplyVSchema
 
@@ -26,8 +27,9 @@ vtctldclient ApplyVSchema {--vschema=<vschema> || --vschema-file=<vschema file>
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Backup.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_Backup.md
@@ -1,6 +1,7 @@
 ---
 title: Backup
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient Backup
 
@@ -23,8 +24,9 @@ vtctldclient Backup [--concurrency <concurrency>] [--allow-primary] [--increment
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md
@@ -1,6 +1,7 @@
 ---
 title: BackupShard
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient BackupShard
 
@@ -29,8 +30,9 @@ vtctldclient BackupShard [--concurrency <concurrency>] [--allow-primary] [--incr
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/...t/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md b/...t/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md
@@ -1,6 +1,7 @@
 ---
 title: ChangeTabletType
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient ChangeTabletType
 
@@ -27,8 +28,9 @@ vtctldclient ChangeTabletType [--dry-run] <alias> <tablet-type>
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/...ent/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md b/...ent/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md
@@ -1,6 +1,7 @@
 ---
 title: CreateKeyspace
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient CreateKeyspace
 
@@ -34,8 +35,9 @@ vtctldclient CreateKeyspace <keyspace> [--force|-f] [--type KEYSPACE_TYPE] [--ba
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md
@@ -1,6 +1,7 @@
 ---
 title: CreateShard
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient CreateShard
 
@@ -21,8 +22,9 @@ vtctldclient CreateShard [--force|-f] [--include-parent|-p] <keyspace/shard>
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/...ent/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md b/...ent/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md
@@ -1,6 +1,7 @@
 ---
 title: DeleteCellInfo
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient DeleteCellInfo
 
@@ -24,8 +25,9 @@ vtctldclient DeleteCellInfo [--force] <cell>
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/...t/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md b/...t/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md
@@ -1,6 +1,7 @@
 ---
 title: DeleteCellsAlias
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient DeleteCellsAlias
 
@@ -23,8 +24,9 @@ vtctldclient DeleteCellsAlias <alias>
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/...ent/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md b/...ent/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md
@@ -1,6 +1,7 @@
 ---
 title: DeleteKeyspace
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient DeleteKeyspace
 
@@ -28,8 +29,9 @@ vtctldclient DeleteKeyspace [--recursive|-r] [--force|-f] <keyspace>
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md
@@ -1,6 +1,7 @@
 ---
 title: DeleteShards
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient DeleteShards
 
@@ -30,8 +31,9 @@ vtctldclient DeleteShards [--recursive|-r] [--even-if-serving] [--force|-f] <key
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/...t/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_DeleteSrvVSchema.md b/...t/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_DeleteSrvVSchema.md
@@ -1,6 +1,7 @@
 ---
 title: DeleteSrvVSchema
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient DeleteSrvVSchema
 
@@ -19,8 +20,9 @@ vtctldclient DeleteSrvVSchema <cell>
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md b/content/en/docs/18.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md
@@ -1,6 +1,7 @@
 ---
 title: DeleteTablets
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient DeleteTablets
 
@@ -20,8 +21,9 @@ vtctldclient DeleteTablets <alias> [ <alias> ... ]
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO

diff --git a/...ocs/18.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md b/...ocs/18.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md
@@ -1,6 +1,7 @@
 ---
 title: EmergencyReparentShard
 series: vtctldclient
+commit: fe3121946231107b737e319b680c9686396b9ce1
 ---
 ## vtctldclient EmergencyReparentShard
 
@@ -24,8 +25,9 @@ vtctldclient EmergencyReparentShard <keyspace/shard>
 ### Options inherited from parent commands
 
 ```
-      --action_timeout duration   timeout for the total command (default 1h0m0s)
-      --server string             server to use for connection (required)
+      --action_timeout duration   timeout to use for the command (default 1h0m0s)
+      --compact                   use compact format for otherwise verbose outputs
+      --server string             server to use for the connection (required)
 ```
 
 ### SEE ALSO