topodata

Type Members

1. final case class CellInfo(serverAddress: String = "", root: String = "") extends GeneratedMessage with Message[CellInfo] with Updatable[CellInfo] with Product with Serializable

   

   CellInfo contains information about a cell.

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

   serverAddress

   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.

   root

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

   Annotations

   @SerialVersionUID()

2. final case class KeyRange(start: ByteString = ..., end: ByteString = ...) extends GeneratedMessage with Message[KeyRange] with Updatable[KeyRange] with Product with Serializable

   

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

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

   Annotations

   @SerialVersionUID()

3. final case class Keyspace(shardingColumnName: String = "", shardingColumnType: KeyspaceIdType = ..., servedFroms: Seq[ServedFrom] = _root_.scala.collection.Seq.empty) extends GeneratedMessage with Message[Keyspace] with Updatable[Keyspace] with Product with Serializable

   

   A Keyspace contains data about a keyspace.

   A Keyspace contains data about a keyspace.

   shardingColumnName

   name of the column used for sharding empty if the keyspace is not sharded

   shardingColumnType

   type of the column used for sharding UNSET if the keyspace is not sharded

   servedFroms

   ServedFrom will redirect the appropriate traffic to another keyspace.

   Annotations

   @SerialVersionUID()

4. sealed trait KeyspaceIdType extends GeneratedEnum

   

5. final case class Shard(masterAlias: Option[TabletAlias] = None, keyRange: Option[KeyRange] = None, servedTypes: Seq[ServedType] = _root_.scala.collection.Seq.empty, sourceShards: Seq[SourceShard] = _root_.scala.collection.Seq.empty, cells: Seq[String] = _root_.scala.collection.Seq.empty, tabletControls: Seq[TabletControl] = _root_.scala.collection.Seq.empty) extends GeneratedMessage with Message[Shard] with Updatable[Shard] with Product with Serializable

   

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

   A Shard contains data about a subset of the data whithin a keyspace. master_alias is the tablet alias of the master for the shard. If it is unset, then there is no master in this shard yet.

   masterAlias

   No lock is necessary to update this field, when for instance TabletExternallyReparented updates this. However, we lock the shard for reparenting operations (InitShardMaster, PlannedReparentShard,EmergencyReparentShard), to guarantee exclusive operation.

   keyRange

   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.

   servedTypes

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

   sourceShards

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

   cells

   Cells is the list of cells that contain tablets for this shard. No lock is necessary to update this field.

   tabletControls

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

   Annotations

   @SerialVersionUID()

6. final case class ShardReference(name: String = "", keyRange: Option[KeyRange] = None) extends GeneratedMessage with Message[ShardReference] with Updatable[ShardReference] with Product with Serializable

   

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

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

   name

   Copied from Shard.

   Annotations

   @SerialVersionUID()

7. final case class ShardReplication(nodes: Seq[Node] = _root_.scala.collection.Seq.empty) extends GeneratedMessage with Message[ShardReplication] with Updatable[ShardReplication] with Product with Serializable

   

   ShardReplication describes the MySQL replication relationships whithin a cell.

   ShardReplication describes the MySQL replication relationships whithin a cell.

   nodes

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

   Annotations

   @SerialVersionUID()

8. final case class SrvKeyspace(partitions: Seq[KeyspacePartition] = _root_.scala.collection.Seq.empty, shardingColumnName: String = "", shardingColumnType: KeyspaceIdType = ..., servedFrom: Seq[ServedFrom] = _root_.scala.collection.Seq.empty) extends GeneratedMessage with Message[SrvKeyspace] with Updatable[SrvKeyspace] with Product with Serializable

   

   SrvKeyspace is a rollup node for the keyspace itself.

   SrvKeyspace is a rollup node for the keyspace itself.

   partitions

   The partitions this keyspace is serving, per tablet type.

   shardingColumnName

   copied from Keyspace

   Annotations

   @SerialVersionUID()

9. final case class Tablet(alias: Option[TabletAlias] = None, hostname: String = "", ip: String = "", portMap: Map[String, Int] = ..., keyspace: String = "", shard: String = "", keyRange: Option[KeyRange] = None, type: TabletType = ..., dbNameOverride: String = "", tags: Map[String, String] = ...) extends GeneratedMessage with Message[Tablet] with Updatable[Tablet] with Product with Serializable

   

   Tablet represents information about a running instance of vttablet.

   Tablet represents information about a running instance of vttablet.

   alias

   alias is the unique name of the tablet.

   hostname

   Fully qualified domain name of the host.

   ip

   IP address, stored as a string.

   portMap

   Map of named ports. Normally this should include vt, grpc, and mysql.

   keyspace

   Keyspace name.

   shard

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

   keyRange

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

   type

   type is the current type of the tablet.

   dbNameOverride

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

   tags

   tablet tags

   Annotations

   @SerialVersionUID()

10. final case class TabletAlias(cell: String = "", uid: Int = 0) extends GeneratedMessage with Message[TabletAlias] with Updatable[TabletAlias] with Product with Serializable

    

    TabletAlias is a globally unique tablet identifier.

    TabletAlias is a globally unique tablet identifier.

    cell

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

    uid

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

    Annotations

    @SerialVersionUID()

11. sealed trait TabletType extends GeneratedEnum