package topodata

Get desktop application:
View/edit binary Protocol Buffers messages

CellInfo contains information about a cell. CellInfo objects are stored in the global topology server, and describe how to reach local topology servers.

Used in: vtadmin.ClusterCellInfo, vtctldata.AddCellInfoRequest, vtctldata.GetCellInfoResponse, vtctldata.UpdateCellInfoRequest, vtctldata.UpdateCellInfoResponse

• string server_address = 1

  ServerAddress contains the address of the server for the cell. The syntax of this field is topology implementation specific. For instance, for Zookeeper, it is a comma-separated list of server addresses.

• string root = 2

  Root is the path to store data in. It is only used when talking to server_address.

CellsAlias

Used in: vtadmin.ClusterCellsAliases, vtctldata.GetCellsAliasesResponse, vtctldata.UpdateCellsAliasRequest, vtctldata.UpdateCellsAliasResponse

• repeated string cells = 2

  Cells that map to this alias

ExternalClusters

• repeated ExternalVitessCluster vitess_cluster = 1

Used in: ExternalClusters

• optional TopoConfig topo_config = 1

KeyRange describes a range of sharding keys, when range-based sharding is used.

Used in: binlogdata.BinlogSource, binlogdata.StreamKeyRangeRequest, Shard, Shard.SourceShard, ShardReference, ShardTabletControl, Tablet, vtctldata.SourceShardAddRequest

• bytes start = 1

• bytes end = 2

A Keyspace contains data about a keyspace.

Used in: vtctldata.Keyspace, vtctldata.SetKeyspaceDurabilityPolicyResponse, vtctldata.SetKeyspaceShardingInfoResponse

• KeyspaceType keyspace_type = 5

  keyspace_type will determine how this keyspace is treated by vtgate / vschema. Normal keyspaces are routable by any query. Snapshot keyspaces are only accessible by explicit addresssing or by calling "use keyspace" first

• string base_keyspace = 6

  base_keyspace is the base keyspace from which a snapshot keyspace is created. empty for normal keyspaces

• optional vttime.Time snapshot_time = 7

  snapshot_time (in UTC) is a property of snapshot keyspaces which tells us what point in time the snapshot is of

• string durability_policy = 8

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

• optional ThrottlerConfig throttler_config = 9

  ThrottlerConfig has the configuration for the tablet server's lag throttler, and applies to the entire keyspace, across all shards and tablets.

• string sidecar_db_name = 10

  SidecarDBName is the name of the Vitess sidecar database used for various system metadata that is stored in each tablet's mysqld instance.

KeyspaceType describes the type of the keyspace

Used in: Keyspace, vtctldata.CreateKeyspaceRequest

• NORMAL = 0

  NORMAL is the default value

• SNAPSHOT = 1

  SNAPSHOT is when we are creating a snapshot keyspace

A Shard contains data about a subset of the data whithin a keyspace.

Used in: vtctldata.SetShardIsPrimaryServingResponse, vtctldata.SetShardTabletControlResponse, vtctldata.Shard, vtctldata.SourceShardAddResponse, vtctldata.SourceShardDeleteResponse

• optional TabletAlias primary_alias = 1

  primary_alias is the tablet alias of the primary for the shard. If it is unset, then there is no primary in this shard yet. No lock is necessary to update this field, when for instance TabletExternallyReparented updates this. However, we lock the shard for reparenting operations (InitShardPrimary, PlannedReparentShard,EmergencyReparentShard), to guarantee exclusive operation.

• optional vttime.Time primary_term_start_time = 8

  primary_term_start_time is the time (in UTC) at which the current term of the primary specified in primary_alias began. A new primary term begins any time an authoritative decision is communicated about which tablet should be the primary, such as via Vitess replication-management commands like PlannedReparentShard, EmergencyReparentShard, and TabletExternallyReparented. The primary_alias should only ever be changed if the new primary's term began at a later time than this. Note that a new term can start for the tablet that is already the primary. In that case, the primary_term_start_time would be increased without changing the primary_alias.

• optional KeyRange key_range = 2

  key_range is the KeyRange for this shard. It can be unset if: - we are not using range-based sharding in this shard. - the shard covers the entire keyrange. This must match the shard name based on our other conventions, but helpful to have it decomposed here. Once set at creation time, it is never changed.

• repeated Shard.SourceShard source_shards = 4

  SourceShards is the list of shards we're replicating from, using filtered replication. The keyspace lock is always taken when changing this.

