Skip to content

Commit

Permalink
Add docs for vitessio/vitess#15933 (#1757)
Browse files Browse the repository at this point in the history
This also brings all of the vtctldclient docs up to date with:
export COBRADOC_VERSION_PAIRS="get_topo_path_version:20.0"
export VITESS_DIR=~/git/vitess
make vtctldclient-docs

Signed-off-by: Matt Lord <[email protected]>
  • Loading branch information
mattlord authored May 31, 2024
1 parent f8abcfd commit 69ea3e2
Show file tree
Hide file tree
Showing 152 changed files with 158 additions and 156 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtctldclient
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AddCellInfo
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient AddCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AddCellsAlias
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient AddCellsAlias

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyKeyspaceRoutingRules
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient ApplyKeyspaceRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyRoutingRules
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient ApplyRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplySchema
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient ApplySchema

Expand Down Expand Up @@ -32,7 +32,7 @@ vtctldclient ApplySchema [--ddl-strategy <strategy>] [--uuid <uuid> ...] [--migr
```
--batch-size int How many queries to batch together. Only applicable when all queries are CREATE TABLE|VIEW
--caller-id string Effective caller ID used for the operation and should map to an ACL name which grants this identity the necessary permissions to perform the operation (this is only necessary when strict table ACLs are used).
--ddl-strategy string Online DDL strategy, compatible with @@ddl_strategy session variable (examples: 'vitess', 'pt-osc', 'gh-ost --max-load=Threads_running=100'. (default "direct")
--ddl-strategy string Online DDL strategy, compatible with @@ddl_strategy session variable (examples: 'gh-ost', 'pt-osc', 'gh-ost --max-load=Threads_running=100'. (default "direct")
-h, --help help for ApplySchema
--migration-context string For Online DDL, optionally supply a custom unique string used as context for the migration(s) in this command. By default a unique context is auto-generated by Vitess.
--sql stringArray Semicolon-delimited, repeatable SQL commands to apply. Exactly one of --sql|--sql-file is required.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyShardRoutingRules
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient ApplyShardRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyVSchema
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient ApplyVSchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Backup
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient Backup

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: BackupShard
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient BackupShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ChangeTabletType
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient ChangeTabletType

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CreateKeyspace
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient CreateKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CreateShard
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient CreateShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteCellInfo
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient DeleteCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteCellsAlias
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient DeleteCellsAlias

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteKeyspace
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient DeleteKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteShards
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient DeleteShards

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteSrvVSchema
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient DeleteSrvVSchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteTablets
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient DeleteTablets

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: EmergencyReparentShard
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient EmergencyReparentShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteFetchAsApp
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient ExecuteFetchAsApp

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteFetchAsDBA
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient ExecuteFetchAsDBA

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteHook
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient ExecuteHook

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteMultiFetchAsDBA
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient ExecuteMultiFetchAsDBA

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: FindAllShardsInKeyspace
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient FindAllShardsInKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GenerateShardRanges
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GenerateShardRanges

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetBackups
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetBackups

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellInfo
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellInfoNames
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetCellInfoNames

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellsAliases
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetCellsAliases

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetFullStatus
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetFullStatus

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetKeyspace
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetKeyspaceRoutingRules
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetKeyspaceRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetKeyspaces
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetKeyspaces

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetPermissions
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetPermissions

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetRoutingRules
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetSchema
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetSchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetShard
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetShardReplication
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetShardReplication

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetShardRoutingRules
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetShardRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetSrvKeyspaceNames
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetSrvKeyspaceNames

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetSrvKeyspaces
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetSrvKeyspaces

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetSrvVSchema
series: vtctldclient
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
commit: b9b567acbb1f36404f46b5daa168d37831dd137f
---
## vtctldclient GetSrvVSchema

Expand Down
Loading

0 comments on commit 69ea3e2

Please sign in to comment.