package query

Get desktop application:
View/edit binary Protocol Buffers messages

AggregateStats contains information about the health of a group of tablets for a Target. It is used to propagate stats from a vtgate to another, or from the Gateway layer of a vtgate to the routing layer.

• int32 healthy_tablet_count = 1

  healthy_tablet_count is the number of healthy tablets in the group.

• int32 unhealthy_tablet_count = 2

  unhealthy_tablet_count is the number of unhealthy tablets in the group.

• uint32 replication_lag_seconds_min = 3

  replication_lag_seconds_min is the minimum of the replication_lag_seconds values of the healthy tablets. It is unset if the tablet type is primary.

• uint32 replication_lag_seconds_max = 4

  replication_lag_seconds_max is the maximum of the replication_lag_seconds values of the healthy tablets. It is unset if the tablet type is primary.

BeginExecuteRequest is the payload to BeginExecute

Used as request type in: queryservice.Query.BeginExecute

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• optional BoundQuery query = 4

• optional ExecuteOptions options = 5

• int64 reserved_id = 6

• repeated string pre_queries = 7

BeginExecuteResponse is the returned value from BeginExecute

Used as response type in: queryservice.Query.BeginExecute

• optional vtrpc.RPCError error = 1

  error contains an application level error if necessary. Note the transaction_id may be set, even when an error is returned, if the begin worked but the execute failed.

• optional QueryResult result = 2

• int64 transaction_id = 3

  transaction_id might be non-zero even if an error is present.

• optional topodata.TabletAlias tablet_alias = 4

• string session_state_changes = 5

  The session_state_changes might be set if the transaction is a snapshot transaction and the MySQL implementation supports getting a start gtid on snapshot

BeginRequest is the payload to Begin

Used as request type in: queryservice.Query.Begin

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• optional ExecuteOptions options = 4

BeginResponse is the returned value from Begin

Used as response type in: queryservice.Query.Begin

• int64 transaction_id = 1

• optional topodata.TabletAlias tablet_alias = 2

• string session_state_changes = 3

  The session_state_changes might be set if the transaction is a snapshot transaction and the MySQL implementation supports getting a start gtid on snapshot

BeginStreamExecuteRequest is the payload to BeginStreamExecute

Used as request type in: queryservice.Query.BeginStreamExecute

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• optional BoundQuery query = 4

• optional ExecuteOptions options = 5

• repeated string pre_queries = 6

• int64 reserved_id = 7

BeginStreamExecuteResponse is the returned value from BeginStreamExecute

Used as response type in: queryservice.Query.BeginStreamExecute

• optional vtrpc.RPCError error = 1

  error contains an application level error if necessary. Note the transaction_id may be set, even when an error is returned, if the begin worked but the stream execute failed.

• optional QueryResult result = 2

• int64 transaction_id = 3

  transaction_id might be non-zero even if an error is present.

• optional topodata.TabletAlias tablet_alias = 4

• string session_state_changes = 5

  The session_state_changes might be set if the transaction is a snapshot transaction and the MySQL implementation supports getting a start gtid on snapshot

BindVariable represents a single bind variable in a Query.

Used in: BoundQuery, vtgate.Session

• Type type = 1

• bytes value = 2

• repeated Value values = 3

  values are set if type is TUPLE.

BoundQuery is a query with its bind variables

Used in: BeginExecuteRequest, BeginStreamExecuteRequest, ExecuteRequest, ReserveBeginExecuteRequest, ReserveBeginStreamExecuteRequest, ReserveExecuteRequest, ReserveStreamExecuteRequest, StreamExecuteRequest, vtgate.ExecuteBatchRequest, vtgate.ExecuteRequest, vtgate.PrepareRequest, vtgate.StreamExecuteRequest

• string sql = 1

  sql is the SQL query to execute

• map<string, BindVariable> bind_variables = 2

  bind_variables is a map of all bind variables to expand in the query. nil values are not allowed. Use NULL_TYPE to express a NULL value.

CommitPreparedRequest is the payload to CommitPrepared

Used as request type in: queryservice.Query.CommitPrepared

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• string dtid = 4

CommitPreparedResponse is the returned value from CommitPrepared

Used as response type in: queryservice.Query.CommitPrepared

(message has no fields)

CommitRequest is the payload to Commit

Used as request type in: queryservice.Query.Commit

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• int64 transaction_id = 4

CommitResponse is the returned value from Commit

Used as response type in: queryservice.Query.Commit

• int64 reserved_id = 1

ConcludeTransactionRequest is the payload to ConcludeTransaction

Used as request type in: queryservice.Query.ConcludeTransaction

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• string dtid = 4

ConcludeTransactionResponse is the returned value from ConcludeTransaction

Used as response type in: queryservice.Query.ConcludeTransaction

(message has no fields)

CreateTransactionRequest is the payload to CreateTransaction