• repeated Shard.TabletControl tablet_controls = 6

  tablet_controls has at most one entry per TabletType. The keyspace lock is always taken when changing this.

• bool is_primary_serving = 7

  is_primary_serving sets whether this shard primary is serving traffic or not. The keyspace lock is always taken when changing this.

SourceShard represents a data source for filtered replication across shards. When this is used in a destination shard, the primary of that shard will run filtered replication.

Used in: Shard

• int32 uid = 1

  Uid is the unique ID for this SourceShard object.

• string keyspace = 2

  the source keyspace

• string shard = 3

  the source shard

• optional KeyRange key_range = 4

  the source shard keyrange

• repeated string tables = 5

  the source table list to replicate

TabletControl controls tablet's behavior

Used in: Shard, vtctldata.Workflow.ShardStream

• TabletType tablet_type = 1

  which tablet type is affected

• repeated string cells = 2

• repeated string denied_tables = 4

• bool frozen = 5

  frozen is set if we've started failing over traffic for the primary. If set, this record should not be removed.

ShardReference is used as a pointer from a SrvKeyspace to a Shard

Used in: SrvKeyspace.KeyspacePartition

• string name = 1

  Copied from Shard.

• optional KeyRange key_range = 2

  Disable query serving in this shard

ShardReplication describes the MySQL replication relationships whithin a cell.

Used in: vtctldata.GetShardReplicationResponse

• repeated ShardReplication.Node nodes = 1

  Note there can be only one Node in this array for a given tablet.

Node describes a tablet instance within the cell

Used in: ShardReplication

• optional TabletAlias tablet_alias = 1

ShardReplicationError describes the error being fixed by ShardReplicationFix.

Used in: vtctldata.ShardReplicationFixResponse

• ShardReplicationError.Type type = 1

  Type is the category of problem being fixed.

• optional TabletAlias tablet_alias = 2

  TabletAlias is the tablet record that has the problem.

Used in: ShardReplicationError

• UNKNOWN = 0

  UNKNOWN is not a valid value.

• NOT_FOUND = 1

  NOT_FOUND occurs when a tablet is in the ShardReplication record but does not exist in the topology.

• TOPOLOGY_MISMATCH = 2

  TOPOLOGY_MISMATCH occurs when a tablet is in the replication graph and exists in the topology, but at least one of the Keyspace, Shard, or Cell fields for that tablet does not match the ShardReplication record.

ShardTabletControl is used as a pointer from a SrvKeyspace to a Shard

Used in: SrvKeyspace.KeyspacePartition

• string name = 1

  Copied from Shard.

• optional KeyRange key_range = 2

• bool query_service_disabled = 3

  Disable query serving in this shard

SrvKeyspace is a rollup node for the keyspace itself.

Used in: vtctldata.GetSrvKeyspacesResponse

• repeated SrvKeyspace.KeyspacePartition partitions = 1

  The partitions this keyspace is serving, per tablet type.

• optional ThrottlerConfig throttler_config = 6

  ThrottlerConfig has the configuration for the tablet server's lag throttler, and applies to the entire keyspace, across all shards and tablets. This is copied from the global keyspace object.

Used in: SrvKeyspace

• TabletType served_type = 1

  The type this partition applies to.

• repeated ShardReference shard_references = 2

  List of non-overlapping continuous shards sorted by range.

• repeated ShardTabletControl shard_tablet_controls = 3

  List of shard tablet controls

Tablet represents information about a running instance of vttablet.

Used in: vtadmin.Tablet, vtctldata.ChangeTabletTypeResponse, vtctldata.GetTabletResponse, vtctldata.GetTabletsResponse, vtctldata.ShardReplicationPositionsResponse

• optional TabletAlias alias = 1

  alias is the unique name of the tablet.

• string hostname = 2

  Fully qualified domain name of the host.

• map<string, int32> port_map = 4

  Map of named ports. Normally this should include vt and grpc. Going forward, the mysql port will be stored in mysql_port instead of here. For accessing mysql port, use topoproto.MysqlPort to fetch, and topoproto.SetMysqlPort to set. These wrappers will ensure legacy behavior is supported.

• string keyspace = 5

  Keyspace name.

• string shard = 6

  Shard name. If range based sharding is used, it should match key_range.

• optional KeyRange key_range = 7

  If range based sharding is used, range for the tablet's shard.

• TabletType type = 8

  type is the current type of the tablet.

