package vtctldata

Get desktop application:
View/edit binary Protocol Buffers messages

Used as request type in: vtctlservice.Vtctld.AddCellInfo

• string name = 1

• optional topodata.CellInfo cell_info = 2

Used as response type in: vtctlservice.Vtctld.AddCellInfo

(message has no fields)

Used as request type in: vtctlservice.Vtctld.AddCellsAlias

• string name = 1

• repeated string cells = 2

Used as response type in: vtctlservice.Vtctld.AddCellsAlias

(message has no fields)

Used as request type in: vtctlservice.Vtctld.ApplyRoutingRules

• optional vschema.RoutingRules routing_rules = 1

• bool skip_rebuild = 2

  SkipRebuild, if set, will cause ApplyRoutingRules to skip rebuilding the SrvVSchema objects in each cell in RebuildCells.

• repeated string rebuild_cells = 3

  RebuildCells limits the SrvVSchema rebuild to the specified cells. If not provided the SrvVSchema will be rebuilt in every cell in the topology. Ignored if SkipRebuild is set.

Used as response type in: vtctlservice.Vtctld.ApplyRoutingRules

(message has no fields)

Used as request type in: vtctlservice.Vtctld.ApplySchema

• string keyspace = 1

• bool allow_long_unavailability = 2

  Allow large schema changes which incur a longer unavailability of the database.

• repeated string sql = 3

  SQL commands to run.

