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

• optional vschema.KeyspaceRoutingRules keyspace_routing_rules = 1

• bool skip_rebuild = 2

  SkipRebuild, if set, will cause ApplyKeyspaceRoutingRules 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.ApplyKeyspaceRoutingRules

• optional vschema.KeyspaceRoutingRules keyspace_routing_rules = 1

  KeyspaceRoutingRules returns the current set of rules.

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

Used as field type in: vtadmin.ApplySchemaRequest

• string keyspace = 1

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

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

• int64 batch_size = 10

  BatchSize indicates how many queries to apply together

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

• repeated string uuid_list = 1

• map<string, uint64> rows_affected_by_shard = 2

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

• bool strict = 7

  Strict returns an error if there are unknown vindex params.

Used as response type in: vtctlservice.Vtctld.ApplyVSchema

• optional vschema.Keyspace v_schema = 1

• map<string, ApplyVSchemaResponse.ParamList> unknown_vindex_params = 2

  UnknownVindexParams is a map of vindex name to params that were not recognized by the vindex type. E.g.: { "lookup_vdx": { "params": ["raed_lock", "not_verify"] } }

Used in: ApplyVSchemaResponse

• repeated string params = 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.

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

• bool upgrade_safe = 5

  UpgradeSafe indicates if the backup should be taken with innodb_fast_shutdown=0 so that it's a backup that can be used for an upgrade.

• optional string backup_engine = 6

  BackupEngine specifies if we want to use a particular backup engine for this backup request

• optional vttime.Duration mysql_shutdown_timeout = 7

  MysqlShutdownTimeout is the duration to wait for mysqld to shutdown before starting the backup. This is available so we can override this for upgrade safe backups which might take longer to shut down.

• optional tabletmanagerdata.BackupRequest.InitSQL init_sql = 8

  Optional queries to run on the mysqld instance prior to the backup and fields to control the related behavior.

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.

• int32 concurrency = 4

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

• bool upgrade_safe = 5

  UpgradeSafe indicates if the backup should be taken with innodb_fast_shutdown=0 so that it's a backup that can be used for an upgrade.

• string incremental_from_pos = 6

  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.

• optional vttime.Duration mysql_shutdown_timeout = 7

  MysqlShutdownTimeout is the duration to wait for mysqld to shutdown before starting the backup. This is available so we can override this for upgrade safe backups which might take longer to shut down.

• optional tabletmanagerdata.BackupRequest.InitSQL init_sql = 8

  Optional queries to run on the mysqld instance prior to the backup and fields to control the related behavior.

Used as request type in: vtctlservice.Vtctld.CancelSchemaMigration

Used as field type in: vtadmin.CancelSchemaMigrationRequest

• string keyspace = 1

• string uuid = 2

• optional vtrpc.CallerID caller_id = 3

  caller_id identifies the caller. This is the effective caller ID, set by the application to further identify the caller. This is needed when strict table ACLs are enforced on the tablets.

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

• map<string, uint64> rows_affected_by_shard = 1

Used as request type in: vtctlservice.Vtctld.ChangeTabletTags

• optional topodata.TabletAlias tablet_alias = 1

• map<string, string> tags = 2

• bool replace = 3

Used as response type in: vtctlservice.Vtctld.ChangeTabletTags

• map<string, string> before_tags = 1

• map<string, string> after_tags = 2

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

• optional topodata.TabletAlias tablet_alias = 1

• string app_name = 2

• string scope = 3

• bool skip_request_heartbeats = 4

  SkipRequestHeartbeats ensures this check does not renew heartbeat lease

• bool ok_if_not_exists = 5

  OKIfNotExists asks the throttler to return OK even if the metric does not exist

Used as response type in: vtctlservice.Vtctld.CheckThrottler

• optional topodata.TabletAlias tablet_alias = 1

• optional tabletmanagerdata.CheckThrottlerResponse Check = 2

Used as request type in: vtctlservice.Vtctld.CleanupSchemaMigration

Used as field type in: vtadmin.CleanupSchemaMigrationRequest

• string keyspace = 1

• string uuid = 2

• optional vtrpc.CallerID caller_id = 3

  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: vtadmin.VTAdmin.CleanupSchemaMigration, vtctlservice.Vtctld.CleanupSchemaMigration

• map<string, uint64> rows_affected_by_shard = 1

Used as request type in: vtctlservice.Vtctld.CompleteSchemaMigration

Used as field type in: vtadmin.CompleteSchemaMigrationRequest

