package tabletmanagerdata

Get desktop application:
View/edit binary Protocol Buffers messages

Used as request type in: tabletmanagerservice.TabletManager.ApplySchema

• string sql = 1

• bool force = 2

• bool allow_replication = 3

• optional SchemaDefinition before_schema = 4

• optional SchemaDefinition after_schema = 5

• string sql_mode = 6

• int64 batch_size = 7

  BatchSize indicates how many queries to apply together.

• bool disable_foreign_key_checks = 8

  DisableForeignKeyChecks will result in setting foreign_key_checks to off before applying the schema.

Used as response type in: tabletmanagerservice.TabletManager.ApplySchema

• optional SchemaDefinition before_schema = 1

• optional SchemaDefinition after_schema = 2

Used as request type in: tabletmanagerservice.TabletManager.Backup

• int32 concurrency = 1

• bool allow_primary = 2

• string incremental_from_pos = 3

  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 = 4

  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 = 5

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

• optional vttime.Duration mysql_shutdown_timeout = 6

  MysqlShutdownTimeout is the timeout in seconds to wait for MySQL to shutdown before taking the backup. If not set, the default value is used.

• optional BackupRequest.InitSQL init_sql = 7

Used in: BackupRequest, vtctldata.BackupRequest, vtctldata.BackupShardRequest

• repeated string queries = 1

  The queries to run on the mysqld instance prior to backing it up.

• repeated topodata.TabletType tablet_types = 2

  The tablet types to run the queries on.

• optional vttime.Duration timeout = 3

  At what point to time out the init SQL query work.

• bool fail_on_error = 4

  Should the backup fail if the SQL init work fails?

Used as response type in: tabletmanagerservice.TabletManager.Backup

• optional logutil.Event event = 1

Used as request type in: tabletmanagerservice.TabletManager.ChangeTags

• map<string, string> tags = 1

• bool replace = 2

Used as response type in: tabletmanagerservice.TabletManager.ChangeTags

• map<string, string> tags = 1

Used as request type in: tabletmanagerservice.TabletManager.ChangeType

• topodata.TabletType tablet_type = 1

• bool semiSync = 2

Used as response type in: tabletmanagerservice.TabletManager.ChangeType

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.CheckThrottler

• string app_name = 1

• string scope = 2

• bool skip_request_heartbeats = 3

  SkipRequestHeartbeats ensures this check does not renew heartbeat lease

• bool ok_if_not_exists = 4

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

Used as response type in: tabletmanagerservice.TabletManager.CheckThrottler

Used as field type in: vtctldata.CheckThrottlerResponse

• double value = 2

  Value is the metric value collected by the tablet

• double threshold = 3

  Threshold is the throttling threshold the table was comparing the value with

• string error = 4

  Error indicates an error retrieving the value

• string message = 5

  Message

• bool recently_checked = 6

  RecentlyChecked indicates that the tablet has been hit with a user-facing check, which can then imply that heartbeats lease should be renwed.

• map<string, CheckThrottlerResponse.Metric> metrics = 7

  Metrics is a map (metric name -> metric value/error) so that the client has as much information as possible about all the checked metrics.

• string app_name = 8

  AppName is the name of app that was matched by the throttler

• string summary = 9

  Summary is a human readable analysis of the result

• CheckThrottlerResponseCode response_code = 10

  ResponseCode is the enum representation of the response

Used in: CheckThrottlerResponse

• string name = 1

  Name of the metric

• double value = 3

  Value is the metric value collected by the tablet

• double threshold = 4

  Threshold is the throttling threshold the table was comparing the value with

• string error = 5

  Error indicates an error retrieving the value

• string message = 6

  Message

• string scope = 7

  Scope used in this check

• CheckThrottlerResponseCode response_code = 8

  ResponseCode is the enum representation of the response

Used in: CheckThrottlerResponse, CheckThrottlerResponse.Metric, GetThrottlerStatusResponse.RecentApp

• UNDEFINED = 0

• OK = 1

• THRESHOLD_EXCEEDED = 2

• APP_DENIED = 3