Used as request type in: queryservice.Query.CreateTransaction

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• string dtid = 4

• repeated Target participants = 5

CreateTransactionResponse is the returned value from CreateTransaction

Used as response type in: queryservice.Query.CreateTransaction

(message has no fields)

EventToken is a structure that describes a point in time in a replication stream on one shard. The most recent known replication position can be retrieved from vttablet when executing a query. It is also sent with the replication streams from the binlog service.

Used in: binlogdata.BinlogTransaction, StreamEvent

• int64 timestamp = 1

  timestamp is the MySQL timestamp of the statements. Seconds since Epoch.

• string shard = 2

  The shard name that applied the statements. Note this is not set when streaming from a vttablet. It is only used on the client -> vtgate link.

• string position = 3

  The position on the replication stream after this statement was applied. It is not the transaction ID / GTID, but the position / GTIDSet.

ExecuteOptions is passed around for all Execute calls.

Used in: BeginExecuteRequest, BeginRequest, BeginStreamExecuteRequest, ExecuteRequest, ReserveBeginExecuteRequest, ReserveBeginStreamExecuteRequest, ReserveExecuteRequest, ReserveStreamExecuteRequest, StreamExecuteRequest, vtgate.Session

• ExecuteOptions.IncludedFields included_fields = 4

  Controls what fields are returned in Field message responses from mysql, i.e. field name, table name, etc. This is an optimization for high-QPS queries where the client knows what it's getting

• bool client_found_rows = 5

  client_rows_found specifies if rows_affected should return rows found instead of rows affected. Behavior is defined by MySQL's CLIENT_FOUND_ROWS flag.

• ExecuteOptions.Workload workload = 6

  workload specifies the type of workload: OLTP: DMLs allowed, results have row count limit, and query timeouts are shorter. OLAP: DMLS not allowed, no limit on row count, timeouts can be as high as desired. DBA: no limit on rowcount or timeout, all queries allowed but intended for long DMLs and DDLs.

• int64 sql_select_limit = 8

  sql_select_limit sets an implicit limit on all select statements. Since vitess also sets a rowcount limit on queries, the smallest value wins.

• ExecuteOptions.TransactionIsolation transaction_isolation = 9

• bool skip_query_plan_cache = 10

  skip_query_plan_cache specifies if the query plan should be cached by vitess. By default all query plans are cached.

• ExecuteOptions.PlannerVersion planner_version = 11

  PlannerVersion specifies which planner to use. If DEFAULT is chosen, whatever vtgate was started with will be used

• bool has_created_temp_tables = 12

  has_created_temp_tables signals whether plans created in this session should be cached or not if the user has created temp tables, Vitess will not reuse plans created for this session in other sessions. The current session can still use other sessions cached plans.

• ExecuteOptions.Consolidator consolidator = 13

• repeated ExecuteOptions.TransactionAccessMode transaction_access_mode = 14

  TransactionAccessMode specifies the access modes to be used while starting the transaction i.e. READ WRITE/READ ONLY/WITH CONSISTENT SNAPSHOT If not specified, the transaction will be started with the default access mode on the connection.

• string WorkloadName = 15

  WorkloadName specifies the name of the workload as indicated in query directives. This is used for instrumentation in metrics and tracing spans.

• string priority = 16

  priority specifies the priority of the query, between 0 and 100. This is leveraged by the transaction throttler to determine whether, under resource contention, a query should or should not be throttled.

• oneof timeout

  timeout specifies the query timeout in milliseconds. If not set, the default timeout is used.

  • int64 authoritative_timeout = 17

• bool fetch_last_insert_id = 18

  fetch_last_insert_id indicates that after executing a DML involving last_insert_id(x), a subsequent "SELECT last_insert_id()" should be performed to retrieve the updated value. This is to circumvent a bug where setting last_insert_id(x) to zero is not signaled by mysql https://bugs.mysql.com/bug.php?id=116939

• bool in_dml_execution = 19

  in_dml_execution indicates that the query is being executed as part of a DML execution.

• optional int64 transaction_timeout = 20

  transaction_timeout specifies the transaction timeout in milliseconds. If not set, the default timeout is used.

• bool no_result = 21

  no_result specifies that the caller does not need the query result rows. When set, the server will still execute the query via the Execute RPC but will not return rows or fields in the response. This flag is not currently honored by StreamExecute. This is useful for warming reads where the goal is to warm the buffer pool, not to retrieve data.

Used in: ExecuteOptions

• CONSOLIDATOR_UNSPECIFIED = 0

• CONSOLIDATOR_DISABLED = 1

• CONSOLIDATOR_ENABLED = 2

• CONSOLIDATOR_ENABLED_REPLICAS = 3

Used in: ExecuteOptions

• TYPE_AND_NAME = 0

• TYPE_ONLY = 1

• ALL = 2

Used in: ExecuteOptions

• DEFAULT_PLANNER = 0