• string keyspace = 1

• string uuid = 2

• optional vtrpc.CallerID caller_id = 3

  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: vtadmin.VTAdmin.CompleteSchemaMigration, vtctlservice.Vtctld.CompleteSchemaMigration

• map<string, uint64> rows_affected_by_shard = 1

Used as request type in: vtctlservice.Vtctld.ConcludeTransaction

• string dtid = 1

• repeated query.Target participants = 2

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

(message has no fields)

Used as request type in: vtctlservice.Vtctld.CopySchemaShard

• optional topodata.TabletAlias source_tablet_alias = 1

• repeated string tables = 2

• repeated string exclude_tables = 3

• bool include_views = 4

• bool skip_verify = 5

• optional vttime.Duration wait_replicas_timeout = 6

• string destination_keyspace = 7

• string destination_shard = 8

Used as response type in: vtctlservice.Vtctld.CopySchemaShard

(message has no fields)

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.

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

• string sidecar_db_name = 11

  SidecarDBName is the name of the sidecar database that each vttablet in the keyspace will use.

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.

• bool wait_for_all_tablets = 7

  WaitForAllTablets makes ERS wait for a response from all the tablets before proceeding. Useful when all the tablets are up and reachable.

• optional topodata.TabletAlias expected_primary = 8

  ExpectedPrimary is the optional alias we expect to be the current primary in order for the reparent operation to succeed.

• bool allow_split_brain_promotion = 9

  AllowSplitBrainPromotion permits promoting NewPrimary when divergent GTID histories are detected. NewPrimary is required and must be an upfront undominated candidate. Transactions only present on losing histories will not be preserved.

• string required_position = 10

  RequiredPosition is the minimum MySQL GTID set, for example <uuid>:1-100, that the new primary must have. The reparent fails if no candidate has received it, either applied or still in its relay log. The check supports MySQL GTID shards only. On any other shard, the reparent fails only after it stops replication and demotes a reachable primary. Empty means no requirement.

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

Used as request type in: vtctlservice.Vtctld.ExecuteMultiFetchAsDBA

• optional topodata.TabletAlias tablet_alias = 1

• string sql = 2

  SQL could have potentially multiple queries separated by semicolons.

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

• repeated query.QueryResult results = 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

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

• string keyspace = 1

• string uuid = 2

• optional vtrpc.CallerID caller_id = 3

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

• map<string, uint64> rows_affected_by_shard = 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.GetKeyspaceRoutingRules

(message has no fields)

Used as response type in: vtctlservice.Vtctld.GetKeyspaceRoutingRules

• optional vschema.KeyspaceRoutingRules keyspace_routing_rules = 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.GetMirrorRules

(message has no fields)

Used as response type in: vtctlservice.Vtctld.GetMirrorRules

• optional vschema.MirrorRules mirror_rules = 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

GetSchemaMigrationsRequest controls the behavior of the GetSchemaMigrations rpc. Keyspace is a required field, while all other fields are optional. If UUID is set, other optional fields will be ignored, since there will be at most one migration with that UUID. Furthermore, if no migration with that UUID exists, an empty response, not an error, is returned. MigrationContext, Status, and Recent are mutually exclusive.

Used as request type in: vtctlservice.Vtctld.GetSchemaMigrations

Used as field type in: vtadmin.GetSchemaMigrationsRequest.ClusterRequest

• string keyspace = 1

• string uuid = 2

  Uuid, if set, will cause GetSchemaMigrations to return exactly 1 migration, namely the one with that UUID. If no migration exists, the response will be an empty slice, not an error. If this field is set, other fields (status filters, limit, skip, order) are ignored.

• string migration_context = 3

• SchemaMigration.Status status = 4

• optional vttime.Duration recent = 5

  Recent, if set, returns migrations requested between now and the provided value.

• QueryOrdering order = 6

• uint64 limit = 7

• uint64 skip = 8

Used as response type in: vtctlservice.Vtctld.GetSchemaMigrations

• repeated SchemaMigration migrations = 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

Used as response type in: vtctlservice.Vtctld.GetSchema

• optional tabletmanagerdata.SchemaDefinition schema = 1

Used as request type in: vtctlservice.Vtctld.GetShardReplication

• string keyspace = 1

• string shard = 2

• repeated string cells = 3

  Cells is the list of cells to fetch data for. Omit to fetch data from all cells.

Used as response type in: vtctlservice.Vtctld.GetShardReplication