• UNKNOWN_METRIC = 4

• INTERNAL_ERROR = 5

Used as request type in: tabletmanagerservice.TabletManager.ConcludeTransaction

• string dtid = 1

• bool mm = 2

Used as response type in: tabletmanagerservice.TabletManager.ConcludeTransaction

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.CreateVReplicationWorkflow

• string workflow = 1

• repeated binlogdata.BinlogSource binlog_source = 2

• repeated string cells = 3

  Optional parameters.

• repeated topodata.TabletType tablet_types = 4

  TabletTypes is the list of tablet types to use when selecting source tablets.

• TabletSelectionPreference tablet_selection_preference = 5

• binlogdata.VReplicationWorkflowType workflow_type = 6

• binlogdata.VReplicationWorkflowSubType workflow_sub_type = 7

• bool defer_secondary_keys = 8

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

• bool auto_start = 9

  AutoStart specifies if the workflow should be started when created.

• bool stop_after_copy = 10

  Should the workflow stop after the copy phase.

• string options = 11

Used as response type in: tabletmanagerservice.TabletManager.CreateVReplicationWorkflow

• optional query.QueryResult result = 1

DbPermission describes a single row in the mysql.db table Primary key is Host+Db+User

Used in: Permissions

• string host = 1

• string db = 2

• string user = 3

• map<string, string> privileges = 4

Used as request type in: tabletmanagerservice.TabletManager.DeleteTableData

• map<string, string> table_filters = 1

  The key is the table that we want to delete data from. The value is the filter or WHERE clause to use when deleting data in the table.

• int64 batch_size = 2

  BatchSize is the number of rows to delete in a single batch.

Used as response type in: tabletmanagerservice.TabletManager.DeleteTableData

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.DeleteVReplicationWorkflow

• string workflow = 1

Used as response type in: tabletmanagerservice.TabletManager.DeleteVReplicationWorkflow

• optional query.QueryResult result = 1

Used as request type in: tabletmanagerservice.TabletManager.DemotePrimary

• bool force = 1

Used as response type in: tabletmanagerservice.TabletManager.DemotePrimary

• optional replicationdata.PrimaryStatus primary_status = 2

  PrimaryStatus represents the response from calling `SHOW BINARY LOG STATUS` on a primary that has been demoted.

Used as request type in: tabletmanagerservice.TabletManager.ExecuteFetchAsAllPrivs

• bytes query = 1

• string db_name = 2

• uint64 max_rows = 3

• bool reload_schema = 4

Used as response type in: tabletmanagerservice.TabletManager.ExecuteFetchAsAllPrivs

• optional query.QueryResult result = 1

Used as request type in: tabletmanagerservice.TabletManager.ExecuteFetchAsApp

• bytes query = 1

• uint64 max_rows = 2

Used as response type in: tabletmanagerservice.TabletManager.ExecuteFetchAsApp

• optional query.QueryResult result = 1

Used as request type in: tabletmanagerservice.TabletManager.ExecuteFetchAsDba

• bytes query = 1

• string db_name = 2

• uint64 max_rows = 3

• bool disable_binlogs = 4

• bool reload_schema = 5

• bool disable_foreign_key_checks = 6

Used as response type in: tabletmanagerservice.TabletManager.ExecuteFetchAsDba

• optional query.QueryResult result = 1

Used as request type in: tabletmanagerservice.TabletManager.ExecuteHook

Used as field type in: vtctldata.ExecuteHookRequest

• string name = 1

• repeated string parameters = 2

• map<string, string> extra_env = 3

Used as response type in: tabletmanagerservice.TabletManager.ExecuteHook

Used as field type in: vtctldata.ExecuteHookResponse

• int64 exit_status = 1

• string stdout = 2

• string stderr = 3

Used as request type in: tabletmanagerservice.TabletManager.ExecuteMultiFetchAsDba

• bytes sql = 1

• string db_name = 2

• uint64 max_rows = 3

• bool disable_binlogs = 4

• bool reload_schema = 5

• bool disable_foreign_key_checks = 6