• string ddl_strategy = 4

  Online DDL strategy, compatible with @@ddl_strategy session variable (examples: 'gh-ost', 'pt-osc', 'gh-ost --max-load=Threads_running=100'")

• repeated string uuid_list = 5

  Optional: explicit UUIDs for migration. If given, must match number of DDL changes

• string migration_context = 6

  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

• optional vttime.Duration wait_replicas_timeout = 7

  WaitReplicasTimeout is the duration of time to wait for replicas to catch up in reparenting.

• bool skip_preflight = 8

  Skip pre-apply schema checks, and directly forward schema change query to shards

• optional vtrpc.CallerID caller_id = 9

  caller_id identifies the caller. This is the effective caller ID, set by the application to further identify the caller.

Used as response type in: vtctlservice.Vtctld.ApplySchema

• repeated string uuid_list = 1

Used as request type in: vtctlservice.Vtctld.ApplyShardRoutingRules

• optional vschema.ShardRoutingRules shard_routing_rules = 1

• bool skip_rebuild = 2

  SkipRebuild, if set, will cause ApplyShardRoutingRules to skip rebuilding the SrvVSchema objects in each cell in RebuildCells.

• repeated string rebuild_cells = 3

  RebuildCells limits the SrvVSchema rebuild to the specified cells. If not provided the SrvVSchema will be rebuilt in every cell in the topology. Ignored if SkipRebuild is set.

Used as response type in: vtctlservice.Vtctld.ApplyShardRoutingRules

(message has no fields)

Used as request type in: vtctlservice.Vtctld.ApplyVSchema

• string keyspace = 1

• bool skip_rebuild = 2

• bool dry_run = 3

• repeated string cells = 4

• optional vschema.Keyspace v_schema = 5

• string sql = 6

Used as response type in: vtctlservice.Vtctld.ApplyVSchema

• optional vschema.Keyspace v_schema = 1

Used as request type in: vtctlservice.Vtctld.Backup

• optional topodata.TabletAlias tablet_alias = 1

• bool allow_primary = 2

  AllowPrimary allows the backup to proceed if TabletAlias is a PRIMARY. WARNING: If using the builtin backup engine, this will shutdown mysqld on the primary for the duration of the backup, and no writes will be possible.

• uint64 concurrency = 3

  Concurrency specifies the number of compression/checksum jobs to run simultaneously.

• string incremental_from_pos = 4

  IncrementalFromPos indicates a position of a previous backup. When this value is non-empty then the backup becomes incremental and applies as of given position.

Used as response type in: vtctlservice.Vtctld.Backup, vtctlservice.Vtctld.BackupShard

• optional topodata.TabletAlias tablet_alias = 1

  TabletAlias is the alias being used for the backup.

• string keyspace = 2

• string shard = 3

• optional logutil.Event event = 4

Used as request type in: vtctlservice.Vtctld.BackupShard

• string keyspace = 1

• string shard = 2

• bool allow_primary = 3

  AllowPrimary allows the backup to occur on a PRIMARY tablet. See BackupRequest.AllowPrimary for warnings and caveats.

• uint64 concurrency = 4

  Concurrency specifies the number of compression/checksum jobs to run simultaneously.

• repeated FilterTableRule filter_table_rules = 1

Used as request type in: vtctlservice.Vtctld.ChangeTabletType

• optional topodata.TabletAlias tablet_alias = 1

• topodata.TabletType db_type = 2

• bool dry_run = 3

Used as response type in: vtctlservice.Vtctld.ChangeTabletType

• optional topodata.Tablet before_tablet = 1

• optional topodata.Tablet after_tablet = 2

• bool was_dry_run = 3

Used as request type in: vtctlservice.Vtctld.CreateKeyspace

Used as field type in: vtadmin.CreateKeyspaceRequest

• string name = 1

  Name is the name of the keyspace.

• bool force = 2

  Force proceeds with the request even if the keyspace already exists.

• bool allow_empty_v_schema = 3

  AllowEmptyVSchema allows a keyspace to be created with no vschema.

• repeated topodata.Keyspace.ServedFrom served_froms = 6

  ServedFroms specifies a set of db_type:keyspace pairs used to serve traffic for the keyspace.

• topodata.KeyspaceType type = 7

  Type is the type of the keyspace to create.

• string base_keyspace = 8

  BaseKeyspace specifies the base keyspace for SNAPSHOT keyspaces. It is required to create a SNAPSHOT keyspace.

• optional vttime.Time snapshot_time = 9

  SnapshotTime specifies the snapshot time for this keyspace. It is required to create a SNAPSHOT keyspace.

• string durability_policy = 10

  DurabilityPolicy is the durability policy to be used for this keyspace.

Used as response type in: vtctlservice.Vtctld.CreateKeyspace

• optional Keyspace keyspace = 1

  Keyspace is the newly-created keyspace.

Used as request type in: vtctlservice.Vtctld.CreateShard

Used as field type in: vtadmin.CreateShardRequest

• string keyspace = 1

  Keyspace is the name of the keyspace to create the shard in.

• string shard_name = 2

  ShardName is the name of the shard to create. E.g. "-" or "-80".

• bool force = 3

  Force treats an attempt to create a shard that already exists as a non-error.

• bool include_parent = 4

  IncludeParent creates the parent keyspace as an empty BASE keyspace, if it doesn't already exist.

Used as response type in: vtadmin.VTAdmin.CreateShard, vtctlservice.Vtctld.CreateShard

• optional Keyspace keyspace = 1

  Keyspace is the created keyspace. It is set only if IncludeParent was specified in the request and the parent keyspace needed to be created.

• optional Shard shard = 2

  Shard is the newly-created shard object.

• bool shard_already_exists = 3

  ShardAlreadyExists is set if Force was specified in the request and the shard already existed.

Used as request type in: vtctlservice.Vtctld.DeleteCellInfo

• string name = 1

• bool force = 2

Used as response type in: vtctlservice.Vtctld.DeleteCellInfo

(message has no fields)

Used as request type in: vtctlservice.Vtctld.DeleteCellsAlias

• string name = 1

Used as response type in: vtctlservice.Vtctld.DeleteCellsAlias

(message has no fields)

Used as request type in: vtctlservice.Vtctld.DeleteKeyspace

Used as field type in: vtadmin.DeleteKeyspaceRequest

• string keyspace = 1

  Keyspace is the name of the keyspace to delete.

• bool recursive = 2

  Recursive causes all shards in the keyspace to be recursively deleted before deleting the keyspace. It is an error to call DeleteKeyspace on a non-empty keyspace without also specifying Recursive.

• bool force = 3

  Force allows a keyspace to be deleted even if the keyspace lock cannot be obtained. This should only be used to force-clean a keyspace.

Used as response type in: vtadmin.VTAdmin.DeleteKeyspace, vtctlservice.Vtctld.DeleteKeyspace

(message has no fields)

Used as request type in: vtctlservice.Vtctld.DeleteShards

Used as field type in: vtadmin.DeleteShardsRequest

• repeated Shard shards = 1

  Shards is the list of shards to delete. The nested topodatapb.Shard field is not required for DeleteShard, but the Keyspace and Shard fields are.

• bool recursive = 2

  Recursive also deletes all tablets belonging to the shard(s). It is an error to call DeleteShard on a non-empty shard without also specificying Recursive.

• bool even_if_serving = 4

  EvenIfServing allows a shard to be deleted even if it is serving, which is normally an error. Use with caution.

• bool force = 5

  Force allows a shard to be deleted even if the shard lock cannot be obtained. This should only be used to force-clean a shard.

Used as response type in: vtadmin.VTAdmin.DeleteShards, vtctlservice.Vtctld.DeleteShards

(message has no fields)

Used as request type in: vtctlservice.Vtctld.DeleteSrvVSchema

• string cell = 1

Used as response type in: vtctlservice.Vtctld.DeleteSrvVSchema

(message has no fields)

Used as request type in: vtctlservice.Vtctld.DeleteTablets

• repeated topodata.TabletAlias tablet_aliases = 1

  TabletAliases is the list of tablets to delete.

• bool allow_primary = 2

  AllowPrimary allows for the primary tablet of a shard to be deleted. Use with caution.

Used as response type in: vtctlservice.Vtctld.DeleteTablets

(message has no fields)

Used as request type in: vtctlservice.Vtctld.EmergencyReparentShard

Used as field type in: vtadmin.EmergencyFailoverShardRequest

• string keyspace = 1

  Keyspace is the name of the keyspace to perform the Emergency Reparent in.

• string shard = 2

  Shard is the name of the shard to perform the Emergency Reparent in.

• optional topodata.TabletAlias new_primary = 3

  Optional alias of a tablet that should become the new shard primary. If not not specified, the vtctld will select the most up-to-date canditate to promote.

• repeated topodata.TabletAlias ignore_replicas = 4

  List of replica aliases to ignore during the Emergency Reparent. The vtctld will not attempt to stop replication on these tablets, nor attempt to demote any that may think they are the shard primary.

• optional vttime.Duration wait_replicas_timeout = 5

  WaitReplicasTimeout is the duration of time to wait for replicas to catch up in reparenting.

• bool prevent_cross_cell_promotion = 6

  PreventCrossCellPromotion is used to only promote the new primary from the same cell as the failed primary.

Used as response type in: vtctlservice.Vtctld.EmergencyReparentShard

• string keyspace = 1

  Keyspace is the name of the keyspace the Emergency Reparent took place in.

• string shard = 2

  Shard is the name of the shard the Emergency Reparent took place in.

• optional topodata.TabletAlias promoted_primary = 3

  PromotedPrimary is the alias of the tablet that was promoted to shard primary. If NewPrimary was set in the request, then this will be the same alias. Otherwise, it will be the alias of the tablet found to be most up-to-date.

• repeated logutil.Event events = 4

Used as request type in: vtctlservice.Vtctld.ExecuteFetchAsApp

• optional topodata.TabletAlias tablet_alias = 1

• string query = 2

• int64 max_rows = 3

  MaxRows is an optional parameter to limit the number of rows read into the QueryResult. Note that this does not apply a LIMIT to the query, just how many rows are read from the MySQL server on the tablet side. This field is optional. Specifying a non-positive value will use whatever default is configured in the VtctldService.

• bool use_pool = 4

  UsePool causes the query to be run with a pooled connection to the tablet.

Used as response type in: vtctlservice.Vtctld.ExecuteFetchAsApp

• optional query.QueryResult result = 1

Used as request type in: vtctlservice.Vtctld.ExecuteFetchAsDBA

• optional topodata.TabletAlias tablet_alias = 1

• string query = 2

• int64 max_rows = 3

  MaxRows is an optional parameter to limit the number of rows read into the QueryResult. Note that this does not apply a LIMIT to the query, just how many rows are read from the MySQL server on the tablet side. This field is optional. Specifying a non-positive value will use whatever default is configured in the VtctldService.

• bool disable_binlogs = 4

  DisableBinlogs instructs the tablet not to use binary logging when executing the query.

• bool reload_schema = 5

  ReloadSchema instructs the tablet to reload its schema after executing the query.

Used as response type in: vtctlservice.Vtctld.ExecuteFetchAsDBA

• optional query.QueryResult result = 1

Used as request type in: vtctlservice.Vtctld.ExecuteHook

• optional topodata.TabletAlias tablet_alias = 1

• optional tabletmanagerdata.ExecuteHookRequest tablet_hook_request = 2

Used as response type in: vtctlservice.Vtctld.ExecuteHook

• optional tabletmanagerdata.ExecuteHookResponse hook_result = 1

ExecuteVtctlCommandRequest is the payload for ExecuteVtctlCommand. timeouts are in nanoseconds.

Used as request type in: vtctlservice.Vtctl.ExecuteVtctlCommand

• repeated string args = 1

• int64 action_timeout = 2

ExecuteVtctlCommandResponse is streamed back by ExecuteVtctlCommand.

Used as response type in: vtctlservice.Vtctl.ExecuteVtctlCommand

• optional logutil.Event event = 1

SpecialTableRule use to special Branch request

Used in: BranchSettings

• uint64 id = 1

• string source_table = 2

• string target_table = 3

• string filtering_rule = 4

• string create_ddl = 5

• string merge_ddl = 6

• bool need_merge_back = 7

• string merge_ddl_uuid = 8

• string default_filter_rules = 9

• bool skip_copy_phase = 10

Used as request type in: vtctlservice.Vtctld.FindAllShardsInKeyspace

• string keyspace = 1

Used as response type in: vtctlservice.Vtctld.FindAllShardsInKeyspace

• map<string, Shard> shards = 1

Used as request type in: vtctlservice.Vtctld.GetBackups

Used as field type in: vtadmin.GetBackupsRequest

• string keyspace = 1

• string shard = 2

• uint32 limit = 3

  Limit, if nonzero, will return only the most N recent backups.

• bool detailed = 4

  Detailed indicates whether to use the backupengine, if supported, to populate additional fields, such as Engine and Status, on BackupInfo objects in the response. If not set, or if the backupengine does not support populating these fields, Engine will always be empty, and Status will always be UNKNOWN.

• uint32 detailed_limit = 5

  DetailedLimit, if nonzero, will only populate additional fields (see Detailed) on the N most recent backups. The Limit field still dictates the total number of backup info objects returned, so, in reality, min(Limit, DetailedLimit) backup infos will have additional fields set, and any remaining backups will not.

Used as response type in: vtctlservice.Vtctld.GetBackups

• repeated mysqlctl.BackupInfo backups = 1

Used as request type in: vtctlservice.Vtctld.GetCellInfoNames

(message has no fields)

Used as response type in: vtctlservice.Vtctld.GetCellInfoNames

• repeated string names = 1

Used as request type in: vtctlservice.Vtctld.GetCellInfo

• string cell = 1

Used as response type in: vtctlservice.Vtctld.GetCellInfo

• optional topodata.CellInfo cell_info = 1

Used as request type in: vtctlservice.Vtctld.GetCellsAliases

(message has no fields)

Used as response type in: vtctlservice.Vtctld.GetCellsAliases

• map<string, topodata.CellsAlias> aliases = 1

Used as request type in: vtctlservice.Vtctld.GetFullStatus

• optional topodata.TabletAlias tablet_alias = 1

Used as response type in: vtadmin.VTAdmin.GetFullStatus, vtctlservice.Vtctld.GetFullStatus

• optional replicationdata.FullStatus status = 1

Used as request type in: vtctlservice.Vtctld.GetKeyspace

• string keyspace = 1

Used as response type in: vtctlservice.Vtctld.GetKeyspace

• optional Keyspace keyspace = 1

Used as request type in: vtctlservice.Vtctld.GetKeyspaces

(message has no fields)

Used as response type in: vtctlservice.Vtctld.GetKeyspaces

• repeated Keyspace keyspaces = 1

Used as request type in: vtctlservice.Vtctld.GetPermissions

• optional topodata.TabletAlias tablet_alias = 1

Used as response type in: vtctlservice.Vtctld.GetPermissions

• optional tabletmanagerdata.Permissions permissions = 1

Used as request type in: vtctlservice.Vtctld.GetRoutingRules

(message has no fields)

Used as response type in: vtctlservice.Vtctld.GetRoutingRules

• optional vschema.RoutingRules routing_rules = 1

Used as request type in: vtctlservice.Vtctld.GetSchema

• optional topodata.TabletAlias tablet_alias = 1

• repeated string tables = 2

  Tables is a list of tables for which we should gather information. Each is either an exact match, or a regular expression of the form /regexp/.

• repeated string exclude_tables = 3

  ExcludeTables is a list of tables to exclude from the result. Each is either an exact match, or a regular expression of the form /regexp/.

• bool include_views = 4

  IncludeViews specifies whether to include views in the result.

• bool table_names_only = 5

  TableNamesOnly specifies whether to limit the results to just table names, rather than full schema information for each table.

• bool table_sizes_only = 6

  TableSizesOnly specifies whether to limit the results to just table sizes, rather than full schema information for each table. It is ignored if TableNamesOnly is set to true.

• bool table_schema_only = 7

  TableSchemaOnly specifies whether to limit the results to just table/view schema definition (CREATE TABLE/VIEW statements) and skip column/field information

• string db_name = 8

Used as response type in: vtctlservice.Vtctld.GetSchema

• optional tabletmanagerdata.SchemaDefinition schema = 1

Used as request type in: vtctlservice.Vtctld.GetShard

• string keyspace = 1

• string shard_name = 2

Used as response type in: vtctlservice.Vtctld.GetShard

• optional Shard shard = 1

Used as request type in: vtctlservice.Vtctld.GetShardRoutingRules

(message has no fields)

Used as response type in: vtctlservice.Vtctld.GetShardRoutingRules

• optional vschema.ShardRoutingRules shard_routing_rules = 1

Used as request type in: vtctlservice.Vtctld.GetSrvKeyspaceNames

• repeated string cells = 1

Used as response type in: vtctlservice.Vtctld.GetSrvKeyspaceNames

• map<string, GetSrvKeyspaceNamesResponse.NameList> names = 1

  Names is a mapping of cell name to a list of SrvKeyspace names.

Used in: GetSrvKeyspaceNamesResponse

• repeated string names = 1

Used as request type in: vtctlservice.Vtctld.GetSrvKeyspaces

• string keyspace = 1

• 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.

Used as response type in: vtctlservice.Vtctld.GetSrvKeyspaces

• map<string, topodata.SrvKeyspace> srv_keyspaces = 1

  SrvKeyspaces is a mapping of cell name to SrvKeyspace.

Used as request type in: vtctlservice.Vtctld.GetSrvVSchema

• string cell = 1

Used as response type in: vtctlservice.Vtctld.GetSrvVSchema

• optional vschema.SrvVSchema srv_v_schema = 1

Used as request type in: vtctlservice.Vtctld.GetSrvVSchemas

• repeated string cells = 2

Used as response type in: vtctlservice.Vtctld.GetSrvVSchemas

• map<string, vschema.SrvVSchema> srv_v_schemas = 1

  SrvVSchemas is a mapping of cell name to SrvVSchema

Used as request type in: vtctlservice.Vtctld.GetTablet

• optional topodata.TabletAlias tablet_alias = 1

Used as response type in: vtctlservice.Vtctld.GetTablet

• optional topodata.Tablet tablet = 1

Used as request type in: vtctlservice.Vtctld.GetTablets

• string keyspace = 1

  Keyspace is the name of the keyspace to return tablets for. Omit to return tablets from all keyspaces.

• string shard = 2

  Shard is the name of the shard to return tablets for. This field is ignored if Keyspace is not set.

• repeated string cells = 3

  Cells is an optional set of cells to return tablets for.

• bool strict = 4

  Strict specifies how the server should treat failures from individual cells. When false (the default), GetTablets will return data from any cells that return successfully, but will fail the request if all cells fail. When true, any individual cell can fail the full request.

• repeated topodata.TabletAlias tablet_aliases = 5

  TabletAliases is an optional list of tablet aliases to fetch Tablet objects for. If specified, Keyspace, Shard, and Cells are ignored, and tablets are looked up by their respective aliases' Cells directly.

• topodata.TabletType tablet_type = 6

  tablet_type specifies the type of tablets to return. Omit to return all tablet types.

Used as response type in: vtctlservice.Vtctld.GetTablets

• repeated topodata.Tablet tablets = 1

Used as request type in: vtctlservice.Vtctld.GetTopologyPath

• string path = 1

Used as response type in: vtadmin.VTAdmin.GetTopologyPath, vtctlservice.Vtctld.GetTopologyPath

• optional TopologyCell cell = 1

Used as request type in: vtctlservice.Vtctld.GetVSchema

• string keyspace = 1

Used as response type in: vtctlservice.Vtctld.GetVSchema

• optional vschema.Keyspace v_schema = 1

Used as request type in: vtctlservice.Vtctld.GetVersion

• optional topodata.TabletAlias tablet_alias = 1

Used as response type in: vtctlservice.Vtctld.GetVersion

• string version = 1

Used as request type in: vtctlservice.Vtctld.GetWorkflows

• string keyspace = 1

• bool active_only = 2

Used as response type in: vtctlservice.Vtctld.GetWorkflows

• repeated Workflow workflows = 1

Used as request type in: vtctlservice.Vtctld.InitShardPrimary

• string keyspace = 1

• string shard = 2

• optional topodata.TabletAlias primary_elect_tablet_alias = 3

• bool force = 4

• optional vttime.Duration wait_replicas_timeout = 5

Used as response type in: vtctlservice.Vtctld.InitShardPrimary

• repeated logutil.Event events = 1

Used in: vtadmin.Keyspace, CreateKeyspaceResponse, CreateShardResponse, GetKeyspaceResponse, GetKeyspacesResponse

• string name = 1

• optional topodata.Keyspace keyspace = 2

MaterializationIntent describes the reason for creating the Materialize flow

Used in: MaterializeSettings

• CUSTOM = 0

  CUSTOM is the default value

• MOVETABLES = 1

  MOVETABLES is when we are creating a MoveTables flow

• CREATELOOKUPINDEX = 2

  CREATELOOKUPINDEX is when we are creating a CreateLookupIndex flow

• BRANCH = 3

  BRANCH is when we are creating a Branch flow

MaterializeSettings contains the settings for the Materialize command.

• string workflow = 1

  workflow is the name of the workflow.

• string source_keyspace = 2

• string target_keyspace = 3

• bool stop_after_copy = 4

  stop_after_copy specifies if vreplication should be stopped after copying.

• repeated TableMaterializeSettings table_settings = 5

• string cell = 6

  optional parameters.

• string tablet_types = 7

• string external_cluster = 8

  ExternalCluster is the name of the mounted cluster which has the source keyspace/db for this workflow it is of the type <cluster_type.cluster_name>

• MaterializationIntent materialization_intent = 9

  MaterializationIntent is used to identify the reason behind the materialization workflow: eg. MoveTables, CreateLookupVindex

• string source_time_zone = 10

  SourceTimeZone is the time zone in which datetimes on the source were stored, provided as an option in MoveTable

• string target_time_zone = 11

  TargetTimeZone is not currently specifiable by the user, defaults to UTC for the forward workflows and to the SourceTimeZone in reverse workflows

• repeated string source_shards = 12

• string on_ddl = 13

  OnDdl specifies the action to be taken when a DDL is encountered.

• bool defer_secondary_keys = 14

  DeferSecondaryKeys specifies if secondary keys should be created in one shot after table copy finishes.

Used as request type in: vtctlservice.Vtctld.PingTablet

• optional topodata.TabletAlias tablet_alias = 1

Used as response type in: vtctlservice.Vtctld.PingTablet

(message has no fields)

Used as request type in: vtctlservice.Vtctld.PlannedReparentShard

Used as field type in: vtadmin.PlannedFailoverShardRequest

• string keyspace = 1

  Keyspace is the name of the keyspace to perform the Planned Reparent in.

• string shard = 2

  Shard is the name of the shard to perform teh Planned Reparent in.

• optional topodata.TabletAlias new_primary = 3

  NewPrimary is the alias of the tablet to promote to shard primary. If not specified, the vtctld will select the most up-to-date candidate to promote. It is an error to set NewPrimary and AvoidPrimary to the same alias.

• optional topodata.TabletAlias avoid_primary = 4

  AvoidPrimary is the alias of the tablet to demote. In other words, specifying an AvoidPrimary alias tells the vtctld to promote any replica other than this one. A shard whose current primary is not this one is then a no-op. It is an error to set NewPrimary and AvoidPrimary to the same alias.

• optional vttime.Duration wait_replicas_timeout = 5

  WaitReplicasTimeout is the duration of time to wait for replicas to catch up in replication both before and after the reparent. The timeout is not cumulative across both wait periods, meaning that the replicas have WaitReplicasTimeout time to catch up before the reparent, and an additional WaitReplicasTimeout time to catch up after the reparent.

Used as response type in: vtctlservice.Vtctld.PlannedReparentShard

• string keyspace = 1

  Keyspace is the name of the keyspace the Planned Reparent took place in.

• string shard = 2

  Shard is the name of the shard the Planned Reparent took place in.

• optional topodata.TabletAlias promoted_primary = 3

  PromotedPrimary is the alias of the tablet that was promoted to shard primary. If NewPrimary was set in the request, then this will be the same alias. Otherwise, it will be the alias of the tablet found to be most up-to-date.

• repeated logutil.Event events = 4

Used as request type in: vtctlservice.Vtctld.RebuildKeyspaceGraph

• string keyspace = 1

• repeated string cells = 2

• bool allow_partial = 3

  AllowPartial, when set, allows a SNAPSHOT keyspace to serve with an incomplete set of shards. It is ignored for all other keyspace types.

Used as response type in: vtctlservice.Vtctld.RebuildKeyspaceGraph

(message has no fields)

Used as request type in: vtctlservice.Vtctld.RebuildVSchemaGraph

• repeated string cells = 1

  Cells specifies the cells to rebuild the SrvVSchema objects for. If empty, RebuildVSchemaGraph rebuilds the SrvVSchema for every cell in the topo.

Used as response type in: vtctlservice.Vtctld.RebuildVSchemaGraph

(message has no fields)

Used as request type in: vtctlservice.Vtctld.RefreshStateByShard

• string keyspace = 1

• string shard = 2

• repeated string cells = 3

Used as response type in: vtctlservice.Vtctld.RefreshStateByShard

• bool is_partial_refresh = 1

• string partial_refresh_details = 2

  This explains why we had a partial refresh (if we did)

Used as request type in: vtctlservice.Vtctld.RefreshState

• optional topodata.TabletAlias tablet_alias = 1

Used as response type in: vtctlservice.Vtctld.RefreshState

(message has no fields)

Used as request type in: vtctlservice.Vtctld.ReloadSchemaKeyspace

• string keyspace = 1

• string wait_position = 2

• bool include_primary = 3

• uint32 concurrency = 4

  Concurrency is the global concurrency across all shards in the keyspace (so, at most this many tablets will be reloaded across the keyspace at any given point).

Used as response type in: vtctlservice.Vtctld.ReloadSchemaKeyspace

• repeated logutil.Event events = 1

Used as request type in: vtctlservice.Vtctld.ReloadSchema

• optional topodata.TabletAlias tablet_alias = 1

Used as response type in: vtctlservice.Vtctld.ReloadSchema

(message has no fields)

Used as request type in: vtctlservice.Vtctld.ReloadSchemaShard

• string keyspace = 1

• string shard = 2

• string wait_position = 3

• bool include_primary = 4

• uint32 concurrency = 5

  Concurrency is the maximum number of tablets to reload at one time.

Used as response type in: vtctlservice.Vtctld.ReloadSchemaShard

• repeated logutil.Event events = 2

Used as request type in: vtctlservice.Vtctld.RemoveBackup

• string keyspace = 1

• string shard = 2

• string name = 3

Used as response type in: vtctlservice.Vtctld.RemoveBackup

(message has no fields)

Used as request type in: vtctlservice.Vtctld.RemoveKeyspaceCell

• string keyspace = 1

• string cell = 2

• bool force = 3

  Force proceeds even if the cell's topology server cannot be reached. This should only be set if a cell has been shut down entirely, and the global topology data just needs to be updated.

• bool recursive = 4

  Recursive also deletes all tablets in that cell belonging to the specified keyspace.

(TODO:@amason) Consider including the deleted SrvKeyspace object and any deleted Tablet objects here.

Used as response type in: vtctlservice.Vtctld.RemoveKeyspaceCell

(message has no fields)

Used as request type in: vtctlservice.Vtctld.RemoveShardCell

• string keyspace = 1

• string shard_name = 2

• string cell = 3

• bool force = 4

  Force proceeds even if the cell's topology server cannot be reached. This should only be set if a cell has been shut down entirely, and the global topology data just needs to be updated.

• bool recursive = 5

  Recursive also deletes all tablets in that cell belonging to the specified keyspace and shard.

(TODO:@amason) Consider including the deleted SrvKeyspacePartitions objects and any deleted Tablet objects here.

Used as response type in: vtctlservice.Vtctld.RemoveShardCell

(message has no fields)

Used as request type in: vtctlservice.Vtctld.ReparentTablet

• optional topodata.TabletAlias tablet = 1

  Tablet is the alias of the tablet that should be reparented under the current shard primary.

Used as response type in: vtctlservice.Vtctld.ReparentTablet

• string keyspace = 1

  Keyspace is the name of the keyspace the tablet was reparented in.

• string shard = 2

  Shard is the name of the shard the tablet was reparented in.

• optional topodata.TabletAlias primary = 3

  Primary is the alias of the tablet that the tablet was reparented under.

Used as request type in: vtctlservice.Vtctld.RestoreFromBackup

• optional topodata.TabletAlias tablet_alias = 1

• optional vttime.Time backup_time = 2

  BackupTime, if set, will use the backup taken most closely at or before this time. If nil, the latest backup will be restored on the tablet.

• string restore_to_pos = 3

  RestoreToPos indicates a position for a point-in-time recovery. The recovery is expected to utilize one full backup, followed by zero or more incremental backups, that reach the precise desired position

• bool dry_run = 4

  Dry run does not actually performs the restore, but validates the steps and availability of backups

Used as response type in: vtctlservice.Vtctld.RestoreFromBackup

• optional topodata.TabletAlias tablet_alias = 1

  TabletAlias is the alias of the tablet doing the restore.

• string keyspace = 2

• string shard = 3

• optional logutil.Event event = 4

Used as request type in: vtctlservice.Vtctld.RunHealthCheck

• optional topodata.TabletAlias tablet_alias = 1

Used as response type in: vtctlservice.Vtctld.RunHealthCheck

(message has no fields)

Used as request type in: vtctlservice.Vtctld.SetKeyspaceDurabilityPolicy

• string keyspace = 1

• string durability_policy = 2

Used as response type in: vtctlservice.Vtctld.SetKeyspaceDurabilityPolicy

• optional topodata.Keyspace keyspace = 1

  Keyspace is the updated keyspace record.

• string keyspace = 1

• topodata.TabletType tablet_type = 2

• repeated string cells = 3

• bool remove = 4

• string source_keyspace = 5

• optional topodata.Keyspace keyspace = 1

  Keyspace is the updated keyspace record.

• string keyspace = 1

• bool force = 4

• optional topodata.Keyspace keyspace = 1

  Keyspace is the updated keyspace record.

Used as request type in: vtctlservice.Vtctld.SetShardIsPrimaryServing

• string keyspace = 1

• string shard = 2

• bool is_serving = 3

Used as response type in: vtctlservice.Vtctld.SetShardIsPrimaryServing

• optional topodata.Shard shard = 1

  Shard is the updated shard record.

Used as request type in: vtctlservice.Vtctld.SetShardTabletControl

• string keyspace = 1

• string shard = 2

• topodata.TabletType tablet_type = 3

• repeated string cells = 4

• repeated string denied_tables = 5

  DeniedTables updates the list of denied tables the shard will serve for the given tablet type. This is useful to fix tables that are being blocked after a MoveTables operation. NOTE: Setting this field will cause DisableQueryService to be ignored.

• bool disable_query_service = 6

  DisableQueryService instructs whether to enable the query service on tablets of the given type in the shard. This is useful to fix Reshard operations gone awry. NOTE: this is ignored if DeniedTables is not empty.

• bool remove = 7

  Remove removes the ShardTabletControl record entirely. If set, this takes precedence over DeniedTables and DisableQueryService fields, and is useful to manually remove serving restrictions after a completed MoveTables operation.

Used as response type in: vtctlservice.Vtctld.SetShardTabletControl

• optional topodata.Shard shard = 1

  Shard is the updated shard record.

Used as request type in: vtctlservice.Vtctld.SetWritable

• optional topodata.TabletAlias tablet_alias = 1

• bool writable = 2

Used as response type in: vtctlservice.Vtctld.SetWritable

(message has no fields)

Used in: vtadmin.Keyspace, vtadmin.Shard, CreateShardResponse, DeleteShardsRequest, FindAllShardsInKeyspaceResponse, GetShardResponse

• string keyspace = 1

• string name = 2

• optional topodata.Shard shard = 3

Used as request type in: vtctlservice.Vtctld.ShardReplicationAdd

• string keyspace = 1

• string shard = 2

• optional topodata.TabletAlias tablet_alias = 3

Used as response type in: vtctlservice.Vtctld.ShardReplicationAdd

(message has no fields)

Used as request type in: vtctlservice.Vtctld.ShardReplicationFix

• string keyspace = 1

• string shard = 2

• string cell = 3

Used as response type in: vtctlservice.Vtctld.ShardReplicationFix

• optional topodata.ShardReplicationError error = 1

  Error contains information about the error fixed by a ShardReplicationFix RPC. If there were no errors to fix (i.e. all nodes in the replication graph are valid), this field is nil.

Used as request type in: vtctlservice.Vtctld.ShardReplicationPositions

• string keyspace = 1

• string shard = 2

Used as response type in: vtctlservice.Vtctld.ShardReplicationPositions

Used as field type in: vtadmin.ClusterShardReplicationPosition

• map<string, replicationdata.Status> replication_statuses = 1

  ReplicationStatuses is a mapping of tablet alias string to replication status for that tablet.

• map<string, topodata.Tablet> tablet_map = 2

  TabletMap is the set of tablets whose replication statuses were queried, keyed by tablet alias.

Used as request type in: vtctlservice.Vtctld.ShardReplicationRemove

• string keyspace = 1

• string shard = 2

• optional topodata.TabletAlias tablet_alias = 3

Used as response type in: vtctlservice.Vtctld.ShardReplicationRemove

(message has no fields)

Used as request type in: vtctlservice.Vtctld.SleepTablet

• optional topodata.TabletAlias tablet_alias = 1

• optional vttime.Duration duration = 2

Used as response type in: vtctlservice.Vtctld.SleepTablet

(message has no fields)

Used as request type in: vtctlservice.Vtctld.SourceShardAdd

• string keyspace = 1

• string shard = 2

• uint32 uid = 3

• string source_keyspace = 4

• string source_shard = 5

• optional topodata.KeyRange key_range = 6

  KeyRange identifies the key range to use for the SourceShard. This field is optional.

• repeated string tables = 7

  Tables is a list of tables replicate (for MoveTables). Each "table" can be either an exact match or a regular expression of the form "/regexp/".

Used as response type in: vtctlservice.Vtctld.SourceShardAdd

• optional topodata.Shard shard = 1

  Shard is the updated shard record.

Used as request type in: vtctlservice.Vtctld.SourceShardDelete

• string keyspace = 1

• string shard = 2

• uint32 uid = 3

Used as response type in: vtctlservice.Vtctld.SourceShardDelete

• optional topodata.Shard shard = 1

  Shard is the updated shard record.

Used as request type in: vtctlservice.Vtctld.StartReplication

• optional topodata.TabletAlias tablet_alias = 1

Used as response type in: vtctlservice.Vtctld.StartReplication

(message has no fields)

Used as request type in: vtctlservice.Vtctld.StopReplication

• optional topodata.TabletAlias tablet_alias = 1

Used as response type in: vtctlservice.Vtctld.StopReplication

(message has no fields)

TableMaterializeSttings contains the settings for one table.

Used in: MaterializeSettings

• string target_table = 1

• string source_expression = 2

  source_expression is a select statement.

• string create_ddl = 3

  create_ddl contains the DDL to create the target table. If empty, the target table must already exist. if "copy", the target table DDL is the same as the source table.

• bool skip_copy_phase = 4

Used as request type in: vtctlservice.Vtctld.TabletExternallyReparented

• optional topodata.TabletAlias tablet = 1

  Tablet is the alias of the tablet that was promoted externally and should be updated to the shard primary in the topo.

Used as response type in: vtctlservice.Vtctld.TabletExternallyReparented

• string keyspace = 1

• string shard = 2

• optional topodata.TabletAlias new_primary = 3

• optional topodata.TabletAlias old_primary = 4

Used in: GetTopologyPathResponse

• string name = 1

• string path = 2

• string data = 3

  Data is the file contents of the cell located at path. It is only populated if the cell is a terminal node.

• repeated string children = 4

Used as request type in: vtctlservice.Vtctld.UpdateCellInfo

• string name = 1

• optional topodata.CellInfo cell_info = 2

Used as response type in: vtctlservice.Vtctld.UpdateCellInfo

• string name = 1

• optional topodata.CellInfo cell_info = 2

Used as request type in: vtctlservice.Vtctld.UpdateCellsAlias

• string name = 1

• optional topodata.CellsAlias cells_alias = 2

Used as response type in: vtctlservice.Vtctld.UpdateCellsAlias

• string name = 1

• optional topodata.CellsAlias cells_alias = 2

Used as request type in: vtctlservice.Vtctld.UpdateThrottlerConfig

• string keyspace = 1

• bool enable = 2

  Enable instructs to enable the throttler

• bool disable = 3

  Disable instructs to disable the throttler

• double threshold = 4

  Threshold for throttler (with no custom query, ie using default query, only positive values are considered)

• string custom_query = 5

  CustomQuery replaces the default replication lag query

• bool custom_query_set = 6

  CustomQuerySet indicates that the value of CustomQuery has changed

• bool check_as_check_self = 7

  CheckAsCheckSelf instructs the throttler to respond to /check requests by checking the tablet's own health

• bool check_as_check_shard = 8

  CheckAsCheckShard instructs the throttler to respond to /check requests by checking the shard's health (this is the default behavior)

Used as response type in: vtctlservice.Vtctld.UpdateThrottlerConfig

(message has no fields)

Used as request type in: vtctlservice.Vtctld.ValidateKeyspace

• string keyspace = 1

• bool ping_tablets = 2

Used as response type in: vtadmin.VTAdmin.ValidateKeyspace, vtctlservice.Vtctld.ValidateKeyspace

Used as field type in: ValidateResponse

• repeated string results = 1

• map<string, ValidateShardResponse> results_by_shard = 2

Used as request type in: vtctlservice.Vtctld.Validate

• bool ping_tablets = 1

Used as response type in: vtadmin.VTAdmin.Validate, vtctlservice.Vtctld.Validate

• repeated string results = 1

• map<string, ValidateKeyspaceResponse> results_by_keyspace = 2

Used as request type in: vtctlservice.Vtctld.ValidateSchemaKeyspace

• string keyspace = 1

• repeated string exclude_tables = 2

• bool include_views = 3

• bool skip_no_primary = 4

• bool include_vschema = 5

Used as response type in: vtadmin.VTAdmin.ValidateSchemaKeyspace, vtctlservice.Vtctld.ValidateSchemaKeyspace

• repeated string results = 1

• map<string, ValidateShardResponse> results_by_shard = 2

Used as request type in: vtctlservice.Vtctld.ValidateShard

• string keyspace = 1

• string shard = 2

• bool ping_tablets = 3

Used as response type in: vtadmin.VTAdmin.ValidateShard, vtctlservice.Vtctld.ValidateShard

Used as field type in: ValidateKeyspaceResponse, ValidateSchemaKeyspaceResponse, ValidateVSchemaResponse, ValidateVersionKeyspaceResponse

• repeated string results = 1

Used as request type in: vtctlservice.Vtctld.ValidateVSchema

• string keyspace = 1

• repeated string shards = 2

• repeated string exclude_tables = 3

• bool include_views = 4

Used as response type in: vtctlservice.Vtctld.ValidateVSchema

• repeated string results = 1

• map<string, ValidateShardResponse> results_by_shard = 2

Used as request type in: vtctlservice.Vtctld.ValidateVersionKeyspace

• string keyspace = 1

Used as response type in: vtadmin.VTAdmin.ValidateVersionKeyspace, vtctlservice.Vtctld.ValidateVersionKeyspace

• repeated string results = 1

• map<string, ValidateShardResponse> results_by_shard = 2

Used as request type in: vtctlservice.Vtctld.ValidateVersionShard

• string keyspace = 1

• string shard = 2

Used as response type in: vtadmin.VTAdmin.ValidateVersionShard, vtctlservice.Vtctld.ValidateVersionShard

• repeated string results = 1

TODO: comment the hell out of this.

Used in: vtadmin.Workflow, GetWorkflowsResponse

• string name = 1

• optional Workflow.ReplicationLocation source = 2

• optional Workflow.ReplicationLocation target = 3

• int64 max_v_replication_lag = 4

• map<string, Workflow.ShardStream> shard_streams = 5

• string workflow_type = 6

• string workflow_sub_type = 7

Used in: Workflow

• string keyspace = 1

• repeated string shards = 2

Used in: Workflow

• repeated Stream streams = 1

• repeated topodata.Shard.TabletControl tablet_controls = 2

• bool is_primary_serving = 3

Used in: ShardStream

• int64 id = 1

• string shard = 2

• optional topodata.TabletAlias tablet = 3

• optional binlogdata.BinlogSource binlog_source = 4

• string position = 5

• string stop_position = 6

• string state = 7

• string db_name = 8

• optional vttime.Time transaction_timestamp = 9

• optional vttime.Time time_updated = 10

• string message = 11

• repeated Stream.CopyState copy_states = 12

• repeated Stream.Log logs = 13

• string log_fetch_error = 14

  LogFetchError is set if we fail to fetch some logs for this stream. We will never fail to fetch workflows because we cannot fetch the logs, but we will still forward log-fetch errors to the caller, should that be relevant to the context in which they are fetching workflows. Note that this field being set does not necessarily mean that Logs is nil; if there are N logs that exist for the stream, and we fail to fetch the ith log, we will still return logs in [0, i) + (i, N].

• repeated string tags = 15

Used in: Stream

• string table = 1

• string last_pk = 2

Used in: Stream

• int64 id = 1

• int64 stream_id = 2

• string type = 3

• string state = 4

• optional vttime.Time created_at = 5

• optional vttime.Time updated_at = 6

• string message = 7

• int64 count = 8