• map<string, topodata.ShardReplication> shard_replication_by_cell = 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: vtadmin.VTAdmin.GetSrvKeyspace, vtctlservice.Vtctld.GetSrvKeyspaces

Used as field type in: vtadmin.GetSrvKeyspacesResponse

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

• optional topodata.TabletAlias tablet_alias = 1

  TabletAlias is the alias of the tablet to probe

Used as response type in: vtctlservice.Vtctld.GetThrottlerStatus

• optional tabletmanagerdata.GetThrottlerStatusResponse status = 1

Used as request type in: vtctlservice.Vtctld.GetTopologyPath

• string path = 1

• int64 version = 2

• bool as_json = 3

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

• optional TopologyCell cell = 1

Used as request type in: vtctlservice.Vtctld.GetTransactionInfo

Used as field type in: vtadmin.GetTransactionInfoRequest

• string dtid = 1

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

• optional query.TransactionMetadata metadata = 1

• repeated ShardTransactionState shard_states = 2

Used as request type in: vtctlservice.Vtctld.GetUnresolvedTransactions

• string keyspace = 1

• int64 abandon_age = 2

  in seconds

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

• repeated query.TransactionMetadata transactions = 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

• bool name_only = 3

• string workflow = 4

  If you only want a specific workflow then set this field.

• bool include_logs = 5

• repeated string shards = 6

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

Used as request type in: vtctlservice.Vtctld.LaunchSchemaMigration

Used as field type in: vtadmin.LaunchSchemaMigrationRequest

• string keyspace = 1

• string uuid = 2

• optional vtrpc.CallerID caller_id = 3

  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: vtadmin.VTAdmin.LaunchSchemaMigration, vtctlservice.Vtctld.LaunchSchemaMigration

• map<string, uint64> rows_affected_by_shard = 1

Used as request type in: vtctlservice.Vtctld.LookupVindexComplete

• string keyspace = 1

  Where the lookup vindex lives.

• string name = 2

  This is the name of the lookup vindex and the vreplication workflow.

• string table_keyspace = 3

  Where the vreplication workflow lives.

Used as response type in: vtctlservice.Vtctld.LookupVindexComplete

(message has no fields)

Used as request type in: vtctlservice.Vtctld.LookupVindexCreate

• string keyspace = 1

• string workflow = 2

• repeated string cells = 3

• optional vschema.Keyspace vindex = 4

• bool continue_after_copy_with_owner = 5

• repeated topodata.TabletType tablet_types = 6

• tabletmanagerdata.TabletSelectionPreference tablet_selection_preference = 7

Used as response type in: vtctlservice.Vtctld.LookupVindexCreate

(message has no fields)

Used as request type in: vtctlservice.Vtctld.LookupVindexExternalize

• string keyspace = 1

  Where the lookup vindex lives.

• string name = 2

  This is the name of the lookup vindex and the vreplication workflow.

• string table_keyspace = 3

  Where the vreplication workflow lives.

• bool delete_workflow = 4

  If this is set true, we directly delete the workflow instead of stopping. Also, complete command is not required to delete workflow in that case.

Used as response type in: vtctlservice.Vtctld.LookupVindexExternalize

• bool workflow_stopped = 1

  Was the workflow stopped.

• bool workflow_deleted = 2

  Was the workflow deleted.

Used as request type in: vtctlservice.Vtctld.LookupVindexInternalize

• string keyspace = 1

  Where the lookup vindex lives.

• string name = 2

  This is the name of the lookup vindex and the vreplication workflow.

• string table_keyspace = 3

  Where the vreplication workflow lives.

Used as response type in: vtctlservice.Vtctld.LookupVindexInternalize

(message has no fields)

MaterializationIntent describes the reason for creating the Materialize flow

Used in: MaterializeSettings, WorkflowAddTablesRequest

• 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

• REFERENCE = 3

  REFERENCE is when we are creating a materialization for reference tables

Used as request type in: vtctlservice.Vtctld.MaterializeCreate

Used as field type in: vtadmin.MaterializeCreateRequest

• optional MaterializeSettings settings = 1

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

(message has no fields)

MaterializeSettings contains the settings for the Materialize command.

Used in: MaterializeCreateRequest

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

• tabletmanagerdata.TabletSelectionPreference tablet_selection_preference = 15

• bool atomic_copy = 16

• optional WorkflowOptions workflow_options = 17

• repeated string reference_tables = 18

  ReferenceTables is set to a csv list of tables, if the materialization is for reference tables.

• string workflow = 1