Used as response type in: tabletmanagerservice.TabletManager.ExecuteMultiFetchAsDba

• repeated query.QueryResult results = 1

Used as request type in: tabletmanagerservice.TabletManager.ExecuteQuery

• bytes query = 1

• string db_name = 2

• uint64 max_rows = 3

• optional vtrpc.CallerID caller_id = 4

  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: tabletmanagerservice.TabletManager.ExecuteQuery

• optional query.QueryResult result = 1

Used as request type in: tabletmanagerservice.TabletManager.FullStatus

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.FullStatus

• optional replicationdata.FullStatus status = 1

Used as request type in: tabletmanagerservice.TabletManager.GetGlobalStatusVars

• repeated string variables = 1

Used as response type in: tabletmanagerservice.TabletManager.GetGlobalStatusVars

• map<string, string> status_values = 1

Used as request type in: tabletmanagerservice.TabletManager.GetMaxValueForSequences

• repeated GetMaxValueForSequencesRequest.SequenceMetadata sequences = 1

Used in: GetMaxValueForSequencesRequest

• string backing_table_name = 1

  The name of the sequence table. This will be used for mapping max value with table in the response.

• string using_col_escaped = 2

  Escaped column name specified for sequence in table.

• string using_table_name_escaped = 3

  Escaped name of the table using the sequence.

• string using_table_db_name_escaped = 4

  Escaped db name in use by the keyspace where the using table lives.

Used as response type in: tabletmanagerservice.TabletManager.GetMaxValueForSequences

• map<string, int64> max_values_by_sequence_table = 1

  Max used sequence value mapped with the backing sequence table.

Used as request type in: tabletmanagerservice.TabletManager.GetPermissions

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.GetPermissions

• optional Permissions permissions = 1

Used as request type in: tabletmanagerservice.TabletManager.GetReplicas

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.GetReplicas

• repeated string addrs = 1

Used as request type in: tabletmanagerservice.TabletManager.GetSchema

• repeated string tables = 1

• bool include_views = 2

• repeated string exclude_tables = 3

• bool table_schema_only = 4

  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: tabletmanagerservice.TabletManager.GetSchema

• optional SchemaDefinition schema_definition = 1

Used as request type in: tabletmanagerservice.TabletManager.GetThrottlerStatus

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.GetThrottlerStatus

Used as field type in: vtctldata.GetThrottlerStatusResponse

• string tablet_alias = 1

  TabletAlias of probed tablet

• string keyspace = 2

• string shard = 3

• bool is_leader = 4

  IsLeader indicates if the tablet is the leader of the shard, ie. the primary

• bool is_open = 5

  IsOpen per stateManager

• bool is_enabled = 6

  IsEnabled per throttler configuration

• bool is_dormant = 7

  IsDormant: whether the throttler is dormant, ie has not received any checks in a while and goes into low-frequency probing mode.

• string lag_metric_query = 8

  LagMetricQuery is the query used to check the lag metric, a constant used by the throttler.

• string custom_metric_query = 9

  CustomMetricQuery is the query used to check the custom metric, supplied by the user.

• double default_threshold = 10

  DefaultThreshold is the threshold used by the throttler for the default metric (lag or custom in single-metric throttlers)

• string metric_name_used_as_default = 11

  MetricNameUsedAsDefault is the name of the metric used as the default metric: "lag" or "custom", for backwards compatibility with single-metric throttlers

• map<string, GetThrottlerStatusResponse.MetricResult> aggregated_metrics = 12

  AggregatedMetrics is a map of metric names to their values/errors Names are, for example, "self", "self/lag", "shard/lag", "shard/loadavg", etc.

• map<string, double> metric_thresholds = 13

  MetricThresholds is a map of metric names to their thresholds.

• map<string, GetThrottlerStatusResponse.MetricHealth> metrics_health = 14

  MetricsHealth is a map of metric names to their health status.

• map<string, topodata.ThrottledAppRule> throttled_apps = 15

  ThrottledApps is a map of app names to their throttling rules

• map<string, string> app_checked_metrics = 16

  AppCheckedMetrics is a map of app names to their assigned metrics

