From feb82faaed7ddc03ebdde0b4946c4476048f0a9d Mon Sep 17 00:00:00 2001 From: Matt Lord Date: Tue, 11 Feb 2025 11:07:41 -0500 Subject: [PATCH] Update docs for https://github.com/vitessio/vitess/pull/17442 (#1912) * Update docs for https://github.com/vitessio/vitess/pull/17442 Signed-off-by: Matt Lord * CopySchemaShard is now the same so no need to mention it Signed-off-by: Matt Lord * Remove vtctl binary docs and update vtctl concept page Signed-off-by: Matt Lord * Improve text Signed-off-by: Matt Lord * Update vtctl concept page Signed-off-by: Matt Lord * Update generated docs from main Signed-off-by: Matt Lord --------- Signed-off-by: Matt Lord --- content/en/docs/22.0/concepts/vtctl.md | 12 +- .../22.0/reference/programs/vtctl/_index.md | 268 ---------- .../reference/programs/vtctl/cell-aliases.md | 80 --- .../22.0/reference/programs/vtctl/cells.md | 114 ----- .../22.0/reference/programs/vtctl/generic.md | 91 ---- .../reference/programs/vtctl/keyspaces.md | 388 --------------- .../programs/vtctl/replication-graph.md | 30 -- .../vtctl/schema-version-permissions.md | 384 -------------- .../reference/programs/vtctl/serving-graph.md | 70 --- .../22.0/reference/programs/vtctl/shards.md | 467 ------------------ .../22.0/reference/programs/vtctl/tablets.md | 437 ---------------- .../reference/programs/vtctl/throttler.md | 52 -- .../22.0/reference/programs/vtctl/topo.md | 69 --- .../reference/programs/vtctldclient/_index.md | 14 +- .../vtctldclient/vtctldclient_AddCellInfo.md | 3 +- .../vtctldclient_AddCellsAlias.md | 3 +- .../vtctldclient_ApplyKeyspaceRoutingRules.md | 3 +- .../vtctldclient_ApplyRoutingRules.md | 3 +- .../vtctldclient/vtctldclient_ApplySchema.md | 7 +- .../vtctldclient_ApplyShardRoutingRules.md | 3 +- .../vtctldclient/vtctldclient_ApplyVSchema.md | 3 +- .../vtctldclient/vtctldclient_Backup.md | 3 +- .../vtctldclient/vtctldclient_BackupShard.md | 3 +- .../vtctldclient_ChangeTabletTags.md | 3 +- .../vtctldclient_ChangeTabletType.md | 3 +- .../vtctldclient_CheckThrottler.md | 3 +- .../vtctldclient_CopySchemaShard.md | 38 ++ .../vtctldclient_CreateKeyspace.md | 3 +- .../vtctldclient/vtctldclient_CreateShard.md | 3 +- .../vtctldclient_DeleteCellInfo.md | 3 +- .../vtctldclient_DeleteCellsAlias.md | 3 +- .../vtctldclient_DeleteKeyspace.md | 3 +- .../vtctldclient/vtctldclient_DeleteShards.md | 3 +- .../vtctldclient_DeleteSrvVSchema.md | 3 +- .../vtctldclient_DeleteTablets.md | 3 +- .../_index.md | 3 +- ...dclient_DistributedTransaction_conclude.md | 1 - ...dclient_DistributedTransaction_get-info.md | 1 - ..._DistributedTransaction_unresolved-list.md | 1 - .../vtctldclient_EmergencyReparentShard.md | 3 +- .../vtctldclient_ExecuteFetchAsApp.md | 3 +- .../vtctldclient_ExecuteFetchAsDBA.md | 3 +- .../vtctldclient/vtctldclient_ExecuteHook.md | 3 +- .../vtctldclient_ExecuteMultiFetchAsDBA.md | 3 +- .../vtctldclient_FindAllShardsInKeyspace.md | 3 +- .../vtctldclient_GenerateShardRanges.md | 3 +- .../vtctldclient/vtctldclient_GetBackups.md | 3 +- .../vtctldclient/vtctldclient_GetCellInfo.md | 3 +- .../vtctldclient_GetCellInfoNames.md | 3 +- .../vtctldclient_GetCellsAliases.md | 3 +- .../vtctldclient_GetFullStatus.md | 3 +- .../vtctldclient/vtctldclient_GetKeyspace.md | 3 +- .../vtctldclient_GetKeyspaceRoutingRules.md | 3 +- .../vtctldclient/vtctldclient_GetKeyspaces.md | 3 +- .../vtctldclient_GetMirrorRules.md | 3 +- .../vtctldclient_GetPermissions.md | 3 +- .../vtctldclient_GetRoutingRules.md | 3 +- .../vtctldclient/vtctldclient_GetSchema.md | 3 +- .../vtctldclient/vtctldclient_GetShard.md | 3 +- .../vtctldclient_GetShardReplication.md | 3 +- .../vtctldclient_GetShardRoutingRules.md | 3 +- .../vtctldclient_GetSrvKeyspaceNames.md | 3 +- .../vtctldclient_GetSrvKeyspaces.md | 3 +- .../vtctldclient_GetSrvVSchema.md | 3 +- .../vtctldclient_GetSrvVSchemas.md | 3 +- .../vtctldclient/vtctldclient_GetTablet.md | 3 +- .../vtctldclient_GetTabletVersion.md | 3 +- .../vtctldclient/vtctldclient_GetTablets.md | 3 +- .../vtctldclient_GetThrottlerStatus.md | 3 +- .../vtctldclient_GetTopologyPath.md | 3 +- .../vtctldclient/vtctldclient_GetVSchema.md | 3 +- .../vtctldclient/vtctldclient_GetWorkflows.md | 3 +- .../vtctldclient_LegacyVtctlCommand.md | 3 +- .../vtctldclient_LookupVindex/_index.md | 7 +- .../vtctldclient_LookupVindex_cancel.md | 1 - .../vtctldclient_LookupVindex_complete.md | 42 ++ .../vtctldclient_LookupVindex_create.md | 1 - .../vtctldclient_LookupVindex_externalize.md | 4 +- .../vtctldclient_LookupVindex_internalize.md | 42 ++ .../vtctldclient_LookupVindex_show.md | 1 - .../vtctldclient_Materialize/_index.md | 3 +- .../vtctldclient_Materialize_cancel.md | 1 - .../vtctldclient_Materialize_create.md | 7 +- .../vtctldclient_Materialize_show.md | 1 - .../vtctldclient_Materialize_start.md | 1 - .../vtctldclient_Materialize_stop.md | 1 - .../vtctldclient_Migrate/_index.md | 3 +- .../vtctldclient_Migrate_cancel.md | 1 - .../vtctldclient_Migrate_complete.md | 1 - .../vtctldclient_Migrate_create.md | 1 - .../vtctldclient_Migrate_show.md | 1 - .../vtctldclient_Migrate_status.md | 1 - .../vtctldclient/vtctldclient_Mount/_index.md | 3 +- .../vtctldclient_Mount_list.md | 1 - .../vtctldclient_Mount_register.md | 1 - .../vtctldclient_Mount_show.md | 1 - .../vtctldclient_Mount_unregister.md | 1 - .../vtctldclient_MoveTables/_index.md | 3 +- .../vtctldclient_MoveTables_cancel.md | 1 - .../vtctldclient_MoveTables_complete.md | 1 - .../vtctldclient_MoveTables_create.md | 1 - .../vtctldclient_MoveTables_mirrortraffic.md | 1 - .../vtctldclient_MoveTables_reversetraffic.md | 1 - .../vtctldclient_MoveTables_show.md | 1 - .../vtctldclient_MoveTables_start.md | 1 - .../vtctldclient_MoveTables_status.md | 1 - .../vtctldclient_MoveTables_stop.md | 1 - .../vtctldclient_MoveTables_switchtraffic.md | 1 - .../vtctldclient_OnlineDDL/_index.md | 3 +- .../vtctldclient_OnlineDDL_cancel.md | 1 - .../vtctldclient_OnlineDDL_cleanup.md | 1 - .../vtctldclient_OnlineDDL_complete.md | 1 - .../vtctldclient_OnlineDDL_force-cutover.md | 1 - .../vtctldclient_OnlineDDL_launch.md | 1 - .../vtctldclient_OnlineDDL_retry.md | 1 - .../vtctldclient_OnlineDDL_show.md | 1 - .../vtctldclient_OnlineDDL_throttle.md | 1 - .../vtctldclient_OnlineDDL_unthrottle.md | 1 - .../vtctldclient/vtctldclient_PingTablet.md | 3 +- .../vtctldclient_PlannedReparentShard.md | 3 +- .../vtctldclient_RebuildKeyspaceGraph.md | 3 +- .../vtctldclient_RebuildVSchemaGraph.md | 3 +- .../vtctldclient/vtctldclient_RefreshState.md | 3 +- .../vtctldclient_RefreshStateByShard.md | 3 +- .../vtctldclient/vtctldclient_ReloadSchema.md | 3 +- .../vtctldclient_ReloadSchemaKeyspace.md | 3 +- .../vtctldclient_ReloadSchemaShard.md | 3 +- .../vtctldclient/vtctldclient_RemoveBackup.md | 3 +- .../vtctldclient_RemoveKeyspaceCell.md | 3 +- .../vtctldclient_RemoveShardCell.md | 3 +- .../vtctldclient_ReparentTablet.md | 3 +- .../vtctldclient_Reshard/_index.md | 3 +- .../vtctldclient_Reshard_cancel.md | 1 - .../vtctldclient_Reshard_complete.md | 1 - .../vtctldclient_Reshard_create.md | 1 - .../vtctldclient_Reshard_reversetraffic.md | 1 - .../vtctldclient_Reshard_show.md | 1 - .../vtctldclient_Reshard_start.md | 1 - .../vtctldclient_Reshard_status.md | 1 - .../vtctldclient_Reshard_stop.md | 1 - .../vtctldclient_Reshard_switchtraffic.md | 1 - .../vtctldclient_RestoreFromBackup.md | 3 +- .../vtctldclient_RunHealthCheck.md | 3 +- ...tctldclient_SetKeyspaceDurabilityPolicy.md | 3 +- .../vtctldclient_SetShardIsPrimaryServing.md | 3 +- .../vtctldclient_SetShardTabletControl.md | 3 +- .../vtctldclient/vtctldclient_SetWritable.md | 3 +- .../vtctldclient_ShardReplicationFix.md | 3 +- .../vtctldclient_ShardReplicationPositions.md | 3 +- .../vtctldclient/vtctldclient_SleepTablet.md | 3 +- .../vtctldclient_SourceShardAdd.md | 3 +- .../vtctldclient_SourceShardDelete.md | 3 +- .../vtctldclient_StartReplication.md | 3 +- .../vtctldclient_StopReplication.md | 3 +- ...vtctldclient_TabletExternallyReparented.md | 3 +- .../vtctldclient_UpdateCellInfo.md | 3 +- .../vtctldclient_UpdateCellsAlias.md | 3 +- .../vtctldclient_UpdateThrottlerConfig.md | 3 +- .../vtctldclient/vtctldclient_VDiff/_index.md | 3 +- .../vtctldclient_VDiff_create.md | 1 - .../vtctldclient_VDiff_delete.md | 1 - .../vtctldclient_VDiff_resume.md | 1 - .../vtctldclient_VDiff_show.md | 1 - .../vtctldclient_VDiff_stop.md | 1 - .../vtctldclient/vtctldclient_Validate.md | 3 +- .../vtctldclient_ValidateKeyspace.md | 3 +- ...tctldclient_ValidatePermissionsKeyspace.md | 33 ++ .../vtctldclient_ValidatePermissionsShard.md | 33 ++ .../vtctldclient_ValidateSchemaKeyspace.md | 5 +- .../vtctldclient_ValidateSchemaShard.md | 37 ++ .../vtctldclient_ValidateShard.md | 3 +- .../vtctldclient_ValidateVersionKeyspace.md | 5 +- .../vtctldclient_ValidateVersionShard.md | 3 +- .../vtctldclient_Workflow/_index.md | 3 +- .../vtctldclient_Workflow_delete.md | 1 - .../vtctldclient_Workflow_list.md | 1 - .../vtctldclient_Workflow_show.md | 1 - .../vtctldclient_Workflow_start.md | 1 - .../vtctldclient_Workflow_stop.md | 1 - .../vtctldclient_Workflow_update.md | 1 - .../vtctldclient_WriteTopologyPath.md | 34 ++ .../vtctldclient-transition/command_diff.md | 6 +- 182 files changed, 390 insertions(+), 2732 deletions(-) delete mode 100644 content/en/docs/22.0/reference/programs/vtctl/_index.md delete mode 100644 content/en/docs/22.0/reference/programs/vtctl/cell-aliases.md delete mode 100644 content/en/docs/22.0/reference/programs/vtctl/cells.md delete mode 100644 content/en/docs/22.0/reference/programs/vtctl/generic.md delete mode 100644 content/en/docs/22.0/reference/programs/vtctl/keyspaces.md delete mode 100644 content/en/docs/22.0/reference/programs/vtctl/replication-graph.md delete mode 100644 content/en/docs/22.0/reference/programs/vtctl/schema-version-permissions.md delete mode 100644 content/en/docs/22.0/reference/programs/vtctl/serving-graph.md delete mode 100644 content/en/docs/22.0/reference/programs/vtctl/shards.md delete mode 100644 content/en/docs/22.0/reference/programs/vtctl/tablets.md delete mode 100644 content/en/docs/22.0/reference/programs/vtctl/throttler.md delete mode 100644 content/en/docs/22.0/reference/programs/vtctl/topo.md create mode 100644 content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CopySchemaShard.md create mode 100644 content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_complete.md create mode 100644 content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_internalize.md create mode 100644 content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidatePermissionsKeyspace.md create mode 100644 content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidatePermissionsShard.md create mode 100644 content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateSchemaShard.md create mode 100644 content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_WriteTopologyPath.md diff --git a/content/en/docs/22.0/concepts/vtctl.md b/content/en/docs/22.0/concepts/vtctl.md index 339ac96aa..a085c5392 100644 --- a/content/en/docs/22.0/concepts/vtctl.md +++ b/content/en/docs/22.0/concepts/vtctl.md @@ -2,8 +2,14 @@ title: vtctl --- -**vtctl** is a command-line tool used to administer a Vitess cluster. It is available as both a standalone tool (`vtctl`) and client-server (`vtctldclient` in combination with `vtctld`). Using client-server is recommended, as it provides an additional layer of security when using the client remotely. +**vtctl** is the Vitess control system used to administer a Vitess cluster. It consists of a command-line client, [`vtctldclient`](../../reference/programs/vtctldclient/), that is used as both a standalone tool (`vtctldclient --server=internal`) +and more commonly in client-server mode with [`vtctldclient`](../../reference/programs/vtctldclient/) interacting with a [`vtctld`](../../reference/programs/vtctld/) server. Using client-server mode is recommended, as it provides an additional +layer of security when using the client remotely. -Using vtctl, you can identify primary and replica databases, create tables, initiate failovers, perform resharding operations, and so forth. +Using this you can identify primary and replica databases, create tables, initiate failovers, perform resharding operations, and so forth. -As vtctl performs operations, the Topology Service is updated as needed. Other Vitess servers observe those changes and react accordingly. For example, if you use vtctl to fail over to a new primary database, vtgate sees the change and directs future write operations to the new primary. +As operations are performed the [Topology Service](../topology-service/) is updated as needed. Other Vitess processes observe those changes and react accordingly. For example, if you use `vtctldclient` to fail over to a new primary database +using [`PlannedReparentShard`](../../reference/programs/vtctldclient/vtctldclient_plannedreparentshard/), [`vtgate`](../../reference/programs/vtgate/) sees the changes in the [Topology Service](../topology-service/) and directs future write +operations to the new primary. + +Please see the [reference documentation](../../reference/programs/vtctldclient/) for additional details. diff --git a/content/en/docs/22.0/reference/programs/vtctl/_index.md b/content/en/docs/22.0/reference/programs/vtctl/_index.md deleted file mode 100644 index b0c6fa494..000000000 --- a/content/en/docs/22.0/reference/programs/vtctl/_index.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -title: vtctl -description: vtctl Command Index -aliases: ['/docs/reference/vitess-api/','/docs/reference/vtctl/'] ---- - -`vtctl` is a command-line tool used to administer a Vitess cluster. It is available as both a standalone tool (`vtctl`) and client-server (`vtctlclient` in combination with `vtctld`). Using client-server is recommended, as it provides an additional layer of security when using the client remotely. - -Note that wherever `vtctl` commands produced master or MASTER for tablet type, they now produce primary or PRIMARY. Scripts and tools that depend on parsing command output will need to be updated. - -## Commands - -### Tablets - -| Name | Example Usage | -| :-------- | :--------------- | -| (DEPRECATED) [InitTablet](../vtctl/tablets#inittablet) DEPRECATED | `InitTablet -- [--allow_update] [--allow_different_shard] [--allow_master_override] [--parent] [--db_name_override=] [--hostname=] [--mysql_port=] [--port=] [--grpc_port=] [--tags=tag1:value1,tag2:value2] -keyspace= -shard= ` | -| [GetTablet](../vtctl/tablets#gettablet) | `GetTablet ` | -| (DEPRECATED) [UpdateTabletAddrs](../vtctl/tablets#updatetabletaddrs) DEPRECATED | `UpdateTabletAddrs -- [--hostname ] [--ip-addr ] [--mysql-port ] [--vt-port ] [--grpc-port ] ` | -| [DeleteTablet](../vtctl/tablets#deletetablet) | `DeleteTablet -- [--allow_primary=false] ...` | -| [SetReadOnly](../vtctl/tablets#setreadonly) | `SetReadOnly ` | -| [SetReadWrite](../vtctl/tablets#setreadwrite) | `SetReadWrite ` | -| [StartReplication](../vtctl/tablets#startreplication) | `StartReplication ` | -| [StopReplication](../vtctl/tablets#stopreplication) | `StopReplication ` | -| [ChangeTabletType](../vtctl/tablets#changetablettype) | `ChangeTabletType -- [--dry-run] ` | -| [Ping](../vtctl/tablets#ping) | `Ping ` | -| [RefreshState](../vtctl/tablets#refreshstate) | `RefreshState ` | -| [RefreshStateByShard](../vtctl/tablets#refreshstatebyshard) | `RefreshStateByShard -- [--cells=c1,c2,...] ` | -| [RunHealthCheck](../vtctl/tablets#runhealthcheck) | `RunHealthCheck ` | -| [Sleep](../vtctl/tablets#sleep) | `Sleep ` | -| [ExecuteHook](../vtctl/tablets#executehook) | `ExecuteHook [ ...]` | -| [ExecuteFetchAsApp](../vtctl/tablets#executefetchasapp) | `ExecuteFetchAsApp -- [--max_rows=10000] [--json] [--use_pool] ` | -| [ExecuteFetchAsDba](../vtctl/tablets#executefetchasdba) | `ExecuteFetchAsDba -- [--max_rows=10000] [--disable_binlogs] [--json] ` | -| [VReplicationExec](../vtctl/tablets#vreplicationexec) | `VReplicationExec -- [--json] ` | -| [Backup](../vtctl/tablets#backup) | `Backup -- [--concurrency=4] [--allow_primary=false] [--upgrade-safe=false] [--incremental-from-pos=] ` | -| [RestoreFromBackup](../vtctl/tablets#restorefrombackup) | `RestoreFromBackup ` | -| [ReparentTablet](../vtctl/tablets#reparenttablet) | `ReparentTablet ` | - -### Shards - -| Name | Example Usage | -| :-------- | :--------------- | -| [CreateShard](../vtctl/shards#createshard) | `CreateShard -- [--force] [--parent] ` | -| [GetShard](../vtctl/shards#getshard) | `GetShard ` | -| [ValidateShard](../vtctl/shards#validateshard) | `ValidateShard -- [--ping-tablets] ` | -| [ShardReplicationPositions](../vtctl/shards#shardreplicationpositions) | `ShardReplicationPositions ` | -| [ListShardTablets](../vtctl/shards#listshardtablets) | `ListShardTablets ` | -| [SetShardIsPrimaryServing](../vtctl/shards#setshardisprimaryserving) | `SetShardIsPrimaryServing ` | -| [SetShardTabletControl](../vtctl/shards#setshardtabletcontrol) | `SetShardTabletControl -- [--cells=c1,c2,...] [--denied_tables=t1,t2,...] [--remove] [--disable_query_service] ` | -| [UpdateSrvKeyspacePartition](../vtctl/shards#updatesrvkeyspacepartition)| `UpdateSrvKeyspacePartition -- [--cells=c1,c2,...] [--remove] ` | -| [SourceShardDelete](../vtctl/shards#sourcesharddelete) | `SourceShardDelete ` | -| [SourceShardAdd](../vtctl/shards#sourceshardadd) | `SourceShardAdd -- [--key_range=] [--tables=] ` | -| [ShardReplicationFix](../vtctl/shards#shardreplicationfix) | `ShardReplicationFix ` | -| [WaitForFilteredReplication](../vtctl/shards#waitforfilteredreplication) | `WaitForFilteredReplication -- [--max_delay ] ` | -| [RemoveShardCell](../vtctl/shards#removeshardcell) | `RemoveShardCell -- [--force] [--recursive] ` | -| [DeleteShard](../vtctl/shards#deleteshard) | `DeleteShard -- [--recursive] [--even_if_serving] ...` | -| [ListBackups](../vtctl/shards#listbackups) | `ListBackups ` | -| [BackupShard](../vtctl/shards#backupshard) | `BackupShard -- [--allow_primary=false] [--upgrade-safe=false] ` [--incremental_from_pos=] | -| [RemoveBackup](../vtctl/shards#removebackup) | `RemoveBackup ` | -| (DEPRECATED) [InitShardPrimary](../vtctl/shards#initshardprimary) | `InitShardPrimary -- [--force] [--wait_replicas_timeout=] ` | -| [PlannedReparentShard](../vtctl/shards#plannedreparentshard) | `PlannedReparentShard -- --keyspace_shard= [--new_primary=] [--avoid_tablet=] [--wait_replicas_timeout=]` | -| [EmergencyReparentShard](../vtctl/shards#emergencyreparentshard) | `EmergencyReparentShard -- --keyspace_shard= [--new_primary=] [--wait_replicas_timeout=] [--ignore_replicas=] [--prevent_cross_cell_promotion=]` -| [TabletExternallyReparented](../vtctl/shards#tabletexternallyreparented) | `TabletExternallyReparented ` | -| [GenerateShardRanges](../vtctl/shards#generateshardranges) | `GenerateShardRanges ` | - -### Keyspaces - -| Name | Example Usage | -| :-------- | :--------------- | -| [CreateKeyspace](../vtctl/keyspaces#createkeyspace) | `CreateKeyspace -- [--sharding_column_name=name] [--sharding_column_type=type] [--served_from=tablettype1:ks1,tablettype2:ks2,...] [--force] [--keyspace_type=type] [--base_keyspace=base_keyspace] [--snapshot_time=time] [--durability-policy=policy_name] [--sidecar-db-name=db_name] ` | -| [DeleteKeyspace](../vtctl/keyspaces#deletekeyspace) | `DeleteKeyspace -- [--recursive] ` | -| [RemoveKeyspaceCell](../vtctl/keyspaces#removekeyspacecell) | `RemoveKeyspaceCell -- [--force] [--recursive] ` | -| [GetKeyspace](../vtctl/keyspaces#getkeyspace) | `GetKeyspace ` | -| [GetKeyspaces](../vtctl/keyspaces#getkeyspaces) | `GetKeyspaces ` | -| [RebuildKeyspaceGraph](../vtctl/keyspaces#rebuildkeyspacegraph) | `RebuildKeyspaceGraph -- [--cells=c1,c2,...] ...` | -| [ValidateKeyspace](../vtctl/keyspaces#validatekeyspace) | `ValidateKeyspace -- [--ping-tablets] ` | -| [CreateLookupVindex](../vtctl/keyspaces#createlookupvindex) | `CreateLookupVindex -- [--cell=] [--tablet_types=] ` | -| [ExternalizeVindex](../vtctl/keyspaces#externalizevindex) | `ExternalizeVindex .` | -| [Materialize](../vtctl/keyspaces#materialize) | `Materialize , example : '{"workflow": "aaa", "source_keyspace": "source", "target_keyspace": "target", "table_settings": [{"target_table": "customer", "source_expression": "select * from customer", "create_ddl": "copy"}]}'` | -| [VDiff](../vtctl/keyspaces#vdiff) | `VDiff -- [--source_cell=] [--target_cell=] [--tablet_types=in_order:RDONLY,REPLICA,PRIMARY] [--limit=] [--tables=] [--format=json] [--auto-retry] [--verbose] [--max_extra_rows_to_compare=1000] [--filtered_replication_wait_time=30s] [--debug_query] [--only_pks] [--wait] [--wait-update-interval=1m] [] []` | -| [FindAllShardsInKeyspace](../vtctl/keyspaces#findallshardsinkeyspace) | `FindAllShardsInKeyspace ` | - -### Generic - -| Name | Example Usage | -| :-------- | :--------------- | -| [Validate](../vtctl/generic#validate) | `Validate -- [--ping-tablets]` | -| [ListAllTablets](../vtctl/generic#listalltablets) | `ListAllTablets -- [--keyspace=''] [--tablet_type=] [,,...]` | -| [ListTablets](../vtctl/generic#listtablets) | `ListTablets ...` | -| [Help](../vtctl/generic#help) | `Help [command name]` | - -### Schema, Version, Permissions - -| Name | Example Usage | -| :-------- | :--------------- | -| [GetSchema](../vtctl/schema-version-permissions#getschema) | `GetSchema -- [--tables=,,...] [--exclude_tables=,,...] [--include-views] ` | -| [ReloadSchema](../vtctl/schema-version-permissions#reloadschema) | `ReloadSchema ` | -| [ReloadSchemaShard](../vtctl/schema-version-permissions#reloadschemashard) | `ReloadSchemaShard -- [--concurrency=10] [--include_primary=false] ` | -| [ReloadSchemaKeyspace](../vtctl/schema-version-permissions#reloadschemakeyspace) | `ReloadSchemaKeyspace -- [--concurrency=10] [--include_primary=false] ` | -| [ValidateSchemaShard](../vtctl/schema-version-permissions#validateschemashard) | `ValidateSchemaShard -- [--exclude_tables=''] [--include-views] ` | -| [ValidateSchemaKeyspace](../vtctl/schema-version-permissions#validateschemakeyspace) | `ValidateSchemaKeyspace -- [--exclude_tables=''] [--include-views] ` | -| [ApplySchema](../vtctl/schema-version-permissions#applyschema) | `ApplySchema -- [--wait_replicas_timeout=10s] {--sql= \|\| --sql-file=} [--batch-size=100] ` | -| [CopySchemaShard](../vtctl/schema-version-permissions#copyschemashard) | `CopySchemaShard -- [--tables=,,...] [--exclude_tables=,,...] [--include-views] [--skip-verify] [--wait_replicas_timeout=10s] { \|\| } ` | -| [ValidateVersionShard](../vtctl/schema-version-permissions#validateversionshard) | `ValidateVersionShard ` | -| [ValidateVersionKeyspace](../vtctl/schema-version-permissions#validateversionkeyspace) | `ValidateVersionKeyspace ` | -| [GetPermissions](../vtctl/schema-version-permissions#getpermissions) | `GetPermissions ` | -| [ValidatePermissionsShard](../vtctl/schema-version-permissions#validatepermissionsshard) | `ValidatePermissionsShard ` | -| [ValidatePermissionsKeyspace](../vtctl/schema-version-permissions#validatepermissionskeyspace) | `ValidatePermissionsKeyspace ` | -| [GetVSchema](../vtctl/schema-version-permissions#getvschema) | `GetVSchema ` | -| [ApplyVSchema](../vtctl/schema-version-permissions#applyvschema) | `ApplyVSchema -- {--vschema= \|\| --vschema_file= \|\| --sql= \|\| --sql_file=} [--cells=c1,c2,...] [--skip_rebuild] [--dry-run] ` | -| [GetRoutingRules](../vtctl/schema-version-permissions#getroutingrules) | `GetRoutingRules ` | -| [ApplyRoutingRules](../vtctl/schema-version-permissions#applyroutingrules) | `ApplyRoutingRules -- {--rules= \|\| --rules_file=} [--cells=c1,c2,...] [--skip_rebuild] [--dry-run]` | -| [RebuildVSchemaGraph](../vtctl/schema-version-permissions#rebuildvschemagraph) | `RebuildVSchemaGraph -- [--cells=c1,c2,...]` | - -### Serving Graph - -| Name | Example Usage | -| :-------- | :--------------- | -| [GetSrvKeyspaceNames](../vtctl/serving-graph#getsrvkeyspacenames) | `GetSrvKeyspaceNames ` | -| [GetSrvKeyspace](../vtctl/serving-graph#getsrvkeyspace) | `GetSrvKeyspace ` | -| [GetSrvVSchema](../vtctl/serving-graph#getsrvvsvchema) | `GetSrvVSchema ` | -| [DeleteSrvVSchema](../vtctl/serving-graph#deletesrvvschema) | `DeleteSrvVSchema ` | - -### Replication Graph - -| Name | Example Usage | -| :-------- | :--------------- | -| [GetShardReplication](../vtctl/replication-graph#getshardreplication) | `GetShardReplication ` | - -### Cells - -| Name | Example Usage | -| :-------- | :--------------- | -| [AddCellInfo](../vtctl/cells#addcellinfo) | `AddCellInfo -- [--server_address ] [--root ] ` | -| [UpdateCellInfo](../vtctl/cells#updatecellinfo) | `UpdateCellInfo -- [--server_address ] [--root ] ` | -| [DeleteCellInfo](../vtctl/cells#deletecellinfo) | `DeleteCellInfo -- [--force] ` | -| [GetCellInfoNames](../vtctl/cells#getcellinfonames) | `GetCellInfoNames ` | -| [GetCellInfo](../vtctl/cells#getcellinfo) | `GetCellInfo ` | - -### CellsAliases - -| Name | Example Usage | -| :-------- | :--------------- | -| [AddCellsAlias](../vtctl/cell-aliases#addcellsalias) | `AddCellsAlias -- [--cells ] ` | -| [UpdateCellsAlias](../vtctl/cell-aliases#updatecellsalias) | `UpdateCellsAlias -- [--cells ] ` | -| [DeleteCellsAlias](../vtctl/cell-aliases#deletecellsalias) | `DeleteCellsAlias ` | -| [GetCellsAliases](../vtctl/cell-aliases#getcellsaliases) | `GetCellsAliases ` | - -### Topo - -| Name | Example Usage | -| :-------- | :--------------- | -| [TopoCat](../vtctl/topo#topocat) | `TopoCat -- [--cell ] [--decode_proto] [--decode_proto_json] [--long] [...]` | -| [TopoCp](../vtctl/topo#topocp) | `TopoCp -- [--cell ] [--to_topo] ` | - -### Throttler - -| Name | Example Usage | -| :-------- | :--------------- | -| [UpdateThrottlerConfig](../vtctl/throttler#updatethrottlerconfig) | `UpdateThrottlerConfig -- [--enable\|--disable] [--threshold=] [--custom-query=] [--check-as-check-self\|--check-as-check-shard] [--throttle-app|unthrottle-app=] [--throttle-app-ratio=] [--throttle-app-duration=] ` - -## Options - -The following global options apply to `vtctl`: - - -| Name | Type | Definition | -| :------------------------------------ | :--------- | :----------------------------------------------------------------------------------------- | -| --alsologtostderr | | log to standard error as well as files | -| --azblob_backup_account_key_file | string | Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path) | -| --azblob_backup_account_name | string | Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used | -| --azblob_backup_buffer_size | int | The memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service. (default 104857600) | -| --azblob_backup_container_name | string | Azure Blob Container Name | -| --azblob_backup_parallelism | int | Azure Blob operation parallelism (requires extra memory when increased -- a multiple of azblob_backup_buffer_size). (default 1) | -| --azblob_backup_storage_root | string | Root prefix for all backup-related Azure Blobs; this should exclude both initial and trailing '/' (e.g. just 'a/b' not '/a/b/') | -| --backup_engine_implementation | string | Specifies which implementation to use for creating new backups (builtin or xtrabackup). Restores will always be done with whichever engine created a given backup. (default "builtin") | -| --backup_storage_block_size | int | if backup_storage_compress is true, backup_storage_block_size sets the byte size for each block while compressing (default is 250000). (default 250000) | -| --backup_storage_compress | | if set, the backup files will be compressed (default is true). | -| --backup_storage_implementation | string | which implementation to use for the backup storage feature | -| --backup_storage_number_blocks | int | if backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, at once, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression (default 2) | -| --ceph_backup_storage_config | string | Path to JSON config file for ceph backup storage (default "ceph_backup_config.json") | -| --consul_auth_static_file | string | JSON File to read the topos/tokens from. | -| --datadog-agent-host | string | host to send spans to. if empty, no tracing will be done | -| --datadog-agent-port | string | port to send spans to. if empty, no tracing will be done | -| --detach | | detached mode - run vtcl detached from the terminal | -|-file_backup_storage_root | string | root directory for the file backup storage -- this path must be on shared storage to provide a global view of backups to all vitess components | -| --gcs_backup_storage_bucket | string | Google Cloud Storage bucket to use for backups | -| --gcs_backup_storage_root | string | root prefix for all backup-related object names | -| --grpc_auth_static_client_creds | string | when using grpc_static_auth in the server, this file provides the credentials to use to authenticate with server | -| --grpc_compression | string | how to compress gRPC, default: nothing, supported: snappy | -| --grpc_enable_tracing | | Enable GRPC tracing | -| --grpc_initial_conn_window_size | int | grpc initial connection window size | -| --grpc_initial_window_size | int | grpc initial window size | -| --grpc_keepalive_time | duration | After a duration of this time if the client doesn't see any activity it pings the server to see if the transport is still alive. (default 10s) | -| --grpc_keepalive_timeout | duration | After having pinged for keepalive check, the client waits for a duration of Timeout and if no activity is seen even after that the connection is closed. (default 10s) | -| --grpc_max_message_size | int | Maximum allowed RPC message size. Larger messages will be rejected by gRPC with the error 'exceeding the max size'. (default 16777216) | -| --grpc_prometheus | | Enable gRPC monitoring with Prometheus | -| --jaeger-agent-host | string | host and port to send spans to. if empty, no tracing will be done | -| --keep_logs | duration | keep logs for this long (using ctime) (zero to keep forever) | -| --keep_logs_by_mtime | duration | keep logs for this long (using mtime) (zero to keep forever) | -| --log_backtrace_at | value | when logging hits line file:N, emit a stack trace | -| --log_dir | string | If non-empty, write log files in this directory | -| --log_err_stacks | | log stack traces for errors | -| --log_rotate_max_size | uint | size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800) | -| --logtostderr | | log to standard error instead of files | -| --mysql_server_version | string | MySQL server version to advertise. | -| --pprof | strings | enable profiling | -| --purge_logs_interval | duration | how often try to remove old logs (default 1h0m0s) | -| --remote_operation_timeout | duration | time to wait for a remote operation (default 30s) | -| --s3_backup_aws_endpoint | string | endpoint of the S3 backend (region must be provided) | -| --s3_backup_aws_region | string | AWS region to use (default "us-east-1") | -| --s3_backup_aws_retries | int | AWS request retries (default -1) | -| --s3_backup_force_path_style | | force the s3 path style | -| --s3_backup_log_level | string | determine the S3 loglevel to use from LogOff, LogDebug, LogDebugWithSigning, LogDebugWithHTTPBody, LogDebugWithRequestRetries, LogDebugWithRequestErrors (default "LogOff") | -| --s3_backup_server_side_encryption | string | server-side encryption algorithm (e.g., AES256, aws:kms) | -| --s3_backup_storage_bucket | string | S3 bucket to use for backups | -| --s3_backup_storage_root | string | root prefix for all backup-related object names | -| --s3_backup_tls_skip_verify_cert | | skip the 'certificate is valid' check for SSL connections | -| --security_policy | string | the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only) | -| --service_map | value | comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice | -| --sql-max-length-errors | int | truncate queries in error logs to the given length (default unlimited) | -| --sql-max-length-ui | int | truncate queries in debug UIs to the given length (default 512) (default 512) | -| --stderrthreshold | value | logs at or above this threshold go to stderr (default 1) | -| --tablet_grpc_ca | string | the server ca to use to validate servers when connecting | -| --tablet_grpc_cert | string | the cert to use to connect | -| --tablet_grpc_crl | string | the server crl to use to validate server certificates when connecting | -| --tablet_grpc_key | string | the key to use to connect | -| --tablet_grpc_server_name | string | the server name to use to validate server certificate | -| --tablet_manager_grpc_ca | string | the server ca to use to validate servers when connecting | -| --tablet_manager_grpc_cert | string | the cert to use to connect | -| --tablet_manager_grpc_concurrency | int | concurrency to use to talk to a vttablet server for performance-sensitive RPCs (like ExecuteFetchAs{Dba,AllPrivs,App}) (default 8) | -| --tablet_manager_grpc_connpool_size | int | number of tablets to keep tmclient connections open to (default 100) | -| --tablet_manager_grpc_crl | string | the server crl to use to validate server certificates when connecting | -| --tablet_manager_grpc_key | string | the key to use to connect | -| --tablet_manager_grpc_server_name | string | the server name to use to validate server certificate | -| --tablet_manager_protocol | string | the protocol to use to talk to vttablet (default "grpc") | -| --tablet_protocol | string | how to talk to the vttablets (default "grpc") | -| --topo_consul_lock_session_ttl | string | TTL for consul session. | -| --topo_consul_watch_poll_duration | duration | time of the long poll for watch queries. (default 30s) | -| --topo_etcd_lease_ttl | int | Lease TTL for locks and leader election. The client will use KeepAlive to keep the lease going. (default 30) | -| --topo_etcd_tls_ca | string | path to the ca to use to validate the server cert when connecting to the etcd topo server | -| --topo_etcd_tls_cert | string | path to the client cert to use to connect to the etcd topo server, requires topo_etcd_tls_key, enables TLS | -| --topo_etcd_tls_key | string | path to the client key to use to connect to the etcd topo server, enables TLS | -| --topo_global_root | string | the path of the global topology data in the global topology server | -| --topo_global_server_address | string | the address of the global topology server | -| --topo_implementation | string | the topology implementation to use | -| --topo_zk_auth_file | string | auth to use when connecting to the zk topo server, file contents should be :, e.g., digest:user:pass | -| --topo_zk_base_timeout | duration | zk base timeout (see zk.Connect) (default 30s) | -| --topo_zk_max_concurrency | int | maximum number of pending requests to send to a Zookeeper server. (default 64) | -| --topo_zk_tls_ca | string | the server ca to use to validate servers when connecting to the zk topo server | -| --topo_zk_tls_cert | string | the cert to use to connect to the zk topo server, requires topo_zk_tls_key, enables TLS | -| --topo_zk_tls_key | string | the key to use to connect to the zk topo server, enables TLS | -| --tracer | string | tracing service to use (default "noop") | -| --tracing-enable-logging | | whether to enable logging in the tracing service | -| --tracing-sampling-rate | float | sampling rate for the probabilistic jaeger sampler (default 0.1) | -| --tracing-sampling-type | string | sampling strategy to use for | -| --v | value | log level for V logs | -| --version | | print binary version | -| --vmodule | value | comma-separated list of pattern=N settings for file-filtered logging | -| --vtctl_healthcheck_retry_delay | duration | delay before retrying a failed healthcheck (default 5s) | -| --vtctl_healthcheck_timeout | duration | the health check timeout period (default 1m0s) | -| --vtctl_healthcheck_topology_refresh | duration | refresh interval for re-reading the topology (default 30s) | -| --vtgate_grpc_ca | string | the server ca to use to validate servers when connecting | -| --vtgate_grpc_cert | string | the cert to use to connect | -| --vtgate_grpc_crl | string | the server crl to use to validate server certificates when connecting | -| --vtgate_grpc_key | string | the key to use to connect | -| --vtgate_grpc_server_name | string | the server name to use to validate server certificate | -| --wait-time | duration | time to wait on an action (default 24h0m0s) | diff --git a/content/en/docs/22.0/reference/programs/vtctl/cell-aliases.md b/content/en/docs/22.0/reference/programs/vtctl/cell-aliases.md deleted file mode 100644 index 74eef73b6..000000000 --- a/content/en/docs/22.0/reference/programs/vtctl/cell-aliases.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: vtctl Cell Aliases Command Reference -series: vtctl -docs_nav_title: Cell Aliases ---- - -The following `vtctl` commands are available for administering Cell Aliases. - -## Commands - -### AddCellsAlias - -Defines a group of cells within which replica/rdonly traffic can be routed across cells. By default, Vitess does not allow traffic between replicas that are part of different cells. Between cells that are not in the same group (alias), only primary traffic can be routed. - - -#### Example - -
AddCellsAlias -- [--cells <cell1,cell2,cell3>] <alias>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| cells | string | The list of cell names that are members of this alias. | - - -#### Arguments - -* <alias> – Required. Alias name for this grouping. - -#### Errors - -* the <alias> argument is required for the <AddCellsAlias> command This error occurs if the command is not called with exactly one argument. - -### UpdateCellsAlias - -Updates the content of a CellAlias with the provided parameters. Empty values and intersections with other aliases are not supported. - -#### Example - -
UpdateCellsAliases -- [--cells <cell1,cell2,cell3>] <alias>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| cells | string |The list of cell names that are members of this alias. | - - -#### Arguments - -* <alias> – Required. Alias name group to update. - -#### Errors - -* the <alias> argument is required for the <UpdateCellsAlias> command This error occurs if the command is not called with exactly one argument. - -### DeleteCellsAlias - -Deletes the CellsAlias for the provided alias. After deleting an alias, cells that were part of the group are not going to be able to route replica/rdonly traffic to the rest of the cells that were part of the grouping. - -#### Example - -
DeleteCellsAlias <alias>
- -#### Errors - -* the <alias> argument is required for the <DeleteCellsAlias> command This error occurs if the command is not called with exactly one argument. - -### GetCellsAliases - -Fetches in json format all the existent cells alias groups. - -#### Example - -
GetCellsAliases
- -## See Also - -* [vtctl command index](../../vtctl) diff --git a/content/en/docs/22.0/reference/programs/vtctl/cells.md b/content/en/docs/22.0/reference/programs/vtctl/cells.md deleted file mode 100644 index 9a3c4646a..000000000 --- a/content/en/docs/22.0/reference/programs/vtctl/cells.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: vtctl Cell Command Reference -series: vtctl -docs_nav_title: Cells ---- - -The following `vtctl` commands are available for administering Cells. - -## Commands - -### AddCellInfo - -Registers a local topology service in a new cell by creating the CellInfo with the provided parameters. The address will be used to connect to the topology service, and we'll put Vitess data starting at the provided root. - -#### Example - -
AddCellInfo -- [--server_address <addr>] [--root <root>] <cell>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| root | string | The root path the topology service is using for that cell. | -| server_address | string | The address the topology service is using for that cell. | - - -#### Arguments - -* <addr> – Required. -* <cell> – Required. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms "cell" and "data center" are interchangeable. The argument value is a string that does not contain whitespace. - -#### Errors - -* the <cell> argument is required for the <AddCellInfo> command This error occurs if the command is not called with exactly one argument. - -### DeleteCellInfo - -Deletes the CellInfo for the provided cell. The cell cannot be referenced by any Shard record. - -#### Example - -
DeleteCellInfo <cell>
- -#### Errors - -* the <cell> argument is required for the <DeleteCellInfo> command This error occurs if the command is not called with exactly one argument. - - -### GetCellInfo - -Prints a JSON representation of the CellInfo for a cell. - -#### Example - -
GetCellInfo <cell>
- -#### Errors - -* the <cell> argument is required for the <GetCellInfo> command This error occurs if the command is not called with exactly one argument. - -### GetCellInfoNames - -Lists all the cells for which we have a CellInfo object, meaning we have a local topology service registered. - -#### Example - -
GetCellInfoNames
- -#### Errors - -* <GetCellInfoNames> command takes no parameter This error occurs if the command is not called with exactly 0 arguments. - - -### UpdateCellInfo - -Updates the content of a CellInfo with the provided parameters. If a value is empty, it is not updated. The CellInfo will be created if it doesn't exist. - -#### Example - -
UpdateCellInfo -- [--server_address <addr>] [--root <root>] <cell>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :----------- | -| root | string | The root path the topology service is using for that cell. | -| server_address | string | The address the topology service is using for that cell. | - - -#### Arguments - -* <addr> – Required. -* <cell> – Required. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms "cell" and "data center" are interchangeable. The argument value is a string that does not contain whitespace. - -#### Errors - -* the <cell> argument is required for the <UpdateCellInfo> command This error occurs if the command is not called with exactly one argument. - -### GetCellInfo - -Prints a JSON representation of the CellInfo for a cell. - -#### Example - -
GetCellInfo <cell>
- -#### Errors - -* the <cell> argument is required for the <GetCellInfo> command This error occurs if the command is not called with exactly one argument. - - -## See Also - -* [vtctl command index](../../vtctl) diff --git a/content/en/docs/22.0/reference/programs/vtctl/generic.md b/content/en/docs/22.0/reference/programs/vtctl/generic.md deleted file mode 100644 index 5a00359f5..000000000 --- a/content/en/docs/22.0/reference/programs/vtctl/generic.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: vtctl Generic Command Reference -series: vtctl -docs_nav_title: Generic Commands ---- - -The following generic `vtctl` commands are available for administering Vitess. - -## Commands - -### Validate - -Validates that all nodes reachable from the global replication graph and that all tablets in all discoverable cells are consistent. - -#### Example - -
Validate -- [--ping-tablets]
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| ping-tablets | Boolean | Indicates whether all tablets should be pinged during the validation process | - - -### ListAllTablets - -Lists all tablets in an awk-friendly way. - -#### Example - -
ListAllTablets -- [--keyspace=''] [--tablet_type=<primary,replica,rdonly,spare>] [<cell_name1>,<cell_name2>,...]
- -#### Arguments - -* <cell_name> – Optional. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms "cell" and "data center" are interchangeable. The argument value is a string that does not contain whitespace. This allows you to request server side filtering to exlude tablets in cells not explicitly specified. - -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :---------- | -| keyspace | string | (Optional) A keyspace is a logical database. This allows you to request server side filtering to exlude tablets not in this keyspace. | -| tablet_type | string | (Optional) A tablet type is one of PRIMARY,REPLICA,RDONLY,SPARE. This allows you to request server side filtering to exlude tablets not of this type. | - -#### Errors - -* An error will be returned if you specify a non-existent cell or an invalid tablet type. - -### ListTablets - -Lists specified tablets in an awk-friendly way. - -#### Example - -
ListTablets <tablet alias> ...
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. To specify multiple values for this argument, separate individual values with a space. - -#### Errors - -* the <tablet alias> argument is required for the <ListTablets> command This error occurs if the command is not called with at least one argument. - -### GenerateShardRanges - -Generates shard ranges assuming a keyspace with N shards. - -#### Example - -
GenerateShardRanges -- [--num_shards 2]
- -#### Flags - -| Name | Type | Definition | -| :-------- |:--------| :---------- | -| num_shards | Integer | Number of shards to generate shard ranges for. (default 2) | - -### Help - -Provides help for a command. - -#### Example - -``` -Help [command name] -``` - -## See Also - -* [vtctl command index](../../vtctl) diff --git a/content/en/docs/22.0/reference/programs/vtctl/keyspaces.md b/content/en/docs/22.0/reference/programs/vtctl/keyspaces.md deleted file mode 100644 index 4f28b65a6..000000000 --- a/content/en/docs/22.0/reference/programs/vtctl/keyspaces.md +++ /dev/null @@ -1,388 +0,0 @@ ---- -title: vtctl Keyspace Command Reference -series: vtctl -docs_nav_title: Keyspaces ---- - -The following `vtctl` commands are available for administering Keyspaces. - -## Commands - -### CreateKeyspace - -Creates the specified keyspace. - -#### Example - -
CreateKeyspace -- [--sharding_column_name=name] [--sharding_column_type=type] [--served_from=tablettype1:ks1,tablettype2:ks2,...] [--force] [--keyspace_type=type] [--base_keyspace=base_keyspace] [--snapshot_time=time] [--durability-policy=policy_name] [--sidecar-db-name=db_name] <keyspace name>
- -#### Flags - -| Name | Type | Definition | -|:---------------------|:--------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| allow_empty_vschema | Boolean | If set this will allow a new keyspace to have no vschema | -| base_keyspace | Boolean | Specifies the base keyspace for a snapshot keyspace type | -| durability-policy | String | Specifies the [durability policy](../../../../user-guides/configuration-basic/durability_policy) to use for the keyspace | -| force | Boolean | Proceeds even if the keyspace already exists | -| keyspace_type | String | Specifies the type of the keyspace. It can be NORMAL or SNAPSHOT. For a SNAPSHOT keyspace you must specify the name of a base_keyspace, and a snapshot_time in UTC, in RFC3339 time format, e.g. 2006-01-02T15:04:05+00:00 | -| sharding_column_name | String | Specifies the column to use for sharding operations | -| sharding_column_type | String | Specifies the type of the column to use for sharding operations | -| sidecar-db-name | String | (Experimental) Specifies the name of the Vitess sidecar database that tablets in this keyspace will use for internal metadata | -| served_from | String | Specifies a comma-separated list of dbtype:keyspace pairs used to serve traffic | -| snapshot_time | String | Specifies the snapshot time for this keyspace | - - -#### Arguments - -* <keyspace name> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* the <keyspace name> argument is required for the <CreateKeyspace> command This error occurs if the command is not called with exactly one argument. - -### DeleteKeyspace - -Deletes the specified keyspace. In recursive mode, it also recursively deletes all shards in the keyspace. Otherwise, there must be no shards left in the keyspace. - -#### Example - -
DeleteKeyspace -- [--recursive] <keyspace>
-Deletes the specified keyspace. In recursive mode, it also recursively deletes all shards in the keyspace. Otherwise, there must be no shards left in the keyspace.
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| recursive | Boolean | Also recursively delete all shards in the keyspace. | - - -#### Arguments - -* <keyspace> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* must specify the <keyspace> argument for <DeleteKeyspace> This error occurs if the command is not called with exactly one argument. - -### RemoveKeyspaceCell - -Removes the cell from the Cells list for all shards in the keyspace, and the SrvKeyspace for that keyspace in that cell. - -#### Example - -
RemoveKeyspaceCell -- [--force] [--recursive] <keyspace> <cell>
-Removes the cell from the Cells list for all shards in the keyspace, and the SrvKeyspace for that keyspace in that cell.
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| force | Boolean | Proceeds even if the cell's topology service cannot be reached. The assumption is that you turned down the entire cell, and just need to update the global topo data. | -| recursive | Boolean | Also delete all tablets in that cell belonging to the specified keyspace. | - - -#### Arguments - -* <keyspace> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. -* <cell> – Required. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms "cell" and "data center" are interchangeable. The argument value is a string that does not contain whitespace. - -#### Errors - -* the <keyspace> and <cell> arguments are required for the <RemoveKeyspaceCell> command This error occurs if the command is not called with exactly 2 arguments. - -### GetKeyspace - -Outputs a JSON structure that contains information about the Keyspace. - -#### Example - -
GetKeyspace <keyspace>
-Outputs a JSON structure that contains information about the Keyspace.
- -#### Arguments - -* <keyspace> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* the <keyspace> argument is required for the <GetKeyspace> command This error occurs if the command is not called with exactly one argument. - -### GetKeyspaces - -Outputs a sorted list of all keyspaces. - -### RebuildKeyspaceGraph - -Rebuilds the serving data for the keyspace. This command may trigger an update to all connected clients. - -#### Example - -
RebuildKeyspaceGraph -- [--cells=c1,c2,...] [--allow_partial] <keyspace> ...
-Rebuilds the serving data for the keyspace. This command may trigger an update to all connected clients.
- -#### Flags - -| Name | Type | Definition | -|:--------------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------| -| allow_partial | Boolean | Specifies whether a SNAPSHOT keyspace is allowed to serve with an incomplete set of shards. Ignored for all other types of keyspaces | -| cells | String | Specifies a comma-separated list of cells to update | - -#### Arguments - -* <keyspace> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. To specify multiple values for this argument, separate individual values with a space. - -#### Errors - -* the <keyspace> argument must be used to specify at least one keyspace when calling the <RebuildKeyspaceGraph> command This error occurs if the command is not called with at least one argument. - - -### ValidateKeyspace - -Validates that all nodes reachable from the specified keyspace are consistent. - -#### Example - -
ValidateKeyspace -- [--ping-tablets] <keyspace name>
-Validates that all nodes reachable from the specified keyspace are consistent.
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| ping-tablets | Boolean | Specifies whether all tablets will be pinged during the validation process | - - -#### Arguments - -* <keyspace name> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* the <keyspace name> argument is required for the <ValidateKeyspace> command This error occurs if the command is not called with exactly one argument. - - -### FindAllShardsInKeyspace - -Displays all of the shards in the specified keyspace. - -#### Example - -
FindAllShardsInKeyspace <keyspace>
-Displays all of the shards in the specified keyspace.
- -#### Arguments - -* <keyspace> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* the <keyspace> argument is required for the <FindAllShardsInKeyspace> command This error occurs if the command is not called with exactly one argument. - - -### Reshard - -Start a Resharding process. Example: Reshard --cells='zone1,alias1' --tablet_types='PRIMARY,REPLICA,RDONLY' ks.workflow001 -- '0' '-80,80-' - -#### Example - -
Reshard -- [--source_shards=<source_shards>] [--target_shards=<target_shards>] [--cells=<cells>] [--tablet_types=<source_tablet_types>] [--on-ddl=<ddl-action>] [--skip_schema_copy] <action> <keyspace.workflow>
- -#### Flags - -| Name | Type | Definition | -|:----------------------------|:---------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| all | Boolean | MoveTables only. Move all tables from the source keyspace. Either table_specs or --all needs to be specified. | -| auto_start | Boolean | If false, streams will start in the Stopped state and will need to be explicitly started (default true) | -| cells | String | Cell(s) or CellAlias(es) (comma-separated) to replicate from. | -| drop_foreign_keys | Boolean | If true, tables in the target keyspace will be created without foreign keys. | -| dry_run | Boolean | Does a dry run of SwitchTraffic and only reports the actions to be taken. --dry_run is only supported for SwitchTraffic, ReverseTraffic and Complete. | -| exclude | String | MoveTables only. Tables to exclude (comma-separated) if --all is specified | -| keep_data | Boolean | Do not drop tables or shards (if true, only vreplication artifacts are cleaned up). --keep_data is only supported for Complete and Cancel. | -| keep_routing_rules | Boolean | Do not remove the routing rules for the source keyspace. --keep_routing_rules is only supported for Complete and Cancel. | -| max_replication_lag_allowed | Duration | Allow traffic to be switched only if vreplication lag is below this (in seconds) (default 30s) | -| on-ddl | String | What to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE. (default "IGNORE") | -| rename_tables | Boolean | MoveTables only. Rename tables instead of dropping them. --rename_tables is only supported for Complete. | -| reverse_replication | Boolean | Also reverse the replication (default true). --reverse_replication is only supported for SwitchTraffic. (default true) | -| skip_schema_copy | Boolean | Reshard only. Skip copying of schema to target shards | -| source | String | MoveTables only. Source keyspace | -| source_shards | String | Source shards | -| source_time_zone | String | MoveTables only. Specifying this causes any DATETIME fields to be converted from given time zone into UTC | -| stop_after_copy | Boolean | Streams will be stopped once the copy phase is completed | -| tables | String | MoveTables only. A table spec or a list of tables. Either table_specs or --all needs to be specified. | -| tablet_types | String | Source tablet types to replicate from (e.g. PRIMARY, REPLICA, RDONLY). Note: SwitchTraffic overrides this default and uses in_order:RDONLY,REPLICA,PRIMARY to switch all traffic by default. (default "in_order:REPLICA,PRIMARY") | -| target_shards | String | Reshard only. Target shards | -| timeout | Duration | Specifies the maximum time to wait, in seconds, for vreplication to catch up on primary migrations. The migration will be cancelled on a timeout. --timeout is only supported for SwitchTraffic and ReverseTraffic. (default 30s) | - -#### Arguments - -* <action> - Required. Action must be one of the following: Create, Complete, Cancel, SwitchTraffic, ReverseTrafffic, Show, or Progress. -* <keyspace.workflow> - Required. The name of the keyspace and workflow to be used for the resharding process. The argument value must be a string that does not contain whitespace. - - -### MoveTables - -Move table(s) to another keyspace, table_specs is a list of tables or the tables section of the vschema for the target keyspace. -Example: -```json -{ - "t1": {"column_vindexes": [{"column": "id1", "name": "xxhash"}]}, - "t2": {"column_vindexes": [{"column": "id2", "name": "xxhash"}]} -} -``` - -In the case of an unsharded target keyspace the vschema for each table may be empty. -Example: -```json -{ - "t1":{}, - "t2":{} -} -``` - -#### Example - -
MoveTables [--source=<sourceKs>] [--tables=<tableSpecs>] [--cells=<cells>] [--tablet_types=<source_tablet_types>] [--all] [--exclude=<tables>] [--auto_start] [--stop_after_copy] [--on-ddl=<ddl-action>] [--source_shards=<source_shards>] <action> <targetKs.workflow>
- -#### Flags - -| Name | Type | Definition | -|:----------------------------|:---------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| all | Boolean | MoveTables only. Move all tables from the source keyspace. Either table_specs or --all needs to be specified. | -| auto_start | Boolean | If false, streams will start in the Stopped state and will need to be explicitly started (default true) | -| cells | String | Cell(s) or CellAlias(es) (comma-separated) to replicate from. | -| drop_foreign_keys | Boolean | If true, tables in the target keyspace will be created without foreign keys. | -| dry_run | Boolean | Does a dry run of SwitchTraffic and only reports the actions to be taken. --dry_run is only supported for SwitchTraffic, ReverseTraffic and Complete. | -| exclude | String | MoveTables only. Tables to exclude (comma-separated) if --all is specified | -| keep_data | Boolean | Do not drop tables or shards (if true, only vreplication artifacts are cleaned up). --keep_data is only supported for Complete and Cancel. | -| keep_routing_rules | Boolean | Do not remove the routing rules for the source keyspace. --keep_routing_rules is only supported for Complete and Cancel. | -| max_replication_lag_allowed | Duration | Allow traffic to be switched only if vreplication lag is below this (in seconds) (default 30s) | -| on-ddl | String | What to do when DDL is encountered in the VReplication stream. Possible values are IGNORE, STOP, EXEC, and EXEC_IGNORE. (default "IGNORE") | -| rename_tables | Boolean | MoveTables only. Rename tables instead of dropping them. --rename_tables is only supported for Complete. | -| reverse_replication | Boolean | Also reverse the replication (default true). --reverse_replication is only supported for SwitchTraffic. (default true) | -| skip_schema_copy | Boolean | Reshard only. Skip copying of schema to target shards | -| source | String | MoveTables only. Source keyspace | -| source_shards | String | Source shards | -| source_time_zone | String | MoveTables only. Specifying this causes any DATETIME fields to be converted from given time zone into UTC | -| stop_after_copy | Boolean | Streams will be stopped once the copy phase is completed | -| tables | String | MoveTables only. A table spec or a list of tables. Either table_specs or --all needs to be specified. | -| tablet_types | String | Source tablet types to replicate from (e.g. PRIMARY, REPLICA, RDONLY). Note: SwitchTraffic overrides this default and uses in_order:RDONLY,REPLICA,PRIMARY to switch all traffic by default. (default "in_order:REPLICA,PRIMARY") | -| target_shards | String | Reshard only. Target shards | -| timeout | Duration | Specifies the maximum time to wait, in seconds, for vreplication to catch up on primary migrations. The migration will be cancelled on a timeout. --timeout is only supported for SwitchTraffic and ReverseTraffic. (default 30s) | - - -#### Arguments - -* <action> - Required. Action must be one of the following: Create, Complete, Cancel, SwitchTraffic, ReverseTrafffic, Show, or Progress. -* <keyspace.workflow> - Required. The name of the keyspace and workflow to be used for the resharding process. The argument value must be a string that does not contain whitespace. - - -### CreateLookupVindex - -Create and backfill a lookup vindex. the json_spec must contain the vindex and colvindex specs for the new lookup. - -#### Example - -
-CreateLookupVindex  -- [--cells=<source_cells>] [--continue_after_copy_with_owner=false] [--tablet_types=<source_tablet_types>] <keyspace> <json_spec>
-Create and backfill a lookup vindex. the json_spec must contain the vindex and colvindex specs for the new lookup.
-
- -### Flags - -| Name | Type | Definition | -|:-------------------------------|:--------|:--------------------------------------------------------------------------| -| cells | String | Source cells to replicate from. | -| continue_after_copy_with_owner | Boolean | Vindex will continue materialization after copy when an owner is provided | -| tablet_types | String | Source tablet types to replicate from. | - -### Arguments - -* <keyspace> - Required. The name of the keyspace where lookup vindex needs to be created. -* <json_spec> - Required. json specification about how to create the lookup vindex. More information in [user-guides](../../../../user-guides/configuration-advanced/createlookupvindex) - - -### ExternalizeVindex - -Externalize (activate) a lookup vindex backfilled using `CreateLookupVindex`. - -This removes the workflow and vreplication streams associated with the -backfill, and clears the `write_only` flag on the vindex. After this flag is -removed, applications can start using the vindex for lookups. - -#### Example - -
-ExternalizeVindex <keyspace>.<vindex>
-
- -### Materialize - -Performs materialization based on the json spec. Is used directly to form VReplication rules, with an optional step to copy table structure/DDL. - -#### Example - -
-Materialize -- [--cells=<cells>] [--tablet_types=<source_tablet_types>] <json_spec>
-
- -#### Flags - -| Name | Type | Definition | -|:-------------|:-------|:---------------------------------------| -| cells | String | Source cells to replicate from. | -| tablet_types | String | Source tablet types to replicate from. | - - -#### Argument - -* - Required. - -Example: -```json -{ - "workflow": "aaa", - "source_keyspace": "source", - "target_keyspace": "target", - "table_settings": [{ - "target_table": "customer", - "source_expression": "select * from customer", - "create_ddl": "copy"}] -} -``` - -### `VDiff` - -Perform a diff of all tables in the workflow - -#### Example - -
-VDiff -- [--source_cell=<cell>] [--target_cell=<cell>] [--tablet_types=in_order:RDONLY,REPLICA,PRIMARY] [--limit=<max rows to diff>] [--tables=<table list>] [--format=json] [--auto-retry] [--verbose] [--max_extra_rows_to_compare=1000] [--filtered_replication_wait_time=30s] [--debug_query] [--only_pks] [--wait] [--wait-update-interval=1m] <keyspace.workflow> [<action>] [<UUID>]
-
- -#### Flags - -| Name | Type | Definition | -|:-------------|:-------|:---------------------------------------| -| auto-retry | Boolean | Should this vdiff automatically retry and continue in case of recoverable errors (default true) | -| checksum | Boolean | Use row-level checksums to compare, not yet implemented | -| debug_query | Boolean | Adds a mysql query to the report that can be used for further debugging | -| filtered_replication_wait_time | Duration | Specifies the maximum time to wait, in seconds, for filtered replication to catch up on primary migrations. The migration will be cancelled on a timeout. (default 30s) | -| format | String | Format of report (default "text") | -| limit | Int | Max rows to stop comparing after (default 9223372036854775807) | -| max_extra_rows_to_compare | Int | If there are collation differences between the source and target, you can have rows that are identical but simply returned in a different order from MySQL. We will do a second pass to compare the rows for any actual differences in this case and this flag allows you to control the resources used for this operation. (default 1000) | -| only_pks | Boolean | When reporting missing rows, only show primary keys in the report. | -| sample_pct | Int | How many rows to sample, not yet implemented (default 100) | -| source_cell | String | The source cell to compare from; default is any available cell | -| tables | String | Only run vdiff for these tables in the workflow | -| tablet_types | String | Tablet types for source (PRIMARY is always used on target) (default "in_order:RDONLY,REPLICA,PRIMARY") | -| target_cell | String | The target cell to compare with; default is any available cell | -| v1 | Boolean | Use legacy VDiff v1 | -| verbose | Boolean | Show verbose vdiff output in summaries | -| wait | Boolean | When creating or resuming a vdiff, wait for it to finish before exiting | -| wait-update-interval | Duration |When waiting on a vdiff to finish, check and display the current status this often (default 1m0s) | - - -## See Also - -* [vtctl command index](../../vtctl) diff --git a/content/en/docs/22.0/reference/programs/vtctl/replication-graph.md b/content/en/docs/22.0/reference/programs/vtctl/replication-graph.md deleted file mode 100644 index a4ab5b269..000000000 --- a/content/en/docs/22.0/reference/programs/vtctl/replication-graph.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: vtctl Replication Graph Command Reference -series: vtctl -docs_nav_title: Replication Graph ---- - -The following `vtctl` commands are available for administering the Replication Graph. - -## Commands - -### GetShardReplication - -Outputs a JSON structure that contains information about the ShardReplication. - -#### Example - -
GetShardReplication <cell> <keyspace/shard>
- -#### Arguments - -* <cell> – Required. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms "cell" and "data center" are interchangeable. The argument value is a string that does not contain whitespace. -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* the <cell> and <keyspace/shard> arguments are required for the <GetShardReplication> command This error occurs if the command is not called with exactly 2 arguments. - -## See Also - -* [vtctl command index](../../vtctl) diff --git a/content/en/docs/22.0/reference/programs/vtctl/schema-version-permissions.md b/content/en/docs/22.0/reference/programs/vtctl/schema-version-permissions.md deleted file mode 100644 index b6253becb..000000000 --- a/content/en/docs/22.0/reference/programs/vtctl/schema-version-permissions.md +++ /dev/null @@ -1,384 +0,0 @@ ---- -title: vtctl Schema, Version, Permissions Command Reference -series: vtctl -docs_nav_title: Schema Versions & Permissions ---- - -The following `vtctl` commands are available for administering Schema, Versions and Permissions. - -## Commands - -### GetSchema - -Displays the full schema for a tablet, or just the schema for the specified tables in that tablet. - -#### Example - -
GetSchema -- [--tables=<table1>,<table2>,...] [--exclude_tables=<table1>,<table2>,...] [--include-views] <tablet alias>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| exclude_tables | string | Specifies a comma-separated list of tables to exclude. Each is either an exact match, or a regular expression of the form /regexp/ | -| include-views | Boolean | Includes views in the output | -| table_names_only | Boolean | Only displays table names that match | -| tables | string | Specifies a comma-separated list of tables for which we should gather information. Each is either an exact match, or a regular expression of the form /regexp/ | - - -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* The <tablet alias> argument is required for the <GetSchema> command This error occurs if the command is not called with exactly one argument. - - -### ReloadSchema - -Reloads the schema on a remote tablet. - -#### Example - -
ReloadSchema <tablet alias>
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* The <tablet alias> argument is required for the <ReloadSchema> command This error occurs if the command is not called with exactly one argument. - -### ReloadSchemaShard - -Reloads the schema on all the tablets in a shard. - -#### Example - -
ReloadSchemaShard -- [--concurrency=10] [--include_primary=false] <keyspace/shard>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| concurrency | Int | How many tablets to reload in parallel | -| include_primary | Boolean | Include the primary tablet | - - -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* The <keyspace/shard> argument is required for the <ReloadSchemaShard> command This error occurs if the command is not called with exactly one argument. - -### ReloadSchemaKeyspace - -Reloads the schema on all the tablets in a keyspace. - -#### Example - -
ReloadSchemaKeyspace -- [--concurrency=10] [--include_primary=false] <keyspace>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| concurrency | Int | How many tablets to reload in parallel | -| include_primary | Boolean | Include the primary tablet(s) | - - -#### Arguments - -* <keyspace> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* The <keyspace> argument is required for the <ReloadSchemaKeyspace> command This error occurs if the command is not called with exactly one argument. - -### ValidateSchemaShard - -Validates that the schema on the primary tablet matches all of the replicas. - -#### Example - -
ValidateSchemaShard -- [--exclude_tables=''] [-include-views] <keyspace/shard>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| exclude_tables | string | Specifies a comma-separated list of tables to exclude. Each is either an exact match, or a regular expression of the form /regexp/ | -| include-views | Boolean | Includes views in the validation | - - -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* The <keyspace/shard> argument is required for the <ValidateSchemaShard> command This error occurs if the command is not called with exactly one argument. - -### ValidateSchemaKeyspace - -Validates that the schema on the primary tablet for shard 0 matches the schema on all of the other tablets in the keyspace. - -#### Example - -
ValidateSchemaKeyspace -- [--exclude_tables=''] [--include-views] <keyspace name>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| exclude_tables | string | Specifies a comma-separated list of tables to exclude. Each is either an exact match, or a regular expression of the form /regexp/ | -| include-views | Boolean | Includes views in the validation | - - -#### Arguments - -* <keyspace name> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* The <keyspace name> argument is required for the <ValidateSchemaKeyspace> command This error occurs if the command is not called with exactly one argument. - -### ApplySchema - -Applies the schema change to the specified keyspace on all shards. The recommended method of applying schema changes is via [Online DDL](../../../../user-guides/schema-changes/managed-online-schema-changes/), which ensures migrations are non-blocking and keeps replication in sync throughout the operation. `--ddl_strategy` is used to choose migration strategy such as `vitess`, `mysql` or `direct`, with optional parameters. `-request_context` allows the user to specify a custom request context for online DDL migrations. - -#### Example - -
ApplySchema -- [--wait_replicas_timeout=10s] [--ddl_strategy=] [--request_context=] {--sql=<sql> || --sql-file=<filename>} <keyspace>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| caller_id | string | Effective caller ID used for the operation and should map to an ACL name which grants this identity the necessary permissions to perform the operation (this is only necessary when strict table ACLs are used). | -| ddl_strategy | string | Online DDL strategy, compatible with @@ddl_strategy session variable (examples: 'mysql', 'vitess --postpone-completion' (default "direct"). | -| request_context | string | For Only DDL, optionally supply a custom unique string used as context for the migration(s) in this command. By default a unique context is auto-generated by Vitess. | -| sql | string | A list of semicolon-delimited SQL commands. | -| sql-file | string | Identifies the file that contains the SQL commands. This file needs to exist on the server, rather than on the client. | -| wait_replicas_timeout | Duration | The amount of time to wait for replicas to receive the schema change via replication (default 10s). | - -#### Arguments - -* <keyspace> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* The <keyspace> argument is required for the command<ApplySchema> command This error occurs if the command is not called with exactly one argument. -* If using a file you may need to pass the absolute path. - -### 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. - -#### Example - -
CopySchemaShard -- [--tables=<table1>,<table2>,...] [--exclude_tables=<table1>,<table2>,...] [--include-views] [--wait_replicas_timeout=10s] {<source keyspace/shard> || <source tablet alias>} <destination keyspace/shard>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| exclude_tables | string | Specifies a comma-separated list of tables to exclude. Each is either an exact match, or a regular expression of the form /regexp/ | -| include-views | Boolean | Includes views in the output | -| tables | string | 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. | - - -#### Arguments - -* <source keyspace/shard> – Required. A keyspace or shard to be used as the source of the copy. -* <source tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. -* <destination keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* The <source keyspace/shard> and <destination keyspace/shard> arguments are both required for the <CopySchemaShard> command. Instead of the <source keyspace/shard> argument, you can also specify <tablet alias> which refers to a specific tablet of the shard in the source keyspace This error occurs if the command is not called with exactly 2 arguments. - -### ValidateVersionShard - -Validates that the version on the primary matches all of the replicas. - -#### Example - -
ValidateVersionShard <keyspace/shard>
- -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* The <keyspace/shard> argument is required for the <ValidateVersionShard> command This error occurs if the command is not called with exactly one argument. - -### ValidateVersionKeyspace - -Validates that the version on the primary of shard 0 matches all of the other tablets in the keyspace. - -#### Example - -
ValidateVersionKeyspace <keyspace name>
- -#### Arguments - -* <keyspace name> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* The <keyspace name> argument is required for the <ValidateVersionKeyspace> command This error occurs if the command is not called with exactly one argument. - -### GetPermissions - -Displays the permissions for a tablet. - -#### Example - -
GetPermissions <tablet alias>
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* The <tablet alias> argument is required for the <GetPermissions> command This error occurs if the command is not called with exactly one argument. - -### ValidatePermissionsShard - -Validates that the permissions on the primary tablet match all the replicas. - -#### Example - -
ValidatePermissionsShard <keyspace/shard>
- -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* The <keyspace/shard> argument is required for the <ValidatePermissionsShard> command This error occurs if the command is not called with exactly one argument. - -### ValidatePermissionsKeyspace - -Validates that the permissions on the primary of shard 0 match those of all of the other tablets in the keyspace. - -#### Example - -
ValidatePermissionsKeyspace <keyspace name>
- -#### Arguments - -* <keyspace name> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* The <keyspace name> argument is required for the <ValidatePermissionsKeyspace> command This error occurs if the command is not called with exactly one argument. - -### GetVSchema - -Displays the VTGate routing schema. - -#### Example - -
GetVSchema <keyspace>
- -#### Arguments - -* <keyspace> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* The <keyspace> argument is required for the <GetVSchema> command This error occurs if the command is not called with exactly one argument. - -### ApplyVSchema - -Applies the VTGate routing schema to the provided keyspace. Shows the result after application. - -#### Example - -
ApplyVSchema -- {--vschema=<vschema> || --vschema_file=<vschema file> || --sql=<sql> || --sql_file=<sql file>} [--cells=c1,c2,...] [--skip_rebuild] [--dry-run]<keyspace>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| cells | string | If specified, limits the rebuild to the cells, after upload. Ignored if skipRebuild is set. | -| dry-run | Boolean | If set, do not save the altered vschema, simply echo to console. | -| skip_rebuild | Boolean | If set, do not rebuild the SrvSchema objects. | -| sql | add vindex | A vschema ddl SQL statement (e.g. add vindex, `alter table t add vindex hash(id)`, etc) | -| sql_file | add vindex | A vschema ddl SQL statement (e.g. add vindex, `alter table t add vindex hash(id)`, etc) | -| vschema | string | Identifies the VTGate routing schema | -| vschema_file | string | Identifies the VTGate routing schema file | - -#### Arguments - -* <keyspace> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* The <keyspace> argument is required for the <ApplyVSchema> command. This error occurs if the command is not called with exactly one argument. -* Either the <vschema> or <vschema>File flag must be specified when calling the <ApplyVSchema> command. -* If using a file you may need to pass the absolute path. - -#### Warnings - -* In some cases, unknown params passed to Vindexes may be accepted but reported as warnings in the command response. - -### GetRoutingRules - -``` -GetRoutingRules -``` - -### ApplyRoutingRules - -Applies the VSchema routing rules. - -#### Example - -``` -ApplyRoutingRules -- {--rules= | --rules_file=} [--cells=c1,c2,...] [--skip_rebuild] [--dry-run] -``` - -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| cells | string | If specified, limits the rebuild to the cells, after upload. Ignored if skip_rebuild is set. | -| dry-run | Boolean | If set, do not save the altered vschema, simply echo to console. | -| skip_rebuild | Boolean | If set, do not rebuild the SrvSchema objects. | -| rules | string | Specify rules as a string. | -| rules_file | string | Specify rules in a file. | - - -### RebuildVSchemaGraph - -Rebuilds the cell-specific SrvVSchema from the global VSchema objects in the provided cells (or all cells if none provided). - -#### Example - -
RebuildVSchemaGraph -- [--cells=c1,c2,...]
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| cells | string | Specifies a comma-separated list of cells to look for tablets | - - -#### Errors - -* <RebuildVSchemaGraph> doesn't take any arguments This error occurs if the command is not called with exactly 0 arguments. - -## See Also - -* [vtctl command index](../../vtctl) diff --git a/content/en/docs/22.0/reference/programs/vtctl/serving-graph.md b/content/en/docs/22.0/reference/programs/vtctl/serving-graph.md deleted file mode 100644 index 0c756ce11..000000000 --- a/content/en/docs/22.0/reference/programs/vtctl/serving-graph.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: vtctl Serving Graph Command Reference -series: vtctl -docs_nav_title: Serving Graph ---- - -The following `vtctl` commands are available for administering the Serving Graph. - -## Commands - -### GetSrvKeyspaceNames - -Outputs a list of keyspace names. - -#### Example - -
GetSrvKeyspaceNames <cell>
- -#### Arguments - -* <cell> – Required. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms "cell" and "data center" are interchangeable. The argument value is a string that does not contain whitespace. - -#### Errors - -* the <cell> argument is required for the <GetSrvKeyspaceNames> command This error occurs if the command is not called with exactly one argument. - - -### GetSrvKeyspace - -Outputs a JSON structure that contains information about the SrvKeyspace. - -#### Example - -
GetSrvKeyspace <cell> <keyspace>
- -#### Arguments - -* <cell> – Required. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms "cell" and "data center" are interchangeable. The argument value is a string that does not contain whitespace. -* <keyspace> – Required. The name of a sharded database that contains one or more tables. Vitess distributes keyspace shards into multiple machines and provides an SQL interface to query the data. The argument value must be a string that does not contain whitespace. - -#### Errors - -* the <cell> and <keyspace> arguments are required for the <GetSrvKeyspace> command This error occurs if the command is not called with exactly 2 arguments. - -### GetSrvVSchema - -Outputs a JSON structure that contains information about the SrvVSchema. - -#### Example - -
GetSrvVSchema <cell>
- -#### Arguments - -* <cell> – Required. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms "cell" and "data center" are interchangeable. The argument value is a string that does not contain whitespace. - -#### Errors - -* the <cell> argument is required for the <GetSrvVSchema> command This error occurs if the command is not called with exactly one argument. - -### DeleteSrvVSchema - -``` -DeleteSrvVSchema -``` - - -## See Also - -* [vtctl command index](../../vtctl) diff --git a/content/en/docs/22.0/reference/programs/vtctl/shards.md b/content/en/docs/22.0/reference/programs/vtctl/shards.md deleted file mode 100644 index 66e70fc6d..000000000 --- a/content/en/docs/22.0/reference/programs/vtctl/shards.md +++ /dev/null @@ -1,467 +0,0 @@ ---- -title: vtctl Shard Command Reference -series: vtctl -docs_nav_title: Shards -aliases: ['/docs/reference/vtctl/shards/'] ---- - -The following `vtctl` commands are available for administering shards. - -## Commands - -### CreateShard - -Creates the specified shard. - -#### Example - -
CreateShard -- [--force] [--parent] <keyspace/shard>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| force | Boolean | Proceeds with the command even if the keyspace already exists | -| parent | Boolean | Creates the parent keyspace if it doesn't already exist | - - -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* the <keyspace/shard> argument is required for the <CreateShard> command This error occurs if the command is not called with exactly one argument. - -### GetShard - -Outputs a JSON structure that contains information about the Shard. - -#### Example - -
GetShard <keyspace/shard>
- -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* the <keyspace/shard> argument is required for the <GetShard> command This error occurs if the command is not called with exactly one argument. - -### ValidateShard - -Validates that all nodes that are reachable from this shard are consistent. - -#### Example - -
ValidateShard -- [--ping-tablets] <keyspace/shard>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| ping-tablets | Boolean | Indicates whether all tablets should be pinged during the validation process | - - -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* the <keyspace/shard> argument is required for the <ValidateShard> command This error occurs if the command is not called with exactly one argument. - -### ShardReplicationPositions - -Shows the replication status of each replica machine in the shard graph. In this case, the status refers to the replication lag between the primary vttablet and the replica vttablet. In Vitess, data is always written to the primary vttablet first and then replicated to all replica vttablets. Output is sorted by tablet type, then replication position. Use ctrl-C to interrupt command and see partial result if needed. - -#### Example - -
ShardReplicationPositions <keyspace/shard>
- -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* the <keyspace/shard> argument is required for the <ShardReplicationPositions> command This error occurs if the command is not called with exactly one argument. - - -### ListShardTablets - -Lists all tablets in the specified shard. - -#### Example - -
ListShardTablets <keyspace/shard>
- -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* the <keyspace/shard> argument is required for the <ListShardTablets> command This error occurs if the command is not called with exactly one argument. - -### SetShardIsPrimaryServing - -``` -SetShardIsPrimaryServing -``` - -### SetShardTabletControl - -Sets the shardTabletControls or the tabletControls records for a shard and tablet type in the topology service. Only use this for an emergency fix or after a corrupted MoveTables action. Always specify the `denied_tables` flag for MoveTables, but never for Reshard operations. - -To set the `queryServiceDisabled` for the tablet, set `disable_query_service` to true; to unset the queryServiceDisabled provide `denied_tables` with an empty table set. Useful to fix vReplication operations gone wrong. These specific flags update the values for `shardTabletControls` in the topology path: `/keyspaces//SrvKeyspace`. - -{{< warning >}} -It is important to note here the queryServiceDisabled can not be removed by `disable_query_service=false` or the `remove` flags. Only `denied_tables=""` will remove this setting. -{{< /warning >}} - -To change the `deniedTables` list, specify the `denied_tables` parameter with the new list, this is useful to fix tables that are being errantly blocked. To remove the tabletControls for selected tables, use the `remove` flag. These specific flags update the values for `tabletControls` in the topology path: `/keyspaces//shards//Shard`. - -The `SetShardTabletControl` only updates the topology records for a given shard and type, you still need to run [RefreshStateByShard](../tablets#refreshstatebyshard) to inform the vttablets of the topology change. - -#### Examples - -
SetShardTabletControl -- [--cells=c1,c2,...] [--denied_tables=t1,t2,...] [--remove] [--disable_query_service] <keyspace/shard> <tablet type>
- -**Disable serving of the listed tables for the selected keyspace/shard and tablet type:** - -
SetShardTabletControl -- [--denied_tables=t1,t2,...] <keyspace/shard> <tablet type>

-RefreshStateByShard <keyspace/shard>
- -**Serve all tables for the selected keyspace/shard and tablet type:** - -
SetShardTabletControl -- --remove <keyspace/shard> <tablet type>

-RefreshStateByShard <keyspace/shard>
- -**Disable serving for the selected keyspace/shard and tablet type:** - -
SetShardTabletControl -- --disable_query_service=true <keyspace/shard> <tablet type>

-RefreshStateByShard <keyspace/shard>
- -**Enable serving for the selected keyspace/shard and tablet type:** - -
SetShardTabletControl -- --denied_tables="" <keyspace/shard> <tablet type>

-RefreshStateByShard <keyspace/shard>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| denied_tables | string | Specifies a comma-separated list of tables to deny queries on. Each is either an exact match, or a regular expression of the form '/regexp/'. | -| cells | string | Specifies a comma-separated list of cells to update | -| disable_query_service | Boolean | Disables query service on the provided nodes. This flag requires 'denied_tables' and 'remove' to be unset, otherwise it's ignored. | -| remove | Boolean | Removes cells for MoveTables. | - - -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. -* <tablet type> – Required. The vttablet's role. Valid values are: - - * backup – A replicated copy of data that is offline to queries other than for backup purposes - * batch – A replicated copy of data for OLAP load patterns (typically for MapReduce jobs) - * experimental – A replicated copy of data that is ready but not serving query traffic. The value indicates a special characteristic of the tablet that indicates the tablet should not be considered a potential primary. Vitess also does not worry about lag for experimental tablets when reparenting. - * primary – A primary copy of data - * master – Deprecated, same as primary - * rdonly – A replicated copy of data for OLAP load patterns - * replica – A replicated copy of data ready to be promoted to primary - * restore – A tablet that is restoring from a snapshot. Typically, this happens at tablet startup, then it goes to its right state. - * spare – A replicated copy of data that is ready but not serving query traffic. The data could be a potential primary tablet. - - -#### Errors - -* the <keyspace/shard> and <tablet type> arguments are both required for the <SetShardTabletControl> command This error occurs if the command is not called with exactly 2 arguments. - -### UpdateSrvKeyspacePartition - -``` -UpdateSrvKeyspacePartition -- [--cells=c1,c2,...] [--remove] -``` - -### SourceShardDelete - -Deletes the SourceShard record with the provided index. This is meant as an emergency cleanup function. It does not call RefreshState for the shard primary. - -#### Example - -
SourceShardDelete <keyspace/shard> <uid>
- -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. -* <uid> – Required. - -#### Errors - -* the <keyspace/shard> and <uid> arguments are both required for the <SourceShardDelete> command This error occurs if the command is not called with at least 2 arguments. - -### SourceShardAdd - -Adds the SourceShard record with the provided index. This is meant as an emergency function. It does not call RefreshState for the shard primary. - -#### Example - -
SourceShardAdd -- [--key_range=<keyrange>] [--tables=<table1,table2,...>] <keyspace/shard> <uid> <source keyspace/shard>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| key_range | string | Identifies the key range to use for the SourceShard | -| tables | string | Specifies a comma-separated list of tables to replicate. Each is either an exact match, or a regular expression of the form /regexp/ | - - -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. -* <uid> – Required. -* <source keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* the <keyspace/shard>, <uid>, and <source keyspace/shard> arguments are all required for the <SourceShardAdd> command This error occurs if the command is not called with exactly 3 arguments. - -### ShardReplicationFix - -Walks through a ShardReplication object and fixes the first error that it encounters. - -#### Example - -
ShardReplicationFix <cell> <keyspace/shard>
- -#### Arguments - -* <cell> – Required. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms "cell" and "data center" are interchangeable. The argument value is a string that does not contain whitespace. -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* the <cell> and <keyspace/shard> arguments are required for the ShardReplicationRemove command This error occurs if the command is not called with exactly 2 arguments. - -### WaitForFilteredReplication - -Blocks until the specified shard has caught up with the filtered replication of its source shard. - -#### Example - -
WaitForFilteredReplication -- [--max_delay <max_delay, default 30s>] <keyspace/shard>
- -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* the <keyspace/shard> argument is required for the <WaitForFilteredReplication> command This error occurs if the command is not called with exactly one argument. - -### RemoveShardCell - -Removes the cell from the shard's Cells list. - -#### Example - -
RemoveShardCell -- [--force] [--recursive] <keyspace/shard> <cell>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| force | Boolean | Proceeds even if the cell's topology service cannot be reached. The assumption is that you turned down the entire cell, and just need to update the global topo data. | -| recursive | Boolean | Also delete all tablets in that cell belonging to the specified shard. | - - -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. -* <cell> – Required. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms "cell" and "data center" are interchangeable. The argument value is a string that does not contain whitespace. - -#### Errors - -* the <keyspace/shard> and <cell> arguments are required for the <RemoveShardCell> command This error occurs if the command is not called with exactly 2 arguments. - -### DeleteShard - -Deletes the specified shard(s). In recursive mode, it also deletes all tablets belonging to the shard. Otherwise, there must be no tablets left in the shard. - -#### Example - -
DeleteShard -- [--recursive] [--even_if_serving] <keyspace/shard> ...
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| even_if_serving | Boolean | Remove the shard even if it is serving. Use with caution. | -| recursive | Boolean | Also delete all tablets belonging to the shard. | - - -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. To specify multiple values for this argument, separate individual values with a space. - -#### Errors - -* the <keyspace/shard> argument must be used to identify at least one keyspace and shard when calling the <DeleteShard> command This error occurs if the command is not called with at least one argument. - -### ListBackups - -Lists all the backups for a shard. - -#### Example - -
ListBackups <keyspace/shard>
- -#### Errors - -* action <ListBackups> requires <keyspace/shard> This error occurs if the command is not called with exactly one argument. - -### BackupShard - -``` -BackupShard -- [--allow_primary=false] [--upgrade-safe=false] [--incremental-from-pos=] -``` - -### RemoveBackup - -Removes a backup from the BackupStorage. - -#### Example - -
RemoveBackup <keyspace/shard> <backup name>
- -#### Arguments - -* <backup name> – Required. - -#### Errors - -* action <RemoveBackup> requires <keyspace/shard> <backup name> This error occurs if the command is not called with exactly 2 arguments. - -### InitShardPrimary - -This command has been deprecated. Please use PlannedReparentShard instead. - -Sets the initial primary for a shard. Will make all other tablets in the shard replicas of the provided primary. WARNING: this could cause data loss on an already replicating shard. - -#### Example - -
InitShardPrimary -- [--force] [--wait_replicas_timeout=<duration>] <keyspace/shard> <tablet alias>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| force | Boolean | will force the reparent even if the provided tablet is not writable or the shard primary | -| wait_replicas_timeout | Duration | time to wait for replicas to catch up in reparenting | - - -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* action <InitShardPrimary> requires <keyspace/shard> <tablet alias> This error occurs if the command is not called with exactly 2 arguments. -* active reparent commands disabled (unset the --disable_active_reparents flag to enable) - -### PlannedReparentShard - -Reparents the shard to a new primary that can either be explicitly specified, -or chosen by Vitess. Both the existing primary and new primary need to be up -and running to use this command. If the existing primary for the shard is -down, you should use [EmergencyReparentShard](#emergencyreparentshard) instead. - -If the `new_primary` flag is not provided, Vitess will try to automatically -choose a replica to promote to primary, avoiding any replicas specified in -the `avoid_tablet` flag, if provided. Note that Vitess **will not consider -any replicas outside the cell the current primary is in for promotion**, -therefore you **must** pass the `new_primary` flag if you need to promote -a replica in a different cell from the primary. In the automated selection -mode Vitess will prefer the most advanced replica for promotion, to minimize -failover time. - -#### Example - -
PlannedReparentShard -- --keyspace_shard=<keyspace/shard> [--new_primary=<tablet alias>] [--avoid_tablet=<tablet alias>]
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| avoid_tablet | string | alias of a tablet that should not be the primary, i.e. reparent to any replica other than this one | -| keyspace_shard | string | keyspace/shard of the shard that needs to be reparented | -| new_primary | string | alias of a tablet that should be the new primary | -| wait_replicas_timeout | Duration | time to wait for replicas to catch up in reparenting | - - -#### Errors - -* action <PlannedReparentShard> requires --keyspace_shard=<keyspace/shard> [--new_primary=<tablet alias>] [--avoid_tablet=<tablet alias>] This error occurs if the command is not called with exactly 0 arguments. -* active reparent commands disabled (unset the --disable_active_reparents flag to enable) -* cannot use legacy syntax and flags --<keyspace_shard> and --<new_primary> for action <PlannedReparentShard> at the same time - -### EmergencyReparentShard - -Reparents the shard to the new primary. Assumes the old primary is dead and not responding. - -#### Example - -
EmergencyReparentShard -- --keyspace_shard=<keyspace/shard> -new_primary=<tablet alias>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| keyspace_shard | string | keyspace/shard of the shard that needs to be reparented | -| new_primary | string | alias of a tablet that should be the new primary | -| wait_replicas_timeout | Duration | time to wait for replicas to catch up in reparenting | - - -#### Errors - -* action <EmergencyReparentShard> requires --keyspace_shard=<keyspace/shard> --new_primary=<tablet alias> This error occurs if the command is not called with exactly 0 arguments. -* active reparent commands disabled (unset the --disable_active_reparents flag to enable) -* cannot use legacy syntax and flag --<new_primary> for action <EmergencyReparentShard> at the same time - - -### TabletExternallyReparented - -Changes metadata in the topology service to acknowledge a shard primary change performed by an external tool. See [Reparenting](../../../../user-guides/configuration-advanced/reparenting/#external-reparenting) for more information. - -#### Example - -
TabletExternallyReparented <tablet alias>
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet to promote to primary. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* the <tablet alias> argument is required for the <TabletExternallyReparented> command This error occurs if the command is not called with exactly one argument. - -### GenerateShardRanges - -Generates shard ranges assuming a keyspace with N shards. - -#### Example - -
GenerateShardRanges -- --num_shards=<N>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| num_shards | int | Number of shards to generate shard ranges for. (default 2) | - -## See Also - -* [vtctl command index](../../vtctl) diff --git a/content/en/docs/22.0/reference/programs/vtctl/tablets.md b/content/en/docs/22.0/reference/programs/vtctl/tablets.md deleted file mode 100644 index 915415109..000000000 --- a/content/en/docs/22.0/reference/programs/vtctl/tablets.md +++ /dev/null @@ -1,437 +0,0 @@ ---- -title: vtctl Tablet Command Reference -series: vtctl -docs_nav_title: Tablets ---- - -The following `vtctl` commands are available for administering tablets. - -## Commands - -### InitTablet - -Deprecated. It is no longer necessary to run this command to initialize a tablet's record in the topology. Starting up a vttablet ensures that the tablet record is eventually published. - -#### Example - -
InitTablet -- [--allow_update] [--allow_different_shard] [--allow_master_override] [--parent] [--db_name_override=<db name>] [--hostname=<hostname>] [--mysql_port=<port>] [--port=<port>] [--grpc_port=<port>] -keyspace=<keyspace> --shard=<shard> <tablet alias> <tablet type>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| allow_master_override | Boolean | Use this flag to force initialization if a tablet is created as primary, and a primary for the keyspace/shard already exists. Use with caution. | -| allow_update | Boolean | Use this flag to force initialization if a tablet with the same name already exists. Use with caution. | -| db_name_override | string | Overrides the name of the database that the vttablet uses | -| grpc_port | Int | The gRPC port for the vttablet process | -| hostname | string | The server on which the tablet is running | -| keyspace | string | The keyspace to which this tablet belongs | -| mysql_host | string | The mysql host for the mysql server | -| mysql_port | Int | The mysql port for the mysql server | -| parent | Boolean | Creates the parent shard and keyspace if they don't yet exist | -| port | Int | The main port for the vttablet process | -| shard | string | The shard to which this tablet belongs | -| tags | string | A comma-separated list of key:value pairs that are used to tag the tablet | - - -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. -* <tablet type> – Required. The vttablet's role. Valid values are: - - * backup – A replicated copy of data that is offline to queries other than for backup purposes - * batch – A replicated copy of data for OLAP load patterns (typically for MapReduce jobs) - * experimental – A replicated copy of data that is ready but not serving query traffic. The value indicates a special characteristic of the tablet that indicates the tablet should not be considered a potential primary. Vitess also does not worry about lag for experimental tablets when reparenting. - * primary – A primary copy of data - * master – Deprecated, same as primary - * rdonly – A replicated copy of data for OLAP load patterns - * replica – A replicated copy of data ready to be promoted to primary - * restore – A tablet that is restoring from a snapshot. Typically, this happens at tablet startup, then it goes to its right state. - * spare – A replicated copy of data that is ready but not serving query traffic. The data could be a potential primary tablet. - - -#### Errors - -* the <tablet alias> and <tablet type> arguments are both required for the <InitTablet> command This error occurs if the command is not called with exactly 2 arguments. - - -### GetTablet - -Outputs a JSON structure that contains information about the Tablet. - -#### Example - -
GetTablet <tablet alias>
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* the <tablet alias> argument is required for the <GetTablet> command This error occurs if the command is not called with exactly one argument. - - -### IgnoreHealthError - -Deprecated. - -### UpdateTabletAddrs - -Deprecated. Updates the IP address and port numbers of a tablet. - -#### Example - -
UpdateTabletAddrs -- [--hostname <hostname>] [--ip-addr <ip addr>] [--mysql-port <mysql port>] [--vt-port <vt port>] [--grpc-port <grpc port>] <tablet alias>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| grpc-port | Int | The gRPC port for the vttablet process | -| hostname | string | The fully qualified host name of the server on which the tablet is running. | -| mysql-port | Int | The mysql port for the mysql daemon | -| mysql_host | string | The mysql host for the mysql server | -| vt-port | Int | The main port for the vttablet process | - - -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* the <tablet alias> argument is required for the <UpdateTabletAddrs> command This error occurs if the command is not called with exactly one argument. - -### DeleteTablet - -Deletes tablet(s) from the topology. - -#### Example - -
DeleteTablet -- [--allow_primary] <tablet alias> ...
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| allow_primary | Boolean | Allows for the primary tablet of a shard to be deleted. Use with caution. | - - -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. To specify multiple values for this argument, separate individual values with a space. - -#### Errors - -* the <tablet alias> argument must be used to specify at least one tablet when calling the <DeleteTablet> command This error occurs if the command is not called with at least one argument. - -### SetReadOnly - -Sets the tablet as read-only. - -#### Example - -
SetReadOnly <tablet alias>
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* the <tablet alias> argument is required for the <SetReadOnly> command This error occurs if the command is not called with exactly one argument. -* failed reading tablet %v: %v - -### SetReadWrite - -Sets the tablet as read-write. - -#### Example - -
SetReadWrite <tablet alias>
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* the <tablet alias> argument is required for the <SetReadWrite> command This error occurs if the command is not called with exactly one argument. -* failed reading tablet %v: %v - -### StartReplication - -Starts replication on the specified tablet. - -#### Example - -
StartReplication <tablet alias>
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* action <StartReplication> requires <tablet alias> This error occurs if the command is not called with exactly one argument. -* failed reading tablet %v: %v - -### StopReplication - -Stops replication on the specified tablet. - -#### Example - -
StopReplication <tablet alias>
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* action <StopReplication> requires <tablet alias> This error occurs if the command is not called with exactly one argument. -* failed reading tablet %v: %v - -### ChangeTabletType - -Changes the db type for the specified tablet, if possible. This command is used primarily to arrange replicas, and it will not convert a primary.

NOTE: This command automatically updates the serving graph.

- -#### Example - -
ChangeTabletType -- [--dry-run] <tablet alias> <tablet type>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| dry-run | Boolean | Lists the proposed change without actually executing it | - - -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. -* <tablet type> – Required. The vttablet's role. Valid values are: - - * backup – A replicated copy of data that is offline to queries other than for backup purposes - * batch – A replicated copy of data for OLAP load patterns (typically for MapReduce jobs) - * experimental – A replicated copy of data that is ready but not serving query traffic. The value indicates a special characteristic of the tablet that indicates the tablet should not be considered a potential primary. Vitess also does not worry about lag for experimental tablets when reparenting. - * primary – A primary copy of data - * master – Deprecated, same as primary - * rdonly – A replicated copy of data for OLAP load patterns - * replica – A replicated copy of data ready to be promoted to primary - * restore – A tablet that is restoring from a snapshot. Typically, this happens at tablet startup, then it goes to its right state. - * spare – A replicated copy of data that is ready but not serving query traffic. The data could be a potential primary tablet. - -#### Errors - -* the <tablet alias> and <db type> arguments are required for the <ChangeTabletType> command This error occurs if the command is not called with exactly 2 arguments. -* failed reading tablet %v: %v -* invalid type transition %v: %v --> %v - -### Ping - -hecks that the specified tablet is awake and responding to RPCs. This command can be blocked by other in-flight operations. - -#### Example - -
Ping <tablet alias>
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* the <tablet alias> argument is required for the <Ping> command This error occurs if the command is not called with exactly one argument. - -### RefreshState - -Reloads the tablet record on the specified tablet. - -#### Example - -
RefreshState <tablet alias>
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* the <tablet alias> argument is required for the <RefreshState> command This error occurs if the command is not called with exactly one argument. - -### RefreshStateByShard - -Runs 'RefreshState' on all tablets in the given shard. - -#### Example - -
RefreshStateByShard -- [--cells=c1,c2,...] <keyspace/shard>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| cells | string | Specifies a comma-separated list of cells whose tablets are included. If empty, all cells are considered. | - - -#### Arguments - -* <keyspace/shard> – Required. The name of a sharded database that contains one or more tables as well as the shard associated with the command. The keyspace must be identified by a string that does not contain whitespace, while the shard is typically identified by a string in the format <range start>-<range end>. - -#### Errors - -* the <keyspace/shard> argument is required for the <RefreshStateByShard> command This error occurs if the command is not called with exactly one argument. - -### RunHealthCheck - -Runs a health check on a remote tablet. - -#### Example - -
RunHealthCheck <tablet alias>
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* the <tablet alias> argument is required for the <RunHealthCheck> command This error occurs if the command is not called with exactly one argument. -* this only reports an error if a "healthcheck" RPC call to a vttablet fails. It is only useful as a connectivity and vttablet liveness check. - -### Sleep - -Blocks the action queue on the specified tablet for the specified amount of time. This is typically used for testing. - -#### Example - -
Sleep <tablet alias> <duration>
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. -* <duration> – Required. The amount of time that the action queue should be blocked. The value is a string that contains a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms" or "1h45m". See the definition of the Go language's ParseDuration function for more details. Note that, in practice, the value should be a positively signed value. - -#### Errors - -* the <tablet alias> and <duration> arguments are required for the <Sleep> command This error occurs if the command is not called with exactly 2 arguments. - -### ExecuteHook - -Runs the specified hook on the given tablet. A hook is a script that resides in the $VTROOT/vthook directory. You can put any script into that directory and use this command to run that script.

For this command, the param=value arguments are parameters that the command passes to the specified hook. - -#### Example - -
ExecuteHook <tablet alias> <hook name> [<param1=value1> <param2=value2> ...]
- -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. -* <hook name> – Required. -* <param1=value1> <param2=value2> . – Optional. - -#### Errors - -* the <tablet alias> and <hook name> arguments are required for the <ExecuteHook> command This error occurs if the command is not called with at least 2 arguments. - -### ExecuteFetchAsApp - -``` -ExecuteFetchAsApp -- [--max_rows=10000] [--json] [--use_pool] -``` - -### ExecuteFetchAsDba - -Runs the given SQL command as a DBA on the remote tablet. - -#### Example - -
ExecuteFetchAsDba -- [--max_rows=10000] [--disable_binlogs] [--json] <tablet alias> <sql command>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| disable_binlogs | Boolean | Disables writing to binlogs during the query | -| json | Boolean | Output JSON instead of human-readable table | -| max_rows | Int | Specifies the maximum number of rows to allow in reset | -| reload_schema | Boolean | Indicates whether the tablet schema will be reloaded after executing the SQL command. The default value is false, which indicates that the tablet schema will not be reloaded. | - - -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. -* <sql command> – Required. - -#### Errors - -* the <tablet alias> and <sql command> arguments are required for the <ExecuteFetchAsDba> command This error occurs if the command is not called with exactly 2 arguments. - -### VReplicationExec - -``` -VReplicationExec -- [--json] -``` - -### Backup - -Stops mysqld and uses the [BackupEngine](../../../../user-guides/operating-vitess/backup-and-restore/backup-and-restore/#backup-engines) to generate a new backup and uses the [BackupStorage](../../../../user-guides/operating-vitess/backup-and-restore/backup-and-restore/#backup-storage-services) service to store the results. This function also remembers if the tablet was replicating so that it can restore the same state after the backup completes. - -#### Example - -
Backup -- [--concurrency=4] [--upgrade-safe=false] <tablet alias>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| concurrency | Int | Specifies the number of compression/checksum jobs to run simultaneously | -| upgrade-safe | Boolean | Whether to use innodb_fast_shutdown=0 for the backup so it is safe to use for MySQL upgrades | - -#### Arguments - -* <tablet alias> – Required. A Tablet Alias uniquely identifies a vttablet. The argument value is in the format <cell name>-<uid>. - -#### Errors - -* the <Backup> command requires the <tablet alias> argument This error occurs if the command is not called with exactly one argument. - -### RestoreFromBackup - -Stops mysqld and restores the data from the latest backup. - -#### Example - -
RestoreFromBackup -- [--backup_timestamp=2021-09-24.021828] <tablet alias>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| backup_timestamp | String | Use the latest backup at or before this time -- in `yyyy-MM-dd.HHmmss` format -- rather than using the most recent backup (Vitess 12.0+) | - -#### Errors - -* the <RestoreFromBackup> command requires the <tablet alias> argument This error occurs if the command is not called with exactly one argument. - - -### ReparentTablet - -Reparent a tablet to the current primary in the shard. This only works if the current replication position matches the last known reparent action. - -#### Example - -
ReparentTablet <tablet alias>
- -#### Errors - -* action <ReparentTablet> requires <tablet alias> This error occurs if the command is not called with exactly one argument. -* active reparent commands disabled (unset the -disable_active_reparents flag to enable) - - -## See Also - -* [vtctl command index](../../vtctl) diff --git a/content/en/docs/22.0/reference/programs/vtctl/throttler.md b/content/en/docs/22.0/reference/programs/vtctl/throttler.md deleted file mode 100644 index 49cd192d9..000000000 --- a/content/en/docs/22.0/reference/programs/vtctl/throttler.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: vtctl Throttler Command Reference -series: vtctl -docs_nav_title: Throttler ---- - -The following `vtctl` commands are available for controlling the tablet throttler - -## Commands - -### UpdateThrottlerConfig - -Update tablet throttler configuration for all tablets of a given keyspace. - -#### Usage - -
UpdateThrottlerConfig -- [--enable|--disable] [--threshold=<float64>] [--custom-query=<query>] [--check-as-check-self|--check-as-check-shard] [--throttle-app|unthrottle-app=<name>] [--throttle-app-ratio=<float, range [0..1]>] [--throttle-app-duration=<duration>] <keyspace>
- -#### Examples - -```UpdateThrottlerConfig -- --enable --threshold "3.0" commerce``` - -```UpdateThrottlerConfig -- --disable commerce``` - -```UpdateThrottlerConfig -- --throttle-app="vreplication" --throttle-app-ratio=0.5 --throttle-app-duration="30m" commerce``` - -```UpdateThrottlerConfig -- --unthrottle-app="vreplication" commerce``` - - -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- | :--------- | -| `enable` | Boolean | enable the throttler. Once enabled, the throttler probes the MySQL servers for metrics, and responds to `check` requests according to those metrics | -| `disable` | Boolean | disables the throttler. Once disabled, the throttler responds to all `check` requests with `200 OK`. It will not probe the MySQL servers for metrics | -| `threshold` | Double | set a new threshold. Unless specified otherwise, the throttler measures replication lag by querying for heartbeat values, and the threshold stands for _seconds_ of lag (i.e. the value `2.5` stands for two and a half seconds) | -| `custom-query` | String | override the default replication lag measurement, and suggest a different query. Valid values are:
- _empty_, meaning the throttler should use the default replication lag query
- A `SELECT` that returns a single line, single column, floating point value
- A `SHOW GLOBAL STATUS|VARIABLES LIKE '...'`, for example `show global status like 'threads_running'` | -| `check-as-check-shard` | Boolean | this is the default behavior. A `/throttler/check` request checks the shard health. When using the default replication lag query, this is the desired check: the primary tablet's throttler responds by evaluating the overall lag throughout the shard/replicas | -| `check-as-check-self` | Boolean | override default behavior, and this can be useful when a `--custom-query` is set. A `/throttler/check` request will only consider the tablet's own metrics, and not the overall shard metrics | - - -#### Arguments - -* <keyspace> – Required. The keyspace for which to apply the throttler configuration. All tablets in all shards and cells assigned to this keyspace are affected. - -#### Errors - -Any error transporting the configuration to a cell's local topo server. - -## See Also - -* [vtctl command index](../../vtctl) diff --git a/content/en/docs/22.0/reference/programs/vtctl/topo.md b/content/en/docs/22.0/reference/programs/vtctl/topo.md deleted file mode 100644 index b6f8a69c4..000000000 --- a/content/en/docs/22.0/reference/programs/vtctl/topo.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: vtctl Topo Command Reference -series: vtctl -docs_nav_title: Topology Service ---- - -The following `vtctl` commands are available for administering Topology Services. - -## Commands - -### TopoCat - -Retrieves the file(s) at <path> from the topo service, and displays it. It can resolve wildcards, and decode the proto-encoded data. - -#### Example - -
TopoCat -- [--cell <cell>] [--decode_proto] [--long] <path> [<path>...]
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- |:----------------------------------------------------------------| -| cell | string | topology cell to cat the file from. Defaults to global cell. | -| decode_proto | Boolean | decode proto files and display them as text. Defaults to false. | -| decode_proto_json | Boolean | decode proto files and display them as json. Defaults to false. | -| long | Boolean | long listing. Defaults to false. | - - -#### Arguments - -* <cell> – Required. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms "cell" and "data center" are interchangeable. The argument value is a string that does not contain whitespace. -* <path> – Required. -* <path>. – Optional. - -#### Errors - -* <TopoCat>: no path specified. This error occurs if the command is not called with at least one argument. -* <TopoCat>: invalid wildcards. If you send paths that don't contain any wildcard and don't exist. -* <TopoCat>: some paths had errors. If there is an error getting node data for given paths. - -### TopoCp - -Copy data at given path from topo service to local file or vice versa. - -#### Example - -
TopoCp -- [--cell <cell>] [--to_topo] <src> <dst>
- -#### Flags - -| Name | Type | Definition | -| :-------- | :--------- |:------------------------------------------------| -| cell | string | topology cell to use for the copy. Defaults to global cell. | -| to_topo | Boolean | copies from local server to topo instead (reverse direction). Defaults to false. | - -#### Arguments - -* <cell> – Required. A cell is a location for a service. Generally, a cell resides in only one cluster. In Vitess, the terms "cell" and "data center" are interchangeable. The argument value is a string that does not contain whitespace. -* <src> – Required. Source from which data needs to be copied. It can be local file or some path in topo service, depedning on if `to_topo` is specified. -* <dst>. – Required. Destination to which data will be copied. It can be local file or some path in topo service, depedning on if `to_topo` is specified. - -#### Errors - -* <TopoCp>: need source and destination. This error occurs if the command is not called with proper `src` and `dst`. - - -## See Also - -* [vtctl command index](../../vtctl) diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/_index.md b/content/en/docs/22.0/reference/programs/vtctldclient/_index.md index ae6254c76..38b2d1523 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/_index.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/_index.md @@ -1,15 +1,14 @@ --- title: vtctldclient series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient -Executes a cluster management command on the remote vtctld server. +Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. ### Synopsis -Executes a cluster management command on the remote vtctld server. +Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. If there are no running vtctld servers -- for example when bootstrapping a new Vitess cluster -- you can specify a --server value of 'internal'. When doing so, you would use the --topo* flags so that the client can @@ -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. @@ -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 the 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 the primary match all of 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. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md index 289abc8e8..582aae9a3 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_AddCellInfo.md @@ -1,7 +1,6 @@ --- title: AddCellInfo series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient AddCellInfo @@ -40,5 +39,5 @@ vtctldclient AddCellInfo --root [--server-address ] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md index 460ac269e..d70716738 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_AddCellsAlias.md @@ -1,7 +1,6 @@ --- title: AddCellsAlias series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient AddCellsAlias @@ -39,5 +38,5 @@ vtctldclient AddCellsAlias --cells [--cells ...] ] [--uuid ...] [--migr ``` --batch-size int How many queries to batch together. Only applicable when all queries are CREATE TABLE|VIEW --caller-id string Effective caller ID used for the operation and should map to an ACL name which grants this identity the necessary permissions to perform the operation (this is only necessary when strict table ACLs are used). - --ddl-strategy string Online DDL strategy, compatible with @@ddl_strategy session variable (examples: 'mysql', 'vitess --postpone-completion'. (default "direct") + --ddl-strategy string Online DDL strategy, compatible with @@ddl_strategy session variable (examples: 'direct', 'mysql', 'vitess --postpone-completion'. (default "direct") -h, --help help for ApplySchema --migration-context string For Online DDL, optionally supply a custom unique string used as context for the migration(s) in this command. By default a unique context is auto-generated by Vitess. --sql stringArray Semicolon-delimited, repeatable SQL commands to apply. Exactly one of --sql|--sql-file is required. @@ -54,5 +53,5 @@ vtctldclient ApplySchema [--ddl-strategy ] [--uuid ...] [--migr ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md index e425c6bd6..0ce90ecd4 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ApplyShardRoutingRules.md @@ -1,7 +1,6 @@ --- title: ApplyShardRoutingRules series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ApplyShardRoutingRules @@ -35,5 +34,5 @@ vtctldclient ApplyShardRoutingRules {--rules RULES | --rules-file RULES_FILE} [- ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md index 1548f46d9..c211cb19b 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ApplyVSchema.md @@ -1,7 +1,6 @@ --- title: ApplyVSchema series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ApplyVSchema @@ -38,5 +37,5 @@ vtctldclient ApplyVSchema {--vschema= || --vschema-file= ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Backup.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Backup.md index e3b3c8d97..5e2b886a2 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Backup.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Backup.md @@ -1,7 +1,6 @@ --- title: Backup series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Backup @@ -35,5 +34,5 @@ vtctldclient Backup [--concurrency ] [--allow-primary] [--increment ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md index 895b11368..4e8eab1dd 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_BackupShard.md @@ -1,7 +1,6 @@ --- title: BackupShard series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient BackupShard @@ -40,5 +39,5 @@ vtctldclient BackupShard [--concurrency ] [--allow-primary] [--incr ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletTags.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletTags.md index cbd11a9d6..60ad089d4 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletTags.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletTags.md @@ -1,7 +1,6 @@ --- title: ChangeTabletTags series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ChangeTabletTags @@ -37,5 +36,5 @@ vtctldclient ChangeTabletTags [ ... ] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md index e39c8b14f..1a4e93fa5 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ChangeTabletType.md @@ -1,7 +1,6 @@ --- title: ChangeTabletType series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ChangeTabletType @@ -38,5 +37,5 @@ vtctldclient ChangeTabletType [--dry-run] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CheckThrottler.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CheckThrottler.md index a84a34e59..3dc8a635a 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CheckThrottler.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CheckThrottler.md @@ -1,7 +1,6 @@ --- title: CheckThrottler series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient CheckThrottler @@ -40,5 +39,5 @@ CheckThrottler --app-name online-ddl zone1-0000000101 ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CopySchemaShard.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CopySchemaShard.md new file mode 100644 index 000000000..12c5bb3a8 --- /dev/null +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CopySchemaShard.md @@ -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=,,...] [--exclude-tables=,,...] [--include-views] [--skip-verify] [--wait-replicas-timeout=10s] { || } +``` + +### 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 or alternatively as a standalone binary using --server=internal. + diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md index c2cac306b..7175ce6e9 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CreateKeyspace.md @@ -1,7 +1,6 @@ --- title: CreateKeyspace series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient CreateKeyspace @@ -44,5 +43,5 @@ vtctldclient CreateKeyspace [--force|-f] [--type KEYSPACE_TYPE] [--ba ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md index eb054d0d6..5127e26d6 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_CreateShard.md @@ -1,7 +1,6 @@ --- title: CreateShard series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient CreateShard @@ -32,5 +31,5 @@ vtctldclient CreateShard [--force|-f] [--include-parent|-p] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md index 1b8f30223..34cf87a8b 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteCellInfo.md @@ -1,7 +1,6 @@ --- title: DeleteCellInfo series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient DeleteCellInfo @@ -35,5 +34,5 @@ vtctldclient DeleteCellInfo [--force] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md index 9a3b6872a..144923884 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteCellsAlias.md @@ -1,7 +1,6 @@ --- title: DeleteCellsAlias series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient DeleteCellsAlias @@ -34,5 +33,5 @@ vtctldclient DeleteCellsAlias ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md index 46bf9e20e..11df1c597 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteKeyspace.md @@ -1,7 +1,6 @@ --- title: DeleteKeyspace series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient DeleteKeyspace @@ -39,5 +38,5 @@ vtctldclient DeleteKeyspace [--recursive|-r] [--force|-f] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md index b46cf493a..28c822bd2 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteShards.md @@ -1,7 +1,6 @@ --- title: DeleteShards series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient DeleteShards @@ -41,5 +40,5 @@ vtctldclient DeleteShards [--recursive|-r] [--even-if-serving] [--force|-f] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md index d9d32f34a..4f8ed76fa 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DeleteTablets.md @@ -1,7 +1,6 @@ --- title: DeleteTablets series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient DeleteTablets @@ -31,5 +30,5 @@ vtctldclient DeleteTablets [ ... ] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/_index.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/_index.md index ccad0ef51..7ab930145 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/_index.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/_index.md @@ -1,7 +1,6 @@ --- title: DistributedTransaction series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient DistributedTransaction @@ -26,7 +25,7 @@ Perform commands on distributed transaction ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. * [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 get-info](./vtctldclient_distributedtransaction_get-info/) - Reads the state of the unresolved transaction by querying each participating shard. * [vtctldclient DistributedTransaction unresolved-list](./vtctldclient_distributedtransaction_unresolved-list/) - Retrieves unresolved transactions for the given keyspace. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_conclude.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_conclude.md index 635336b0a..c8848e397 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_conclude.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_conclude.md @@ -1,7 +1,6 @@ --- title: DistributedTransaction conclude series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient DistributedTransaction conclude diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_get-info.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_get-info.md index 130d129c9..b87426142 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_get-info.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_get-info.md @@ -1,7 +1,6 @@ --- title: DistributedTransaction get-info series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient DistributedTransaction get-info diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_unresolved-list.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_unresolved-list.md index c2fb75675..895eed162 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_unresolved-list.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_DistributedTransaction/vtctldclient_DistributedTransaction_unresolved-list.md @@ -1,7 +1,6 @@ --- title: DistributedTransaction unresolved-list series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient DistributedTransaction unresolved-list diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md index f590037f5..096460561 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_EmergencyReparentShard.md @@ -1,7 +1,6 @@ --- title: EmergencyReparentShard series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient EmergencyReparentShard @@ -36,5 +35,5 @@ vtctldclient EmergencyReparentShard ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsApp.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsApp.md index 8458bb6e5..7a715178f 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsApp.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsApp.md @@ -1,7 +1,6 @@ --- title: ExecuteFetchAsApp series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ExecuteFetchAsApp @@ -33,5 +32,5 @@ vtctldclient ExecuteFetchAsApp [--max-rows ] [--json|-j] [--use-pool] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsDBA.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsDBA.md index 4c24245be..2d6280450 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsDBA.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteFetchAsDBA.md @@ -1,7 +1,6 @@ --- title: ExecuteFetchAsDBA series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ExecuteFetchAsDBA @@ -34,5 +33,5 @@ vtctldclient ExecuteFetchAsDBA [--max-rows ] [--json|-j] [--disable-bi ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteHook.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteHook.md index cf4b3a6ee..1eec1eaf6 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteHook.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteHook.md @@ -1,7 +1,6 @@ --- title: ExecuteHook series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ExecuteHook @@ -44,5 +43,5 @@ vtctldclient ExecuteHook [ ...] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteMultiFetchAsDBA.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteMultiFetchAsDBA.md index c7c0a32eb..2e304e7f9 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteMultiFetchAsDBA.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ExecuteMultiFetchAsDBA.md @@ -1,7 +1,6 @@ --- title: ExecuteMultiFetchAsDBA series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ExecuteMultiFetchAsDBA @@ -34,5 +33,5 @@ vtctldclient ExecuteMultiFetchAsDBA [--max-rows ] [--json|-j] [--disab ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_FindAllShardsInKeyspace.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_FindAllShardsInKeyspace.md index 1bc5fa0e6..53c111f4c 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_FindAllShardsInKeyspace.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_FindAllShardsInKeyspace.md @@ -1,7 +1,6 @@ --- title: FindAllShardsInKeyspace series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient FindAllShardsInKeyspace @@ -30,5 +29,5 @@ vtctldclient FindAllShardsInKeyspace ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GenerateShardRanges.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GenerateShardRanges.md index 81423bb1f..a5789b51c 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GenerateShardRanges.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GenerateShardRanges.md @@ -1,7 +1,6 @@ --- title: GenerateShardRanges series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GenerateShardRanges @@ -30,5 +29,5 @@ vtctldclient GenerateShardRanges ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetBackups.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetBackups.md index 63a616d60..f6fee4135 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetBackups.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetBackups.md @@ -1,7 +1,6 @@ --- title: GetBackups series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetBackups @@ -32,5 +31,5 @@ vtctldclient GetBackups [--limit ] [--json] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetCellInfo.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetCellInfo.md index 1c13b201a..c87722066 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetCellInfo.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetCellInfo.md @@ -1,7 +1,6 @@ --- title: GetCellInfo series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetCellInfo @@ -30,5 +29,5 @@ vtctldclient GetCellInfo ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetCellInfoNames.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetCellInfoNames.md index 2c21afa24..80319f812 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetCellInfoNames.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetCellInfoNames.md @@ -1,7 +1,6 @@ --- title: GetCellInfoNames series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetCellInfoNames @@ -30,5 +29,5 @@ vtctldclient GetCellInfoNames ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetCellsAliases.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetCellsAliases.md index bfe3d630a..ac808bf8b 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetCellsAliases.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetCellsAliases.md @@ -1,7 +1,6 @@ --- title: GetCellsAliases series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetCellsAliases @@ -30,5 +29,5 @@ vtctldclient GetCellsAliases ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetFullStatus.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetFullStatus.md index 8b5c43b5c..65313c590 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetFullStatus.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetFullStatus.md @@ -1,7 +1,6 @@ --- title: GetFullStatus series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetFullStatus @@ -30,5 +29,5 @@ vtctldclient GetFullStatus ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetKeyspace.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetKeyspace.md index ce0068c94..43b6fc108 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetKeyspace.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetKeyspace.md @@ -1,7 +1,6 @@ --- title: GetKeyspace series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetKeyspace @@ -30,5 +29,5 @@ vtctldclient GetKeyspace ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaceRoutingRules.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaceRoutingRules.md index a44a94b0a..b48c850f3 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaceRoutingRules.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaceRoutingRules.md @@ -1,7 +1,6 @@ --- title: GetKeyspaceRoutingRules series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetKeyspaceRoutingRules @@ -30,5 +29,5 @@ vtctldclient GetKeyspaceRoutingRules ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaces.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaces.md index 6f7af82ce..df3106c3c 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaces.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetKeyspaces.md @@ -1,7 +1,6 @@ --- title: GetKeyspaces series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetKeyspaces @@ -30,5 +29,5 @@ vtctldclient GetKeyspaces ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetMirrorRules.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetMirrorRules.md index 310cb048b..26ac1c138 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetMirrorRules.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetMirrorRules.md @@ -1,7 +1,6 @@ --- title: GetMirrorRules series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetMirrorRules @@ -30,5 +29,5 @@ vtctldclient GetMirrorRules ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetPermissions.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetPermissions.md index c33830b77..504312b4e 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetPermissions.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetPermissions.md @@ -1,7 +1,6 @@ --- title: GetPermissions series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetPermissions @@ -30,5 +29,5 @@ vtctldclient GetPermissions ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetRoutingRules.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetRoutingRules.md index 6b3ca1060..cdde11c9d 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetRoutingRules.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetRoutingRules.md @@ -1,7 +1,6 @@ --- title: GetRoutingRules series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetRoutingRules @@ -30,5 +29,5 @@ vtctldclient GetRoutingRules ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSchema.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSchema.md index 509a9f913..dffa2d439 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSchema.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSchema.md @@ -1,7 +1,6 @@ --- title: GetSchema series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetSchema @@ -36,5 +35,5 @@ vtctldclient GetSchema [--tables TABLES ...] [--exclude-tables EXCLUDE_TABLES .. ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetShard.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetShard.md index 16a8a1cd0..b21c45d34 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetShard.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetShard.md @@ -1,7 +1,6 @@ --- title: GetShard series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetShard @@ -30,5 +29,5 @@ vtctldclient GetShard ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetShardReplication.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetShardReplication.md index 49da5f840..82930e29f 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetShardReplication.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetShardReplication.md @@ -1,7 +1,6 @@ --- title: GetShardReplication series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetShardReplication @@ -30,5 +29,5 @@ vtctldclient GetShardReplication [cell1 [cell2...]] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetShardRoutingRules.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetShardRoutingRules.md index 2722fd9fa..d9d165ae6 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetShardRoutingRules.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetShardRoutingRules.md @@ -1,7 +1,6 @@ --- title: GetShardRoutingRules series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetShardRoutingRules @@ -38,5 +37,5 @@ vtctldclient GetShardRoutingRules ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvKeyspaceNames.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvKeyspaceNames.md index 5bb9df9a5..482d7a8c7 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvKeyspaceNames.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvKeyspaceNames.md @@ -1,7 +1,6 @@ --- title: GetSrvKeyspaceNames series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetSrvKeyspaceNames @@ -30,5 +29,5 @@ vtctldclient GetSrvKeyspaceNames [ ...] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvKeyspaces.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvKeyspaces.md index 04c0ef26b..b6097940f 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvKeyspaces.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvKeyspaces.md @@ -1,7 +1,6 @@ --- title: GetSrvKeyspaces series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetSrvKeyspaces @@ -30,5 +29,5 @@ vtctldclient GetSrvKeyspaces [ ...] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvVSchema.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvVSchema.md index d518dbb30..b59b4b16c 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvVSchema.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvVSchema.md @@ -1,7 +1,6 @@ --- title: GetSrvVSchema series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetSrvVSchema @@ -30,5 +29,5 @@ vtctldclient GetSrvVSchema cell ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvVSchemas.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvVSchemas.md index 0796fb966..564a74b71 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvVSchemas.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetSrvVSchemas.md @@ -1,7 +1,6 @@ --- title: GetSrvVSchemas series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetSrvVSchemas @@ -30,5 +29,5 @@ vtctldclient GetSrvVSchemas [ ...] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTablet.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTablet.md index fa2a8316d..01e7988ef 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTablet.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTablet.md @@ -1,7 +1,6 @@ --- title: GetTablet series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetTablet @@ -30,5 +29,5 @@ vtctldclient GetTablet ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTabletVersion.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTabletVersion.md index 01822889e..5049acaa0 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTabletVersion.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTabletVersion.md @@ -1,7 +1,6 @@ --- title: GetTabletVersion series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetTabletVersion @@ -30,5 +29,5 @@ vtctldclient GetTabletVersion ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTablets.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTablets.md index 34bd356fd..32a434592 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTablets.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTablets.md @@ -1,7 +1,6 @@ --- title: GetTablets series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetTablets @@ -58,5 +57,5 @@ vtctldclient GetTablets [--strict] [{--cell $c1 [--cell $c2 ...] [--tablet-type ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetThrottlerStatus.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetThrottlerStatus.md index f0c138d18..47f683298 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetThrottlerStatus.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetThrottlerStatus.md @@ -1,7 +1,6 @@ --- title: GetThrottlerStatus series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetThrottlerStatus @@ -36,5 +35,5 @@ GetThrottlerStatus zone1-0000000101 ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTopologyPath.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTopologyPath.md index 1cdf8f5bb..84f9309cc 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTopologyPath.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetTopologyPath.md @@ -1,7 +1,6 @@ --- title: GetTopologyPath series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetTopologyPath @@ -32,5 +31,5 @@ vtctldclient GetTopologyPath ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetVSchema.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetVSchema.md index ed12e810f..cfa233c74 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetVSchema.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetVSchema.md @@ -1,7 +1,6 @@ --- title: GetVSchema series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetVSchema @@ -30,5 +29,5 @@ vtctldclient GetVSchema ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetWorkflows.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetWorkflows.md index c26850270..7eab6a937 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetWorkflows.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_GetWorkflows.md @@ -1,7 +1,6 @@ --- title: GetWorkflows series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient GetWorkflows @@ -32,5 +31,5 @@ vtctldclient GetWorkflows ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LegacyVtctlCommand.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LegacyVtctlCommand.md index b3461d3cc..286c23331 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LegacyVtctlCommand.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LegacyVtctlCommand.md @@ -1,7 +1,6 @@ --- title: LegacyVtctlCommand series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient LegacyVtctlCommand @@ -63,5 +62,5 @@ LegacyVtctlCommand -- AddCellInfo --server_address "localhost:5678" --root "/vit ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/_index.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/_index.md index 681b22183..bbe2f394c 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/_index.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/_index.md @@ -1,7 +1,6 @@ --- title: LookupVindex series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient LookupVindex @@ -28,9 +27,11 @@ Perform commands related to creating, backfilling, and externalizing Lookup Vind ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. * [vtctldclient LookupVindex cancel](./vtctldclient_lookupvindex_cancel/) - Cancel the VReplication workflow that backfills the Lookup Vindex. +* [vtctldclient LookupVindex complete](./vtctldclient_lookupvindex_complete/) - Complete the LookupVindex workflow. The Vindex must have been previously externalized. If you want to delete the workflow without externalizing the Vindex then use the cancel command instead. * [vtctldclient LookupVindex create](./vtctldclient_lookupvindex_create/) - Create the Lookup Vindex in the specified keyspace and backfill it with a VReplication workflow. -* [vtctldclient LookupVindex externalize](./vtctldclient_lookupvindex_externalize/) - Externalize the Lookup Vindex. If the Vindex has an owner the VReplication workflow will also be deleted. +* [vtctldclient LookupVindex externalize](./vtctldclient_lookupvindex_externalize/) - Externalize the Lookup Vindex. If the Vindex has an owner the VReplication workflow will also be stopped/deleted. +* [vtctldclient LookupVindex internalize](./vtctldclient_lookupvindex_internalize/) - Internalize the Vindex again to continue the backfill, making it unusable for queries again. * [vtctldclient LookupVindex show](./vtctldclient_lookupvindex_show/) - Show the status of the VReplication workflow that backfills the Lookup Vindex. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_cancel.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_cancel.md index 9e0d01fd0..e208dfd8d 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_cancel.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_cancel.md @@ -1,7 +1,6 @@ --- title: LookupVindex cancel series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient LookupVindex cancel diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_complete.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_complete.md new file mode 100644 index 000000000..8a64ead6b --- /dev/null +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_complete.md @@ -0,0 +1,42 @@ +--- +title: LookupVindex complete +series: vtctldclient +--- +## vtctldclient LookupVindex complete + +Complete the LookupVindex workflow. The Vindex must have been previously externalized. If you want to delete the workflow without externalizing the Vindex then use the cancel command instead. + +``` +vtctldclient LookupVindex complete +``` + +### Examples + +``` +vtctldclient --server localhost:15999 LookupVindex --name corder_lookup_vdx --table-keyspace customer complete +``` + +### Options + +``` + -h, --help help for complete + --keyspace string The keyspace containing the Lookup Vindex. If no value is specified then the table-keyspace will be used. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --name string The name of the Lookup Vindex to create. This will also be the name of the VReplication workflow created to backfill the Lookup Vindex. + --server string server to use for the connection (required) + --table-keyspace string The keyspace to create the lookup table in. This is also where the VReplication workflow is created to backfill the Lookup Vindex. + --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 LookupVindex](../) - Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows. + diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_create.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_create.md index 14bdf8363..b51e5a171 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_create.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_create.md @@ -1,7 +1,6 @@ --- title: LookupVindex create series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient LookupVindex create diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_externalize.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_externalize.md index 7abc6f385..928a58cab 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_externalize.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_externalize.md @@ -1,11 +1,10 @@ --- title: LookupVindex externalize series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient LookupVindex externalize -Externalize the Lookup Vindex. If the Vindex has an owner the VReplication workflow will also be deleted. +Externalize the Lookup Vindex. If the Vindex has an owner the VReplication workflow will also be stopped/deleted. ``` vtctldclient LookupVindex externalize @@ -20,6 +19,7 @@ vtctldclient --server localhost:15999 LookupVindex --name corder_lookup_vdx --ta ### Options ``` + --delete Delete the VReplication workflow after externalizing the Vindex, instead of stopping (default false). -h, --help help for externalize --keyspace string The keyspace containing the Lookup Vindex. If no value is specified then the table-keyspace will be used. ``` diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_internalize.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_internalize.md new file mode 100644 index 000000000..0216cc00f --- /dev/null +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_internalize.md @@ -0,0 +1,42 @@ +--- +title: LookupVindex internalize +series: vtctldclient +--- +## vtctldclient LookupVindex internalize + +Internalize the Vindex again to continue the backfill, making it unusable for queries again. + +``` +vtctldclient LookupVindex internalize +``` + +### Examples + +``` +vtctldclient --server localhost:15999 LookupVindex --name corder_lookup_vdx --table-keyspace customer internalize +``` + +### Options + +``` + -h, --help help for internalize + --keyspace string The keyspace containing the Lookup Vindex. If no value is specified then the table-keyspace will be used. +``` + +### Options inherited from parent commands + +``` + --action_timeout duration timeout to use for the command (default 1h0m0s) + --compact use compact format for otherwise verbose outputs + --name string The name of the Lookup Vindex to create. This will also be the name of the VReplication workflow created to backfill the Lookup Vindex. + --server string server to use for the connection (required) + --table-keyspace string The keyspace to create the lookup table in. This is also where the VReplication workflow is created to backfill the Lookup Vindex. + --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 LookupVindex](../) - Perform commands related to creating, backfilling, and externalizing Lookup Vindexes using VReplication workflows. + diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_show.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_show.md index 12d0967d8..3aa5d31bf 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_show.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_LookupVindex/vtctldclient_LookupVindex_show.md @@ -1,7 +1,6 @@ --- title: LookupVindex show series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient LookupVindex show diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/_index.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/_index.md index 4f7ebe9f4..09816a20a 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/_index.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/_index.md @@ -1,7 +1,6 @@ --- title: Materialize series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Materialize @@ -29,7 +28,7 @@ Perform commands related to materializing query results from the source keyspace ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. * [vtctldclient Materialize cancel](./vtctldclient_materialize_cancel/) - Cancel a Materialize VReplication workflow. * [vtctldclient Materialize create](./vtctldclient_materialize_create/) - Create and run a Materialize VReplication workflow. * [vtctldclient Materialize show](./vtctldclient_materialize_show/) - Show the details for a Materialize VReplication workflow. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_cancel.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_cancel.md index 1c12d0345..34a9b772a 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_cancel.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_cancel.md @@ -1,7 +1,6 @@ --- title: Materialize cancel series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Materialize cancel diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_create.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_create.md index b751b7c6a..76e38ba28 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_create.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_create.md @@ -1,7 +1,6 @@ --- title: Materialize create series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Materialize create @@ -32,7 +31,7 @@ should be copied as-is from the source keyspace. Here's an example value for tab { "target_table": "sales_by_sku", "source_expression": "select sku, count(*) as orders, sum(price) as revenue from corder group by sku", - "create_ddl": "create table sales_by_sku (sku varchar(128) not null primary key, orders bigint, revenue bigint)" + "create_ddl": "create table sales_by_sku (sku varbinary(128) not null primary key, orders bigint, revenue bigint)" } ] @@ -44,7 +43,7 @@ vtctldclient Materialize create ### Examples ``` -vtctldclient --server localhost:15999 materialize --workflow product_sales --target-keyspace commerce create --source-keyspace commerce --table-settings '[{"target_table": "sales_by_sku", "create_ddl": "create table sales_by_sku (sku varchar(128) not null primary key, orders bigint, revenue bigint)", "source_expression": "select sku, count(*) as orders, sum(price) as revenue from corder group by sku"}]' --cells zone1 --cells zone2 --tablet-types replica +vtctldclient --server localhost:15999 materialize --workflow product_sales --target-keyspace commerce create --source-keyspace commerce --table-settings '[{"target_table": "sales_by_sku", "create_ddl": "create table sales_by_sku (sku varbinary(128) not null primary key, orders bigint, revenue bigint)", "source_expression": "select sku, count(*) as orders, sum(price) as revenue from corder group by sku"}]' --cells zone1 --cells zone2 --tablet-types replica ``` ### Options @@ -52,7 +51,7 @@ vtctldclient --server localhost:15999 materialize --workflow product_sales --tar ``` -c, --cells strings Cells and/or CellAliases to copy table data from. -h, --help help for create - --mysql_server_version string Configure the MySQL version to use for example for the parser. (default "8.0.30-Vitess") + --mysql_server_version string Configure the MySQL version to use for example for the parser. (default "8.0.40-Vitess") -r, --reference-tables strings Used to specify the reference tables to materialize on every target shard. --source-keyspace string Keyspace where the tables queried in the 'source_expression' values within table-settings live. --sql-max-length-errors int truncate queries in error logs to the given length (default unlimited) diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_show.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_show.md index f920c7895..bc6cc6742 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_show.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_show.md @@ -1,7 +1,6 @@ --- title: Materialize show series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Materialize show diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_start.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_start.md index 801ee397f..0938619dd 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_start.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_start.md @@ -1,7 +1,6 @@ --- title: Materialize start series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Materialize start diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_stop.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_stop.md index c79e5a4e2..3ee97e955 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_stop.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Materialize/vtctldclient_Materialize_stop.md @@ -1,7 +1,6 @@ --- title: Materialize stop series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Materialize stop diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/_index.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/_index.md index fa3592258..4892f55d7 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/_index.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/_index.md @@ -1,7 +1,6 @@ --- title: Migrate series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Migrate @@ -29,7 +28,7 @@ Migrate is used to import data from an external cluster into the current cluster ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. * [vtctldclient Migrate cancel](./vtctldclient_migrate_cancel/) - Cancel a Migrate VReplication workflow. * [vtctldclient Migrate complete](./vtctldclient_migrate_complete/) - Complete a Migrate VReplication workflow. * [vtctldclient Migrate create](./vtctldclient_migrate_create/) - Create and optionally run a Migrate VReplication workflow. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_cancel.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_cancel.md index 226147ac2..74e37e350 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_cancel.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_cancel.md @@ -1,7 +1,6 @@ --- title: Migrate cancel series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Migrate cancel diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_complete.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_complete.md index 82a855505..61b8ee09e 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_complete.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_complete.md @@ -1,7 +1,6 @@ --- title: Migrate complete series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Migrate complete diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_create.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_create.md index a609463e4..137f6ae10 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_create.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_create.md @@ -1,7 +1,6 @@ --- title: Migrate create series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Migrate create diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_show.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_show.md index eecdfcb0f..85d766ead 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_show.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_show.md @@ -1,7 +1,6 @@ --- title: Migrate show series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Migrate show diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_status.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_status.md index 0d59b6e74..c217fa5df 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_status.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Migrate/vtctldclient_Migrate_status.md @@ -1,7 +1,6 @@ --- title: Migrate status series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Migrate status diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/_index.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/_index.md index 53a442072..7fb91d537 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/_index.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/_index.md @@ -1,7 +1,6 @@ --- title: Mount series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Mount @@ -26,7 +25,7 @@ Mount is used to link an external Vitess cluster in order to migrate data from i ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. * [vtctldclient Mount list](./vtctldclient_mount_list/) - List all mounted external Vitess Clusters. * [vtctldclient Mount register](./vtctldclient_mount_register/) - Register an external Vitess Cluster. * [vtctldclient Mount show](./vtctldclient_mount_show/) - Show attributes of a previously mounted external Vitess Cluster. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_list.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_list.md index 887186e30..f0d47e287 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_list.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_list.md @@ -1,7 +1,6 @@ --- title: Mount list series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Mount list diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_register.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_register.md index eaaa5b149..9ecdd6325 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_register.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_register.md @@ -1,7 +1,6 @@ --- title: Mount register series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Mount register diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_show.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_show.md index ebf1e7c33..a8e49c659 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_show.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_show.md @@ -1,7 +1,6 @@ --- title: Mount show series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Mount show diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_unregister.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_unregister.md index 6ddd2c726..7f0eab40b 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_unregister.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Mount/vtctldclient_Mount_unregister.md @@ -1,7 +1,6 @@ --- title: Mount unregister series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Mount unregister diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md index 2918531d6..f3e16d55c 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/_index.md @@ -1,7 +1,6 @@ --- title: MoveTables series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient MoveTables @@ -29,7 +28,7 @@ Perform commands related to moving tables from a source keyspace to a target key ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. * [vtctldclient MoveTables cancel](./vtctldclient_movetables_cancel/) - Cancel a MoveTables VReplication workflow. * [vtctldclient MoveTables complete](./vtctldclient_movetables_complete/) - Complete a MoveTables VReplication workflow. * [vtctldclient MoveTables create](./vtctldclient_movetables_create/) - Create and optionally run a MoveTables VReplication workflow. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md index 22cdc8986..8f69812e7 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_cancel.md @@ -1,7 +1,6 @@ --- title: MoveTables cancel series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient MoveTables cancel diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md index 14373c062..16411d2f8 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_complete.md @@ -1,7 +1,6 @@ --- title: MoveTables complete series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient MoveTables complete diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_create.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_create.md index 9acd81c49..ac353fc44 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_create.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_create.md @@ -1,7 +1,6 @@ --- title: MoveTables create series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient MoveTables create diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_mirrortraffic.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_mirrortraffic.md index 1bc94ed8f..7e915f541 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_mirrortraffic.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_mirrortraffic.md @@ -1,7 +1,6 @@ --- title: MoveTables mirrortraffic series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient MoveTables mirrortraffic diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md index be940fdba..1384b4ca2 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_reversetraffic.md @@ -1,7 +1,6 @@ --- title: MoveTables reversetraffic series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient MoveTables reversetraffic diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md index 24ee11e5f..c86066f81 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_show.md @@ -1,7 +1,6 @@ --- title: MoveTables show series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient MoveTables show diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md index 76d18b012..77ece809e 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_start.md @@ -1,7 +1,6 @@ --- title: MoveTables start series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient MoveTables start diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md index 1cb26a9f6..3ce49cc8a 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_status.md @@ -1,7 +1,6 @@ --- title: MoveTables status series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient MoveTables status diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md index 5a77456ac..fdaf532e0 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_stop.md @@ -1,7 +1,6 @@ --- title: MoveTables stop series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient MoveTables stop diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md index b57cba802..3d9003e52 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_MoveTables/vtctldclient_MoveTables_switchtraffic.md @@ -1,7 +1,6 @@ --- title: MoveTables switchtraffic series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient MoveTables switchtraffic diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md index e972ea177..4620faf3b 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/_index.md @@ -1,7 +1,6 @@ --- title: OnlineDDL series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient OnlineDDL @@ -26,7 +25,7 @@ Operates on online DDL (schema migrations). ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. * [vtctldclient OnlineDDL cancel](./vtctldclient_onlineddl_cancel/) - Cancel one or all migrations, terminating any running ones as needed. * [vtctldclient OnlineDDL cleanup](./vtctldclient_onlineddl_cleanup/) - Mark a given schema migration, or all complete/failed/cancelled migrations, ready for artifact cleanup. * [vtctldclient OnlineDDL complete](./vtctldclient_onlineddl_complete/) - Complete one or all migrations executed with --postpone-completion diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md index daabf1277..ea279ce5c 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cancel.md @@ -1,7 +1,6 @@ --- title: OnlineDDL cancel series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient OnlineDDL cancel diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cleanup.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cleanup.md index 0df04b80c..58da58a81 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cleanup.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_cleanup.md @@ -1,7 +1,6 @@ --- title: OnlineDDL cleanup series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient OnlineDDL cleanup diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md index 4ba70c39d..92e127f00 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_complete.md @@ -1,7 +1,6 @@ --- title: OnlineDDL complete series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient OnlineDDL complete diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_force-cutover.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_force-cutover.md index bab354614..178b5b9e0 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_force-cutover.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_force-cutover.md @@ -1,7 +1,6 @@ --- title: OnlineDDL force-cutover series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient OnlineDDL force-cutover diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md index fe9887a7c..7b24d8383 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_launch.md @@ -1,7 +1,6 @@ --- title: OnlineDDL launch series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient OnlineDDL launch diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.md index 5c189fe6a..4d869adda 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_retry.md @@ -1,7 +1,6 @@ --- title: OnlineDDL retry series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient OnlineDDL retry diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_show.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_show.md index 8ac3cf1b9..d68c57024 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_show.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_show.md @@ -1,7 +1,6 @@ --- title: OnlineDDL show series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient OnlineDDL show diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_throttle.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_throttle.md index 260d324ed..17e07b4f7 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_throttle.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_throttle.md @@ -1,7 +1,6 @@ --- title: OnlineDDL throttle series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient OnlineDDL throttle diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_unthrottle.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_unthrottle.md index 225d37ae3..4dbf42887 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_unthrottle.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_OnlineDDL/vtctldclient_OnlineDDL_unthrottle.md @@ -1,7 +1,6 @@ --- title: OnlineDDL unthrottle series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient OnlineDDL unthrottle diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_PingTablet.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_PingTablet.md index dbc6b5880..d125fc7cc 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_PingTablet.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_PingTablet.md @@ -1,7 +1,6 @@ --- title: PingTablet series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient PingTablet @@ -30,5 +29,5 @@ vtctldclient PingTablet ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_PlannedReparentShard.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_PlannedReparentShard.md index b3cbedc81..e5b0fe4ad 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_PlannedReparentShard.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_PlannedReparentShard.md @@ -1,7 +1,6 @@ --- title: PlannedReparentShard series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient PlannedReparentShard @@ -36,5 +35,5 @@ vtctldclient PlannedReparentShard ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RebuildKeyspaceGraph.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RebuildKeyspaceGraph.md index 8651ca1be..ffb3170fd 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RebuildKeyspaceGraph.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RebuildKeyspaceGraph.md @@ -1,7 +1,6 @@ --- title: RebuildKeyspaceGraph series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient RebuildKeyspaceGraph @@ -32,5 +31,5 @@ vtctldclient RebuildKeyspaceGraph [--cells=c1,c2,...] [--allow-partial] ks1 [ks2 ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RebuildVSchemaGraph.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RebuildVSchemaGraph.md index 4429630fb..ce65f2f2e 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RebuildVSchemaGraph.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RebuildVSchemaGraph.md @@ -1,7 +1,6 @@ --- title: RebuildVSchemaGraph series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient RebuildVSchemaGraph @@ -31,5 +30,5 @@ vtctldclient RebuildVSchemaGraph [--cells=c1,c2,...] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RefreshState.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RefreshState.md index 03bf25098..853b6a2b1 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RefreshState.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RefreshState.md @@ -1,7 +1,6 @@ --- title: RefreshState series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient RefreshState @@ -30,5 +29,5 @@ vtctldclient RefreshState ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RefreshStateByShard.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RefreshStateByShard.md index e6cf94287..4a0e98d4f 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RefreshStateByShard.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RefreshStateByShard.md @@ -1,7 +1,6 @@ --- title: RefreshStateByShard series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient RefreshStateByShard @@ -31,5 +30,5 @@ vtctldclient RefreshStateByShard [--cell ...] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ReloadSchema.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ReloadSchema.md index b06398e53..8cf855c6c 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ReloadSchema.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ReloadSchema.md @@ -1,7 +1,6 @@ --- title: ReloadSchema series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ReloadSchema @@ -30,5 +29,5 @@ vtctldclient ReloadSchema ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaKeyspace.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaKeyspace.md index 7caa35c45..5de5bf374 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaKeyspace.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaKeyspace.md @@ -1,7 +1,6 @@ --- title: ReloadSchemaKeyspace series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ReloadSchemaKeyspace @@ -32,5 +31,5 @@ vtctldclient ReloadSchemaKeyspace [--concurrency=] [--include-prima ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaShard.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaShard.md index ef16104aa..74d1fcd48 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaShard.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ReloadSchemaShard.md @@ -1,7 +1,6 @@ --- title: ReloadSchemaShard series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ReloadSchemaShard @@ -32,5 +31,5 @@ vtctldclient ReloadSchemaShard [--concurrency=10] [--include-primary] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RemoveKeyspaceCell.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RemoveKeyspaceCell.md index 3f3a800a2..56ab5500c 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RemoveKeyspaceCell.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RemoveKeyspaceCell.md @@ -1,7 +1,6 @@ --- title: RemoveKeyspaceCell series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient RemoveKeyspaceCell @@ -32,5 +31,5 @@ vtctldclient RemoveKeyspaceCell [--force|-f] [--recursive|-r] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RemoveShardCell.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RemoveShardCell.md index dbeb27584..388546c2a 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RemoveShardCell.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RemoveShardCell.md @@ -1,7 +1,6 @@ --- title: RemoveShardCell series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient RemoveShardCell @@ -32,5 +31,5 @@ vtctldclient RemoveShardCell [--force|-f] [--recursive|-r] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/_index.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/_index.md index a4ca877fe..f87036cb1 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/_index.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/_index.md @@ -1,7 +1,6 @@ --- title: Reshard series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Reshard @@ -29,7 +28,7 @@ Perform commands related to resharding a keyspace. ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. * [vtctldclient Reshard cancel](./vtctldclient_reshard_cancel/) - Cancel a Reshard VReplication workflow. * [vtctldclient Reshard complete](./vtctldclient_reshard_complete/) - Complete a Reshard VReplication workflow. * [vtctldclient Reshard create](./vtctldclient_reshard_create/) - Create and optionally run a Reshard VReplication workflow. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_cancel.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_cancel.md index fcea97f4f..51132d4a7 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_cancel.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_cancel.md @@ -1,7 +1,6 @@ --- title: Reshard cancel series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Reshard cancel diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_complete.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_complete.md index 93ac1ce0b..778bd87e9 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_complete.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_complete.md @@ -1,7 +1,6 @@ --- title: Reshard complete series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Reshard complete diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_create.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_create.md index b16edbd4e..c38288902 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_create.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_create.md @@ -1,7 +1,6 @@ --- title: Reshard create series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Reshard create diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_reversetraffic.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_reversetraffic.md index 18676825f..13e9f5fe2 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_reversetraffic.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_reversetraffic.md @@ -1,7 +1,6 @@ --- title: Reshard reversetraffic series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Reshard reversetraffic diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_show.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_show.md index 23496b430..b5bfb81fb 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_show.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_show.md @@ -1,7 +1,6 @@ --- title: Reshard show series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Reshard show diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_start.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_start.md index 9b97dbada..a2ed75466 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_start.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_start.md @@ -1,7 +1,6 @@ --- title: Reshard start series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Reshard start diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_status.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_status.md index a5ee75763..0781416cb 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_status.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_status.md @@ -1,7 +1,6 @@ --- title: Reshard status series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Reshard status diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_stop.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_stop.md index 3e24630ad..c1044201d 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_stop.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_stop.md @@ -1,7 +1,6 @@ --- title: Reshard stop series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Reshard stop diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_switchtraffic.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_switchtraffic.md index da3edf353..9d66840ed 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_switchtraffic.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Reshard/vtctldclient_Reshard_switchtraffic.md @@ -1,7 +1,6 @@ --- title: Reshard switchtraffic series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Reshard switchtraffic diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RestoreFromBackup.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RestoreFromBackup.md index 947cc2100..92e856c14 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RestoreFromBackup.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RestoreFromBackup.md @@ -1,7 +1,6 @@ --- title: RestoreFromBackup series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient RestoreFromBackup @@ -35,5 +34,5 @@ vtctldclient RestoreFromBackup [--backup-timestamp|-t ] [--re ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RunHealthCheck.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RunHealthCheck.md index 7e65a77a7..e85512fbf 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RunHealthCheck.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_RunHealthCheck.md @@ -1,7 +1,6 @@ --- title: RunHealthCheck series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient RunHealthCheck @@ -30,5 +29,5 @@ vtctldclient RunHealthCheck ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SetKeyspaceDurabilityPolicy.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SetKeyspaceDurabilityPolicy.md index bc8223359..5ef4e157c 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SetKeyspaceDurabilityPolicy.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SetKeyspaceDurabilityPolicy.md @@ -1,7 +1,6 @@ --- title: SetKeyspaceDurabilityPolicy series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient SetKeyspaceDurabilityPolicy @@ -40,5 +39,5 @@ vtctldclient SetKeyspaceDurabilityPolicy [--durability-policy=policy_name] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SetShardTabletControl.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SetShardTabletControl.md index e0ea4dab0..45f6c7606 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SetShardTabletControl.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SetShardTabletControl.md @@ -1,7 +1,6 @@ --- title: SetShardTabletControl series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient SetShardTabletControl @@ -52,5 +51,5 @@ vtctldclient SetShardTabletControl [--cells=c1,c2...] [--denied-tables=t1,t2,... ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SetWritable.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SetWritable.md index fb3a4e6f3..d99503ea0 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SetWritable.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SetWritable.md @@ -1,7 +1,6 @@ --- title: SetWritable series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient SetWritable @@ -30,5 +29,5 @@ vtctldclient SetWritable ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ShardReplicationFix.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ShardReplicationFix.md index cf9101da4..c438580a5 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ShardReplicationFix.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ShardReplicationFix.md @@ -1,7 +1,6 @@ --- title: ShardReplicationFix series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ShardReplicationFix @@ -30,5 +29,5 @@ vtctldclient ShardReplicationFix ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ShardReplicationPositions.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ShardReplicationPositions.md index fc643363a..c869ae200 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ShardReplicationPositions.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ShardReplicationPositions.md @@ -1,7 +1,6 @@ --- title: ShardReplicationPositions series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ShardReplicationPositions @@ -36,5 +35,5 @@ vtctldclient ShardReplicationPositions ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SleepTablet.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SleepTablet.md index 1e655fc69..8ae5d2936 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SleepTablet.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SleepTablet.md @@ -1,7 +1,6 @@ --- title: SleepTablet series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient SleepTablet @@ -46,5 +45,5 @@ vtctldclient SleepTablet ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SourceShardAdd.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SourceShardAdd.md index 1ac2ff34a..e9ccbe53f 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SourceShardAdd.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_SourceShardAdd.md @@ -1,7 +1,6 @@ --- title: SourceShardAdd series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient SourceShardAdd @@ -32,5 +31,5 @@ vtctldclient SourceShardAdd [--key-range ] [--tables ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_StartReplication.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_StartReplication.md index e8e3bc2f8..b9762d1b7 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_StartReplication.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_StartReplication.md @@ -1,7 +1,6 @@ --- title: StartReplication series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient StartReplication @@ -30,5 +29,5 @@ vtctldclient StartReplication ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_StopReplication.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_StopReplication.md index 3fa527ae4..ced9f8cec 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_StopReplication.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_StopReplication.md @@ -1,7 +1,6 @@ --- title: StopReplication series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient StopReplication @@ -30,5 +29,5 @@ vtctldclient StopReplication ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_TabletExternallyReparented.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_TabletExternallyReparented.md index 0cdc1287f..360377fb9 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_TabletExternallyReparented.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_TabletExternallyReparented.md @@ -1,7 +1,6 @@ --- title: TabletExternallyReparented series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient TabletExternallyReparented @@ -37,5 +36,5 @@ vtctldclient TabletExternallyReparented ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_UpdateCellInfo.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_UpdateCellInfo.md index 71999bc1a..1a3bb4330 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_UpdateCellInfo.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_UpdateCellInfo.md @@ -1,7 +1,6 @@ --- title: UpdateCellInfo series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient UpdateCellInfo @@ -38,5 +37,5 @@ vtctldclient UpdateCellInfo [--root ] [--server-address ] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_UpdateCellsAlias.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_UpdateCellsAlias.md index 3f3da852c..aa49e0625 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_UpdateCellsAlias.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_UpdateCellsAlias.md @@ -1,7 +1,6 @@ --- title: UpdateCellsAlias series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient UpdateCellsAlias @@ -35,5 +34,5 @@ vtctldclient UpdateCellsAlias [--cells [--cells ...]] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md index 77c12f2c2..5f3d9e9e2 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_UpdateThrottlerConfig.md @@ -1,7 +1,6 @@ --- title: UpdateThrottlerConfig series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient UpdateThrottlerConfig @@ -42,5 +41,5 @@ vtctldclient UpdateThrottlerConfig [--enable|--disable] [--metric-name=] [ ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/_index.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/_index.md index a1b202aa5..395c6a062 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/_index.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/_index.md @@ -1,7 +1,6 @@ --- title: VDiff series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient VDiff @@ -29,7 +28,7 @@ Perform commands related to diffing tables involved in a VReplication workflow b ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. * [vtctldclient VDiff create](./vtctldclient_vdiff_create/) - Create and run a VDiff to compare the tables involved in a VReplication workflow between the source and target. * [vtctldclient VDiff delete](./vtctldclient_vdiff_delete/) - Delete VDiffs. * [vtctldclient VDiff resume](./vtctldclient_vdiff_resume/) - Resume a VDiff. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_create.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_create.md index bae4cf7e4..2f25ac60f 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_create.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_create.md @@ -1,7 +1,6 @@ --- title: VDiff create series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient VDiff create diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_delete.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_delete.md index 4ddb4e4ec..a8aa4ff8a 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_delete.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_delete.md @@ -1,7 +1,6 @@ --- title: VDiff delete series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient VDiff delete diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_resume.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_resume.md index df4acfe23..ac9a84ca7 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_resume.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_resume.md @@ -1,7 +1,6 @@ --- title: VDiff resume series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient VDiff resume diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_show.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_show.md index ae20b4d0c..627645eae 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_show.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_show.md @@ -1,7 +1,6 @@ --- title: VDiff show series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient VDiff show diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_stop.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_stop.md index 675e3001e..a628dc33b 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_stop.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_VDiff/vtctldclient_VDiff_stop.md @@ -1,7 +1,6 @@ --- title: VDiff stop series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient VDiff stop diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Validate.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Validate.md index 69973d416..a76e0843a 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Validate.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Validate.md @@ -1,7 +1,6 @@ --- title: Validate series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Validate @@ -31,5 +30,5 @@ vtctldclient Validate [--ping-tablets] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateKeyspace.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateKeyspace.md index c897b25a5..76e3e070f 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateKeyspace.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateKeyspace.md @@ -1,7 +1,6 @@ --- title: ValidateKeyspace series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ValidateKeyspace @@ -31,5 +30,5 @@ vtctldclient ValidateKeyspace [--ping-tablets] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidatePermissionsKeyspace.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidatePermissionsKeyspace.md new file mode 100644 index 000000000..829fcba2e --- /dev/null +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidatePermissionsKeyspace.md @@ -0,0 +1,33 @@ +--- +title: ValidatePermissionsKeyspace +series: vtctldclient +--- +## vtctldclient ValidatePermissionsKeyspace + +Validates that the permissions on the primary of the first shard match those of all of the other tablets in the keyspace. + +``` +vtctldclient ValidatePermissionsKeyspace +``` + +### Options + +``` + -h, --help help for ValidatePermissionsKeyspace +``` + +### 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 or alternatively as a standalone binary using --server=internal. + diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidatePermissionsShard.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidatePermissionsShard.md new file mode 100644 index 000000000..92e0d6273 --- /dev/null +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidatePermissionsShard.md @@ -0,0 +1,33 @@ +--- +title: ValidatePermissionsShard +series: vtctldclient +--- +## vtctldclient ValidatePermissionsShard + +Validates that the permissions on the primary match all of the replicas. + +``` +vtctldclient ValidatePermissionsShard +``` + +### Options + +``` + -h, --help help for ValidatePermissionsShard +``` + +### 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 or alternatively as a standalone binary using --server=internal. + diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateSchemaKeyspace.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateSchemaKeyspace.md index c9429185d..e702d5b54 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateSchemaKeyspace.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateSchemaKeyspace.md @@ -1,11 +1,10 @@ --- title: ValidateSchemaKeyspace series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ValidateSchemaKeyspace -Validates that the schema on the primary tablet for shard 0 matches the schema on all other tablets in the keyspace. +Validates that the schema on the primary tablet for the first shard matches the schema on all other tablets in the keyspace. ``` vtctldclient ValidateSchemaKeyspace [--exclude-tables=] [--include-views] [--skip-no-primary] [--include-vschema] @@ -34,5 +33,5 @@ vtctldclient ValidateSchemaKeyspace [--exclude-tables=] [--inclu ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateSchemaShard.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateSchemaShard.md new file mode 100644 index 000000000..7e6892580 --- /dev/null +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateSchemaShard.md @@ -0,0 +1,37 @@ +--- +title: ValidateSchemaShard +series: vtctldclient +--- +## 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 ValidateSchemaShard [--exclude-tables=] [--include-views] [--skip-no-primary] [--include-vschema] +``` + +### Options + +``` + --exclude-tables strings Tables to exclude during schema comparison. + -h, --help help for ValidateSchemaShard + --include-views Includes views in compared schemas. + --include-vschema Includes VSchema validation in validation results. + --skip-no-primary Skips validation on whether or not a primary exists in shards. +``` + +### 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 or alternatively as a standalone binary using --server=internal. + diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateShard.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateShard.md index c975fbbdd..15c3b35c7 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateShard.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateShard.md @@ -1,7 +1,6 @@ --- title: ValidateShard series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ValidateShard @@ -31,5 +30,5 @@ vtctldclient ValidateShard [--ping-tablets] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateVersionKeyspace.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateVersionKeyspace.md index 14bba10de..642d5b6a4 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateVersionKeyspace.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateVersionKeyspace.md @@ -1,11 +1,10 @@ --- title: ValidateVersionKeyspace series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ValidateVersionKeyspace -Validates that the version on the primary tablet of shard 0 matches all of the other tablets in the keyspace. +Validates that the version on the primary tablet of the first shard matches all of the other tablets in the keyspace. ``` vtctldclient ValidateVersionKeyspace @@ -30,5 +29,5 @@ vtctldclient ValidateVersionKeyspace ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateVersionShard.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateVersionShard.md index 8adc0a1f0..04a38b541 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateVersionShard.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_ValidateVersionShard.md @@ -1,7 +1,6 @@ --- title: ValidateVersionShard series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient ValidateVersionShard @@ -30,5 +29,5 @@ vtctldclient ValidateVersionShard ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/_index.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/_index.md index 5e36f0b9b..5e6603c48 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/_index.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/_index.md @@ -1,7 +1,6 @@ --- title: Workflow series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Workflow @@ -31,7 +30,7 @@ vtctldclient Workflow --keyspace [command] [command-flags] ### SEE ALSO -* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server. +* [vtctldclient](../) - Executes a cluster management command on the remote vtctld server or alternatively as a standalone binary using --server=internal. * [vtctldclient Workflow delete](./vtctldclient_workflow_delete/) - Delete a VReplication workflow. * [vtctldclient Workflow list](./vtctldclient_workflow_list/) - List the VReplication workflows in the given keyspace. * [vtctldclient Workflow show](./vtctldclient_workflow_show/) - Show the details for a VReplication workflow. diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_delete.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_delete.md index 49a258cfb..ce0b0ed1f 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_delete.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_delete.md @@ -1,7 +1,6 @@ --- title: Workflow delete series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Workflow delete diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_list.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_list.md index 59661433b..29f1fb9ec 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_list.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_list.md @@ -1,7 +1,6 @@ --- title: Workflow list series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Workflow list diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_show.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_show.md index fcb3ed0c3..e3db86975 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_show.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_show.md @@ -1,7 +1,6 @@ --- title: Workflow show series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Workflow show diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_start.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_start.md index 3c4a2c15c..7c97a1d6f 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_start.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_start.md @@ -1,7 +1,6 @@ --- title: Workflow start series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Workflow start diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_stop.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_stop.md index ba7387569..9d61f54a6 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_stop.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_stop.md @@ -1,7 +1,6 @@ --- title: Workflow stop series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Workflow stop diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_update.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_update.md index 38358b910..f49c28bc8 100644 --- a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_update.md +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_Workflow/vtctldclient_Workflow_update.md @@ -1,7 +1,6 @@ --- title: Workflow update series: vtctldclient -commit: d9ab9f7a1cf3cae19a1ea06963798a7646e8fb27 --- ## vtctldclient Workflow update diff --git a/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_WriteTopologyPath.md b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_WriteTopologyPath.md new file mode 100644 index 000000000..5c062acea --- /dev/null +++ b/content/en/docs/22.0/reference/programs/vtctldclient/vtctldclient_WriteTopologyPath.md @@ -0,0 +1,34 @@ +--- +title: WriteTopologyPath +series: vtctldclient +--- +## vtctldclient WriteTopologyPath + +Copies a local file to the topology server at the given path. + +``` +vtctldclient WriteTopologyPath --server=local +``` + +### Options + +``` + --cell string Topology server cell to copy the file to. (default "global") + -h, --help help for WriteTopologyPath +``` + +### 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 or alternatively as a standalone binary using --server=internal. + diff --git a/content/en/docs/22.0/reference/vtctldclient-transition/command_diff.md b/content/en/docs/22.0/reference/vtctldclient-transition/command_diff.md index bd5e38bb4..589e384df 100644 --- a/content/en/docs/22.0/reference/vtctldclient-transition/command_diff.md +++ b/content/en/docs/22.0/reference/vtctldclient-transition/command_diff.md @@ -15,7 +15,6 @@ For stronger guarantees of compatibility, we highly encourage programming direct | | `vtctlclient` command name (OLD) | `vtctldclient` command name (NEW) | |-|-|-| | | N/A | [`ApplyShardRoutingRules`](../../programs/vtctldclient/vtctldclient_applyroutingrules/) | -| | `CopySchemaShard` | (deleted) | | | `CreateLookupVindex` | [`LookupVindex create`](../../programs/vtctldclient/vtctldclient_lookupvindex/vtctldclient_lookupvindex_create/) | | | `DeleteShard` | [`DeleteShards`](../../programs/vtctldclient/vtctldclient_deleteshards/) | | | `DeleteTablet` | [`DeleteTablets`](../../programs/vtctldclient/vtctldclient_deletetablets/) | @@ -30,18 +29,15 @@ For stronger guarantees of compatibility, we highly encourage programming direct | | N/A | [`GetSrvVSchemas`](../../programs/vtctldclient/vtctldclient_getsrvvschemas/) | | | N/A | [`GetTabletVersion`](../../programs/vtctldclient/vtctldclient_gettabletversion/) | | | `ListAllTablets`, `ListShardTablets`, `ListTablets` | [`GetTablets`](../../programs/vtctldclient/vtctldclient_gettablets/) | -| | N/A | [`GetTopologyPath`](../../programs/vtctldclient/vtctldclient_gettopologypath/) | | | N/A | [`GetWorkflows`](../../programs/vtctldclient/vtctldclient_getworkflows/) | -| | `InitShardPrimary` | (deleted) | | | `Ping` | [`PingTablet`](../../programs/vtctldclient/vtctldclient_pingtablet/) | | | N/A | [`SetKeyspaceDurabilityPolicy`](../../programs/vtctldclient/vtctldclient_setkeyspacedurabilitypolicy/) | | | `SetReadOnly`, `SetReadWrite` | [`SetWritable`](../../programs/vtctldclient/vtctldclient_setwritable/) | | | `Sleep` | [`SleepTablet`](../../programs/vtctldclient/vtctldclient_sleeptablet/) | | | `TopoCat` | [`GetTopologyPath`](../../programs/vtctldclient/vtctldclient_gettopologypath/) | -| | `TopoCp` | (not yet migrated) | +| | `TopoCp` | [`WriteTopologyPath`](../../programs/vtctldclient/vtctldclient_writetopologypath/) | | | `UpdateSrvKeyspacePartition` | (not yet migrated) | | | `UpdateTabletAddrs` | (deleted) | | | `VReplicationExec` | (deleted) | -| | `ValidatePermissionsKeyspace`, `ValidatePermissionsShard` | (deleted) | | | `VtctldCommand` | N/A | | | `WaitForFilteredReplication` | (deleted) |