• V3 = 1

• Gen4 = 2

• Gen4Greedy = 3

• Gen4Left2Right = 4

• Gen4WithFallback = 5

• Gen4CompareV3 = 6

• V3Insert = 7

Used in: ExecuteOptions

• CONSISTENT_SNAPSHOT = 0

• READ_WRITE = 1

• READ_ONLY = 2

Used in: ExecuteOptions

• DEFAULT = 0

• REPEATABLE_READ = 1

• READ_COMMITTED = 2

• READ_UNCOMMITTED = 3

• SERIALIZABLE = 4

• CONSISTENT_SNAPSHOT_READ_ONLY = 5

  This is not an "official" transaction level but it will do a START TRANSACTION WITH CONSISTENT SNAPSHOT, READ ONLY

• AUTOCOMMIT = 6

  This not an "official" transaction level, it will send queries to mysql without wrapping them in a transaction

Used in: ExecuteOptions

• UNSPECIFIED = 0

• OLTP = 1

• OLAP = 2

• DBA = 3

ExecuteRequest is the payload to Execute

Used as request type in: queryservice.Query.Execute

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• optional BoundQuery query = 4

• int64 transaction_id = 5

• optional ExecuteOptions options = 6

• int64 reserved_id = 7

• bool reserved_conn_keep_alive = 8

  reserved_conn_keep_alive turns the Execute into a keepalive touch for the reserved connections listed in reserved_conn_keep_alive_ids: the tablet refreshes their idle timers without executing the query or sending anything to MySQL, so mysqld's wait_timeout keeps counting only real user traffic. A connection that is busy executing counts as alive. Callers leave reserved_id zero and pass the ids in reserved_conn_keep_alive_ids, so that a tablet predating this field runs the query on a throwaway pooled connection rather than a reserved one and can never kill a reserved connection. This deliberately lives on the request, not in ExecuteOptions: options round-trip through client sessions, and a vtgate predating the feature would relay client-injected option fields to the tablet, while request fields are only ever populated by vtgate itself.

• repeated int64 reserved_conn_keep_alive_ids = 9

  reserved_conn_keep_alive_ids lists the reserved connection ids to refresh in a single keepalive touch, so a client can keep alive all of a tablet's reserved connections with one RPC. Ignored unless reserved_conn_keep_alive is set. The touch reports back which of the ids no longer exist (as result rows) so the caller can stop refreshing them. A tablet that predates this field ignores it and runs the query; it keeps no reserved connection alive until it is upgraded.

• bool reserved_conn_activity_refresh = 10

  reserved_conn_activity_refresh marks this Execute as a background activity refresh of an idle temp-table reserved connection: vtgate fans real session activity out to reserved connections the session's queries did not reach. The query executes normally on the reserved connection (resetting mysqld's wait_timeout clock, unlike a keepalive touch), but the tablet locks the connection under a purpose that a concurrent client command briefly waits out instead of failing with an in-use error. Like reserved_conn_keep_alive, this is a request-level field populated only by vtgate itself, never relayed from client sessions. A tablet that predates this field runs the query without the special lock purpose, restoring the (benign) pre-field race.

ExecuteResponse is the returned value from Execute

Used as response type in: queryservice.Query.Execute

• optional QueryResult result = 1

Field describes a single column returned by a query

Used in: binlogdata.FieldEvent, binlogdata.MinimalTable, binlogdata.VStreamResultsResponse, binlogdata.VStreamRowsResponse, binlogdata.VStreamTablesResponse, QueryResult, StreamEvent.Statement, tabletmanagerdata.TableDefinition, vtgate.PrepareResponse

• string name = 1

  name of the field as returned by mysql C API

• Type type = 2

  vitess-defined type. Conversion function is in sqltypes package.

• string table = 3

  Remaining fields from mysql C API. These fields are only populated when ExecuteOptions.included_fields is set to IncludedFields.ALL.

• string org_table = 4

• string database = 5

• string org_name = 6

• uint32 column_length = 7

  column_length is really a uint32. All 32 bits can be used.

• uint32 charset = 8

  charset is actually a uint16. Only the lower 16 bits are used.

• uint32 decimals = 9

  decimals is actually a uint8. Only the lower 8 bits are used.

• uint32 flags = 10

  flags is actually a uint16. Only the lower 16 bits are used.

• string column_type = 11

  column_type is optionally populated from information_schema.columns

Flag allows us to qualify types by their common properties.

• NONE = 0

• ISINTEGRAL = 256

• ISUNSIGNED = 512

• ISFLOAT = 1024

• ISQUOTED = 2048

• ISTEXT = 4096

• ISBINARY = 8192

GetSchemaRequest is the payload to GetSchema

Used as request type in: queryservice.Query.GetSchema

• optional Target target = 1

• SchemaTableType table_type = 2

• repeated string table_names = 3