• bool recently_checked = 17

• map<string, GetThrottlerStatusResponse.RecentApp> recent_apps = 18

  RecentApps is a map of app names to their recent check status

Used in: GetThrottlerStatusResponse

• optional vttime.Time last_healthy_at = 1

• int64 seconds_since_last_healthy = 2

Used in: GetThrottlerStatusResponse

• double value = 1

• string error = 2

Used in: GetThrottlerStatusResponse

• optional vttime.Time checked_at = 1

• CheckThrottlerResponseCode response_code = 3

  ResponseCode is the enum representation of the response

Used as request type in: tabletmanagerservice.TabletManager.GetTransactionInfo

• string dtid = 1

Used as response type in: tabletmanagerservice.TabletManager.GetTransactionInfo

• string state = 1

• string message = 2

• int64 time_created = 3

• repeated string statements = 4

Used as request type in: tabletmanagerservice.TabletManager.GetUnresolvedTransactions

• int64 abandon_age = 1

Used as response type in: tabletmanagerservice.TabletManager.GetUnresolvedTransactions

• repeated query.TransactionMetadata transactions = 1

Used as request type in: tabletmanagerservice.TabletManager.HasVReplicationWorkflows

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.HasVReplicationWorkflows

• bool has = 1

Used as request type in: tabletmanagerservice.TabletManager.InitPrimary

• bool semiSync = 1

Used as response type in: tabletmanagerservice.TabletManager.InitPrimary

• string position = 1

Used as request type in: tabletmanagerservice.TabletManager.InitReplica

• optional topodata.TabletAlias parent = 1

• string replication_position = 2

• int64 time_created_ns = 3

• bool semiSync = 4

Used as response type in: tabletmanagerservice.TabletManager.InitReplica

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.LockTables

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.LockTables

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.MysqlHostMetrics

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.MysqlHostMetrics

• optional mysqlctl.HostMetricsResponse HostMetrics = 1

Permissions have all the rows in mysql.{user,db} tables, (all rows are sorted by primary key)

Used in: GetPermissionsResponse, vtctldata.GetPermissionsResponse

• repeated UserPermission user_permissions = 1

• repeated DbPermission db_permissions = 2

Used as request type in: tabletmanagerservice.TabletManager.Ping

• string payload = 1

Used as response type in: tabletmanagerservice.TabletManager.Ping

• string payload = 1

Used as request type in: tabletmanagerservice.TabletManager.PopulateReparentJournal

• int64 time_created_ns = 1

• string action_name = 2

• optional topodata.TabletAlias primary_alias = 3

• string replication_position = 4

Used as response type in: tabletmanagerservice.TabletManager.PopulateReparentJournal

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.PreflightSchema

• repeated string changes = 1

Used as response type in: tabletmanagerservice.TabletManager.PreflightSchema

• repeated SchemaChangeResult change_results = 1

  change_results has for each change the schema before and after it. The number of elements is identical to the length of "changes" in the request.

Used as request type in: tabletmanagerservice.TabletManager.PrimaryPosition

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.PrimaryPosition

• string position = 1

Used as request type in: tabletmanagerservice.TabletManager.PrimaryStatus

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.PrimaryStatus

• optional replicationdata.PrimaryStatus status = 1

Used as request type in: tabletmanagerservice.TabletManager.PromoteReplica

• bool semiSync = 1

Used as response type in: tabletmanagerservice.TabletManager.PromoteReplica

• string position = 1

Used as request type in: tabletmanagerservice.TabletManager.ReadReparentJournalInfo

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.ReadReparentJournalInfo

• int32 length = 1

Used as request type in: tabletmanagerservice.TabletManager.ReadTransaction

• string dtid = 1

Used as response type in: tabletmanagerservice.TabletManager.ReadTransaction

• optional query.TransactionMetadata transaction = 1

Used as request type in: tabletmanagerservice.TabletManager.ReadVReplicationWorkflow

• string workflow = 1

Used as response type in: tabletmanagerservice.TabletManager.ReadVReplicationWorkflow

