package vschema

Get desktop application:
View/edit binary Protocol Buffers messages

Autoincrement is used to designate a column as auto-inc.

Used in: Table

• string column = 1

• string sequence = 2

  The sequence must match a table of type SEQUENCE.

Column describes a column.

Used in: Table

• string name = 1

• query.Type type = 2

• bool invisible = 3

• string default = 4

• string collation_name = 5

• int32 size = 6

• int32 scale = 7

• optional bool nullable = 8

• repeated string values = 9

  values contains the list of values for an enum or set column.

ColumnVindex is used to associate a column to a vindex.

Used in: Table

• string column = 1

  Legacy implementation, moving forward all vindexes should define a list of columns.

• string name = 2

  The name must match a vindex defined in Keyspace.

• repeated string columns = 3

  List of columns that define this Vindex

Keyspace is the vschema for a keyspace.

Used in: SrvVSchema, vtadmin.VSchema, vtctldata.ApplyVSchemaRequest, vtctldata.ApplyVSchemaResponse, vtctldata.GetVSchemaResponse, vtctldata.LookupVindexCreateRequest

• bool sharded = 1

  If sharded is false, vindexes and tables are ignored.

• map<string, Vindex> vindexes = 2

• map<string, Table> tables = 3

• bool require_explicit_routing = 4

  If require_explicit_routing is true, vindexes and tables are not added to global routing

• Keyspace.ForeignKeyMode foreign_key_mode = 5

  foreign_key_mode dictates how Vitess should handle foreign keys for this keyspace.

• optional MultiTenantSpec multi_tenant_spec = 6

  multi_tenant_mode specifies that the keyspace is multi-tenant. Currently used during migrations with MoveTables.

Used in: Keyspace

• unspecified = 0

• disallow = 1

• unmanaged = 2

• managed = 3

Used in: KeyspaceRoutingRules

• string from_keyspace = 1

• string to_keyspace = 2

Used in: SrvVSchema, vtctldata.ApplyKeyspaceRoutingRulesRequest, vtctldata.ApplyKeyspaceRoutingRulesResponse, vtctldata.GetKeyspaceRoutingRulesResponse

• repeated KeyspaceRoutingRule rules = 1

MirrorRule specifies a mirror rule.

Used in: MirrorRules

• string from_table = 1

• string to_table = 2

• float percent = 3

MirrorRules specify the high level mirror rules for the VSchema.

Used in: SrvVSchema, vtctldata.GetMirrorRulesResponse, vttest.VTTestTopology

• repeated MirrorRule rules = 1

  rules should ideally be a map. However protos dont't allow repeated fields as elements of a map. So, we use a list instead.

Used in: Keyspace

• string tenant_id_column_name = 1

  tenant_column is the name of the column that specifies the tenant id.

• query.Type tenant_id_column_type = 2

  tenant_column_type is the type of the column that specifies the tenant id.

RoutingRule specifies a routing rule.

Used in: RoutingRules

• string from_table = 1

• repeated string to_tables = 2

RoutingRules specify the high level routing rules for the VSchema.

Used in: SrvVSchema, vtctldata.ApplyRoutingRulesRequest, vtctldata.GetRoutingRulesResponse, vttest.VTTestTopology

• repeated RoutingRule rules = 1

  rules should ideally be a map. However protos dont't allow repeated fields as elements of a map. So, we use a list instead.

ShardRoutingRule specifies a routing rule.

Used in: ShardRoutingRules

• string from_keyspace = 1

• string to_keyspace = 2

• string shard = 3

ShardRoutingRules specify the shard routing rules for the VSchema.

Used in: SrvVSchema, vtctldata.ApplyShardRoutingRulesRequest, vtctldata.GetShardRoutingRulesResponse

• repeated ShardRoutingRule rules = 1

SrvVSchema is the roll-up of all the Keyspace schema for a cell.

Used in: vtadmin.SrvVSchema, vtctldata.GetSrvVSchemaResponse, vtctldata.GetSrvVSchemasResponse

• map<string, Keyspace> keyspaces = 1

  keyspaces is a map of keyspace name -> Keyspace object.

• optional RoutingRules routing_rules = 2

  table routing rules

• optional ShardRoutingRules shard_routing_rules = 3

• optional KeyspaceRoutingRules keyspace_routing_rules = 4

• optional MirrorRules mirror_rules = 5

  mirror rules

Table is the table info for a Keyspace.

Used in: Keyspace

• string type = 1

  If the table is a sequence, type must be "sequence". If the table is a reference, type must be "reference". See https://vitess.io/docs/reference/features/vschema/#reference-tables. Otherwise, it should be empty.

• repeated ColumnVindex column_vindexes = 2

  column_vindexes associates columns to vindexes.

• optional AutoIncrement auto_increment = 3

  auto_increment is specified if a column needs to be associated with a sequence.

• repeated Column columns = 4

  columns lists the columns for the table.

• string pinned = 5

  pinned pins an unsharded table to a specific shard, as dictated by the keyspace id. The keyspace id is represented in hex form like in keyranges.

• bool column_list_authoritative = 6

  column_list_authoritative is set to true if columns is an authoritative list for the table. This allows us to expand 'select *' expressions.

• string source = 7

  reference tables may optionally indicate their source table.

Vindex is the vindex info for a Keyspace.

Used in: Keyspace

• string type = 1

  The type must match one of the predefined (or plugged in) vindex names.

• map<string, string> params = 2

  params is a map of attribute value pairs that must be defined as required by the vindex constructors. The values can only be strings.

• string owner = 3

  A lookup vindex can have an owner table defined. If so, rows in the lookup table are created or deleted in sync with corresponding rows in the owner table.