Skip to content

Commit

Permalink
Document changes from vitessio/vitess#16906
Browse files Browse the repository at this point in the history
Signed-off-by: Matt Lord <[email protected]>
  • Loading branch information
mattlord committed Oct 16, 2024
1 parent b5d05de commit 69f710c
Show file tree
Hide file tree
Showing 158 changed files with 172 additions and 167 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtctldclient
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient

Expand Down Expand Up @@ -42,6 +42,7 @@ vtctldclient [flags]
* [vtctldclient ApplyVSchema](./vtctldclient_applyvschema/) - Applies the VTGate routing schema to the provided keyspace. Shows the result after application.
* [vtctldclient Backup](./vtctldclient_backup/) - Uses the BackupStorage service on the given tablet to create and store a new backup.
* [vtctldclient BackupShard](./vtctldclient_backupshard/) - Finds the most up-to-date REPLICA, RDONLY, or SPARE tablet in the given shard and uses the BackupStorage service on that tablet to create and store a new backup.
* [vtctldclient ChangeTabletTags](./vtctldclient_changetablettags/) - Changes the tablet tags for the specified tablet, if possible.
* [vtctldclient ChangeTabletType](./vtctldclient_changetablettype/) - Changes the db type for the specified tablet, if possible.
* [vtctldclient CheckThrottler](./vtctldclient_checkthrottler/) - Issue a throttler check on the given tablet.
* [vtctldclient CreateKeyspace](./vtctldclient_createkeyspace/) - Creates the specified keyspace in the topology.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AddCellInfo
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient AddCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AddCellsAlias
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient AddCellsAlias

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyKeyspaceRoutingRules
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient ApplyKeyspaceRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyRoutingRules
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient ApplyRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplySchema
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient ApplySchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyShardRoutingRules
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient ApplyShardRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyVSchema
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient ApplyVSchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Backup
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient Backup

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: BackupShard
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient BackupShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ChangeTabletType
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient ChangeTabletType

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CheckThrottler
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient CheckThrottler

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CreateKeyspace
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient CreateKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CreateShard
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient CreateShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteCellInfo
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient DeleteCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteCellsAlias
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient DeleteCellsAlias

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteKeyspace
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient DeleteKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteShards
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient DeleteShards

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteSrvVSchema
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient DeleteSrvVSchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteTablets
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient DeleteTablets

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DistributedTransaction
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient DistributedTransaction

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DistributedTransaction conclude
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient DistributedTransaction conclude

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: EmergencyReparentShard
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient EmergencyReparentShard

Expand All @@ -14,6 +14,7 @@ vtctldclient EmergencyReparentShard <keyspace/shard>
### Options

```
--expected-primary string Alias of a tablet that must be the current primary in order for the reparent to be processed.
-h, --help help for EmergencyReparentShard
-i, --ignore-replicas strings Comma-separated, repeated list of replica tablet aliases to ignore during the emergency reparent.
--new-primary string Alias of a tablet that should be the new primary. If not specified, the vtctld will select the best candidate to promote.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteFetchAsApp
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient ExecuteFetchAsApp

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteFetchAsDBA
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient ExecuteFetchAsDBA

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteHook
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient ExecuteHook

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteMultiFetchAsDBA
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient ExecuteMultiFetchAsDBA

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: FindAllShardsInKeyspace
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient FindAllShardsInKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GenerateShardRanges
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GenerateShardRanges

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetBackups
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetBackups

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellInfo
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellInfoNames
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetCellInfoNames

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellsAliases
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetCellsAliases

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetFullStatus
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetFullStatus

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetKeyspace
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetKeyspaceRoutingRules
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetKeyspaceRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetKeyspaces
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetKeyspaces

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetMirrorRules
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetMirrorRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetPermissions
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetPermissions

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetRoutingRules
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetSchema
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetSchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetShard
series: vtctldclient
commit: 14b6873142558358a99a68d2b5ef0ec204f3776a
commit: 76350bd01072921484303a16e9879f69d907f6f3
---
## vtctldclient GetShard

Expand Down
Loading

0 comments on commit 69f710c

Please sign in to comment.