Used as field type in: ReadVReplicationWorkflowsResponse

• string workflow = 2

• string cells = 3

• repeated topodata.TabletType tablet_types = 4

• TabletSelectionPreference tablet_selection_preference = 5

• string db_name = 6

• string tags = 7

• binlogdata.VReplicationWorkflowType workflow_type = 8

• binlogdata.VReplicationWorkflowSubType workflow_sub_type = 9

• bool defer_secondary_keys = 10

• repeated ReadVReplicationWorkflowResponse.Stream streams = 11

• string options = 12

• map<string, string> config_overrides = 13

Used in: ReadVReplicationWorkflowResponse

• int32 id = 1

• optional binlogdata.BinlogSource bls = 2

• string pos = 3

• string stop_pos = 4

• int64 max_tps = 5

• int64 max_replication_lag = 6

• optional vttime.Time time_updated = 7

• optional vttime.Time transaction_timestamp = 8

• binlogdata.VReplicationWorkflowState state = 9

• string message = 10

• int64 rows_copied = 11

• optional vttime.Time time_heartbeat = 12

• optional vttime.Time time_throttled = 13

• string component_throttled = 14

Used as request type in: tabletmanagerservice.TabletManager.ReadVReplicationWorkflows

• repeated int32 include_ids = 1

• repeated string include_workflows = 2

• repeated binlogdata.VReplicationWorkflowState include_states = 3

• repeated string exclude_workflows = 4

• repeated binlogdata.VReplicationWorkflowState exclude_states = 5

• bool exclude_frozen = 6

Used as response type in: tabletmanagerservice.TabletManager.ReadVReplicationWorkflows

• repeated ReadVReplicationWorkflowResponse workflows = 1

Used as request type in: tabletmanagerservice.TabletManager.RefreshState

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.RefreshState

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.ReloadSchema

• string wait_position = 1

  wait_position allows scheduling a schema reload to occur after a given DDL has replicated to this server, by specifying a replication position to wait for. Leave empty to trigger the reload immediately.

Used as response type in: tabletmanagerservice.TabletManager.ReloadSchema

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.ReplicaWasPromoted

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.ReplicaWasPromoted

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.ReplicaWasRestarted

• optional topodata.TabletAlias parent = 1

  the parent alias the tablet should have

Used as response type in: tabletmanagerservice.TabletManager.ReplicaWasRestarted

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.ReplicationStatus

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.ReplicationStatus

• optional replicationdata.Status status = 1

Used as request type in: tabletmanagerservice.TabletManager.ResetReplicationParameters

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.ResetReplicationParameters

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.ResetReplication

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.ResetReplication

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.ResetSequences

• repeated string tables = 1

Used as response type in: tabletmanagerservice.TabletManager.ResetSequences

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.RestartReplication

• bool semiSync = 1

Used as response type in: tabletmanagerservice.TabletManager.RestartReplication

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.RestoreFromBackup

• optional vttime.Time backup_time = 1

• string restore_to_pos = 2

  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 = 3

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

• optional vttime.Time restore_to_timestamp = 4

  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 = 5

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

Used as response type in: tabletmanagerservice.TabletManager.RestoreFromBackup

• optional logutil.Event event = 1

Used as request type in: tabletmanagerservice.TabletManager.RunHealthCheck

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.RunHealthCheck

(message has no fields)

Used in: PreflightSchemaResponse

• optional SchemaDefinition before_schema = 1

  before_schema holds the schema before each change.

• optional SchemaDefinition after_schema = 2

  after_schema holds the schema after each change.

Used in: ApplySchemaRequest, ApplySchemaResponse, GetSchemaResponse, SchemaChangeResult, vtctldata.GetSchemaResponse

• string database_schema = 1

• repeated TableDefinition table_definitions = 2

Used as request type in: tabletmanagerservice.TabletManager.SetReadOnly

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.SetReadOnly

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.SetReadWrite

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.SetReadWrite

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.SetReplicationSource

• optional topodata.TabletAlias parent = 1

• int64 time_created_ns = 2

