Class ExecuteSqlRequest.Builder (6.54.0)

public static final class ExecuteSqlRequest.Builder extends GeneratedMessageV3.Builder<ExecuteSqlRequest.Builder> implements ExecuteSqlRequestOrBuilder

The request for ExecuteSql and ExecuteStreamingSql.

Protobuf type google.spanner.v1.ExecuteSqlRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExecuteSqlRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExecuteSqlRequest.Builder
Overrides

build()

public ExecuteSqlRequest build()
Returns
TypeDescription
ExecuteSqlRequest

buildPartial()

public ExecuteSqlRequest buildPartial()
Returns
TypeDescription
ExecuteSqlRequest

clear()

public ExecuteSqlRequest.Builder clear()
Returns
TypeDescription
ExecuteSqlRequest.Builder
Overrides

clearDataBoostEnabled()

public ExecuteSqlRequest.Builder clearDataBoostEnabled()

If this is for a partitioned query and this field is set to true, the request will be executed via Spanner independent compute resources.

If the field is set to true but the request does not set partition_token, the API will return an INVALID_ARGUMENT error.

bool data_boost_enabled = 16;

Returns
TypeDescription
ExecuteSqlRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ExecuteSqlRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExecuteSqlRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecuteSqlRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ExecuteSqlRequest.Builder
Overrides

clearParamTypes()

public ExecuteSqlRequest.Builder clearParamTypes()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ExecuteSqlRequest.Builder

clearRequestOptions()

public ExecuteSqlRequest.Builder clearRequestOptions()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 11;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ExecuteSqlRequest.Builder

This builder for chaining.

clearSql()

public ExecuteSqlRequest.Builder clearSql()

Required. The SQL string.

string sql = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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
TypeDescription
ExecuteSqlRequest.Builder

clone()

public ExecuteSqlRequest.Builder clone()
Returns
TypeDescription
ExecuteSqlRequest.Builder
Overrides

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
NameDescription
keyString
Returns
TypeDescription
boolean

getDataBoostEnabled()

public boolean getDataBoostEnabled()

If this is for a partitioned query and this field is set to true, the request will be executed via Spanner independent compute resources.

If the field is set to true but the request does not set partition_token, the API will return an INVALID_ARGUMENT error.

bool data_boost_enabled = 16;

Returns
TypeDescription
boolean

The dataBoostEnabled.

getDefaultInstanceForType()

public ExecuteSqlRequest getDefaultInstanceForType()
Returns
TypeDescription
ExecuteSqlRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMutableParamTypes()

public Map<String,Type> getMutableParamTypes()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Type>

getParamTypes()

public Map<String,Type> getParamTypes()

Use #getParamTypesMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueType
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ExecuteSqlRequest.QueryOptionsOrBuilder

getRequestOptions()

public RequestOptions getRequestOptions()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 11;

Returns
TypeDescription
RequestOptions

The requestOptions.

getRequestOptionsBuilder()

public RequestOptions.Builder getRequestOptionsBuilder()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 11;

Returns
TypeDescription
RequestOptions.Builder

getRequestOptionsOrBuilder()

public RequestOptionsOrBuilder getRequestOptionsOrBuilder()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 11;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for session.

getSql()

public String getSql()

Required. The SQL string.

string sql = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The sql.

getSqlBytes()

public ByteString getSqlBytes()

Required. The SQL string.

string sql = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TransactionSelectorOrBuilder

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
TypeDescription
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
TypeDescription
boolean

Whether the queryOptions field is set.

hasRequestOptions()

public boolean hasRequestOptions()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 11;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the transaction field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExecuteSqlRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecuteSqlRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExecuteSqlRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ExecuteSqlRequest.Builder
Overrides

mergeFrom(ExecuteSqlRequest other)

public ExecuteSqlRequest.Builder mergeFrom(ExecuteSqlRequest other)
Parameter
NameDescription
otherExecuteSqlRequest
Returns
TypeDescription
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
NameDescription
valueStruct
Returns
TypeDescription
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
NameDescription
valueExecuteSqlRequest.QueryOptions
Returns
TypeDescription
ExecuteSqlRequest.Builder

mergeRequestOptions(RequestOptions value)

public ExecuteSqlRequest.Builder mergeRequestOptions(RequestOptions value)

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 11;

Parameter
NameDescription
valueRequestOptions
Returns
TypeDescription
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
NameDescription
valueTransactionSelector
Returns
TypeDescription
ExecuteSqlRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExecuteSqlRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExecuteSqlRequest.Builder
Overrides

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
NameDescription
valuesMap<String,Type>
Returns
TypeDescription
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
NameDescription
keyString
valueType
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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 will be executed via Spanner independent compute resources.

If the field is set to true but the request does not set partition_token, the API will return an INVALID_ARGUMENT error.

bool data_boost_enabled = 16;

Parameter
NameDescription
valueboolean

The dataBoostEnabled to set.

Returns
TypeDescription
ExecuteSqlRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ExecuteSqlRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExecuteSqlRequest.Builder
Overrides

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
NameDescription
valueStruct
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueByteString

The partitionToken to set.

Returns
TypeDescription
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
NameDescription
valueExecuteSqlRequest.QueryMode

The queryMode to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for queryMode to set.

Returns
TypeDescription
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
NameDescription
valueExecuteSqlRequest.QueryOptions
Returns
TypeDescription
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
NameDescription
builderForValueExecuteSqlRequest.QueryOptions.Builder
Returns
TypeDescription
ExecuteSqlRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExecuteSqlRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ExecuteSqlRequest.Builder
Overrides

setRequestOptions(RequestOptions value)

public ExecuteSqlRequest.Builder setRequestOptions(RequestOptions value)

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 11;

Parameter
NameDescription
valueRequestOptions
Returns
TypeDescription
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
NameDescription
builderForValueRequestOptions.Builder
Returns
TypeDescription
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
NameDescription
valueByteString

The resumeToken to set.

Returns
TypeDescription
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
NameDescription
valuelong

The seqno to set.

Returns
TypeDescription
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
NameDescription
valueString

The session to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for session to set.

Returns
TypeDescription
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
NameDescription
valueString

The sql to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for sql to set.

Returns
TypeDescription
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
NameDescription
valueTransactionSelector
Returns
TypeDescription
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
NameDescription
builderForValueTransactionSelector.Builder
Returns
TypeDescription
ExecuteSqlRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ExecuteSqlRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExecuteSqlRequest.Builder
Overrides