Class ExecuteSqlRequest.Builder (6.74.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
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
Overrides

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
Overrides

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
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecuteSqlRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExecuteSqlRequest.Builder
Overrides

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