GetSchemaResponse is the returned value from GetSchema

Used as response type in: queryservice.Query.GetSchema

• repeated UDFInfo udfs = 1

• map<string, string> table_definition = 2

  this is for the schema definition for the requested tables and views.

MessageAckRequest is the request payload for MessageAck.

Used as request type in: queryservice.Query.MessageAck

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• string name = 4

  name is the message table name.

• repeated Value ids = 5

MessageAckResponse is the response for MessageAck.

Used as response type in: queryservice.Query.MessageAck

• optional QueryResult result = 1

  result contains the result of the ack operation. Since this acts like a DML, only RowsAffected is returned in the result.

MessageStreamRequest is the request payload for MessageStream.

Used as request type in: queryservice.Query.MessageStream

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• string name = 4

  name is the message table name.

MessageStreamResponse is a response for MessageStream.

Used as response type in: queryservice.Query.MessageStream

• optional QueryResult result = 1

Flags sent from the MySQL C API

• EMPTY = 0

• NOT_NULL_FLAG = 1

• PRI_KEY_FLAG = 2

• UNIQUE_KEY_FLAG = 4

• MULTIPLE_KEY_FLAG = 8

• BLOB_FLAG = 16

• UNSIGNED_FLAG = 32

• ZEROFILL_FLAG = 64

• BINARY_FLAG = 128

• ENUM_FLAG = 256

• AUTO_INCREMENT_FLAG = 512

• TIMESTAMP_FLAG = 1024

• SET_FLAG = 2048

• NO_DEFAULT_VALUE_FLAG = 4096

• ON_UPDATE_NOW_FLAG = 8192

• NUM_FLAG = 32768

• PART_KEY_FLAG = 16384

• GROUP_FLAG = 32768

• UNIQUE_FLAG = 65536

• BINCMP_FLAG = 131072

PrepareRequest is the payload to Prepare

Used as request type in: queryservice.Query.Prepare

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• int64 transaction_id = 4

• string dtid = 5

PrepareResponse is the returned value from Prepare

Used as response type in: queryservice.Query.Prepare

(message has no fields)

QueryResult is returned by Execute and ExecuteStream. As returned by Execute, len(fields) is always equal to len(row) (for each row in rows). As returned by StreamExecute, the first QueryResult has the fields set, and subsequent QueryResult have rows set. And as Execute, len(QueryResult[0].fields) is always equal to len(row) (for each row in rows for each QueryResult in QueryResult[1:]).

Used in: binlogdata.TableLastPK, binlogdata.VStreamRowsRequest, BeginExecuteResponse, BeginStreamExecuteResponse, ExecuteResponse, MessageAckResponse, MessageStreamResponse, ReserveBeginExecuteResponse, ReserveBeginStreamExecuteResponse, ReserveExecuteResponse, ReserveStreamExecuteResponse, ResultWithError, StreamExecuteResponse, tabletmanagerdata.CreateVReplicationWorkflowResponse, tabletmanagerdata.DeleteVReplicationWorkflowResponse, tabletmanagerdata.ExecuteFetchAsAllPrivsResponse, tabletmanagerdata.ExecuteFetchAsAppResponse, tabletmanagerdata.ExecuteFetchAsDbaResponse, tabletmanagerdata.ExecuteMultiFetchAsDbaResponse, tabletmanagerdata.ExecuteQueryResponse, tabletmanagerdata.UpdateVReplicationWorkflowResponse, tabletmanagerdata.UpdateVReplicationWorkflowsResponse, tabletmanagerdata.VDiffResponse, tabletmanagerdata.VDiffTableLastPK, tabletmanagerdata.VReplicationExecResponse, vtctldata.ExecuteFetchAsAppResponse, vtctldata.ExecuteFetchAsDBAResponse, vtctldata.ExecuteMultiFetchAsDBAResponse, vtgate.ExecuteMultiResponse, vtgate.ExecuteResponse, vtgate.StreamExecuteResponse

• repeated Field fields = 1

• uint64 rows_affected = 2

• uint64 insert_id = 3

• repeated Row rows = 4

• string info = 6

• string session_state_changes = 7

• bool insert_id_changed = 8

QueryWarning is used to convey out of band query execution warnings by storing in the vtgate.Session

Used in: vtgate.Session

• uint32 code = 1

• string message = 2

ReadTransactionRequest is the payload to ReadTransaction

Used as request type in: queryservice.Query.ReadTransaction

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• string dtid = 4

ReadTransactionResponse is the returned value from ReadTransaction

Used as response type in: queryservice.Query.ReadTransaction

• optional TransactionMetadata metadata = 1

RealtimeStats contains information about the tablet status. It is only valid for a single tablet.

Used in: StreamHealthResponse

• string health_error = 1

  health_error is the last error we got from health check, or empty is the server is healthy. This is used for subset selection, we do not send queries to servers that are not healthy.

