package vtadmin
Get desktop application:
View/edit binary Protocol Buffers messages
service VTAdmin
vtadmin.proto:35VTAdmin is the Vitess Admin API service. It provides RPCs that operate on across a range of Vitess clusters.
rpc ApplySchema (, )
vtadmin.proto:37ApplySchema applies a schema to a keyspace in the given cluster.
message
vtadmin.proto:392string cluster_id = 1
string sql = 2
Request.Sql will be overriden by this Sql field.
string caller_id = 3
Request.CallerId will be overriden by this CallerId field.
optional request = 4
CancelSchemaMigration cancels one or all schema migrations in the given cluster, terminating any running ones as needed.
message
vtadmin.proto:401string cluster_id = 1
optional request = 2
CleanupSchemaMigration marks a schema migration in the given cluster as ready for artifact cleanup.
message
vtadmin.proto:406string cluster_id = 1
optional request = 2
CompleteSchemaMigration completes one or all migrations in the given cluster executed with --postpone-completion.
message
vtadmin.proto:411string cluster_id = 1
optional request = 2
rpc ConcludeTransaction (, )
vtadmin.proto:48ConcludeTransaction concludes a distributed transaction identified by the provided dtid.
message
vtadmin.proto:416string cluster_id = 1
string dtid = 2
rpc CreateKeyspace (, )
vtadmin.proto:50CreateKeyspace creates a new keyspace in the given cluster.
message
vtadmin.proto:421string cluster_id = 1
optional options = 2
message
vtadmin.proto:426optional keyspace = 1
rpc CreateShard (, )
vtadmin.proto:52CreateShard creates a new shard in the given cluster and keyspace.
message
vtadmin.proto:430string cluster_id = 1
optional options = 2
rpc DeleteKeyspace (, )
vtadmin.proto:54DeleteKeyspace deletes a keyspace in the given cluster.
message
vtadmin.proto:435string cluster_id = 1
optional options = 2
rpc DeleteShards (, )
vtadmin.proto:56DeleteShard deletes one or more shards in the given cluster and keyspace.
message
vtadmin.proto:440string cluster_id = 1
optional options = 2
rpc DeleteTablet (, )
vtadmin.proto:58DeleteTablet deletes a tablet from the topology
message
vtadmin.proto:445optional alias = 1
repeated string cluster_ids = 2
bool allow_primary = 3
message
vtadmin.proto:451string status = 1
optional cluster = 2
EmergencyFailoverShard fails over a shard to a new primary. It assumes the old primary is dead or otherwise not responding.
message
vtadmin.proto:456string cluster_id = 1
optional options = 2
message
vtadmin.proto:461optional cluster = 1
string keyspace = 2
string shard = 3
optional promoted_primary = 4
PromotedPrimary is the tablet alias that was promoted to shard primary. If NewPrimary was set in the request options, then this will be the same tablet alias. Otherwise, it will be the alias of the tablet found to be most up-to-date in the shard.
repeated events = 5
rpc FindSchema (, )
vtadmin.proto:68FindSchema returns a single Schema that matches the provided table name across all specified clusters IDs. Not specifying a set of cluster IDs causes the search to span all configured clusters. An error occurs if either no table exists across any of the clusters with the specified table name, or if multiple tables exist with that name.
message
vtadmin.proto:473string table = 1
repeated string cluster_ids = 2
optional table_size_options = 3
rpc GetBackups (, )
vtadmin.proto:70GetBackups returns backups grouped by cluster.
message
vtadmin.proto:479repeated string cluster_ids = 1
repeated string keyspaces = 2
Keyspaces, if set, limits backups to just the specified keyspaces. Applies to all clusters in the request.
repeated string keyspace_shards = 3
KeyspaceShards, if set, limits backups to just the specified keyspace/shards. Applies to all clusters in the request. This field takes precedence over Keyspaces. If KeyspaceShards is set, Keyspaces is ignored.
optional request_options = 4
RequestOptions controls the per-shard request options when making GetBackups requests to vtctlds. Note that the Keyspace and Shard fields of this field are ignored; it is used only to specify Limit and Detailed fields.
message
vtadmin.proto:497repeated backups = 1
rpc GetCellInfos (, )
vtadmin.proto:75GetCellInfos returns the CellInfo objects for the specified clusters. Callers may optionally restrict the set of CellInfos, or restrict the response to include only cell names.
message
vtadmin.proto:501repeated string cluster_ids = 1
repeated string cells = 2
Cells, if specified, limits the response to include only CellInfo objects with those names. If omitted, all CellInfo objects in each cluster are returned. Mutually-exclusive with NamesOnly. If both are set, this field takes precedence.
bool names_only = 3
Return only the cell names in each cluster; the actual CellInfo objects will be empty.
message
vtadmin.proto:515repeated cell_infos = 1
rpc GetCellsAliases (, )
vtadmin.proto:77GetCellsAliases returns the CellsAliases data for the specified clusters.
message
vtadmin.proto:519repeated string cluster_ids = 1
message
vtadmin.proto:523repeated aliases = 1
rpc GetClusters (, )
vtadmin.proto:79GetClusters returns all configured clusters.
message
vtadmin.proto:527(message has no fields)
message
vtadmin.proto:529repeated clusters = 1
rpc GetFullStatus (, )
vtadmin.proto:81GetFullStatus returns the full status of MySQL including the replication information, semi-sync information, GTID information among others
message
vtadmin.proto:533string cluster_id = 1
optional alias = 2
rpc GetGates (, )
vtadmin.proto:83GetGates returns all gates across all the specified clusters.
message
vtadmin.proto:538repeated string cluster_ids = 1
message
vtadmin.proto:542repeated gates = 1
rpc GetKeyspace (, )
vtadmin.proto:85GetKeyspace returns a keyspace by name in the specified cluster.
message
vtadmin.proto:546string cluster_id = 1
string keyspace = 2
rpc GetKeyspaces (, )
vtadmin.proto:87GetKeyspaces returns all keyspaces across the specified clusters.
message
vtadmin.proto:551repeated string cluster_ids = 1
message
vtadmin.proto:555repeated keyspaces = 1
rpc GetSchema (, )
vtadmin.proto:90GetSchema returns the schema for the specified (cluster, keyspace, table) tuple.
message
vtadmin.proto:559string cluster_id = 1
string keyspace = 2
string table = 3
optional table_size_options = 4
rpc GetSchemas (, )
vtadmin.proto:92GetSchemas returns all schemas across the specified clusters.
message
vtadmin.proto:566repeated string cluster_ids = 1
optional table_size_options = 2
message
vtadmin.proto:571repeated schemas = 1
rpc GetSchemaMigrations (, )
vtadmin.proto:99GetSchemaMigrations returns one or more online schema migrations for the set of keyspaces (or all keyspaces) in the given clusters, analagous to repeated executions of `SHOW VITESS_MIGRATIONS`. Different fields in the request message result in different behaviors. See the documentation on vtctldata.GetSchemaMigrationsRequest for details.
message
vtadmin.proto:575repeated cluster_requests = 1
message
vtadmin.proto:584repeated schema_migrations = 1
GetShardReplicationPositions returns shard replication positions grouped by cluster.
message
vtadmin.proto:588repeated string cluster_ids = 1
repeated string keyspaces = 2
Keyspaces, if set, limits replication positions to just the specified keyspaces. Applies to all clusters in the request.
repeated string keyspace_shards = 3
KeyspaceShards, if set, limits replicatin positions to just the specified keyspace/shards. Applies to all clusters in the request. This field takes precedence over Keyspaces. If KeyspaceShards is set, Keyspaces is ignored.
message
vtadmin.proto:601repeated replication_positions = 1
rpc GetSrvKeyspace (, )
vtadmin.proto:104GetSrvKeyspace returns the SrvKeyspace for a keyspace in one or more cells.
message
vtadmin.proto:605string cluster_id = 1
string keyspace = 2
repeated string cells = 3
Cells is a list of cells to lookup a SrvKeyspace for. Leaving this empty is equivalent to specifying all cells in the topo.
rpc GetSrvKeyspaces (, )
vtadmin.proto:106GetSrvKeyspaces returns the SrvKeyspaces for all keyspaces across all the specified clusters.
message
vtadmin.proto:613repeated string cluster_ids = 1
An optional list of cluster IDs to filter specific clusters
repeated string cells = 2
Cells is a list of cells to lookup a SrvKeyspace for. Leaving this empty is equivalent to specifying all cells in the topo.
message
vtadmin.proto:621map<string, > srv_keyspaces = 1
GetSrvKeyspaces responses for each keyspace
rpc GetSrvVSchema (, )
vtadmin.proto:108GetSrvVSchema returns the SrvVSchema for the given cluster and cell.
message
vtadmin.proto:626string cluster_id = 1
string cell = 2
rpc GetSrvVSchemas (, )
vtadmin.proto:111GetSrvVSchemas returns all SrvVSchemas across all (or specified) clusters and cells.
message
vtadmin.proto:631repeated string cluster_ids = 1
repeated string cells = 2
message
vtadmin.proto:636repeated srv_v_schemas = 1
rpc GetTablet (, )
vtadmin.proto:114GetTablet looks up a tablet by hostname across all clusters and returns the result.
message
vtadmin.proto:645optional alias = 1
Unique (per cluster) tablet alias.
repeated string cluster_ids = 2
ClusterIDs is an optional parameter to narrow the scope of the search, if the caller knows which cluster the tablet may be in, or, to disambiguate if multiple clusters have a tablet with the same hostname.
rpc GetTablets (, )
vtadmin.proto:116GetTablets returns all tablets across all the specified clusters.
message
vtadmin.proto:654repeated string cluster_ids = 1
message
vtadmin.proto:658repeated tablets = 1
rpc GetTopologyPath (, )
vtadmin.proto:118GetTopologyPath returns the cell located at the specified path in the topology server.
message
vtadmin.proto:662string cluster_id = 1
string path = 2
rpc GetTransactionInfo (, )
vtadmin.proto:120GetTransactionInfo returns the information about a single transaction.
message
vtadmin.proto:667string cluster_id = 1
optional request = 2
GetUnresolvedTransactions returns the unresolved transactions for the request.
message
vtadmin.proto:672string cluster_id = 1
string keyspace = 2
int64 abandon_age = 3
rpc GetVSchema (, )
vtadmin.proto:125GetVSchema returns a VSchema for the specified keyspace in the specified cluster.
message
vtadmin.proto:678string cluster_id = 1
string keyspace = 2
rpc GetVSchemas (, )
vtadmin.proto:127GetVSchemas returns the VSchemas for all specified clusters.
message
vtadmin.proto:683repeated string cluster_ids = 1
message
vtadmin.proto:687repeated v_schemas = 1
rpc GetVtctlds (, )
vtadmin.proto:129GetVtctlds returns the Vtctlds for all specified clusters.
message
vtadmin.proto:691repeated string cluster_ids = 1
message
vtadmin.proto:695repeated vtctlds = 1
rpc GetWorkflow (, )
vtadmin.proto:132GetWorkflow returns a single Workflow for a given cluster, keyspace, and workflow name.
message
vtadmin.proto:699string cluster_id = 1
string keyspace = 2
string name = 3
bool active_only = 4
rpc GetWorkflows (, )
vtadmin.proto:134GetWorkflows returns the Workflows for all specified clusters.
message
vtadmin.proto:724repeated string cluster_ids = 1
bool active_only = 2
ActiveOnly specifies whether to return workflows that are currently active (running or paused) instead of all workflows.
repeated string keyspaces = 3
Keyspaces is a list of keyspaces to restrict the workflow search to. Note that the keyspaces list applies across all cluster IDs in the request. If, for example, you have two clusters, each with a keyspace called "foo" and want the workflows from "foo" in cluster1 but not from cluster2, you must make two requests. Keyspaces and IgnoreKeyspaces are mutually-exclusive, and Keyspaces takes precedence; if Keyspaces is a non-empty list, then IgnoreKeyspaces is ignored completely.
repeated string ignore_keyspaces = 4
IgnoreKeyspaces is a list of keyspaces to skip during the workflow search. It has the same semantics as the Keyspaces parameter, so refer to that documentation for more details.
message
vtadmin.proto:746map<string, > workflows_by_cluster = 1
rpc GetWorkflowStatus (, )
vtadmin.proto:136GetWorkflowStatus returns the status for a specific workflow.
message
vtadmin.proto:706string cluster_id = 1
string keyspace = 2
string name = 3
rpc StartWorkflow (, )
vtadmin.proto:138StartWorkflow starts a vreplication workflow.
message
vtadmin.proto:712string cluster_id = 1
string keyspace = 2
string workflow = 3
rpc StopWorkflow (, )
vtadmin.proto:140StopWorkflow stops a vreplication workflow.
message
vtadmin.proto:718string cluster_id = 1
string keyspace = 2
string workflow = 3
LaunchSchemaMigration launches one or all migrations in the given cluster executed with --postpone-launch.
message
vtadmin.proto:750string cluster_id = 1
optional request = 2
rpc MoveTablesComplete (, )
vtadmin.proto:146MoveTablesComplete completes the move and cleans up the workflow and its related artifacts.
message
vtadmin.proto:763string cluster_id = 1
optional request = 2
rpc MoveTablesCreate (, )
vtadmin.proto:149MoveTablesCreate creates a workflow which moves one or more tables from a source keyspace to a target keyspace.
message
vtadmin.proto:768string cluster_id = 1
optional request = 2
rpc MaterializeCreate (, )
vtadmin.proto:152MaterializeCreate creates a workflow to materialize one or more tables from a source keyspace to a target keyspace using a provided expressions.
message
vtadmin.proto:755string cluster_id = 1
string table_settings = 2
TableSettings is a JSON string defining what tables to materialize using what select statements.
optional request = 3
rpc PingTablet (, )
vtadmin.proto:155PingTablet checks that the specified tablet is awake and responding to RPCs. This command can be blocked by other in-flight operations.
message
vtadmin.proto:773optional alias = 1
Unique (per cluster) tablet alias of the standard form: "$cell-$uid"
repeated string cluster_ids = 2
ClusterIDs is an optional parameter to narrow the scope of the search, if the caller knows which cluster the tablet may be in, or, to disambiguate if multiple clusters have a tablet with the same hostname.
message
vtadmin.proto:782string status = 1
optional cluster = 2
PlannedFailoverShard fails over the shard to a new primary, or away from an old primary. Both the old and new primaries must be reachable and running. NOTE: A planned failover will not consider replicas outside the current shard primary's cell as promotion candidates unless NewPrimary is explicitly provided in the request.
message
vtadmin.proto:787string cluster_id = 1
optional options = 2
message
vtadmin.proto:792optional cluster = 1
string keyspace = 2
string shard = 3
optional promoted_primary = 4
PromotedPrimary is the tablet alias that was promoted to shard primary. If NewPrimary was set in the request options, then this will be the same tablet alias. Otherwise, it will be the alias of the tablet found to be most up-to-date in the shard.
repeated events = 5
RebuildKeyspaceGraph rebuilds the serving data for a keyspace.
message
vtadmin.proto:804string cluster_id = 1
string keyspace = 2
repeated string cells = 3
bool allow_partial = 4
message
vtadmin.proto:811string status = 1
rpc RefreshState (, )
vtadmin.proto:167RefreshState reloads the tablet record on the specified tablet.
message
vtadmin.proto:815optional alias = 1
repeated string cluster_ids = 2
message
vtadmin.proto:820string status = 1
optional cluster = 2
RefreshTabletReplicationSource performs a `CHANGE REPLICATION SOURCE TO` on a tablet to replicate from the current primary in the shard.
message
vtadmin.proto:932optional alias = 1
repeated string cluster_ids = 2
message
vtadmin.proto:937string keyspace = 1
string shard = 2
optional primary = 3
optional cluster = 4
rpc ReloadSchemas (, )
vtadmin.proto:174ReloadSchemas reloads the schema definition across keyspaces, shards, or tablets in one or more clusters, depending on the request fields (see ReloadSchemasRequest for details).
message
vtadmin.proto:825repeated string keyspaces = 1
Keyspaces, if set, will reload schemas across one or more keyspaces. A keyspace not existing in a cluster will not fail the overall request. Superceded by KeyspaceShards and Tablets, in that order.
repeated string keyspace_shards = 2
KeyspaceShards, if set, will reload schemas across one or more shards. Each element must be a valid keyspace/shard according to topoproto.ParseKeyspaceShard. A shard not existing in a cluster will not fail the overall request. Supercedes Keyspaces, and is superceded by Tablets.
repeated tablets = 3
Tablets, if set will reload schemas across one or more tablets. Supercedes both Keyspaces and KeyspaceShards.
repeated string cluster_ids = 4
ClusterIds optionally restricts the reload operation to clusters with the specified IDs. An empty list of ClusterIds will operate on all clusters.
int32 concurrency = 5
Concurrency controls the number of tablets to reload at any given time. Its semantics depend on whether the request is for keyspace, shard, or tablet mode. In Keyspaces mode, Concurrency is the number of tablets to reload at once *per keyspace*. In KeyspaceShards mode, Concurrency is the number of tablets to reload at once *per shard*. In Tablets mode, Concurrency is the number of tablets to reload at once *per cluster*.
string wait_position = 6
WaitPosition is the replication position that replicating tablets should reach prior to reloading their schemas. Does not apply in Tablets mode.
bool include_primary = 7
IncludePrimary, if set, will reload the schemas on PRIMARY tablets as well as REPLICA and RDONLY. Does not apply in Tablets mode.
message
vtadmin.proto:870repeated keyspace_results = 1
KeyspaceResults is the list of KeyspaceResult objects for a ReloadSchemas operation. It is only set when the request mandates Keyspaces mode (see ReloadSchemasRequest).
repeated shard_results = 2
ShardResults is the list of ShardResult objects for a ReloadSchemas operation. It is only set when the request mandates KeyspaceShards mode (see ReloadSchemasRequest).
repeated tablet_results = 3
TabletResults is the list of TabletResult objects for a ReloadSchemas operation. It is only set when the request mandates Tablets mode (see ReloadSchemasRequest).
rpc ReloadSchemaShard (, )
vtadmin.proto:176ReloadSchemaShard reloads the schema on all tablets in a shard. This is done on a best-effort basis.
message
vtadmin.proto:918string cluster_id = 1
string keyspace = 2
string shard = 3
string wait_position = 4
bool include_primary = 5
int32 concurrency = 6
message
vtadmin.proto:928repeated events = 1
rpc RemoveKeyspaceCell (, )
vtadmin.proto:178RemoveKeyspaceCell removes the cell from the Cells list for all shards in the keyspace, and the SrvKeyspace for that keyspace in that cell.
message
vtadmin.proto:944string cluster_id = 1
string keyspace = 2
string cell = 3
bool force = 4
bool recursive = 5
message
vtadmin.proto:952string status = 1
RetrySchemaMigration marks a given schema migration in the given cluster for retry.
message
vtadmin.proto:956string cluster_id = 1
optional request = 2
rpc RunHealthCheck (, )
vtadmin.proto:183RunHealthCheck runs a healthcheck on the tablet.
message
vtadmin.proto:961optional alias = 1
repeated string cluster_ids = 2
message
vtadmin.proto:966string status = 1
optional cluster = 2
rpc ReshardCreate (, )
vtadmin.proto:185ReshardCreate creates a workflow to reshard a keyspace.
message
vtadmin.proto:971string cluster_id = 1
optional request = 2
rpc SetReadOnly (, )
vtadmin.proto:187SetReadOnly sets the tablet to read-only mode.
message
vtadmin.proto:976optional alias = 1
repeated string cluster_ids = 2
message
vtadmin.proto:981(message has no fields)
rpc SetReadWrite (, )
vtadmin.proto:189SetReadWrite sets the tablet to read-write mode.
message
vtadmin.proto:984optional alias = 1
repeated string cluster_ids = 2
message
vtadmin.proto:989(message has no fields)
rpc StartReplication (, )
vtadmin.proto:192StartReplication runs the underlying database command to start replication on a tablet.
message
vtadmin.proto:992optional alias = 1
repeated string cluster_ids = 2
message
vtadmin.proto:997string status = 1
optional cluster = 2
rpc StopReplication (, )
vtadmin.proto:195StopReplication runs the underlying database command to stop replication on a tablet
message
vtadmin.proto:1002optional alias = 1
repeated string cluster_ids = 2
message
vtadmin.proto:1007string status = 1
optional cluster = 2
TabletExternallyPromoted updates the metadata in a cluster's topology to acknowledge a shard primary change performed by an external tool (e.g. orchestrator*). See the Reparenting guide for more information: https://vitess.io/docs/user-guides/configuration-advanced/reparenting/#external-reparenting. * "orchestrator" here refers to external orchestrator, not the newer, Vitess-aware orchestrator, VTOrc.
message
vtadmin.proto:1012optional alias = 1
Tablet is the alias of the tablet that was promoted externally and should be updated to the shard primary in the topo.
repeated string cluster_ids = 2
message
vtadmin.proto:1019optional cluster = 1
string keyspace = 2
string shard = 3
optional new_primary = 4
optional old_primary = 5
rpc Validate (, )
vtadmin.proto:208Validate validates all nodes in a cluster that are reachable from the global replication graph, as well as all tablets in discoverable cells, are consistent
message
vtadmin.proto:1032string cluster_id = 1
bool ping_tablets = 2
rpc ValidateKeyspace (, )
vtadmin.proto:211ValidateKeyspace validates that all nodes reachable from the specified keyspace are consistent.
message
vtadmin.proto:1037string cluster_id = 1
string keyspace = 2
bool ping_tablets = 3
ValidateSchemaKeyspace validates that the schema on the primary tablet for shard 0 matches the schema on all of the other tablets in the keyspace.
message
vtadmin.proto:1043string cluster_id = 1
string keyspace = 2
rpc ValidateShard (, )
vtadmin.proto:217ValidateShard validates that that all nodes reachable from the specified shard are consistent.
message
vtadmin.proto:1048string cluster_id = 1
string keyspace = 2
string shard = 3
bool ping_tablets = 4
ValidateVersionKeyspace validates that the version on the primary of shard 0 matches all of the other tablets in the keyspace.
message
vtadmin.proto:1055string cluster_id = 1
string keyspace = 2
ValidateVersionShard validates that the version on the primary matches all of the replicas.
message
vtadmin.proto:1060string cluster_id = 1
string keyspace = 2
string shard = 3
rpc VDiffCreate (, )
vtadmin.proto:223message
vtadmin.proto:1066string cluster_id = 1
optional request = 2
rpc VDiffShow (, )
vtadmin.proto:224message
vtadmin.proto:1071string cluster_id = 1
optional request = 2
message
vtadmin.proto:1090map<string, > shard_report = 1
rpc VTExplain (, )
vtadmin.proto:227VTExplain provides information on how Vitess plans to execute a particular query.
message
vtadmin.proto:1094string cluster = 1
string keyspace = 2
string sql = 3
message
vtadmin.proto:1100string response = 1
rpc VExplain (, )
vtadmin.proto:230VExplain provides information on how Vitess plans to execute a particular query.
message
vtadmin.proto:1104string cluster_id = 1
string keyspace = 2
string sql = 3
message
vtadmin.proto:1110string response = 1
rpc WorkflowDelete (, )
vtadmin.proto:232WorkflowDelete deletes a vreplication workflow.
message
vtadmin.proto:380string cluster_id = 1
optional request = 2
WorkflowSwitchTraffic switches traffic for a VReplication workflow.
message
vtadmin.proto:385string cluster_id = 1
optional request = 2
message
vtadmin.proto:240Cluster represents information about a Vitess cluster.
Used in: , , , , , , , , , , , , , , , , , , , , , , , ,
string id = 1
string name = 2
message
vtadmin.proto:245Used in:
optional cluster = 1
optional backup = 2
message
vtadmin.proto:255Used in:
optional cluster = 1
string name = 2
optional cell_info = 3
CellInfo contains the data for the cell. It may be nil if the GetCellsInfosRequest specified NamesOnly.
message
vtadmin.proto:250Used in:
optional cluster = 1
map<string, > aliases = 2
message
vtadmin.proto:264Used in:
optional cluster = 1
string keyspace = 2
string shard = 3
optional position_info = 4
message
vtadmin.proto:271Used in:
repeated workflows = 1
repeated string warnings = 2
Warnings is a list of non-fatal errors encountered when fetching workflows for a particular cluster.
message
vtadmin.proto:578Used in:
string cluster_id = 1
optional request = 2
message
vtadmin.proto:640Used in: , ,
bool aggregate_sizes = 1
bool include_non_serving_shards = 2
message
vtadmin.proto:280Keyspace represents information about a keyspace in a particular Vitess cluster.
Used as response type in: VTAdmin.GetKeyspace
Used as field type in: , ,
optional cluster = 1
optional keyspace = 2
map<string, > shards = 3
message
vtadmin.proto:877KeyspaceResult is a grouping of a Keyspace and any log events that occurred in that keyspace during a schema reload (usually associated with partial errors - ReloadSchemas requests are best-effort). It is only set when a ReloadSchemas request mandates Keyspaces mode (see ReloadSchemasRequest).
Used in:
optional keyspace = 1
repeated events = 2
message
vtadmin.proto:892ShardResult is a grouping of a Shard and any log events that occurred in that shard during a schema reload (usually associated with partial errors - ReloadSchemas requests are best-effort). It is only set when a ReloadSchemas request mandates KeyspaceShards mode (see ReloadSchemasRequest).
Used in:
optional shard = 1
repeated events = 2
message
vtadmin.proto:908TabletResult is a grouping of a Tablet and the result of reloading that Tablet's schema. Result will either be the string "ok", or the error message from that tablet. Note ReloadSchemas is best-effort, so tablet's failing to reload is not treated as an overall failure. It is only set when a ReloadSchemas request mandates Tablets mode (see ReloadSchemasRequest).
Used in:
optional tablet = 1
string result = 2
message
vtadmin.proto:286Used as response type in: VTAdmin.FindSchema, VTAdmin.GetSchema
Used as field type in:
optional cluster = 1
string keyspace = 2
repeated table_definitions = 3
map<string, > table_sizes = 4
TableSizes is a mapping of table name to TableSize information.
message
vtadmin.proto:294Used in:
uint64 row_count = 1
uint64 data_length = 2
message
vtadmin.proto:301TableSize aggregates table size information across all shards containing in the given keyspace and cluster, as well as per-shard size information.
Used in:
uint64 row_count = 1
uint64 data_length = 2
map<string, > by_shard = 3
message
vtadmin.proto:308Used in:
optional cluster = 1
optional schema_migration = 2
message
vtadmin.proto:315Shard groups the vtctldata information about a shard record together with the Vitess cluster it belongs to.
Used in:
optional cluster = 1
optional shard = 2
message
vtadmin.proto:320Used as response type in: VTAdmin.GetSrvVSchema
Used as field type in:
string cell = 1
optional cluster = 2
optional srv_v_schema = 3
message
vtadmin.proto:328Tablet groups the topo information of a tablet together with the Vitess cluster it belongs to.
Used as response type in: VTAdmin.GetTablet
Used as field type in: ,
optional cluster = 1
optional tablet = 2
Tablet.ServingState state = 3
string FQDN = 4
Used in:
UNKNOWN = 0
SERVING = 1
NOT_SERVING = 2
message
vtadmin.proto:1027optional alias = 1
repeated string cluster_ids = 2
message
vtadmin.proto:1076Used in:
double percentage = 1
string eta = 2
message
vtadmin.proto:1081Used in:
string state = 1
int64 rows_compared = 2
bool has_mismatch = 3
string started_at = 4
string completed_at = 5
optional progress = 6
message
vtadmin.proto:343VSchema represents the vschema for a keyspace in the cluster it belongs to.
Used as response type in: VTAdmin.GetVSchema
Used as field type in:
optional cluster = 1
string name = 2
Name is the name of the keyspace this VSchema is for.
optional v_schema = 3
message
vtadmin.proto:358VTGate represents information about a single VTGate host.
Used in:
string hostname = 1
Hostname is the shortname of the VTGate.
string pool = 2
Pool is group the VTGate serves queries for. Some deployments segment VTGates into groups or pools, based on the workloads they serve queries for. Use of this field is optional.
string cell = 3
Cell is the topology cell the VTGate is in.
optional cluster = 4
Cluster is the cluster the VTGate serves.
repeated string keyspaces = 5
Keyspaces is the list of keyspaces-to-watch for the VTGate.
string FQDN = 6
message
vtadmin.proto:351Vtctld represents information about a single Vtctld host.
Used in:
string hostname = 1
optional cluster = 2
string FQDN = 3
message
vtadmin.proto:374Used as response type in: VTAdmin.GetWorkflow
Used as field type in:
optional cluster = 1
string keyspace = 2
optional workflow = 3