• bool force_start_replication = 3

• string wait_position = 4

• bool semiSync = 5

• double heartbeat_interval = 6

Used as response type in: tabletmanagerservice.TabletManager.SetReplicationSource

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.Sleep

• int64 duration = 1

  duration is in nanoseconds

Used as response type in: tabletmanagerservice.TabletManager.Sleep

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.StartReplication

• bool semiSync = 1

Used as response type in: tabletmanagerservice.TabletManager.StartReplication

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.StartReplicationUntilAfter

• string position = 1

• int64 wait_timeout = 2

Used as response type in: tabletmanagerservice.TabletManager.StartReplicationUntilAfter

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.StopReplicationAndGetStatus

• replicationdata.StopReplicationMode stop_replication_mode = 1

Used as response type in: tabletmanagerservice.TabletManager.StopReplicationAndGetStatus

• optional replicationdata.StopReplicationStatus status = 2

  Status represents the replication status call right before, and right after telling the replica to stop.

Used as request type in: tabletmanagerservice.TabletManager.StopReplicationMinimum

• string position = 1

• int64 wait_timeout = 2

Used as response type in: tabletmanagerservice.TabletManager.StopReplicationMinimum

• string position = 1

Used as request type in: tabletmanagerservice.TabletManager.StopReplication

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.StopReplication

(message has no fields)

Used in: SchemaDefinition, vtadmin.Schema

• string name = 1

  the table name

• string schema = 2

  the SQL to run to create the table

• repeated string columns = 3

  the columns in the order that will be used to dump and load the data

• repeated string primary_key_columns = 4

  the primary key columns in the primary key order

• string type = 5

  type is either mysqlctl.TableBaseTable or mysqlctl.TableView

• uint64 data_length = 6

  how much space the data file takes.

• uint64 row_count = 7

  approximate number of rows

• repeated query.Field fields = 8

  column names along with their types. NOTE: this is a superset of columns.

This structure allows us to manage tablet selection preferences which are eventually passed to a TabletPicker.

Used in: CreateVReplicationWorkflowRequest, ReadVReplicationWorkflowResponse, UpdateVReplicationWorkflowRequest, vtctldata.LookupVindexCreateRequest, vtctldata.MaterializeSettings, vtctldata.MigrateCreateRequest, vtctldata.MoveTablesCreateRequest, vtctldata.ReshardCreateRequest, vtctldata.VDiffCreateRequest, vtctldata.Workflow.Stream

• ANY = 0

• INORDER = 1

• UNKNOWN = 3

  Don't change any existing value

Used as request type in: tabletmanagerservice.TabletManager.UndoDemotePrimary

• bool semiSync = 1

Used as response type in: tabletmanagerservice.TabletManager.UndoDemotePrimary

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.UnlockTables

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.UnlockTables

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.UpdateSequenceTables

• repeated UpdateSequenceTablesRequest.SequenceMetadata sequences = 1

Used in: UpdateSequenceTablesRequest

• string backing_table_name = 1

  The name of the sequence table.

• string backing_table_db_name = 2

  The dbName in use by the keyspace where the backing table lives.

• int64 max_value = 3

  The maximum used sequence value.

Used as response type in: tabletmanagerservice.TabletManager.UpdateSequenceTables

(message has no fields)

UpdateVReplicationWorkflowRequest is used to update an existing VReplication workflow. Note that the following fields MUST have an explicit value provided if you do NOT wish to update the existing value to the given type's ZeroValue: cells, tablet_types, on_ddl, and state. TODO: leverage the optional modifier for these fields rather than using SimulatedNull values: https://github.com/vitessio/vitess/issues/15627

Used as request type in: tabletmanagerservice.TabletManager.UpdateVReplicationWorkflow

Used as field type in: vtctldata.WorkflowUpdateRequest

• string workflow = 1

• repeated string cells = 2

• repeated topodata.TabletType tablet_types = 3

• optional TabletSelectionPreference tablet_selection_preference = 4

• optional binlogdata.OnDDLAction on_ddl = 5

• optional binlogdata.VReplicationWorkflowState state = 6