• uint32 replication_lag_seconds = 2

  replication_lag_seconds is populated for replicas only. It indicates how far behind on (MySQL) replication a replica currently is. It is used by clients for subset selection (so we don't try to send traffic to tablets that are too far behind). NOTE: This field must not be evaluated if "health_error" is not empty. TODO(mberlin): Let's switch it to int64 instead?

• int32 binlog_players_count = 3

  bin_log_players_count is the number of currently running binlog players. if the value is 0, it means that filtered replication is currently not running on the tablet. If >0, filtered replication is running. NOTE: This field must not be evaluated if "health_error" is not empty.

• int64 filtered_replication_lag_seconds = 4

  filtered_replication_lag_seconds is populated for the receiving primary of an ongoing filtered replication only. It specifies how far the receiving primary lags behind the sending primary. NOTE: This field must not be evaluated if "health_error" is not empty. NOTE: This field must not be evaluated if "bin_log_players_count" is 0.

• double cpu_usage = 5

  cpu_usage is used for load-based balancing

• double qps = 6

  qps is the average QPS (queries per second) rate in the last XX seconds where XX is usually 60 (See query_service_stats.go).

• repeated string table_schema_changed = 7

  table_schema_changed is to provide list of tables that have schema changes detected by the tablet.

• repeated string view_schema_changed = 8

  view_schema_changed is to provide list of views that have schema changes detected by the tablet.

• bool udfs_changed = 9

  udfs_changed is used to signal that the UDFs have changed on the tablet.

• bool tx_unresolved = 10

ReleaseRequest is the payload to Release

Used as request type in: queryservice.Query.Release

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• int64 transaction_id = 4

• int64 reserved_id = 5

ReleaseResponse is the returned value from Release

Used as response type in: queryservice.Query.Release

(message has no fields)

ReserveBeginExecuteRequest is the payload to ReserveBeginExecute

Used as request type in: queryservice.Query.ReserveBeginExecute

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• optional BoundQuery query = 4

• optional ExecuteOptions options = 5

• repeated string pre_queries = 6

• repeated string post_begin_queries = 7

ReserveBeginExecuteResponse is the returned value from ReserveBeginExecute

Used as response type in: queryservice.Query.ReserveBeginExecute

• optional vtrpc.RPCError error = 1

  error contains an application level error if necessary. Note the transaction_id may be set, even when an error is returned, if the begin worked but the execute failed.

• optional QueryResult result = 2

• int64 transaction_id = 3

  The following fields might be non-zero even if an error is present.

• int64 reserved_id = 4

• optional topodata.TabletAlias tablet_alias = 5

• string session_state_changes = 6

  The session_state_changes might be set if the transaction is a snapshot transaction and the MySQL implementation supports getting a start gtid on snapshot

ReserveBeginStreamExecuteRequest is the payload to ReserveBeginStreamExecute

Used as request type in: queryservice.Query.ReserveBeginStreamExecute

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• optional BoundQuery query = 4

• optional ExecuteOptions options = 5

• repeated string pre_queries = 6

• repeated string post_begin_queries = 7

ReserveBeginStreamExecuteResponse is the returned value from ReserveBeginStreamExecute

Used as response type in: queryservice.Query.ReserveBeginStreamExecute

• optional vtrpc.RPCError error = 1

  error contains an application level error if necessary. Note the transaction_id may be set, even when an error is returned, if the begin worked but the stream execute failed.

• optional QueryResult result = 2

• int64 transaction_id = 3

  The following fields might be non-zero even if an error is present.

• int64 reserved_id = 4

• optional topodata.TabletAlias tablet_alias = 5

• string session_state_changes = 6

  The session_state_changes might be set if the transaction is a snapshot transaction and the MySQL implementation supports getting a start gtid on snapshot

ReserveExecuteRequest is the payload to ReserveExecute

Used as request type in: queryservice.Query.ReserveExecute

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• optional BoundQuery query = 4

• int64 transaction_id = 5

• optional ExecuteOptions options = 6

• repeated string pre_queries = 7

ReserveExecuteResponse is the returned value from ReserveExecute

Used as response type in: queryservice.Query.ReserveExecute

• optional vtrpc.RPCError error = 1

• optional QueryResult result = 2

• int64 reserved_id = 3

  The following fields might be non-zero even if an error is present.

• optional topodata.TabletAlias tablet_alias = 4

ReserveStreamExecuteRequest is the payload to ReserveStreamExecute

Used as request type in: queryservice.Query.ReserveStreamExecute

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• optional BoundQuery query = 4

• optional ExecuteOptions options = 5

• int64 transaction_id = 6

• repeated string pre_queries = 7

ReserveStreamExecuteResponse is the returned value from ReserveStreamExecute

Used as response type in: queryservice.Query.ReserveStreamExecute

• optional vtrpc.RPCError error = 1

• optional QueryResult result = 2

• int64 reserved_id = 3

  The following fields might be non-zero even if an error is present.

• optional topodata.TabletAlias tablet_alias = 4

ResultWithError represents a query response in the form of result or error but not both. TODO: To be used in ExecuteBatchResponse and BeginExecuteBatchResponse.

Used in: vtgate.ExecuteBatchResponse, vtgate.StreamExecuteMultiResponse

• optional vtrpc.RPCError error = 1

  error contains an query level error, only set if result is unset.

• optional QueryResult result = 2

  result contains the query result, only set if error is unset.

RollbackPreparedRequest is the payload to RollbackPrepared

Used as request type in: queryservice.Query.RollbackPrepared

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• int64 transaction_id = 4

• string dtid = 5

RollbackPreparedResponse is the returned value from RollbackPrepared

Used as response type in: queryservice.Query.RollbackPrepared

(message has no fields)

RollbackRequest is the payload to Rollback

Used as request type in: queryservice.Query.Rollback

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• int64 transaction_id = 4

RollbackResponse is the returned value from Rollback

Used as response type in: queryservice.Query.Rollback

• int64 reserved_id = 1

Row is a database row.

Used in: binlogdata.RowChange, binlogdata.VStreamResultsResponse, binlogdata.VStreamRowsResponse, binlogdata.VStreamTablesResponse, QueryResult, StreamEvent.Statement

• repeated sint64 lengths = 1

  lengths contains the length of each value in values. A length of -1 means that the field is NULL. While reading values, you have to accummulate the length to know the offset where the next value begins in values.

• bytes values = 2

  values contains a concatenation of all values in the row.

SchemaTableType represents the type of table requested.

Used in: GetSchemaRequest

• VIEWS = 0

• TABLES = 1

• ALL = 2

• UDFS = 3

SetRollbackRequest is the payload to SetRollback

Used as request type in: queryservice.Query.SetRollback

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• int64 transaction_id = 4

• string dtid = 5

SetRollbackResponse is the returned value from SetRollback

Used as response type in: queryservice.Query.SetRollback

(message has no fields)

StartCommitRequest is the payload to StartCommit

Used as request type in: queryservice.Query.StartCommit

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• int64 transaction_id = 4

• string dtid = 5

StartCommitResponse is the returned value from StartCommit

Used as response type in: queryservice.Query.StartCommit

• StartCommitState state = 1

Used in: StartCommitResponse

• Unknown = 0

• Fail = 1

• Success = 2

StreamEvent describes a set of transformations that happened as a single transactional unit on a server. It is streamed back by the Update Stream calls.

• repeated StreamEvent.Statement statements = 1

  The statements in this transaction.

• optional EventToken event_token = 2

  The Event Token for this event.

One individual Statement in a transaction.

Used in: StreamEvent

• Statement.Category category = 1

• string table_name = 2

  table_name, primary_key_fields and primary_key_values are set for DML.

• repeated Field primary_key_fields = 3

• repeated Row primary_key_values = 4

• bytes sql = 5

  sql is set for all queries. FIXME(alainjobart) we may not need it for DMLs.

The category of one statement.

Used in: Statement

• Error = 0

• DML = 1

• DDL = 2

StreamExecuteRequest is the payload to StreamExecute

Used as request type in: queryservice.Query.StreamExecute

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• optional BoundQuery query = 4

• optional ExecuteOptions options = 5

• int64 transaction_id = 6

• int64 reserved_id = 7

StreamExecuteResponse is the returned value from StreamExecute

Used as response type in: queryservice.Query.StreamExecute

• optional QueryResult result = 1

StreamHealthRequest is the payload for StreamHealth

Used as request type in: queryservice.Query.StreamHealth

(message has no fields)

StreamHealthResponse is streamed by StreamHealth on a regular basis. It is expected to be used between a vtgate and vttablet: - target describes the tablet. - realtime_stats is set. - aggregate_stats is not set (deprecated)

Used as response type in: queryservice.Query.StreamHealth

• optional Target target = 1

  target is the current server type. Only queries with that exact Target record will be accepted (the cell may not match, however).

• bool serving = 2

  serving is true iff the tablet is serving. A tablet may not be serving if filtered replication is enabled on a primary for instance, or if a replica should not be used because the keyspace is being resharded.

• int64 primary_term_start_timestamp = 3

  primary_term_start_timestamp can be interpreted as the last time we knew that this tablet was promoted to a PRIMARY of this shard (if StreamHealthResponse describes a group of tablets, between two vtgates, only one primary will be present in the group, and this is this primary's value). It is used by vtgate when determining the current PRIMARY of a shard. If vtgate sees more than one PRIMARY tablet, this timestamp is used as tiebreaker where the PRIMARY with the highest timestamp wins. Another usage of this timestamp is in go/vt/vtgate/buffer to detect the end of a reparent (failover) and stop buffering. In practice, this field is set to: a) the last time the RPC tabletmanager.TabletExternallyReparented was called on this tablet (usually done by an external failover tool e.g. Orchestrator). The failover tool can call this as long as we are the primary i.e. even ages after the last reparent occurred. OR b) the last time an active reparent was executed through a vtctl command (InitShardPrimary, PlannedReparentShard, EmergencyReparentShard) OR c) the last time vttablet was started and it initialized its tablet type as PRIMARY because it was recorded as the shard's current primary in the topology (see go/vt/vttablet/tabletmanager/init_tablet.go) OR d) 0 if the vttablet is not a PRIMARY.

• optional RealtimeStats realtime_stats = 4

  realtime_stats contains information about the tablet status. It is only filled in if the information is about a tablet.

• optional topodata.TabletAlias tablet_alias = 5

  tablet_alias is the alias of the sending tablet. The discovery/healthcheck.go code uses it to verify that it's talking to the correct tablet and that it hasn't changed in the meantime e.g. due to tablet restarts where ports or ips have been reused but assigned differently.

Target describes what the client expects the tablet is. If the tablet does not match, an error is returned.

Used in: binlogdata.BinlogDumpGTIDRequest, binlogdata.VStreamRequest, binlogdata.VStreamResultsRequest, binlogdata.VStreamRowsRequest, binlogdata.VStreamTablesRequest, BeginExecuteRequest, BeginRequest, BeginStreamExecuteRequest, CommitPreparedRequest, CommitRequest, ConcludeTransactionRequest, CreateTransactionRequest, ExecuteRequest, GetSchemaRequest, MessageAckRequest, MessageStreamRequest, PrepareRequest, ReadTransactionRequest, ReleaseRequest, ReserveBeginExecuteRequest, ReserveBeginStreamExecuteRequest, ReserveExecuteRequest, ReserveStreamExecuteRequest, RollbackPreparedRequest, RollbackRequest, SetRollbackRequest, StartCommitRequest, StreamExecuteRequest, StreamHealthResponse, TransactionMetadata, UnresolvedTransactionsRequest, vtctldata.ConcludeTransactionRequest, vtgate.Session.ShardSession

• string keyspace = 1

• string shard = 2

• topodata.TabletType tablet_type = 3

• string cell = 4

  cell is used for routing queries between vtgate and vttablets. It is not used when Target is part of the Session sent by the client.

TransactionMetadata contains the metadata for a distributed transaction.

Used in: ReadTransactionResponse, UnresolvedTransactionsResponse, tabletmanagerdata.GetUnresolvedTransactionsResponse, tabletmanagerdata.ReadTransactionResponse, vtctldata.GetTransactionInfoResponse, vtctldata.GetUnresolvedTransactionsResponse

• string dtid = 1

• TransactionState state = 2

• int64 time_created = 3

• repeated Target participants = 4

TransactionState represents the state of a distributed transaction.

Used in: TransactionMetadata

• UNKNOWN = 0

• PREPARE = 1

• ROLLBACK = 2

• COMMIT = 3

Type defines the various supported data types in bind vars and query results.

Used in: BindVariable, Field, UDFInfo, Value, vschema.Column, vschema.MultiTenantSpec

• NULL_TYPE = 0

  NULL_TYPE specifies a NULL type.

• INT8 = 257

  INT8 specifies a TINYINT type. Properties: 1, IsNumber.

• UINT8 = 770

  UINT8 specifies a TINYINT UNSIGNED type. Properties: 2, IsNumber, IsUnsigned.

• INT16 = 259

  INT16 specifies a SMALLINT type. Properties: 3, IsNumber.

• UINT16 = 772

  UINT16 specifies a SMALLINT UNSIGNED type. Properties: 4, IsNumber, IsUnsigned.

• INT24 = 261

  INT24 specifies a MEDIUMINT type. Properties: 5, IsNumber.

• UINT24 = 774

  UINT24 specifies a MEDIUMINT UNSIGNED type. Properties: 6, IsNumber, IsUnsigned.

• INT32 = 263

  INT32 specifies a INTEGER type. Properties: 7, IsNumber.

• UINT32 = 776

  UINT32 specifies a INTEGER UNSIGNED type. Properties: 8, IsNumber, IsUnsigned.

• INT64 = 265

  INT64 specifies a BIGINT type. Properties: 9, IsNumber.

• UINT64 = 778

  UINT64 specifies a BIGINT UNSIGNED type. Properties: 10, IsNumber, IsUnsigned.

• FLOAT32 = 1035

  FLOAT32 specifies a FLOAT type. Properties: 11, IsFloat.

• FLOAT64 = 1036

  FLOAT64 specifies a DOUBLE or REAL type. Properties: 12, IsFloat.

• TIMESTAMP = 2061

  TIMESTAMP specifies a TIMESTAMP type. Properties: 13, IsQuoted.

• DATE = 2062

  DATE specifies a DATE type. Properties: 14, IsQuoted.

• TIME = 2063

  TIME specifies a TIME type. Properties: 15, IsQuoted.

• DATETIME = 2064

  DATETIME specifies a DATETIME type. Properties: 16, IsQuoted.

• YEAR = 785

  YEAR specifies a YEAR type. Properties: 17, IsNumber, IsUnsigned.

• DECIMAL = 18

  DECIMAL specifies a DECIMAL or NUMERIC type. Properties: 18, None.

• TEXT = 6163

  TEXT specifies a TEXT type. Properties: 19, IsQuoted, IsText.

• BLOB = 10260

  BLOB specifies a BLOB type. Properties: 20, IsQuoted, IsBinary.

• VARCHAR = 6165

  VARCHAR specifies a VARCHAR type. Properties: 21, IsQuoted, IsText.

• VARBINARY = 10262

  VARBINARY specifies a VARBINARY type. Properties: 22, IsQuoted, IsBinary.

• CHAR = 6167

  CHAR specifies a CHAR type. Properties: 23, IsQuoted, IsText.

• BINARY = 10264

  BINARY specifies a BINARY type. Properties: 24, IsQuoted, IsBinary.

• BIT = 2073

  BIT specifies a BIT type. Properties: 25, IsQuoted.

• ENUM = 2074

  ENUM specifies an ENUM type. Properties: 26, IsQuoted.

• SET = 2075

  SET specifies a SET type. Properties: 27, IsQuoted.

• TUPLE = 28

  TUPLE specifies a tuple. This cannot be returned in a QueryResult, but it can be sent as a bind var. Properties: 28, None.

• GEOMETRY = 2077

  GEOMETRY specifies a GEOMETRY type. Properties: 29, IsQuoted.

• JSON = 2078

  JSON specifies a JSON type. Properties: 30, IsQuoted.

• EXPRESSION = 31

  EXPRESSION specifies a SQL expression. This type is for internal use only. Properties: 31, None.

• HEXNUM = 4128

  HEXNUM specifies a HEXNUM type (unquoted varbinary). Properties: 32, IsText.

• HEXVAL = 4129

  HEXVAL specifies a HEXVAL type (unquoted varbinary). Properties: 33, IsText.

• BITNUM = 4130

  BITNUM specifies a base 2 binary type (unquoted varbinary). Properties: 34, IsText.

• VECTOR = 2083

  VECTOR specifies a VECTOR type Properties: 35, IsQuoted.

• RAW = 36

  RAW specifies a type which won't be quoted but the value used as-is while encoding. Properties: 36, None.

• ROW_TUPLE = 37

  ROW_TUPLE represents multiple rows. Properties: 37, None.

UDFInfo represents the information about a UDF.

Used in: GetSchemaResponse

• string name = 1

• bool aggregating = 2

• Type return_type = 3

UnresolvedTransactionsRequest is the payload to UnresolvedTransactions

Used as request type in: queryservice.Query.UnresolvedTransactions

• optional vtrpc.CallerID effective_caller_id = 1

• optional VTGateCallerID immediate_caller_id = 2

• optional Target target = 3

• int64 abandon_age = 4

  Unresolved Transactions older than this (in seconds).

UnresolvedTransactionsResponse is the returned value from UnresolvedTransactions

Used as response type in: queryservice.Query.UnresolvedTransactions

• repeated TransactionMetadata transactions = 1

VTGateCallerID is sent by VTGate to VTTablet to describe the caller. If possible, this information is secure. For instance, if using unique certificates that guarantee that VTGate->VTTablet traffic cannot be spoofed, then VTTablet can trust this information, and VTTablet will use it for tablet ACLs, for instance. Because of this security guarantee, this is different than the CallerID structure, which is not secure at all, because it is provided by the Vitess client.

Used in: binlogdata.BinlogDumpGTIDRequest, binlogdata.VStreamRequest, binlogdata.VStreamResultsRequest, binlogdata.VStreamRowsRequest, binlogdata.VStreamTablesRequest, BeginExecuteRequest, BeginRequest, BeginStreamExecuteRequest, CommitPreparedRequest, CommitRequest, ConcludeTransactionRequest, CreateTransactionRequest, ExecuteRequest, MessageAckRequest, MessageStreamRequest, PrepareRequest, ReadTransactionRequest, ReleaseRequest, ReserveBeginExecuteRequest, ReserveBeginStreamExecuteRequest, ReserveExecuteRequest, ReserveStreamExecuteRequest, RollbackPreparedRequest, RollbackRequest, SetRollbackRequest, StartCommitRequest, StreamExecuteRequest, UnresolvedTransactionsRequest

• string username = 1

• repeated string groups = 2

Value represents a typed value.

Used in: BindVariable, MessageAckRequest

• Type type = 1

• bytes value = 2