public static final class ExecuteSqlRequest.Builder extends GeneratedMessageV3.Builder<ExecuteSqlRequest.Builder> implements ExecuteSqlRequestOrBuilderThe request for ExecuteSql and ExecuteStreamingSql.
Protobuf type google.spanner.v1.ExecuteSqlRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExecuteSqlRequest.BuilderImplements
ExecuteSqlRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExecuteSqlRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
build()
public ExecuteSqlRequest build()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest | |
buildPartial()
public ExecuteSqlRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest | |
clear()
public ExecuteSqlRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
clearDataBoostEnabled()
public ExecuteSqlRequest.Builder clearDataBoostEnabled() 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 |
ExecuteSqlRequest.Builder | This builder for chaining. |
clearDirectedReadOptions()
public ExecuteSqlRequest.Builder clearDirectedReadOptions()Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 15;
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public ExecuteSqlRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExecuteSqlRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
clearParamTypes()
public ExecuteSqlRequest.Builder clearParamTypes()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
clearParams()
public ExecuteSqlRequest.Builder clearParams()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 |
ExecuteSqlRequest.Builder | |
clearPartitionToken()
public ExecuteSqlRequest.Builder clearPartitionToken()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 |
ExecuteSqlRequest.Builder | This builder for chaining. |
clearQueryMode()
public ExecuteSqlRequest.Builder clearQueryMode()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.Builder | This builder for chaining. |
clearQueryOptions()
public ExecuteSqlRequest.Builder clearQueryOptions()Query optimizer configuration to use for the given query.
.google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
clearRequestOptions()
public ExecuteSqlRequest.Builder clearRequestOptions()Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
clearResumeToken()
public ExecuteSqlRequest.Builder clearResumeToken() 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 |
ExecuteSqlRequest.Builder | This builder for chaining. |
clearSeqno()
public ExecuteSqlRequest.Builder clearSeqno()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 |
ExecuteSqlRequest.Builder | This builder for chaining. |
clearSession()
public ExecuteSqlRequest.Builder clearSession()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 |
ExecuteSqlRequest.Builder | This builder for chaining. |
clearSql()
public ExecuteSqlRequest.Builder clearSql()Required. The SQL string.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | This builder for chaining. |
clearTransaction()
public ExecuteSqlRequest.Builder clearTransaction()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 |
ExecuteSqlRequest.Builder | |
clone()
public ExecuteSqlRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
containsParamTypes(String key)
public boolean containsParamTypes(String key) 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()
public boolean getDataBoostEnabled() 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. |
getDefaultInstanceForType()
public ExecuteSqlRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDirectedReadOptions()
public DirectedReadOptions getDirectedReadOptions()Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 15;
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions | The directedReadOptions. |
getDirectedReadOptionsBuilder()
public DirectedReadOptions.Builder getDirectedReadOptionsBuilder()Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 15;
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions.Builder | |
getDirectedReadOptionsOrBuilder()
public DirectedReadOptionsOrBuilder getDirectedReadOptionsOrBuilder()Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 15;
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptionsOrBuilder | |
getMutableParamTypes()
public Map<String,Type> getMutableParamTypes()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Type> | |
getParamTypes()
public Map<String,Type> getParamTypes()Use #getParamTypesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Type> | |
getParamTypesCount()
public int getParamTypesCount() 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()
public Map<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)
public Type getParamTypesOrDefault(String key, Type defaultValue) 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)
public Type getParamTypesOrThrow(String key) 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()
public Struct getParams()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. |
getParamsBuilder()
public Struct.Builder getParamsBuilder()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 |
Builder | |
getParamsOrBuilder()
public StructOrBuilder getParamsOrBuilder()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()
public ByteString getPartitionToken()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()
public ExecuteSqlRequest.QueryMode getQueryMode()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()
public int getQueryModeValue()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()
public ExecuteSqlRequest.QueryOptions getQueryOptions()Query optimizer configuration to use for the given query.
.google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions | The queryOptions. |
getQueryOptionsBuilder()
public ExecuteSqlRequest.QueryOptions.Builder getQueryOptionsBuilder()Query optimizer configuration to use for the given query.
.google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptions.Builder | |
getQueryOptionsOrBuilder()
public ExecuteSqlRequest.QueryOptionsOrBuilder getQueryOptionsOrBuilder()Query optimizer configuration to use for the given query.
.google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.QueryOptionsOrBuilder | |
getRequestOptions()
public RequestOptions getRequestOptions()Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Returns | |
|---|---|
| Type | Description |
RequestOptions | The requestOptions. |
getRequestOptionsBuilder()
public RequestOptions.Builder getRequestOptionsBuilder()Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Returns | |
|---|---|
| Type | Description |
RequestOptions.Builder | |
getRequestOptionsOrBuilder()
public RequestOptionsOrBuilder getRequestOptionsOrBuilder()Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Returns | |
|---|---|
| Type | Description |
RequestOptionsOrBuilder | |
getResumeToken()
public ByteString getResumeToken() 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()
public long getSeqno()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()
public String getSession()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()
public ByteString getSessionBytes()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()
public String getSql()Required. The SQL string.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String | The sql. |
getSqlBytes()
public ByteString getSqlBytes()Required. The SQL string.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sql. |
getTransaction()
public TransactionSelector getTransaction()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. |
getTransactionBuilder()
public TransactionSelector.Builder getTransactionBuilder()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.Builder | |
getTransactionOrBuilder()
public TransactionSelectorOrBuilder getTransactionOrBuilder()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()
public boolean hasDirectedReadOptions()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()
public boolean hasParams()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()
public boolean hasQueryOptions()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()
public boolean hasRequestOptions()Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the requestOptions field is set. |
hasTransaction()
public boolean hasTransaction()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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeDirectedReadOptions(DirectedReadOptions value)
public ExecuteSqlRequest.Builder mergeDirectedReadOptions(DirectedReadOptions value)Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 15;
| Parameter | |
|---|---|
| Name | Description |
value | DirectedReadOptions |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExecuteSqlRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ExecuteSqlRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
mergeFrom(ExecuteSqlRequest other)
public ExecuteSqlRequest.Builder mergeFrom(ExecuteSqlRequest other)| Parameter | |
|---|---|
| Name | Description |
other | ExecuteSqlRequest |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
mergeParams(Struct value)
public ExecuteSqlRequest.Builder mergeParams(Struct value)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;
| Parameter | |
|---|---|
| Name | Description |
value | Struct |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
mergeQueryOptions(ExecuteSqlRequest.QueryOptions value)
public ExecuteSqlRequest.Builder mergeQueryOptions(ExecuteSqlRequest.QueryOptions value)Query optimizer configuration to use for the given query.
.google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
| Parameter | |
|---|---|
| Name | Description |
value | ExecuteSqlRequest.QueryOptions |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
mergeRequestOptions(RequestOptions value)
public ExecuteSqlRequest.Builder mergeRequestOptions(RequestOptions value)Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Parameter | |
|---|---|
| Name | Description |
value | RequestOptions |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
mergeTransaction(TransactionSelector value)
public ExecuteSqlRequest.Builder mergeTransaction(TransactionSelector value)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;
| Parameter | |
|---|---|
| Name | Description |
value | TransactionSelector |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExecuteSqlRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
putAllParamTypes(Map<String,Type> values)
public ExecuteSqlRequest.Builder putAllParamTypes(Map<String,Type> values) 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 |
values | Map<String,Type> |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
putParamTypes(String key, Type value)
public ExecuteSqlRequest.Builder putParamTypes(String key, Type value) 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 |
value | Type |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
removeParamTypes(String key)
public ExecuteSqlRequest.Builder removeParamTypes(String key) 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 |
ExecuteSqlRequest.Builder | |
setDataBoostEnabled(boolean value)
public ExecuteSqlRequest.Builder setDataBoostEnabled(boolean value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe dataBoostEnabled to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | This builder for chaining. |
setDirectedReadOptions(DirectedReadOptions value)
public ExecuteSqlRequest.Builder setDirectedReadOptions(DirectedReadOptions value)Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 15;
| Parameter | |
|---|---|
| Name | Description |
value | DirectedReadOptions |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
setDirectedReadOptions(DirectedReadOptions.Builder builderForValue)
public ExecuteSqlRequest.Builder setDirectedReadOptions(DirectedReadOptions.Builder builderForValue)Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 15;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | DirectedReadOptions.Builder |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public ExecuteSqlRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
setParams(Struct value)
public ExecuteSqlRequest.Builder setParams(Struct value)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;
| Parameter | |
|---|---|
| Name | Description |
value | Struct |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
setParams(Struct.Builder builderForValue)
public ExecuteSqlRequest.Builder setParams(Struct.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
setPartitionToken(ByteString value)
public ExecuteSqlRequest.Builder setPartitionToken(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe partitionToken to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | This builder for chaining. |
setQueryMode(ExecuteSqlRequest.QueryMode value)
public ExecuteSqlRequest.Builder setQueryMode(ExecuteSqlRequest.QueryMode value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ExecuteSqlRequest.QueryModeThe queryMode to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | This builder for chaining. |
setQueryModeValue(int value)
public ExecuteSqlRequest.Builder setQueryModeValue(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for queryMode to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | This builder for chaining. |
setQueryOptions(ExecuteSqlRequest.QueryOptions value)
public ExecuteSqlRequest.Builder setQueryOptions(ExecuteSqlRequest.QueryOptions value)Query optimizer configuration to use for the given query.
.google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
| Parameter | |
|---|---|
| Name | Description |
value | ExecuteSqlRequest.QueryOptions |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
setQueryOptions(ExecuteSqlRequest.QueryOptions.Builder builderForValue)
public ExecuteSqlRequest.Builder setQueryOptions(ExecuteSqlRequest.QueryOptions.Builder builderForValue)Query optimizer configuration to use for the given query.
.google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ExecuteSqlRequest.QueryOptions.Builder |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExecuteSqlRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
setRequestOptions(RequestOptions value)
public ExecuteSqlRequest.Builder setRequestOptions(RequestOptions value)Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Parameter | |
|---|---|
| Name | Description |
value | RequestOptions |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
setRequestOptions(RequestOptions.Builder builderForValue)
public ExecuteSqlRequest.Builder setRequestOptions(RequestOptions.Builder builderForValue)Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | RequestOptions.Builder |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
setResumeToken(ByteString value)
public ExecuteSqlRequest.Builder setResumeToken(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe resumeToken to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | This builder for chaining. |
setSeqno(long value)
public ExecuteSqlRequest.Builder setSeqno(long value)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;
| Parameter | |
|---|---|
| Name | Description |
value | longThe seqno to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | This builder for chaining. |
setSession(String value)
public ExecuteSqlRequest.Builder setSession(String value)Required. The session in which the SQL query should be performed.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe session to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | This builder for chaining. |
setSessionBytes(ByteString value)
public ExecuteSqlRequest.Builder setSessionBytes(ByteString value)Required. The session in which the SQL query should be performed.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for session to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | This builder for chaining. |
setSql(String value)
public ExecuteSqlRequest.Builder setSql(String value)Required. The SQL string.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sql to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | This builder for chaining. |
setSqlBytes(ByteString value)
public ExecuteSqlRequest.Builder setSqlBytes(ByteString value)Required. The SQL string.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sql to set. |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | This builder for chaining. |
setTransaction(TransactionSelector value)
public ExecuteSqlRequest.Builder setTransaction(TransactionSelector value)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;
| Parameter | |
|---|---|
| Name | Description |
value | TransactionSelector |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
setTransaction(TransactionSelector.Builder builderForValue)
public ExecuteSqlRequest.Builder setTransaction(TransactionSelector.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | TransactionSelector.Builder |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final ExecuteSqlRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExecuteSqlRequest.Builder | |