Skip to content

Commit

Permalink
Update docs for vitessio/vitess#17442
Browse files Browse the repository at this point in the history
Signed-off-by: Matt Lord <[email protected]>
  • Loading branch information
mattlord committed Jan 3, 2025
1 parent 9e7d730 commit 3305b4b
Show file tree
Hide file tree
Showing 167 changed files with 186 additions and 170 deletions.
10 changes: 7 additions & 3 deletions content/en/docs/22.0/reference/programs/vtctldclient/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: vtctldclient
series: vtctldclient
commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
---
## vtctldclient

Expand Down Expand Up @@ -45,6 +44,7 @@ vtctldclient [flags]
* [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 CopySchemaShard](./vtctldclient_copyschemashard/) - Copies the schema from a source shard's primary (or a specific tablet) to a destination shard. The schema is applied directly on the primary of the destination shard, and it is propagated to the replicas through binlogs.
* [vtctldclient CreateKeyspace](./vtctldclient_createkeyspace/) - Creates the specified keyspace in the topology.
* [vtctldclient CreateShard](./vtctldclient_createshard/) - Creates the specified shard in the topology.
* [vtctldclient DeleteCellInfo](./vtctldclient_deletecellinfo/) - Deletes the CellInfo for the provided cell.
Expand Down Expand Up @@ -128,9 +128,13 @@ vtctldclient [flags]
* [vtctldclient VDiff](./vtctldclient_vdiff/) - Perform commands related to diffing tables involved in a VReplication workflow between the source and target.
* [vtctldclient Validate](./vtctldclient_validate/) - Validates that all nodes reachable from the global replication graph, as well as all tablets in discoverable cells, are consistent.
* [vtctldclient ValidateKeyspace](./vtctldclient_validatekeyspace/) - Validates that all nodes reachable from the specified keyspace are consistent.
* [vtctldclient ValidateSchemaKeyspace](./vtctldclient_validateschemakeyspace/) - Validates that the schema on the primary tablet for shard 0 matches the schema on all other tablets in the keyspace.
* [vtctldclient ValidatePermissionsKeyspace](./vtctldclient_validatepermissionskeyspace/) - Validates that the permissions on primary of the first shard match those of all of the other tablets in the keyspace.
* [vtctldclient ValidatePermissionsShard](./vtctldclient_validatepermissionsshard/) - Validates that the permissions on primary match all the replicas.
* [vtctldclient ValidateSchemaKeyspace](./vtctldclient_validateschemakeyspace/) - Validates that the schema on the primary tablet for the first shard matches the schema on all other tablets in the keyspace.
* [vtctldclient ValidateSchemaShard](./vtctldclient_validateschemashard/) - Validates that the schema on the primary tablet for the specified shard matches the schema on all other tablets in that shard.
* [vtctldclient ValidateShard](./vtctldclient_validateshard/) - Validates that all nodes reachable from the specified shard are consistent.
* [vtctldclient ValidateVersionKeyspace](./vtctldclient_validateversionkeyspace/) - Validates that the version on the primary tablet of shard 0 matches all of the other tablets in the keyspace.
* [vtctldclient ValidateVersionKeyspace](./vtctldclient_validateversionkeyspace/) - Validates that the version on the primary tablet of the first shard matches all of the other tablets in the keyspace.
* [vtctldclient ValidateVersionShard](./vtctldclient_validateversionshard/) - Validates that the version on the primary matches all of the replicas.
* [vtctldclient Workflow](./vtctldclient_workflow/) - Administer VReplication workflows (Reshard, MoveTables, etc) in the given keyspace.
* [vtctldclient WriteTopologyPath](./vtctldclient_writetopologypath/) - Copies a local file to the topology server at the given path.

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

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

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

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

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

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

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

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

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

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

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

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

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: CopySchemaShard
series: vtctldclient
---
## vtctldclient CopySchemaShard

Copies the schema from a source shard's primary (or a specific tablet) to a destination shard. The schema is applied directly on the primary of the destination shard, and it is propagated to the replicas through binlogs.

```
vtctldclient CopySchemaShard [--tables=<table1>,<table2>,...] [--exclude-tables=<table1>,<table2>,...] [--include-views] [--skip-verify] [--wait-replicas-timeout=10s] {<source keyspace/shard> || <source tablet alias>} <destination keyspace/shard>
```

### Options

```
--exclude-tables strings Specifies a comma-separated list of tables to exclude. Each is either an exact match, or a regular expression of the form /regexp/
-h, --help help for CopySchemaShard
--include-views Includes views in the output (default true)
--skip-verify Skip verification of source and target schema after copy
--tables strings Specifies a comma-separated list of tables to copy. Each is either an exact match, or a regular expression of the form /regexp/
--wait-replicas-timeout duration The amount of time to wait for replicas to receive the schema change via replication. (default 10s)
```

### 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,6 @@
---
title: CreateKeyspace
series: vtctldclient
commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
---
## vtctldclient CreateKeyspace

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

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

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

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

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

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

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

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: DistributedTransaction conclude
series: vtctldclient
commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
---
## vtctldclient DistributedTransaction conclude

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: DistributedTransaction get-info
series: vtctldclient
commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
---
## vtctldclient DistributedTransaction get-info

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: DistributedTransaction unresolved-list
series: vtctldclient
commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27
---
## vtctldclient DistributedTransaction unresolved-list

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Expand Down
Loading

0 comments on commit 3305b4b

Please sign in to comment.