publicinterfaceExecuteSqlRequestOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsParamTypes(String key)
publicabstractbooleancontainsParamTypes(Stringkey) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type BYTES and values of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getDataBoostEnabled()
publicabstractbooleangetDataBoostEnabled() If this is for a partitioned query and this field is set to true, the request is executed with Spanner Data Boost independent compute resources.
If the field is set to true but the request does not set partition_token, the API returns an INVALID_ARGUMENT error.
bool data_boost_enabled = 16;
| Returns | |
|---|---|
| Type | Description |
boolean | The dataBoostEnabled. |
getDirectedReadOptions()
publicabstractDirectedReadOptionsgetDirectedReadOptions()Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 15;
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions | The directedReadOptions. |
getDirectedReadOptionsOrBuilder()
publicabstractDirectedReadOptionsOrBuildergetDirectedReadOptionsOrBuilder()Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 15;
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptionsOrBuilder | |
getLastStatement()
publicabstractbooleangetLastStatement()Optional. If set to true, this statement marks the end of the transaction. The transaction should be committed or aborted after this statement executes, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected.
For DML statements, setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of a DML statement should not be assumed until a subsequent Commit call completes successfully.
bool last_statement = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | The lastStatement. |
getParamTypes() (deprecated)
publicabstractMap<String,Type>getParamTypes()Use #getParamTypesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Type> | |
getParamTypesCount()
publicabstractintgetParamTypesCount() It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type BYTES and values of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Returns | |
|---|---|
| Type | Description |
int | |
getParamTypesMap()
publicabstractMap<String,Type>getParamTypesMap() It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type BYTES and values of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Returns | |
|---|---|
| Type | Description |
Map<String,Type> | |
getParamTypesOrDefault(String key, Type defaultValue)
publicabstractTypegetParamTypesOrDefault(Stringkey,TypedefaultValue) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type BYTES and values of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | Type |
| Returns | |
|---|---|
| Type | Description |
Type | |
getParamTypesOrThrow(String key)
publicabstractTypegetParamTypesOrThrow(Stringkey) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type BYTES and values of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Type | |
getParams()
publicabstractStructgetParams()Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers.
Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
.google.protobuf.Struct params = 4;
| Returns | |
|---|---|
| Type | Description |
Struct | The params. |
getParamsOrBuilder()
publicabstractStructOrBuildergetParamsOrBuilder()Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers.
Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
.google.protobuf.Struct params = 4;
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder | |
getPartitionToken()
publicabstractByteStringgetPartitionToken()If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token.
bytes partition_token = 8;
| Returns | |
|---|---|
| Type | Description |
ByteString | The partitionToken. |
getQueryMode()
publicabstractExecuteSqlRequest.QueryModegetQueryMode()Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL.
.google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7;
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryMode | The queryMode. |
getQueryModeValue()
publicabstractintgetQueryModeValue()Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL.
.google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for queryMode. |
getQueryOptions()
publicabstractExecuteSqlRequest.QueryOptionsgetQueryOptions()Query optimizer configuration to use for the given query.
.google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions | The queryOptions. |
getQueryOptionsOrBuilder()
publicabstractExecuteSqlRequest.QueryOptionsOrBuildergetQueryOptionsOrBuilder()Query optimizer configuration to use for the given query.
.google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptionsOrBuilder | |
getRequestOptions()
publicabstractRequestOptionsgetRequestOptions()Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Returns | |
|---|---|
| Type | Description |
RequestOptions | The requestOptions. |
getRequestOptionsOrBuilder()
publicabstractRequestOptionsOrBuildergetRequestOptionsOrBuilder()Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Returns | |
|---|---|
| Type | Description |
RequestOptionsOrBuilder | |
getResumeToken()
publicabstractByteStringgetResumeToken() If this request is resuming a previously interrupted SQL statement execution, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token.
bytes resume_token = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString | The resumeToken. |
getSeqno()
publicabstractlonggetSeqno()A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed.
The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution.
Required for DML statements. Ignored for queries.
int64 seqno = 9;
| Returns | |
|---|---|
| Type | Description |
long | The seqno. |
getSession()
publicabstractStringgetSession()Required. The session in which the SQL query should be performed.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The session. |
getSessionBytes()
publicabstractByteStringgetSessionBytes()Required. The session in which the SQL query should be performed.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for session. |
getSql()
publicabstractStringgetSql()Required. The SQL string.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String | The sql. |
getSqlBytes()
publicabstractByteStringgetSqlBytes()Required. The SQL string.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sql. |
getTransaction()
publicabstractTransactionSelectorgetTransaction()The transaction to use.
For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency.
Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.
Partitioned DML requires an existing Partitioned DML transaction ID.
.google.spanner.v1.TransactionSelector transaction = 2;
| Returns | |
|---|---|
| Type | Description |
TransactionSelector | The transaction. |
getTransactionOrBuilder()
publicabstractTransactionSelectorOrBuildergetTransactionOrBuilder()The transaction to use.
For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency.
Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.
Partitioned DML requires an existing Partitioned DML transaction ID.
.google.spanner.v1.TransactionSelector transaction = 2;
| Returns | |
|---|---|
| Type | Description |
TransactionSelectorOrBuilder | |
hasDirectedReadOptions()
publicabstractbooleanhasDirectedReadOptions()Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 15;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the directedReadOptions field is set. |
hasParams()
publicabstractbooleanhasParams()Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers.
Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
.google.protobuf.Struct params = 4;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the params field is set. |
hasQueryOptions()
publicabstractbooleanhasQueryOptions()Query optimizer configuration to use for the given query.
.google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the queryOptions field is set. |
hasRequestOptions()
publicabstractbooleanhasRequestOptions()Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the requestOptions field is set. |
hasTransaction()
publicabstractbooleanhasTransaction()The transaction to use.
For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency.
Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.
Partitioned DML requires an existing Partitioned DML transaction ID.
.google.spanner.v1.TransactionSelector transaction = 2;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the transaction field is set. |