• string db_name_override = 9

  It this is set, it is used as the database name instead of the normal "vt_" + keyspace.

• map<string, string> tags = 10

  tablet tags

• string mysql_hostname = 12

  MySQL hostname.

• int32 mysql_port = 13

  MySQL port. Use topoproto.MysqlPort and topoproto.SetMysqlPort to access this variable. The functions provide support for legacy behavior.

• optional vttime.Time primary_term_start_time = 14

  primary_term_start_time is the time (in UTC) at which the current term of the current tablet began as primary. If this tablet is not currently the primary, this value is ignored. A new primary term begins any time an authoritative decision is communicated about which tablet should be the primary, such as via Vitess replication-management commands like PlannedReparentShard, EmergencyReparentShard, and TabletExternallyReparented.

• uint32 default_conn_collation = 16

  default_conn_collation is the default connection collation used by this tablet.

TabletAlias is a globally unique tablet identifier.

Used in: mysqlctl.BackupInfo, query.BeginExecuteResponse, query.BeginResponse, query.BeginStreamExecuteResponse, query.ReserveBeginExecuteResponse, query.ReserveBeginStreamExecuteResponse, query.ReserveExecuteResponse, query.ReserveStreamExecuteResponse, query.StreamHealthResponse, tabletmanagerdata.InitReplicaRequest, tabletmanagerdata.PopulateReparentJournalRequest, tabletmanagerdata.ReplicaWasRestartedRequest, tabletmanagerdata.SetReplicationSourceRequest, Shard, ShardReplication.Node, ShardReplicationError, Tablet, vtadmin.DeleteTabletRequest, vtadmin.EmergencyFailoverShardResponse, vtadmin.GetFullStatusRequest, vtadmin.GetTabletRequest, vtadmin.PingTabletRequest, vtadmin.PlannedFailoverShardResponse, vtadmin.RefreshStateRequest, vtadmin.RefreshTabletReplicationSourceRequest, vtadmin.RefreshTabletReplicationSourceResponse, vtadmin.ReloadSchemasRequest, vtadmin.RunHealthCheckRequest, vtadmin.SetReadOnlyRequest, vtadmin.SetReadWriteRequest, vtadmin.StartReplicationRequest, vtadmin.StopReplicationRequest, vtadmin.TabletExternallyPromotedRequest, vtadmin.TabletExternallyPromotedResponse, vtadmin.TabletExternallyReparentedRequest, vtctldata.BackupRequest, vtctldata.BackupResponse, vtctldata.ChangeTabletTagsRequest, vtctldata.ChangeTabletTypeRequest, vtctldata.CheckThrottlerRequest, vtctldata.CheckThrottlerResponse, vtctldata.CopySchemaShardRequest, vtctldata.DeleteTabletsRequest, vtctldata.EmergencyReparentShardRequest, vtctldata.EmergencyReparentShardResponse, vtctldata.ExecuteFetchAsAppRequest, vtctldata.ExecuteFetchAsDBARequest, vtctldata.ExecuteHookRequest, vtctldata.ExecuteMultiFetchAsDBARequest, vtctldata.GetFullStatusRequest, vtctldata.GetPermissionsRequest, vtctldata.GetSchemaRequest, vtctldata.GetTabletRequest, vtctldata.GetTabletsRequest, vtctldata.GetThrottlerStatusRequest, vtctldata.GetVersionRequest, vtctldata.InitShardPrimaryRequest, vtctldata.MoveTablesCreateResponse.TabletInfo, vtctldata.PingTabletRequest, vtctldata.PlannedReparentShardRequest, vtctldata.PlannedReparentShardResponse, vtctldata.RefreshStateRequest, vtctldata.ReloadSchemaRequest, vtctldata.ReparentTabletRequest, vtctldata.ReparentTabletResponse, vtctldata.RestoreFromBackupRequest, vtctldata.RestoreFromBackupResponse, vtctldata.RunHealthCheckRequest, vtctldata.SchemaMigration, vtctldata.SetWritableRequest, vtctldata.ShardReplicationAddRequest, vtctldata.ShardReplicationRemoveRequest, vtctldata.SleepTabletRequest, vtctldata.StartReplicationRequest, vtctldata.StopReplicationRequest, vtctldata.TabletExternallyReparentedRequest, vtctldata.TabletExternallyReparentedResponse, vtctldata.Workflow.Stream, vtctldata.WorkflowDeleteResponse.TabletInfo, vtctldata.WorkflowStatusResponse.ShardStreamState, vtctldata.WorkflowUpdateResponse.TabletInfo, vtgate.Session.ShardSession

