package vtgate

Get desktop application:
View/edit binary Protocol Buffers messages

BinlogDumpGTIDRequest is the payload for BinlogDumpGTID.

Used as request type in: vtgateservice.Vitess.BinlogDumpGTID

• optional vtrpc.CallerID caller_id = 1

  caller_id identifies the caller. This is the effective caller ID, set by the application to further identify the caller.

• string keyspace = 2

  keyspace is the keyspace to stream binlog events from.

• string shard = 3

  shard is the specific shard within the keyspace.

• topodata.TabletType tablet_type = 4

  tablet_type is the type of tablet to stream from (default: PRIMARY).

• optional topodata.TabletAlias tablet_alias = 5

  tablet_alias optionally targets a specific tablet by alias. When set, the stream is routed directly to this tablet. When unset, routing goes through health-check-based selection.

• string binlog_filename = 6

  binlog_filename is not supported through vtgate and must be empty. Binlog filenames are local to individual MySQL instances and differ across replicas. Use gtid_set for positioning instead.

• uint64 binlog_position = 7

  binlog_position must be exactly 4. Position-based replication is not supported through vtgate; use gtid_set for positioning instead. Values below 4 are rejected (MySQL requires >= 4 / BIN_LOG_HEADER_SIZE). Values above 4 are rejected because binlog positions are local to individual MySQL instances and differ across replicas.

• string gtid_set = 8

  gtid_set is the GTID set in string format (e.g., "uuid:1-5,uuid2:1-3").

• uint32 flags = 9

  flags is the raw 2-byte flags field passed through to MySQL. Known flags: BINLOG_DUMP_NON_BLOCK (0x01) — return EOF instead of blocking when caught up USE_HEARTBEAT_EVENT_V2 (0x02) — use Heartbeat_event_v2 format

BinlogDumpResponse is streamed by BinlogDumpGTID.

Used as response type in: vtgateservice.Vitess.BinlogDumpGTID

• bytes raw = 1

  Raw MySQL response stream including MySQL packet headers. A single MySQL packet may be split across multiple BinlogDumpResponse messages (while preserving packet header boundaries), as documented in binlogdata.proto. gRPC clients must reassemble packets that span responses.

CloseSessionRequest is the payload to CloseSession.

Used as request type in: vtgateservice.Vitess.CloseSession

• optional vtrpc.CallerID caller_id = 1

  caller_id identifies the caller. This is the effective caller ID, set by the application to further identify the caller.

• optional Session session = 2

  session carries the session state.

CloseSessionResponse is the returned value from CloseSession.

Used as response type in: vtgateservice.Vitess.CloseSession

• optional vtrpc.RPCError error = 1

  error contains an application level error if necessary. Note the session may have changed, even when an error is returned (for instance if a database integrity error happened).

CommitOrder is used to designate which of the ShardSessions get used for transactions.

• NORMAL = 0

  NORMAL is the default commit order.

• PRE = 1

  PRE is used to designate pre_sessions.

• POST = 2

  POST is used to designate post_sessions.

• AUTOCOMMIT = 3

  AUTOCOMMIT is used to run the statement as autocommitted transaction.

ExecuteBatchRequest is the payload to ExecuteBatch.

Used as request type in: vtgateservice.Vitess.ExecuteBatch

• optional vtrpc.CallerID caller_id = 1

  caller_id identifies the caller. This is the effective caller ID, set by the application to further identify the caller.

• optional Session session = 2

  session carries the session state.

• repeated query.BoundQuery queries = 3

  queries is a list of query and bind variables to execute.

ExecuteBatchResponse is the returned value from ExecuteBatch.

Used as response type in: vtgateservice.Vitess.ExecuteBatch

• optional vtrpc.RPCError error = 1

  error contains an application level error if necessary. Note the session may have changed, even when an error is returned (for instance if a database integrity error happened).

• optional Session session = 2

  session is the updated session information.

• repeated query.ResultWithError results = 3

  results contains the query results, only set if application level error is unset.

ExecuteMultiRequest is the payload to ExecuteMulti.

Used as request type in: vtgateservice.Vitess.ExecuteMulti

• optional vtrpc.CallerID caller_id = 1

  caller_id identifies the caller. This is the effective caller ID, set by the application to further identify the caller.

• string sql = 2

  sql contains the set of queries to execute.

• optional Session session = 3

  session carries the session state.

ExecuteMultiResponse is the returned value from ExecuteMulti.

Used as response type in: vtgateservice.Vitess.ExecuteMulti

• optional vtrpc.RPCError error = 1

  error contains an application level error if necessary. Note the session may have changed, even when an error is returned (for instance if a database integrity error happened).

• optional Session session = 2

  session is the updated session information.

• repeated query.QueryResult results = 3

  results contain the query results. There can be some results even if the error is set.

ExecuteRequest is the payload to Execute.

Used as request type in: vtgateservice.Vitess.Execute

• optional vtrpc.CallerID caller_id = 1

  caller_id identifies the caller. This is the effective caller ID, set by the application to further identify the caller.