• string target_keyspace = 3

• bool keep_data = 4

• bool keep_routing_rules = 5

• bool rename_tables = 6

• bool dry_run = 7

• string summary = 1

• repeated string dry_run_results = 2

Used as request type in: vtctlservice.Vtctld.MigrateCreate

• string workflow = 1

  The necessary info gets passed on to each primary tablet involved in the workflow via the CreateVReplicationWorkflow tabletmanager RPC.

• string source_keyspace = 2

• string target_keyspace = 3

• string mount_name = 4

• repeated string cells = 5

• repeated topodata.TabletType tablet_types = 6

• tabletmanagerdata.TabletSelectionPreference tablet_selection_preference = 7

• bool all_tables = 8

• repeated string include_tables = 9

• repeated string exclude_tables = 10

• string source_time_zone = 11

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

• string on_ddl = 12

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

• bool stop_after_copy = 13

  StopAfterCopy specifies if vreplication should be stopped after copying.

• bool drop_foreign_keys = 14

  DropForeignKeys specifies if foreign key constraints should be elided on the target.

• bool defer_secondary_keys = 15

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

• bool auto_start = 16

  Start the workflow after creating it.

• bool no_routing_rules = 17

  NoRoutingRules is set to true if routing rules should not be created on the target when the workflow is created.

Used as request type in: vtctlservice.Vtctld.MountList

(message has no fields)

Used as response type in: vtctlservice.Vtctld.MountList

• repeated string names = 1

Used as request type in: vtctlservice.Vtctld.MountRegister

• string topo_type = 1

• string topo_server = 2

• string topo_root = 3

• string name = 4

Used as response type in: vtctlservice.Vtctld.MountRegister

(message has no fields)

Used as request type in: vtctlservice.Vtctld.MountShow

• string name = 4

Used as response type in: vtctlservice.Vtctld.MountShow

• string topo_type = 1

• string topo_server = 2

• string topo_root = 3

• string name = 4

Used as request type in: vtctlservice.Vtctld.MountUnregister

• string name = 4

Used as response type in: vtctlservice.Vtctld.MountUnregister

(message has no fields)

Used as request type in: vtctlservice.Vtctld.MoveTablesComplete

Used as field type in: vtadmin.MoveTablesCompleteRequest

• string workflow = 1

• string target_keyspace = 3

• optional bool keep_data = 4

• bool keep_routing_rules = 5

• bool rename_tables = 6

• bool dry_run = 7

• repeated string shards = 8

• bool ignore_source_keyspace = 9

  Set to true if the you know that the source keyspace is no longer available but still want to complete the workflow.

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

• string summary = 1

• repeated string dry_run_results = 2

• repeated string warnings = 3

Used as request type in: vtctlservice.Vtctld.MoveTablesCreate

Used as field type in: vtadmin.MoveTablesCreateRequest

• string workflow = 1

  The necessary info gets passed on to each primary tablet involved in the workflow via the CreateVReplicationWorkflow tabletmanager RPC.

• string source_keyspace = 2

• string target_keyspace = 3

• repeated string cells = 4

• repeated topodata.TabletType tablet_types = 5

• tabletmanagerdata.TabletSelectionPreference tablet_selection_preference = 6

• repeated string source_shards = 7

• bool all_tables = 8

• repeated string include_tables = 9

• repeated string exclude_tables = 10

• string external_cluster_name = 11

  The name of the external cluster mounted in topo server.

• string source_time_zone = 12

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

• string on_ddl = 13

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

• bool stop_after_copy = 14

  StopAfterCopy specifies if vreplication should be stopped after copying.

• bool drop_foreign_keys = 15

  DropForeignKeys specifies if foreign key constraints should be elided on the target.

• bool defer_secondary_keys = 16

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

• bool auto_start = 17

  Start the workflow after creating it.

• bool no_routing_rules = 18

  NoRoutingRules is set to true if routing rules should not be created on the target when the workflow is created.

• bool atomic_copy = 19

  Run a single copy phase for the entire database.

• optional WorkflowOptions workflow_options = 20

• string summary = 1

• repeated MoveTablesCreateResponse.TabletInfo details = 2

Used in: MoveTablesCreateResponse

• optional topodata.TabletAlias tablet = 1

• bool created = 2

  Created is set if the workflow was created on this tablet or not.

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.

• optional vttime.Duration tolerable_replication_lag = 6

  TolerableReplicationLag is the amount of replication lag that is considered acceptable for a tablet to be eligible for promotion when Vitess makes the choice of a new primary. A value of 0 indicates that Vitess shouldn't consider the replication lag at all.

