Skip to content

Commit

Permalink
Document changes from vitessio/vitess#16906 (#1866)
Browse files Browse the repository at this point in the history
* Document changes from vitessio/vitess#16906

Signed-off-by: Matt Lord <[email protected]>

* Bring v22 docs up-to-date with main after PR merged

Signed-off-by: Matt Lord <[email protected]>

* Add two new files

Signed-off-by: Matt Lord <[email protected]>

* Update v21 docs as well

Signed-off-by: Matt Lord <[email protected]>

---------

Signed-off-by: Matt Lord <[email protected]>
  • Loading branch information
mattlord authored Oct 24, 2024
1 parent 89af9aa commit ad92a7c
Show file tree
Hide file tree
Showing 320 changed files with 485 additions and 326 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtctldclient
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AddCellInfo
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient AddCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AddCellsAlias
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient AddCellsAlias

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyKeyspaceRoutingRules
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient ApplyKeyspaceRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyRoutingRules
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient ApplyRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplySchema
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient ApplySchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyShardRoutingRules
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient ApplyShardRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyVSchema
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient ApplyVSchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Backup
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient Backup

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: BackupShard
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient BackupShard

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: ChangeTabletTags
series: vtctldclient
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient ChangeTabletTags

Changes the tablet tags for the specified tablet, if possible.

### Synopsis

Changes the tablet tags for the specified tablet, if possible.

Tags must be specified as key=value pairs.

```
vtctldclient ChangeTabletTags <alias> <tablet-tag> [ <tablet-tag> ... ]
```

### Options

```
-h, --help help for ChangeTabletTags
-r, --replace Replace all tablet tags with the tags provided. By default tags are merged/updated.
```

### Options inherited from parent commands

```
--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)
--topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global")
--topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379])
--topo-implementation string the topology implementation to use (default "etcd2")
```

### SEE ALSO

* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ChangeTabletType
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient ChangeTabletType

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CheckThrottler
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient CheckThrottler

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CreateKeyspace
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient CreateKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CreateShard
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient CreateShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteCellInfo
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient DeleteCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteCellsAlias
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient DeleteCellsAlias

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteKeyspace
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient DeleteKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteShards
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient DeleteShards

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteSrvVSchema
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient DeleteSrvVSchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteTablets
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient DeleteTablets

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DistributedTransaction
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient DistributedTransaction

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DistributedTransaction conclude
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient DistributedTransaction conclude

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: DistributedTransaction unresolved-list
series: vtctldclient
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient DistributedTransaction unresolved-list

Retrieves unresolved transactions for the given keyspace.

```
vtctldclient DistributedTransaction unresolved-list --keyspace <keyspace> --abandon-age <abandon_time_seconds>
```

### Options

```
-a, --abandon-age int unresolved transactions list which are older than the specified age(in seconds).
-h, --help help for unresolved-list
-k, --keyspace string unresolved transactions list for the given keyspace.
```

### Options inherited from parent commands

```
--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)
--topo-global-root string the path of the global topology data in the global topology server (default "/vitess/global")
--topo-global-server-address strings the address of the global topology server(s) (default [localhost:2379])
--topo-implementation string the topology implementation to use (default "etcd2")
```

### SEE ALSO

* [vtctldclient DistributedTransaction](../) - Perform commands on distributed transaction

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: EmergencyReparentShard
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient EmergencyReparentShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteFetchAsApp
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient ExecuteFetchAsApp

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteFetchAsDBA
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient ExecuteFetchAsDBA

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteHook
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient ExecuteHook

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteMultiFetchAsDBA
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient ExecuteMultiFetchAsDBA

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: FindAllShardsInKeyspace
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient FindAllShardsInKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GenerateShardRanges
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient GenerateShardRanges

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetBackups
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient GetBackups

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellInfo
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient GetCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellInfoNames
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient GetCellInfoNames

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellsAliases
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient GetCellsAliases

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetFullStatus
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient GetFullStatus

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetKeyspace
series: vtctldclient
commit: 376c478ce7daca627d063f22af9121e173787e31
commit: 477bb22995e2e6a6dbaf9b45cc8259c017cb95db
---
## vtctldclient GetKeyspace

Expand Down
Loading

0 comments on commit ad92a7c

Please sign in to comment.