• optional Session session = 2

  session carries the session state.

• optional query.BoundQuery query = 3

  query is the query and bind variables to execute.

• bool prepared = 8

ExecuteResponse is the returned value from Execute.

Used as response type in: vtgateservice.Vitess.Execute

• optional vtrpc.RPCError error = 1

  error contains an application level error if necessary. Note the session may have changed, even when an error is returned (for instance if a database integrity error happened).

• optional Session session = 2

  session is the updated session information.

• optional query.QueryResult result = 3

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

PrepareData keeps the prepared statement and other information related for execution of it.

Used in: Session

• string prepare_statement = 1

• int32 params_count = 2

PrepareRequest is the payload to Prepare.

Used as request type in: vtgateservice.Vitess.Prepare

• optional vtrpc.CallerID caller_id = 1

  caller_id identifies the caller. This is the effective caller ID, set by the application to further identify the caller.

• optional Session session = 2

  session carries the session state.

• optional query.BoundQuery query = 3

  query is the query and bind variables to execute.

PrepareResponse is the returned value from Prepare.

Used as response type in: vtgateservice.Vitess.Prepare

• optional vtrpc.RPCError error = 1

  error contains an application level error if necessary. Note the session may have changed, even when an error is returned (for instance if a database integrity error happened).

• optional Session session = 2

  session is the updated session information.

• repeated query.Field fields = 3

  fields contains the fields, only set if error is unset.

• uint32 params_count = 4

ReadAfterWrite contains information regarding gtid set and timeout Also if the gtid information needs to be passed to client.

Used in: Session

• string read_after_write_gtid = 1

• double read_after_write_timeout = 2

• bool session_track_gtids = 3

ResolveTransactionRequest is the payload to ResolveTransaction.

• optional vtrpc.CallerID caller_id = 1

  caller_id identifies the caller. This is the effective caller ID, set by the application to further identify the caller.

• string dtid = 2

  dtid is the dtid of the transaction to be resolved.

ResolveTransactionResponse is the returned value from Rollback.

(message has no fields)

Session objects are exchanged like cookies through various calls to VTGate. The behavior differs between V2 & V3 APIs. V3 APIs are Execute, ExecuteBatch and StreamExecute. All other APIs are V2. For the V3 APIs, the session must be sent with every call to Execute or ExecuteBatch. For the V2 APIs, Begin does not accept a session. It instead returns a brand new one with in_transaction set to true. After a call to Commit or Rollback, the session can be discarded. If you're not in a transaction, Session is an optional parameter for the V2 APIs.

Used in: CloseSessionRequest, ExecuteBatchRequest, ExecuteBatchResponse, ExecuteMultiRequest, ExecuteMultiResponse, ExecuteRequest, ExecuteResponse, PrepareRequest, PrepareResponse, StreamExecuteMultiRequest, StreamExecuteMultiResponse, StreamExecuteRequest, StreamExecuteResponse

• bool in_transaction = 1

  in_transaction is set to true if the session is in a transaction.

• repeated Session.ShardSession shard_sessions = 2

  shard_sessions keep track of per-shard transaction info.

• bool autocommit = 4

  autocommit specifies if the session is in autocommit mode. This is used only for V3.

• string target_string = 5

  target_string is the target expressed as a string. Valid names are: keyspace:shard@target, keyspace@target or @target. This is used only for V3.

• optional query.ExecuteOptions options = 6

  options is used only for V3.

• TransactionMode transaction_mode = 7

  transaction_mode specifies the current transaction mode.

• repeated query.QueryWarning warnings = 8

  warnings contains non-fatal warnings from the previous query

• repeated Session.ShardSession pre_sessions = 9

  pre_sessions contains sessions that have to be committed first.

• repeated Session.ShardSession post_sessions = 10

  post_sessions contains sessions that have to be committed last.

• uint64 last_insert_id = 11

  last_insert_id keeps track of the last seen insert_id for this session

• uint64 found_rows = 12

  found_rows keeps track of how many rows the last query returned

• map<string, query.BindVariable> user_defined_variables = 13

  user_defined_variables contains all the @variables defined for this session

• map<string, string> system_variables = 14

  system_variables keeps track of all session variables set for this connection TODO: systay should we keep this so we can apply it ordered?

• int64 row_count = 15

  row_count keeps track of the last seen rows affected for this session

• repeated string savepoints = 16

  Stores savepoint and release savepoint calls inside a transaction and is reset once transaction is committed or rolled back.

• bool in_reserved_conn = 17

  in_reserved_conn is set to true if the session should be using reserved connections.

• optional Session.ShardSession lock_session = 18

  lock_session keep tracks of shard on which the lock query is sent.

• int64 last_lock_heartbeat = 19

  last_lock_heartbeat keep tracks of when last lock heartbeat was sent.

• optional ReadAfterWrite read_after_write = 20

  read_after_write tracks the ReadAfterWrite settings for this session.

• string DDLStrategy = 21

  DDL strategy

• string SessionUUID = 22

  Session UUID

• bool enable_system_settings = 23

  enable_system_settings defines if we can use reserved connections.