• bool allow_cross_cell_promotion = 7

  AllowCrossCellPromotion allows cross cell promotion,

• optional topodata.TabletAlias expected_primary = 8

  ExpectedPrimary is the optional alias we expect to be the current primary in order for the reparent operation to succeed.

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 in: GetSchemaMigrationsRequest

• NONE = 0

• ASCENDING = 1

• DESCENDING = 2

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

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

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

Used as field type in: vtadmin.ReshardCreateRequest

• string workflow = 1

• string keyspace = 2

• repeated string source_shards = 3

• repeated string target_shards = 4

• repeated string cells = 5

• repeated topodata.TabletType tablet_types = 6

• tabletmanagerdata.TabletSelectionPreference tablet_selection_preference = 7

• bool skip_schema_copy = 8

  SkipSchemaCopy specifies if the schema should be copied from the source shard, set false if schema is already created on the target shard before Reshard is invoked.

• string on_ddl = 9

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

• bool stop_after_copy = 10

  StopAfterCopy specifies if vreplication should be stopped after copying.

• bool defer_secondary_keys = 11

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

• bool auto_start = 12

  Start the workflow after creating it.

• optional WorkflowOptions workflow_options = 13

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

• optional vttime.Time restore_to_timestamp = 5

  RestoreToTimestamp, if given, requested an inremental restore up to (and excluding) the given timestamp. RestoreToTimestamp and RestoreToPos are mutually exclusive.

• repeated string allowed_backup_engines = 6

  AllowedBackupEngines, if present will filter out any backups taken with engines not included in the list

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

Used as field type in: vtadmin.RetrySchemaMigrationRequest

• string keyspace = 1

• string uuid = 2

• optional vtrpc.CallerID caller_id = 3

  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: vtadmin.VTAdmin.RetrySchemaMigration, vtctlservice.Vtctld.RetrySchemaMigration

• map<string, uint64> rows_affected_by_shard = 1

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)

SchemaMigration represents a row in the schema_migrations sidecar table.

Used in: vtadmin.SchemaMigration, GetSchemaMigrationsResponse

• string uuid = 1

• string keyspace = 2

• string shard = 3

• string schema = 4

• string table = 5

• string migration_statement = 6

• SchemaMigration.Strategy strategy = 7

• string options = 8

• optional vttime.Time added_at = 9

• optional vttime.Time requested_at = 10

• optional vttime.Time ready_at = 11

• optional vttime.Time started_at = 12

• optional vttime.Time liveness_timestamp = 13

• optional vttime.Time completed_at = 14

• optional vttime.Time cleaned_up_at = 15

• SchemaMigration.Status status = 16

• string log_path = 17

• string artifacts = 18

• uint64 retries = 19

• optional topodata.TabletAlias tablet = 20

• bool tablet_failure = 21

• float progress = 22

• string migration_context = 23

• string ddl_action = 24

• string message = 25

• int64 eta_seconds = 26

• uint64 rows_copied = 27

• int64 table_rows = 28

• uint32 added_unique_keys = 29

• uint32 removed_unique_keys = 30

• string log_file = 31

• optional vttime.Duration artifact_retention = 32

• bool postpone_completion = 33

• string removed_unique_key_names = 34

• string dropped_no_default_column_names = 35

• string expanded_column_names = 36

• string revertible_notes = 37

• bool allow_concurrent = 38

• string reverted_uuid = 39

• bool is_view = 40

• bool ready_to_complete = 41

• int64 vitess_liveness_indicator = 42

• float user_throttle_ratio = 43

• string special_plan = 44

• optional vttime.Time last_throttled_at = 45

• string component_throttled = 46

• optional vttime.Time cancelled_at = 47

• bool postpone_launch = 48

• string stage = 49

  enum?

• uint32 cutover_attempts = 50

• bool is_immediate_operation = 51

• optional vttime.Time reviewed_at = 52

• optional vttime.Time ready_to_complete_at = 53

• string removed_foreign_key_names = 54

• uint64 in_order_completion_pending_count = 55

Used in: GetSchemaMigrationsRequest, SchemaMigration

• UNKNOWN = 0

• REQUESTED = 1

• CANCELLED = 2

• QUEUED = 3

• READY = 4

• RUNNING = 5

• COMPLETE = 6

• FAILED = 7

Used in: SchemaMigration

