Skip to content

Commit

Permalink
Rebuild docs base on main
Browse files Browse the repository at this point in the history
Signed-off-by: Matt Lord <[email protected]>
  • Loading branch information
mattlord committed Sep 17, 2024
1 parent b428886 commit 6707b8c
Show file tree
Hide file tree
Showing 159 changed files with 257 additions and 157 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtctldclient
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient

Expand Down Expand Up @@ -52,6 +52,7 @@ vtctldclient [flags]
* [vtctldclient DeleteShards](./vtctldclient_deleteshards/) - Deletes the specified shards from the topology.
* [vtctldclient DeleteSrvVSchema](./vtctldclient_deletesrvvschema/) - Deletes the SrvVSchema object in the given cell.
* [vtctldclient DeleteTablets](./vtctldclient_deletetablets/) - Deletes tablet(s) from the topology.
* [vtctldclient DistributedTransaction](./vtctldclient_distributedtransaction/) - Perform commands on distributed transaction
* [vtctldclient EmergencyReparentShard](./vtctldclient_emergencyreparentshard/) - Reparents the shard to the new primary. Assumes the old primary is dead and not responding.
* [vtctldclient ExecuteFetchAsApp](./vtctldclient_executefetchasapp/) - Executes the given query as the App user on the remote tablet.
* [vtctldclient ExecuteFetchAsDBA](./vtctldclient_executefetchasdba/) - Executes the given query as the DBA user on the remote tablet.
Expand Down Expand Up @@ -83,7 +84,6 @@ vtctldclient [flags]
* [vtctldclient GetTablets](./vtctldclient_gettablets/) - Looks up tablets according to filter criteria.
* [vtctldclient GetThrottlerStatus](./vtctldclient_getthrottlerstatus/) - Get the throttler status for the given tablet.
* [vtctldclient GetTopologyPath](./vtctldclient_gettopologypath/) - Gets the value associated with the particular path (key) in the topology server.
* [vtctldclient GetUnresolvedTransactions](./vtctldclient_getunresolvedtransactions/) - Retrieves unresolved transactions for the given keyspace.
* [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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AddCellInfo
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient AddCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AddCellsAlias
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient AddCellsAlias

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyKeyspaceRoutingRules
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient ApplyKeyspaceRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyRoutingRules
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient ApplyRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplySchema
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient ApplySchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyShardRoutingRules
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient ApplyShardRoutingRules

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ApplyVSchema
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient ApplyVSchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Backup
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient Backup

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: BackupShard
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient BackupShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ChangeTabletType
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient ChangeTabletType

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CheckThrottler
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient CheckThrottler

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CreateKeyspace
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient CreateKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: CreateShard
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient CreateShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteCellInfo
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient DeleteCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteCellsAlias
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient DeleteCellsAlias

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteKeyspace
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient DeleteKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteShards
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient DeleteShards

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteSrvVSchema
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient DeleteSrvVSchema

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: DeleteTablets
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient DeleteTablets

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: DistributedTransaction
series: vtctldclient
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient DistributedTransaction

Perform commands on distributed transaction

### Options

```
-h, --help help for DistributedTransaction
```

### 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.
* [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.

Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: DistributedTransaction conclude
series: vtctldclient
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## 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> ...]
```

### Options

```
-h, --help help for conclude
```

### 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
@@ -0,0 +1,34 @@
---
title: DistributedTransaction list
series: vtctldclient
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient DistributedTransaction list

Retrieves unresolved transactions for the given keyspace.

```
vtctldclient DistributedTransaction list <keyspace>
```

### Options

```
-h, --help help for list
```

### 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: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient EmergencyReparentShard

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteFetchAsApp
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient ExecuteFetchAsApp

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteFetchAsDBA
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient ExecuteFetchAsDBA

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteHook
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient ExecuteHook

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: ExecuteMultiFetchAsDBA
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient ExecuteMultiFetchAsDBA

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: FindAllShardsInKeyspace
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient FindAllShardsInKeyspace

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GenerateShardRanges
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient GenerateShardRanges

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetBackups
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient GetBackups

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellInfo
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient GetCellInfo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellInfoNames
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient GetCellInfoNames

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GetCellsAliases
series: vtctldclient
commit: f52a0b141fd20db5af050f5d0e2d8724597b60c0
commit: 069651aed3c06088dc00f8f699a276665056e3d0
---
## vtctldclient GetCellsAliases

Expand Down
Loading

0 comments on commit 6707b8c

Please sign in to comment.