• string cell = 1

  cell is the cell (or datacenter) the tablet is in

• uint32 uid = 2

  uid is a unique id for this tablet within the shard (this is the MySQL server id as well).

TabletType represents the type of a given tablet.

Used in: binlogdata.BinlogSource, query.Target, replicationdata.FullStatus, tabletmanagerdata.ChangeTypeRequest, tabletmanagerdata.CreateVReplicationWorkflowRequest, tabletmanagerdata.ReadVReplicationWorkflowResponse, tabletmanagerdata.UpdateVReplicationWorkflowRequest, Shard.TabletControl, SrvKeyspace.KeyspacePartition, Tablet, vtctldata.ChangeTabletTypeRequest, vtctldata.GetTabletsRequest, vtctldata.LookupVindexCreateRequest, vtctldata.MigrateCreateRequest, vtctldata.MoveTablesCreateRequest, vtctldata.ReshardCreateRequest, vtctldata.SetShardTabletControlRequest, vtctldata.VDiffCreateRequest, vtctldata.Workflow.Stream, vtctldata.WorkflowMirrorTrafficRequest, vtctldata.WorkflowSwitchTrafficRequest, vtgate.VStreamRequest

• UNKNOWN = 0

  UNKNOWN is not a valid value.

• PRIMARY = 1

  PRIMARY is the primary server for the shard. Only PRIMARY allows DMLs.

• MASTER = 1

  DEPRECATED

• REPLICA = 2

  REPLICA replicates from primary. It is used to serve live traffic. A REPLICA can be promoted to PRIMARY. A demoted PRIMARY will go to REPLICA.

• RDONLY = 3

  RDONLY (old name) / BATCH (new name) is used to serve traffic for long-running jobs. It is a separate type from REPLICA so long-running queries don't affect web-like traffic.

• BATCH = 3

• SPARE = 4

  SPARE is a type of servers that cannot serve queries, but is available in case an extra server is needed.

• EXPERIMENTAL = 5

  EXPERIMENTAL is like SPARE, except it can serve queries. This type can be used for usages not planned by Vitess, like online export to another storage engine.

• BACKUP = 6

  BACKUP is the type a server goes to when taking a backup. No queries can be served in BACKUP mode.

• RESTORE = 7

  RESTORE is the type a server uses when restoring a backup, at startup time. No queries can be served in RESTORE mode.

• DRAINED = 8

  DRAINED is the type a server goes into when used by Vitess tools to perform an offline action. It is a serving type (as the tools processes may need to run queries), but it's not used to route queries from Vitess users. In this state, this tablet is dedicated to the process that uses it.

ThrottledAppRule defines an app-specific throttling rule, with expiration.

Used in: tabletmanagerdata.GetThrottlerStatusResponse, ThrottlerConfig, vtctldata.UpdateThrottlerConfigRequest

• string name = 1

  Name of the app to be throttled, e.g. "vreplication" or "online-ddl"

• double ratio = 2

  Ratio defines how much the app should be throttled, range [0.0...1.0]. 1.0 means fully throttled. 0.0 means not throttled at all. Negative values are reserved for a future implementation.

• optional vttime.Time expires_at = 3

  ExpiresAt is the time at which the rule expires.

• bool exempt = 4

  Exempt indicates the app should never be throttled, even if the throttler is, in general, throttling other apps.

Used in: Keyspace, SrvKeyspace

• bool enabled = 1

  Enabled indicates that the throttler is actually checking state for requests. When disabled, it automatically returns 200 OK for all checks.

• double threshold = 2

  Threshold is the threshold for either the default check (heartbeat lag) or custom check.

• string custom_query = 3

  CustomQuery is an optional query that overrides the default check query.

• bool check_as_check_self = 4

  CheckAsCheckSelf indicates whether a throttler /check request should behave like a /check-self.

• map<string, ThrottledAppRule> throttled_apps = 5

  ThrottledApps is a map of rules for app-specific throttling

• map<string, ThrottlerConfig.MetricNames> app_checked_metrics = 6

  AppCheckedMetrics maps app names to the list of metrics that should be checked for that app

• map<string, double> metric_thresholds = 7

  MetricThresholds maps metric names to the threshold values that should be used for that metric

Used in: ThrottlerConfig

• repeated string names = 1

Used in: ExternalVitessCluster

• string topo_type = 1

• string server = 2

• string root = 3