• VITESS = 0

  SchemaMigration_VITESS uses vreplication to run the schema migration. It is the default strategy for OnlineDDL requests. SchemaMigration_VITESS was also formerly called "ONLINE".

• ONLINE = 0

• DIRECT = 3

  SchemaMigration_DIRECT runs the migration directly against MySQL (e.g. `ALTER TABLE ...`), meaning it is not actually an "online" DDL migration.

• MYSQL = 4

  SchemaMigration_MYSQL is a managed migration (queued and executed by the scheduler) but runs through a MySQL `ALTER TABLE`.

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

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

• string keyspace = 1

• string shard = 2

• bool disable = 3

Used as response type in: vtctlservice.Vtctld.SetVtorcEmergencyReparent

(message has no fields)

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 in: GetTransactionInfoResponse

• string shard = 1

• string state = 2

• string message = 3

• int64 time_created = 4

• repeated string statements = 5

Used in: WorkflowOptions

• LEAVE = 0

• REMOVE = 1

• REPLACE = 2

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

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

• int32 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)

Used in: WorkflowStatusResponse.TableCopyState

• UNKNOWN = 0

• NOT_STARTED = 1

• IN_PROGRESS = 2

• COMPLETE = 3

TableMaterializeSttings contains the settings for one table.

Used in: MaterializeSettings, WorkflowAddTablesRequest

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

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

• int64 version = 5

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)

• optional topodata.ThrottledAppRule throttled_app = 9

  ThrottledApp indicates a single throttled app rule (ignored if name is empty)

• string metric_name = 10

  MetricName is the name of the metric for which we apply a new threshold

• string app_name = 11

  AppName is the name of the app for which we assign metrics

• repeated string app_checked_metrics = 12

  AppCheckedMetrics are the metrics to be checked got the given AppName. These can be scoped. For example: ["lag", "self/loadvg", "shard/threads_running"]

Used as response type in: vtctlservice.Vtctld.UpdateThrottlerConfig

(message has no fields)

Used as request type in: vtctlservice.Vtctld.VDiffCreate

Used as field type in: vtadmin.VDiffCreateRequest

• string workflow = 1

  The name of the workflow that we're diffing tables for.

• string target_keyspace = 2

  The keyspace where the vreplication workflow is running.

• string uuid = 3

  A unique identifier for the vdiff. If empty, a new UUID will be generated.

• repeated string source_cells = 4

  The cells to look for source tablets in. If empty, all cells are used.

• repeated string target_cells = 5

  The cells to look for target tablets in. If empty, all cells are used.

• repeated topodata.TabletType tablet_types = 6

  The tablet types to use when searching for tablets to use when streaming results. A default value of "replica,rdonly,primary" is used by the tablet picker.

• tabletmanagerdata.TabletSelectionPreference tablet_selection_preference = 7

  When performing source tablet selection, look for candidates in the type order as they are listed in the tablet_types value (or the default of "replica,rdonly,primary" that the tablet picker uses). The default is ANY (0) and you can use INORDER (1) to e.g. ensure that a primary tablet is only used if there are no available replica or rdonly tablets.

• repeated string tables = 8

  The tables to compare. If empty, all tables in the workflow are compared.

• int64 limit = 9

  The maximum number of rows to compare for each table on each shard. The default is a max int64 value: 2^63 - 1 or 9,223,372,036,854,775,807.

• optional vttime.Duration filtered_replication_wait_time = 10

  How long to wait for the relevant vreplication stream(s) to catch up when attempting to setup the table snapshots on the source and target to use for the diff on each shard. The default is 30s.

• bool debug_query = 11

  Include the MySQL query used for the diff in the report that is stored on each shard primary tablet in the _vt.vdiff_table records.

• bool only_p_ks = 12

  Only show the Primary Key columns in any row diff output. You would typically want to use this if you set the max_sample_rows very high.

• bool update_table_stats = 13

  Update the table statistics, using ANALYZE TABLE, on each table involved in the vdiff during initialization on each target shard. This will ensure that progress estimates are as accurate as possible -- but it does involve locks and can potentially impact query processing on the target keyspace.

• int64 max_extra_rows_to_compare = 14

  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. The default is 0, comparing no extra rows.

• bool wait = 15

  Wait for the vdiff to complete before returning (making the call synchronous vs asynchronous by default).

• optional vttime.Duration wait_update_interval = 16

  When wait is true, this is how frequently the vdiff progress will be shown.

• bool auto_retry = 17

  Automatically retry the vdiff if we encounter an error. This should almost always be set to true (default is false).