• repeated string shards = 7

• map<string, string> config_overrides = 8

• optional string message = 9

• repeated binlogdata.Rule filter_rules = 10

  Specify filter rules which need to be appended in the existing binlogsource filter rules.

Used as response type in: tabletmanagerservice.TabletManager.UpdateVReplicationWorkflow

• optional query.QueryResult result = 1

UpdateVReplicationWorkflowsRequest is used to update multiple existing VReplication workflows. Note that the following fields MUST have an explicit value provided if you do NOT wish to update the existing values to the given type's ZeroValue: state, message, and stop_position. TODO: leverage the optional modifier for these fields rather than using SimulatedNull values: https://github.com/vitessio/vitess/issues/15627

Used as request type in: tabletmanagerservice.TabletManager.UpdateVReplicationWorkflows

• bool all_workflows = 1

• repeated string include_workflows = 2

• repeated string exclude_workflows = 3

• optional binlogdata.VReplicationWorkflowState state = 4

• optional string message = 5

• optional string stop_position = 6

Used as response type in: tabletmanagerservice.TabletManager.UpdateVReplicationWorkflows

• optional query.QueryResult result = 1

UserPermission describes a single row in the mysql.user table Primary key is Host+User PasswordChecksum is the crc64 of the password, for security reasons

Used in: Permissions

• string host = 1

• string user = 2

• uint64 password_checksum = 3

• map<string, string> privileges = 4

Used in: VDiffOptions

• string tables = 1

• bool auto_retry = 2

• int64 max_rows = 3

• bool checksum = 4

• int64 sample_pct = 5

• int64 timeout_seconds = 6

• int64 max_extra_rows_to_compare = 7

• bool update_table_stats = 8

• int64 max_diff_seconds = 9

• optional bool auto_start = 10

Used in: VDiffRequest

• optional VDiffPickerOptions picker_options = 1

• optional VDiffCoreOptions core_options = 2

• optional VDiffReportOptions report_options = 3

options that influence the tablet selected by the picker for streaming data from

Used in: VDiffOptions

• string tablet_types = 1

• string source_cell = 2

• string target_cell = 3

options that only influence how vdiff differences are reported

Used in: VDiffOptions

• bool only_pks = 1

• bool debug_query = 2

• string format = 3

• int64 max_sample_rows = 4

• int64 row_diff_column_truncate_at = 5

Used as request type in: tabletmanagerservice.TabletManager.VDiff

• string keyspace = 1

• string workflow = 2

• string action = 3

• string action_arg = 4

• string vdiff_uuid = 5

• optional VDiffOptions options = 6

Used as response type in: tabletmanagerservice.TabletManager.VDiff

Used as field type in: vtctldata.VDiffShowResponse

• int64 id = 1

• optional query.QueryResult output = 2

• string vdiff_uuid = 3

• optional query.QueryResult target = 1

• optional query.QueryResult source = 2

  If the source value is nil then it's the same as the target and the target value should be used for both.

Used as request type in: tabletmanagerservice.TabletManager.VReplicationExec

• string query = 1

Used as response type in: tabletmanagerservice.TabletManager.VReplicationExec

• optional query.QueryResult result = 1

Used as request type in: tabletmanagerservice.TabletManager.VReplicationWaitForPos

• int32 id = 1

• string position = 2

Used as response type in: tabletmanagerservice.TabletManager.VReplicationWaitForPos

(message has no fields)

Used as request type in: tabletmanagerservice.TabletManager.ValidateVReplicationPermissions

(message has no fields)

Used as response type in: tabletmanagerservice.TabletManager.ValidateVReplicationPermissions

• string user = 1

  The --db_filtered_user on the tablet.

• bool ok = 2

  Does the user have the minimum privileges needed to manage vreplication metadata.

• string error = 3

  The error has to be passed from the tablet since the sidecar name is tablet-specific

Used as request type in: tabletmanagerservice.TabletManager.WaitForPosition

• string position = 1

Used as response type in: tabletmanagerservice.TabletManager.WaitForPosition

(message has no fields)