• map<string, int64> advisory_lock = 24

• int64 query_timeout = 25

  query_timeout is the maximum amount of time a query is permitted to run

• map<string, PrepareData> prepare_statement = 26

• string migration_context = 27

  MigrationContext

• bool error_until_rollback = 28

Used in: Session

• optional query.Target target = 1

• int64 transaction_id = 2

• optional topodata.TabletAlias tablet_alias = 3

• int64 reserved_id = 4

  reserved connection if a dedicated connection is needed

• bool read_only = 5

  read_only is true if the session has only executed read queries.

• bool rows_affected = 6

  rows_affected tracks if any query has modified the rows.

StreamExecuteMultiRequest is the payload to StreamExecuteMulti.

Used as request type in: vtgateservice.Vitess.StreamExecuteMulti

• optional vtrpc.CallerID caller_id = 1

  caller_id identifies the caller. This is the effective caller ID, set by the application to further identify the caller.

• string sql = 2

  sql contains the set of queries to execute.

• optional Session session = 3

  session carries the session state.

StreamExecuteMultiResponse is the returned value from StreamExecuteMulti.

Used as response type in: vtgateservice.Vitess.StreamExecuteMulti

• optional query.ResultWithError result = 1

  result contains the result set or an error if one occurred while executing the query.

• bool more_results = 2

  more_results is set to true if there are more results to follow after this one has concluded.

• bool new_result = 3

  new_result signifies a new result has started with this packet.

• optional Session session = 4

  session is the updated session information.

StreamExecuteRequest is the payload to StreamExecute.

Used as request type in: vtgateservice.Vitess.StreamExecute

• optional vtrpc.CallerID caller_id = 1

  caller_id identifies the caller. This is the effective caller ID, set by the application to further identify the caller.

• optional query.BoundQuery query = 2

  query is the query and bind variables to execute.

• optional Session session = 6

  session carries the session state.

StreamExecuteResponse is the returned value from StreamExecute. The session is currently not returned because StreamExecute is not expected to modify it.

Used as response type in: vtgateservice.Vitess.StreamExecute

• optional query.QueryResult result = 1

  result contains the result data. The first value contains only Fields information. The next values contain the actual rows, a few values per result.

• optional Session session = 2

  session is the updated session information.

TransactionMode controls the execution of distributed transaction across multiple shards.

Used in: Session

• UNSPECIFIED = 0

  UNSPECIFIED uses the transaction mode set by the VTGate flag 'transaction_mode'.

• SINGLE = 1

  SINGLE disallows distributed transactions.

• MULTI = 2

  MULTI allows distributed transactions with best effort commit.

• TWOPC = 3

  TWOPC is for distributed transactions with atomic commits.

Used in: VStreamRequest

• bool minimize_skew = 1

  align streams

• uint32 heartbeat_interval = 2

  how often heartbeats must be sent when idle (seconds)

• bool stop_on_reshard = 3

  stop streams on a reshard (journal event)

• string cells = 4

  if specified, these cells (comma-separated) are used to pick source tablets from. defaults to the cell of the vtgate serving the VStream API.

• string cell_preference = 5

• string tablet_order = 6

• bool stream_keyspace_heartbeats = 7

  When set, all new row events from the `heartbeat` table, for all shards, in the sidecardb will be streamed.

• bool include_reshard_journal_events = 8

  Include reshard journal events in the stream.

• repeated string tables_to_copy = 9

  Copy only these tables, skip the rest in the filter. If not provided, the default behaviour is to copy all tables.

• bool exclude_keyspace_from_table_name = 10

  Exclude the keyspace from the table name that is sent to the vstream client

• int64 transaction_chunk_size = 11

  Transaction chunk threshold in bytes. When a transaction exceeds this size, VTGate will acquire a lock to ensure contiguous, non-interleaved delivery (BEGIN...ROW...COMMIT sent sequentially without mixing events from other shards). Events are still chunked to prevent OOM. Transactions smaller than this are sent without locking for better parallelism.

• uint32 max_stream_age_seconds = 12

  Maximum duration (in seconds) a VStream runs before the server terminates it with UNAVAILABLE. This is best-effort: if a send to the client is in-flight when the age is reached, the server waits for it to complete before returning. The client is expected to reconnect. A random jitter of +/-10% is added to spread out reconnections. 0 means no maximum age.

VStreamRequest is the payload for VStream.

Used as request type in: vtgateservice.Vitess.VStream

• optional vtrpc.CallerID caller_id = 1

• topodata.TabletType tablet_type = 2

• optional binlogdata.VGtid vgtid = 3

  position specifies the starting point of the bin log positions as well as the keyspace-shards to pull events from. position is of the form 'ks1:0@MySQL56/<mysql_pos>|ks2:-80@MySQL56/<mysql_pos>'.

• optional binlogdata.Filter filter = 4

• optional VStreamFlags flags = 5

VStreamResponse is streamed by VStream.

Used as response type in: vtgateservice.Vitess.VStream

• repeated binlogdata.VEvent events = 1