• bool verbose = 18

  Include additional information in the vdiff report that is produced and stored on each target shard primary's _vt sidecar database.

• int64 max_report_sample_rows = 19

  The maximum number of rows to include in the row diff report (when differences are found) for each table on each shard. The default is 0, which will include no sample rows that differed.

• optional vttime.Duration max_diff_duration = 20

  The maximum time that a diff of a single table can run on each target shard before it is stopped and then later resumed from where we left off. This can be helpful in limiting the impact of holding open that large transaction where we scan up to every row in the table. The default is 0 or no limit.

• int64 row_diff_column_truncate_at = 21

  At what length should we truncate the column values in the row diff report generated for each table on each shard when differences are detected. The default is 0, meaning do not truncate.

• optional bool auto_start = 22

  Auto start the vdiff after creating it. The default is true if no value is specified.

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

• string UUID = 1

  Intentionally upper case to maintain compatibility with vtctlclient and other VDiff client command output.

Used as request type in: vtctlservice.Vtctld.VDiffDelete

• string workflow = 1

• string target_keyspace = 2

• string arg = 3

  This will be 'all' or a UUID.

Used as response type in: vtctlservice.Vtctld.VDiffDelete

(message has no fields)

Used as request type in: vtctlservice.Vtctld.VDiffResume

• string workflow = 1

• string target_keyspace = 2

• string uuid = 3

• repeated string target_shards = 4

Used as response type in: vtctlservice.Vtctld.VDiffResume

(message has no fields)

Used as request type in: vtctlservice.Vtctld.VDiffShow

Used as field type in: vtadmin.VDiffShowRequest

• string workflow = 1

• string target_keyspace = 2

• string arg = 3

  This will be 'all', 'last', or a UUID.

• bool no_samples = 4

  no_samples strips the per-table report's row-sample arrays from the response (keeping the scalar counters), avoiding gRPC message-size limits on diffs with large blob/JSON rows.

Used as response type in: vtctlservice.Vtctld.VDiffShow

• map<string, tabletmanagerdata.VDiffResponse> tablet_responses = 1

  The key is keyspace/shard.

Used as request type in: vtctlservice.Vtctld.VDiffStop

• string workflow = 1

• string target_keyspace = 2

• string uuid = 3

• repeated string target_shards = 4

Used as response type in: vtctlservice.Vtctld.VDiffStop

