This document describes Vitess API methods that enable your client application to more easily talk to your storage system to query data. API methods are grouped into the following categories:
The following table lists the methods in each group and links to more detail about each method:
| Range-based Sharding | |
ExecuteBatchKeyspaceIds |
ExecuteBatchKeyspaceIds executes the list of queries based on the specified keyspace ids. |
ExecuteEntityIds |
ExecuteEntityIds executes the query based on the specified external id to keyspace id map. |
ExecuteKeyRanges |
ExecuteKeyRanges executes the query based on the specified key ranges. |
ExecuteKeyspaceIds |
ExecuteKeyspaceIds executes the query based on the specified keyspace ids. |
StreamExecuteKeyRanges |
StreamExecuteKeyRanges executes a streaming query based on key ranges. Use this method if the query returns a large number of rows. |
StreamExecuteKeyspaceIds |
StreamExecuteKeyspaceIds executes a streaming query based on keyspace ids. Use this method if the query returns a large number of rows. |
| Transactions | |
Begin |
Begin a transaction. |
Commit |
Commit a transaction. |
Rollback |
Rollback a transaction. |
| Custom Sharding | |
ExecuteBatchShards |
ExecuteBatchShards executes the list of queries on the specified shards. |
ExecuteShards |
ExecuteShards executes the query on the specified shards. |
StreamExecuteShards |
StreamExecuteShards executes a streaming query based on shards. Use this method if the query returns a large number of rows. |
| Map Reduce | |
SplitQuery |
Split a query into non-overlapping sub queries |
| Topology | |
GetSrvKeyspace |
GetSrvKeyspace returns a SrvKeyspace object (as seen by this vtgate). This method is provided as a convenient way for clients to take a look at the sharding configuration for a Keyspace. Looking at the sharding information should not be used for routing queries (as the information may change, use the Execute calls for that). It is convenient for monitoring applications for instance, or if using custom sharding. |
| v3 API (alpha) | |
Execute |
Execute tries to route the query to the right shard. It depends on the query and bind variables to provide enough information in conjonction with the vindexes to route the query. |
StreamExecute |
StreamExecute executes a streaming query based on shards. It depends on the query and bind variables to provide enough information in conjonction with the vindexes to route the query. Use this method if the query returns a large number of rows. |
ExecuteBatchKeyspaceIds executes the list of queries based on the specified keyspace ids.
ExecuteBatchKeyspaceIdsRequest is the payload to ExecuteBatchKeyspaceId.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
queries list <BoundKeyspaceIdQuery> |
BoundKeyspaceIdQuery represents a single query request for the specified list of keyspace ids. This is used in a list for ExecuteBatchKeyspaceIdsRequest. |
tablet_type topodata.TabletType |
TabletType represents the type of a given tablet. |
as_transaction bool |
as_transaction will execute the queries in this batch in a single transaction per shard, created for this purpose. (this can be seen as adding a 'begin' before and 'commit' after the queries). Only makes sense if tablet_type is master. If set, the Session is ignored. |
options query.ExecuteOptions |
ExecuteOptions is passed around for all Execute calls. |
ExecuteBatchKeyspaceIdsResponse is the returned value from ExecuteBatchKeyspaceId.
| Name | Description |
|---|---|
error vtrpc.RPCError |
RPCError is an application-level error structure returned by VtTablet (and passed along by VtGate if appropriate). We use this so the clients don't have to parse the error messages, but instead can depend on the value of the code. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
results list <query.QueryResult> |
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:]). |
ExecuteEntityIds executes the query based on the specified external id to keyspace id map.
ExecuteEntityIdsRequest is the payload to ExecuteEntityIds.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
query query.BoundQuery |
BoundQuery is a query with its bind variables |
keyspace string |
keyspace to target the query to. |
entity_column_name string |
entity_column_name is the column name to use. |
entity_keyspace_ids list <EntityId> |
entity_keyspace_ids are pairs of entity_column_name values associated with its corresponding keyspace_id. |
tablet_type topodata.TabletType |
TabletType represents the type of a given tablet. |
not_in_transaction bool |
not_in_transaction is deprecated and should not be used. |
options query.ExecuteOptions |
ExecuteOptions is passed around for all Execute calls. |
Properties
| Name | Description |
|---|---|
type query.Type |
Type defines the various supported data types in bind vars and query results. |
value bytes |
value is the value for the entity. Not set if type is NULL_TYPE. |
keyspace_id bytes |
keyspace_id is the associated keyspace_id for the entity. |
ExecuteEntityIdsResponse is the returned value from ExecuteEntityIds.
| Name | Description |
|---|---|
error vtrpc.RPCError |
RPCError is an application-level error structure returned by VtTablet (and passed along by VtGate if appropriate). We use this so the clients don't have to parse the error messages, but instead can depend on the value of the code. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
result query.QueryResult |
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:]). |
ExecuteKeyRanges executes the query based on the specified key ranges.
ExecuteKeyRangesRequest is the payload to ExecuteKeyRanges.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
query query.BoundQuery |
BoundQuery is a query with its bind variables |
keyspace string |
keyspace to target the query to |
key_ranges list <topodata.KeyRange> |
KeyRange describes a range of sharding keys, when range-based sharding is used. |
tablet_type topodata.TabletType |
TabletType represents the type of a given tablet. |
not_in_transaction bool |
not_in_transaction is deprecated and should not be used. |
options query.ExecuteOptions |
ExecuteOptions is passed around for all Execute calls. |
ExecuteKeyRangesResponse is the returned value from ExecuteKeyRanges.
| Name | Description |
|---|---|
error vtrpc.RPCError |
RPCError is an application-level error structure returned by VtTablet (and passed along by VtGate if appropriate). We use this so the clients don't have to parse the error messages, but instead can depend on the value of the code. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
result query.QueryResult |
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:]). |
ExecuteKeyspaceIds executes the query based on the specified keyspace ids.
ExecuteKeyspaceIdsRequest is the payload to ExecuteKeyspaceIds.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
query query.BoundQuery |
BoundQuery is a query with its bind variables |
keyspace string |
keyspace to target the query to. |
keyspace_ids list <bytes> |
keyspace_ids contains the list of keyspace_ids affected by this query. Will be used to find the shards to send the query to. |
tablet_type topodata.TabletType |
TabletType represents the type of a given tablet. |
not_in_transaction bool |
not_in_transaction is deprecated and should not be used. |
options query.ExecuteOptions |
ExecuteOptions is passed around for all Execute calls. |
ExecuteKeyspaceIdsResponse is the returned value from ExecuteKeyspaceIds.
| Name | Description |
|---|---|
error vtrpc.RPCError |
RPCError is an application-level error structure returned by VtTablet (and passed along by VtGate if appropriate). We use this so the clients don't have to parse the error messages, but instead can depend on the value of the code. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
result query.QueryResult |
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:]). |
StreamExecuteKeyRanges executes a streaming query based on key ranges. Use this method if the query returns a large number of rows.
StreamExecuteKeyRangesRequest is the payload to StreamExecuteKeyRanges.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
query query.BoundQuery |
BoundQuery is a query with its bind variables |
keyspace string |
keyspace to target the query to. |
key_ranges list <topodata.KeyRange> |
KeyRange describes a range of sharding keys, when range-based sharding is used. |
tablet_type topodata.TabletType |
TabletType represents the type of a given tablet. |
options query.ExecuteOptions |
ExecuteOptions is passed around for all Execute calls. |
StreamExecuteKeyRangesResponse is the returned value from StreamExecuteKeyRanges.
| Name | Description |
|---|---|
result query.QueryResult |
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:]). |
StreamExecuteKeyspaceIds executes a streaming query based on keyspace ids. Use this method if the query returns a large number of rows.
StreamExecuteKeyspaceIdsRequest is the payload to StreamExecuteKeyspaceIds.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
query query.BoundQuery |
BoundQuery is a query with its bind variables |
keyspace string |
keyspace to target the query to. |
keyspace_ids list <bytes> |
keyspace_ids contains the list of keyspace_ids affected by this query. Will be used to find the shards to send the query to. |
tablet_type topodata.TabletType |
TabletType represents the type of a given tablet. |
options query.ExecuteOptions |
ExecuteOptions is passed around for all Execute calls. |
StreamExecuteKeyspaceIdsResponse is the returned value from StreamExecuteKeyspaceIds.
| Name | Description |
|---|---|
result query.QueryResult |
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:]). |
Begin a transaction.
BeginRequest is the payload to Begin.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
BeginResponse is the returned value from Begin.
| Name | Description |
|---|---|
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
Commit a transaction.
CommitRequest is the payload to Commit.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
CommitResponse is the returned value from Commit.
| Name | Description |
|---|
Rollback a transaction.
RollbackRequest is the payload to Rollback.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
RollbackResponse is the returned value from Rollback.
| Name | Description |
|---|
ExecuteBatchShards executes the list of queries on the specified shards.
ExecuteBatchShardsRequest is the payload to ExecuteBatchShards
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
queries list <BoundShardQuery> |
BoundShardQuery represents a single query request for the specified list of shards. This is used in a list for ExecuteBatchShardsRequest. |
tablet_type topodata.TabletType |
TabletType represents the type of a given tablet. |
as_transaction bool |
as_transaction will execute the queries in this batch in a single transaction per shard, created for this purpose. (this can be seen as adding a 'begin' before and 'commit' after the queries). Only makes sense if tablet_type is master. If set, the Session is ignored. |
options query.ExecuteOptions |
ExecuteOptions is passed around for all Execute calls. |
ExecuteBatchShardsResponse is the returned value from ExecuteBatchShards.
| Name | Description |
|---|---|
error vtrpc.RPCError |
RPCError is an application-level error structure returned by VtTablet (and passed along by VtGate if appropriate). We use this so the clients don't have to parse the error messages, but instead can depend on the value of the code. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
results list <query.QueryResult> |
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:]). |
ExecuteShards executes the query on the specified shards.
ExecuteShardsRequest is the payload to ExecuteShards.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
query query.BoundQuery |
BoundQuery is a query with its bind variables |
keyspace string |
keyspace to target the query to. |
shards list <string> |
shards to target the query to. A DML can only target one shard. |
tablet_type topodata.TabletType |
TabletType represents the type of a given tablet. |
not_in_transaction bool |
not_in_transaction is deprecated and should not be used. |
options query.ExecuteOptions |
ExecuteOptions is passed around for all Execute calls. |
ExecuteShardsResponse is the returned value from ExecuteShards.
| Name | Description |
|---|---|
error vtrpc.RPCError |
RPCError is an application-level error structure returned by VtTablet (and passed along by VtGate if appropriate). We use this so the clients don't have to parse the error messages, but instead can depend on the value of the code. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
result query.QueryResult |
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:]). |
StreamExecuteShards executes a streaming query based on shards. Use this method if the query returns a large number of rows.
StreamExecuteShardsRequest is the payload to StreamExecuteShards.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
query query.BoundQuery |
BoundQuery is a query with its bind variables |
keyspace string |
keyspace to target the query to. |
shards list <string> |
shards to target the query to. |
tablet_type topodata.TabletType |
TabletType represents the type of a given tablet. |
options query.ExecuteOptions |
ExecuteOptions is passed around for all Execute calls. |
StreamExecuteShardsResponse is the returned value from StreamExecuteShards.
| Name | Description |
|---|---|
result query.QueryResult |
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:]). |
Split a query into non-overlapping sub queries
SplitQueryRequest is the payload to SplitQuery. SplitQuery takes a "SELECT" query and generates a list of queries called "query-parts". Each query-part consists of the original query with an added WHERE clause that restricts the query-part to operate only on rows whose values in the the columns listed in the "split_column" field of the request (see below) are in a particular range. It is guaranteed that the set of rows obtained from executing each query-part on a database snapshot and merging (without deduping) the results is equal to the set of rows obtained from executing the original query on the same snapshot with the rows containing NULL values in any of the split_column's excluded. This is typically called by the MapReduce master when reading from Vitess. There it's desirable that the sets of rows returned by the query-parts have roughly the same size.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
keyspace string |
keyspace to target the query to. |
query query.BoundQuery |
BoundQuery is a query with its bind variables |
split_column list <string> |
Each generated query-part will be restricted to rows whose values in the columns listed in this field are in a particular range. The list of columns named here must be a prefix of the list of columns defining some index or primary key of the table referenced in 'query'. For many tables using the primary key columns (in order) is sufficient and this is the default if this field is omitted. See the comment on the 'algorithm' field for more restrictions and information. |
split_count int64 |
You can specify either an estimate of the number of query-parts to generate or an estimate of the number of rows each query-part should return. Thus, exactly one of split_count or num_rows_per_query_part should be nonzero. The non-given parameter is calculated from the given parameter using the formula: split_count * num_rows_per_query_pary = table_size, where table_size is an approximation of the number of rows in the table. Note that if "split_count" is given it is regarded as an estimate. The number of query-parts returned may differ slightly (in particular, if it's not a whole multiple of the number of vitess shards). |
num_rows_per_query_part int64 |
|
algorithm query.SplitQueryRequest.Algorithm |
The algorithm to use to split the query. The split algorithm is performed on each database shard in parallel. The lists of query-parts generated by the shards are merged and returned to the caller. Two algorithms are supported: EQUAL_SPLITS If this algorithm is selected then only the first 'split_column' given is used (or the first primary key column if the 'split_column' field is empty). In the rest of this algorithm's description, we refer to this column as "the split column". The split column must have numeric type (integral or floating point). The algorithm works by taking the interval [min, max], where min and max are the minimum and maximum values of the split column in the table-shard, respectively, and partitioning it into 'split_count' sub-intervals of equal size. The added WHERE clause of each query-part restricts that part to rows whose value in the split column belongs to a particular sub-interval. This is fast, but requires that the distribution of values of the split column be uniform in [min, max] for the number of rows returned by each query part to be roughly the same. FULL_SCAN If this algorithm is used then the split_column must be the primary key columns (in order). This algorithm performs a full-scan of the table-shard referenced in 'query' to get "boundary" rows that are num_rows_per_query_part apart when the table is ordered by the columns listed in 'split_column'. It then restricts each query-part to the rows located between two successive boundary rows. This algorithm supports multiple split_column's of any type, but is slower than EQUAL_SPLITS. |
use_split_query_v2 bool |
Whether to use the new split-query code that supports multiple split-columns and the FULL_SCAN algorithm. This is a temporary field which aids in the migration of SplitQuery to the new code. to the SplitQuery version 2. |
SplitQueryResponse is the returned value from SplitQuery.
| Name | Description |
|---|---|
splits list <Part> |
splits contains the queries to run to fetch the entire data set. |
Properties
| Name | Description |
|---|---|
keyspace string |
keyspace to target the query to. |
key_ranges list <topodata.KeyRange> |
KeyRange describes a range of sharding keys, when range-based sharding is used. |
Properties
| Name | Description |
|---|---|
query query.BoundQuery |
BoundQuery is a query with its bind variables |
key_range_part KeyRangePart |
key_range_part is set if the query should be executed by ExecuteKeyRanges. |
shard_part ShardPart |
shard_part is set if the query should be executed by ExecuteShards. |
size int64 |
size is the approximate number of rows this query will return. |
Properties
| Name | Description |
|---|---|
keyspace string |
keyspace to target the query to. |
shards list <string> |
shards to target the query to. |
GetSrvKeyspace returns a SrvKeyspace object (as seen by this vtgate). This method is provided as a convenient way for clients to take a look at the sharding configuration for a Keyspace. Looking at the sharding information should not be used for routing queries (as the information may change, use the Execute calls for that). It is convenient for monitoring applications for instance, or if using custom sharding.
GetSrvKeyspaceRequest is the payload to GetSrvKeyspace.
| Name | Description |
|---|---|
keyspace string |
keyspace name to fetch. |
GetSrvKeyspaceResponse is the returned value from GetSrvKeyspace.
| Name | Description |
|---|---|
srv_keyspace topodata.SrvKeyspace |
SrvKeyspace is a rollup node for the keyspace itself. |
Execute tries to route the query to the right shard. It depends on the query and bind variables to provide enough information in conjonction with the vindexes to route the query.
ExecuteRequest is the payload to Execute.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
query query.BoundQuery |
BoundQuery is a query with its bind variables |
tablet_type topodata.TabletType |
TabletType represents the type of a given tablet. |
not_in_transaction bool |
not_in_transaction is deprecated and should not be used. |
keyspace string |
keyspace to target the query to. |
options query.ExecuteOptions |
ExecuteOptions is passed around for all Execute calls. |
ExecuteResponse is the returned value from Execute.
| Name | Description |
|---|---|
error vtrpc.RPCError |
RPCError is an application-level error structure returned by VtTablet (and passed along by VtGate if appropriate). We use this so the clients don't have to parse the error messages, but instead can depend on the value of the code. |
session Session |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user. |
result query.QueryResult |
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:]). |
StreamExecute executes a streaming query based on shards. It depends on the query and bind variables to provide enough information in conjonction with the vindexes to route the query. Use this method if the query returns a large number of rows.
StreamExecuteRequest is the payload to StreamExecute.
| Name | Description |
|---|---|
caller_id vtrpc.CallerID |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes. |
query query.BoundQuery |
BoundQuery is a query with its bind variables |
tablet_type topodata.TabletType |
TabletType represents the type of a given tablet. |
keyspace string |
keyspace to target the query to. |
options query.ExecuteOptions |
ExecuteOptions is passed around for all Execute calls. |
StreamExecuteResponse is the returned value from StreamExecute.
| Name | Description |
|---|---|
result query.QueryResult |
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:]). |
Type defines the various supported data types in bind vars and query results.
| Name | Value | Description |
|---|---|---|
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 a tuple. This cannot be returned in a QueryResult, but it can be sent as a bind var. Properties: 28, None. |
KeyspaceIdType describes the type of the sharding key for a range-based sharded keyspace.
| Name | Value | Description |
|---|---|---|
UNSET |
0 |
UNSET is the default value, when range-based sharding is not used. |
UINT64 |
1 |
UINT64 is when uint64 value is used. This is represented as 'unsigned bigint' in mysql |
BYTES |
2 |
BYTES is when an array of bytes is used. This is represented as 'varbinary' in mysql |
TabletType represents the type of a given tablet.
| Name | Value | Description |
|---|---|---|
UNKNOWN |
0 |
UNKNOWN is not a valid value. |
MASTER |
1 |
MASTER is the master server for the shard. Only MASTER allows DMLs. |
REPLICA |
2 |
REPLICA is a slave type. It is used to serve live traffic. A REPLICA can be promoted to MASTER. A demoted MASTER 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 a process needs a separate tablet set aside for a specific action. For example, a vtworker process may set a tablet to drained to perform an offline action. It is a serving type (as the vtworker processes may need queries to run). In this state, this tablet is dedicated to the background process that uses it. |
ErrorCode is the enum values for Errors. Internally, errors should be created with one of these codes. These will then be translated over the wire by various RPC frameworks.
| Name | Value | Description |
|---|---|---|
SUCCESS |
0 |
SUCCESS is returned from a successful call. |
CANCELLED |
1 |
CANCELLED means that the context was cancelled (and noticed in the app layer, as opposed to the RPC layer). |
UNKNOWN_ERROR |
2 |
UNKNOWN_ERROR includes: 1. MySQL error codes that we don't explicitly handle. 2. MySQL response that wasn't as expected. For example, we might expect a MySQL timestamp to be returned in a particular way, but it wasn't. 3. Anything else that doesn't fall into a different bucket. |
BAD_INPUT |
3 |
BAD_INPUT is returned when an end-user either sends SQL that couldn't be parsed correctly, or tries a query that isn't supported by Vitess. |
DEADLINE_EXCEEDED |
4 |
DEADLINE_EXCEEDED is returned when an action is taking longer than a given timeout. |
INTEGRITY_ERROR |
5 |
INTEGRITY_ERROR is returned on integrity error from MySQL, usually due to duplicate primary keys. |
PERMISSION_DENIED |
6 |
PERMISSION_DENIED errors are returned when a user requests access to something that they don't have permissions for. |
RESOURCE_EXHAUSTED |
7 |
RESOURCE_EXHAUSTED is returned when a query exceeds its quota in some dimension and can't be completed due to that. Queries that return RESOURCE_EXHAUSTED should not be retried, as it could be detrimental to the server's health. Examples of errors that will cause the RESOURCE_EXHAUSTED code: 1. TxPoolFull: this is retried server-side, and is only returned as an error if the server-side retries failed. 2. Query is killed due to it taking too long. |
QUERY_NOT_SERVED |
8 |
QUERY_NOT_SERVED means that a query could not be served right now. Client can interpret it as: "the tablet that you sent this query to cannot serve the query right now, try a different tablet or try again later." This could be due to various reasons: QueryService is not serving, should not be serving, wrong shard, wrong tablet type, blacklisted table, etc. Clients that receive this error should usually retry the query, but after taking the appropriate steps to make sure that the query will get sent to the correct tablet. |
NOT_IN_TX |
9 |
NOT_IN_TX means that we're not currently in a transaction, but we should be. |
INTERNAL_ERROR |
10 |
INTERNAL_ERRORs are problems that only the server can fix, not the client. These errors are not due to a query itself, but rather due to the state of the system. Generally, we don't expect the errors to go away by themselves, but they may go away after human intervention. Examples of scenarios where INTERNAL_ERROR is returned: 1. Something is not configured correctly internally. 2. A necessary resource is not available, and we don't expect it to become available by itself. 3. A sanity check fails. 4. Some other internal error occurs. Clients should not retry immediately, as there is little chance of success. However, it's acceptable for retries to happen internally, for example to multiple backends, in case only a subset of backend are not functional. |
TRANSIENT_ERROR |
11 |
TRANSIENT_ERROR is used for when there is some error that we expect we can recover from automatically - often due to a resource limit temporarily being reached. Retrying this error, with an exponential backoff, should succeed. Clients should be able to successfully retry the query on the same backends. Examples of things that can trigger this error: 1. Query has been throttled 2. VtGate could have request backlog |
UNAUTHENTICATED |
12 |
UNAUTHENTICATED errors are returned when a user requests access to something, and we're unable to verify the user's authentication. |
BoundKeyspaceIdQuery represents a single query request for the specified list of keyspace ids. This is used in a list for ExecuteBatchKeyspaceIdsRequest.
| Name | Description |
|---|---|
query query.BoundQuery |
BoundQuery is a query with its bind variables |
keyspace string |
keyspace to target the query to. |
keyspace_ids list <bytes> |
keyspace_ids contains the list of keyspace_ids affected by this query. Will be used to find the shards to send the query to. |
BoundShardQuery represents a single query request for the specified list of shards. This is used in a list for ExecuteBatchShardsRequest.
| Name | Description |
|---|---|
query query.BoundQuery |
BoundQuery is a query with its bind variables |
keyspace string |
keyspace to target the query to. |
shards list <string> |
shards to target the query to. A DML can only target one shard. |
Session objects are session cookies and are invalidated on use. Query results will contain updated session values. Their content should be opaque to the user.
| Name | Description |
|---|---|
in_transaction bool |
|
shard_sessions list <ShardSession> |
Properties
| Name | Description |
|---|---|
target query.Target |
Target describes what the client expects the tablet is. If the tablet does not match, an error is returned. |
transaction_id int64 |
BindVariable represents a single bind variable in a Query.
| Name | Description |
|---|---|
type Type |
|
value bytes |
|
values list <Value> |
Value represents a typed value. |
BoundQuery is a query with its bind variables
| Name | Description |
|---|---|
sql string |
sql is the SQL query to execute |
bind_variables map <string, BindVariable> |
bind_variables is a map of all bind variables to expand in the query |
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.
| Name | Description |
|---|---|
timestamp int64 |
timestamp is the MySQL timestamp of the statements. Seconds since Epoch. |
shard string |
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. |
position string |
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.
| Name | Description |
|---|---|
exclude_field_names bool |
If set, the resulting Field array won’t have a Name, just a Type. This is an optimization for high-QPS queries where the client knows what it's getting. |
Field describes a single column returned by a query
| Name | Description |
|---|---|
name string |
name of the field as returned by mysql C API |
type Type |
vitess-defined type. Conversion function is in sqltypes package. |
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:]).
| Name | Description |
|---|---|
fields list <Field> |
Field describes a single column returned by a query |
rows_affected uint64 |
|
insert_id uint64 |
|
rows list <Row> |
Row is a database row. |
Row is a database row.
| Name | Description |
|---|---|
lengths list <sint64> |
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. |
values bytes |
values contains a concatenation of all values in the row. |
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.
| Name | Description |
|---|---|
statements list <Statement> |
The statements in this transaction. |
event_token EventToken |
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. |
One individual Statement in a transaction.
Properties
| Name | Description |
|---|---|
category Category |
|
table_name string |
table_name, primary_key_fields and primary_key_values are set for DML. |
primary_key_fields list <Field> |
Field describes a single column returned by a query |
primary_key_values list <Row> |
Row is a database row. |
sql bytes |
sql is set for all queries. FIXME(alainjobart) we may not need it for DMLs. |
One individual Statement in a transaction. The category of one statement.
| Name | Value | Description |
|---|---|---|
Error |
0 |
|
DML |
1 |
|
DDL |
2 |
Target describes what the client expects the tablet is. If the tablet does not match, an error is returned.
| Name | Description |
|---|---|
keyspace string |
|
shard string |
|
tablet_type topodata.TabletType |
TabletType represents the type of a given tablet. |
Value represents a typed value.
| Name | Description |
|---|---|
type Type |
|
value bytes |
KeyRange describes a range of sharding keys, when range-based sharding is used.
| Name | Description |
|---|---|
start bytes |
|
end bytes |
ShardReference is used as a pointer from a SrvKeyspace to a Shard
| Name | Description |
|---|---|
name string |
Copied from Shard. |
key_range KeyRange |
KeyRange describes a range of sharding keys, when range-based sharding is used. |
SrvKeyspace is a rollup node for the keyspace itself.
| Name | Description |
|---|---|
partitions list <KeyspacePartition> |
The partitions this keyspace is serving, per tablet type. |
sharding_column_name string |
copied from Keyspace |
sharding_column_type KeyspaceIdType |
|
served_from list <ServedFrom> |
Properties
| Name | Description |
|---|---|
served_type TabletType |
The type this partition applies to. |
shard_references list <ShardReference> |
ShardReference is used as a pointer from a SrvKeyspace to a Shard |
ServedFrom indicates a relationship between a TabletType and the keyspace name that's serving it.
Properties
| Name | Description |
|---|---|
tablet_type TabletType |
ServedFrom indicates a relationship between a TabletType and the keyspace name that's serving it. the tablet type |
keyspace string |
the keyspace name that's serving it |
CallerID is passed along RPCs to identify the originating client for a request. It is not meant to be secure, but only informational. The client can put whatever info they want in these fields, and they will be trusted by the servers. The fields will just be used for logging purposes, and to easily find a client. VtGate propagates it to VtTablet, and VtTablet may use this information for monitoring purposes, to display on dashboards, or for blacklisting purposes.
| Name | Description |
|---|---|
principal string |
principal is the effective user identifier. It is usually filled in with whoever made the request to the appserver, if the request came from an automated job or another system component. If the request comes directly from the Internet, or if the Vitess client takes action on its own accord, it is okay for this field to be absent. |
component string |
component describes the running process of the effective caller. It can for instance be the hostname:port of the servlet initiating the database call, or the container engine ID used by the servlet. |
subcomponent string |
subcomponent describes a component inisde the immediate caller which is responsible for generating is request. Suggested values are a servlet name or an API endpoint name. |
RPCError is an application-level error structure returned by VtTablet (and passed along by VtGate if appropriate). We use this so the clients don't have to parse the error messages, but instead can depend on the value of the code.
| Name | Description |
|---|---|
code ErrorCode |
|
message string |