Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update v20 vtctldclient docs based on main #1720

Merged
merged 2 commits into from
Apr 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ check-all-links: clean build link-checker-setup
bin/htmltest --conf .htmltest.external.yml

ifndef COBRADOC_VERSION_PAIRS
export COBRADOC_VERSION_PAIRS="main:20.0,v19.0.1:19.0,v18.0.3:18.0,v17.0.6:17.0"
export COBRADOC_VERSION_PAIRS="main:20.0,v19.0.3:19.0,v18.0.4:18.0,v17.0.6:17.0"
endif

generated-docs: mysqlctl-docs \
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vtctldclient
series: vtctldclient
commit: fdabcfb130ec3ca15b23c278a0f20802bcd05756
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
---
## vtctldclient

Expand Down Expand Up @@ -35,6 +35,7 @@ vtctldclient [flags]

* [vtctldclient AddCellInfo](./vtctldclient_addcellinfo/) - Registers a local topology service in a new cell by creating the CellInfo.
* [vtctldclient AddCellsAlias](./vtctldclient_addcellsalias/) - Defines a group of cells that can be referenced by a single name (the alias).
* [vtctldclient ApplyKeyspaceRoutingRules](./vtctldclient_applykeyspaceroutingrules/) - Applies the provided keyspace routing rules.
* [vtctldclient ApplyRoutingRules](./vtctldclient_applyroutingrules/) - Applies the VSchema routing rules.
* [vtctldclient ApplySchema](./vtctldclient_applyschema/) - Applies the schema change to the specified keyspace on every primary, running in parallel on all shards. The changes are then propagated to replicas via replication.
* [vtctldclient ApplyShardRoutingRules](./vtctldclient_applyshardroutingrules/) - Applies the provided shard routing rules.
Expand Down Expand Up @@ -63,11 +64,13 @@ vtctldclient [flags]
* [vtctldclient GetCellsAliases](./vtctldclient_getcellsaliases/) - Gets all CellsAlias objects in the cluster.
* [vtctldclient GetFullStatus](./vtctldclient_getfullstatus/) - Outputs a JSON structure that contains full status of MySQL including the replication information, semi-sync information, GTID information among others.
* [vtctldclient GetKeyspace](./vtctldclient_getkeyspace/) - Returns information about the given keyspace from the topology.
* [vtctldclient GetKeyspaceRoutingRules](./vtctldclient_getkeyspaceroutingrules/) - Displays the currently active keyspace routing rules.
* [vtctldclient GetKeyspaces](./vtctldclient_getkeyspaces/) - Returns information about every keyspace in the topology.
* [vtctldclient GetPermissions](./vtctldclient_getpermissions/) - Displays the permissions for a tablet.
* [vtctldclient GetRoutingRules](./vtctldclient_getroutingrules/) - Displays the VSchema routing rules.
* [vtctldclient GetSchema](./vtctldclient_getschema/) - Displays the full schema for a tablet, optionally restricted to the specified tables/views.
* [vtctldclient GetShard](./vtctldclient_getshard/) - Returns information about a shard in the topology.
* [vtctldclient GetShardReplication](./vtctldclient_getshardreplication/) - Returns information about the replication relationships for a shard in the given cell(s).
* [vtctldclient GetShardRoutingRules](./vtctldclient_getshardroutingrules/) - Displays the currently active shard routing rules as a JSON document.
* [vtctldclient GetSrvKeyspaceNames](./vtctldclient_getsrvkeyspacenames/) - Outputs a JSON mapping of cell=>keyspace names served in that cell. Omit to query all cells.
* [vtctldclient GetSrvKeyspaces](./vtctldclient_getsrvkeyspaces/) - Returns the SrvKeyspaces for the given keyspace in one or more cells.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: AddCellInfo
series: vtctldclient
commit: 3b906cf6a3cedd9d216eaee4e162025d408beee9
commit: 6cd09cce61fa79a1b7aacb36886b7dc44ae82a94
---
## vtctldclient AddCellInfo

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Expand Down
Loading