(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.ValidatePermissionsKeyspace

• string keyspace = 1

• repeated string shards = 2

  If you only want to validate a subset of the shards in the keyspace, then specify a list of shard names.

Used as response type in: vtctlservice.Vtctld.ValidatePermissionsKeyspace

(message has no fields)

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

• repeated string shards = 6

  If you only want to validate a subset of the shards in the keyspace, then specify a list of shard names.

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

  This represents how long it's been since we processed any event in the stream.

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

• string workflow_type = 6

• string workflow_sub_type = 7

• int64 max_v_replication_transaction_lag = 8

  This represents the lag across all shards, between the current time and the timestamp of the last transaction OR heartbeat timestamp (if there have been no writes to replicate from the source).

• bool defer_secondary_keys = 9

  This specifies whether to defer the creation of secondary keys.

• optional WorkflowOptions options = 10

  These are additional (optional) settings for vreplication workflows. Previously we used to add it to the binlogdata.BinlogSource proto object. More details in go/vt/sidecardb/schema/vreplication.sql.

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

• int64 rows_copied = 16

• optional Stream.ThrottlerStatus throttler_status = 17

• repeated topodata.TabletType tablet_types = 18

• tabletmanagerdata.TabletSelectionPreference tablet_selection_preference = 19

• repeated string cells = 20

Used in: Stream

• string table = 1

• string last_pk = 2

• int64 stream_id = 3

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

Used in: Stream

• string component_throttled = 1

• optional vttime.Time time_throttled = 2

Used as request type in: vtctlservice.Vtctld.WorkflowAddTables

• string workflow = 1

• string keyspace = 2

• repeated TableMaterializeSettings table_settings = 3

• MaterializationIntent materialization_intent = 4

Used as response type in: vtctlservice.Vtctld.WorkflowAddTables

(message has no fields)

Used as request type in: vtctlservice.Vtctld.WorkflowDelete

Used as field type in: vtadmin.WorkflowDeleteRequest

• string keyspace = 1

• string workflow = 2

• optional bool keep_data = 3

• bool keep_routing_rules = 4

• repeated string shards = 5

• int64 delete_batch_size = 6

  The max records to delete from the moved tables when cleaning up the migrated data. This is only used with multi-tenant MoveTables migrations.

• bool ignore_source_keyspace = 7

  Set to true if the you know that the source keyspace is no longer available but still want to clean everything up on the target keyspace.

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

• string summary = 1

• repeated WorkflowDeleteResponse.TabletInfo details = 2

• repeated string warnings = 3

Used in: WorkflowDeleteResponse

• optional topodata.TabletAlias tablet = 1

• bool deleted = 2

  Delete is set if the workflow was deleted on this tablet.

Used as request type in: vtctlservice.Vtctld.WorkflowMirrorTraffic

• string keyspace = 1

• string workflow = 2

• repeated topodata.TabletType tablet_types = 3

• float percent = 4

Used as response type in: vtctlservice.Vtctld.WorkflowMirrorTraffic

• string summary = 1

• string start_state = 2

• string current_state = 3

Used in: MaterializeSettings, MoveTablesCreateRequest, ReshardCreateRequest, Workflow

• string tenant_id = 1

• ShardedAutoIncrementHandling sharded_auto_increment_handling = 2

  Remove auto_increment clauses on tables when moving them to a sharded keyspace and optionally replace them with vschema AutoIncrement definitions.

• repeated string shards = 3

  Shards on which vreplication streams in the target keyspace are created for this workflow and to which the data from the source will be vreplicated.

• map<string, string> config = 4

• string global_keyspace = 5

  Where to create any related schema and vschema objects such as sequence tables.

• repeated string lookup_vindexes = 6

  Lookup Vindexes that are being backfilled by the workflow.

Used as request type in: vtctlservice.Vtctld.WorkflowStatus

• string keyspace = 1

• string workflow = 2

• repeated string shards = 3

Used as response type in: vtadmin.VTAdmin.GetWorkflowStatus, vtadmin.VTAdmin.MoveTablesCreate, vtadmin.VTAdmin.ReshardCreate, vtctlservice.Vtctld.MigrateCreate, vtctlservice.Vtctld.MoveTablesCreate, vtctlservice.Vtctld.ReshardCreate, vtctlservice.Vtctld.WorkflowStatus

• map<string, WorkflowStatusResponse.TableCopyState> table_copy_state = 1

  The key is keyspace/shard.

• map<string, WorkflowStatusResponse.ShardStreams> shard_streams = 2

• string traffic_state = 3

Used in: ShardStreams

• int32 id = 1

• optional topodata.TabletAlias tablet = 2

• string source_shard = 3

• string position = 4

• string status = 5

• string info = 6

Used in: WorkflowStatusResponse

• repeated ShardStreamState streams = 2

Used in: WorkflowStatusResponse

• int64 rows_copied = 1

• int64 rows_total = 2

• float rows_percentage = 3

• int64 bytes_copied = 4

• int64 bytes_total = 5

• float bytes_percentage = 6

• TableCopyPhase phase = 7

Used as request type in: vtctlservice.Vtctld.WorkflowSwitchTraffic

Used as field type in: vtadmin.WorkflowSwitchTrafficRequest

• string keyspace = 1

• string workflow = 2

• repeated string cells = 3

• repeated topodata.TabletType tablet_types = 4

• optional vttime.Duration max_replication_lag_allowed = 5

• bool enable_reverse_replication = 6

• int32 direction = 7

• optional vttime.Duration timeout = 8

• bool dry_run = 9

• bool initialize_target_sequences = 10

• repeated string shards = 11

• bool force = 12

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

• string summary = 1

• string start_state = 2

• string current_state = 3

• repeated string dry_run_results = 4

Used as request type in: vtctlservice.Vtctld.WorkflowUpdate

• string keyspace = 1

• optional tabletmanagerdata.UpdateVReplicationWorkflowRequest tablet_request = 2

  TabletRequest gets passed on to each primary tablet involved in the workflow via the UpdateVReplicationWorkflow tabletmanager RPC.

Used as response type in: vtadmin.VTAdmin.StartWorkflow, vtadmin.VTAdmin.StopWorkflow, vtctlservice.Vtctld.WorkflowUpdate

• string summary = 1

• repeated WorkflowUpdateResponse.TabletInfo details = 2

Used in: WorkflowUpdateResponse

• optional topodata.TabletAlias tablet = 1

• bool changed = 2

  Changed is true if any of the provided values were different than what was already stored on this tablet.