Class ExecuteSqlRequest (6.72.0) 

public final class ExecuteSqlRequest extends GeneratedMessageV3 implements ExecuteSqlRequestOrBuilder

The request for ExecuteSql and ExecuteStreamingSql.

Protobuf type google.spanner.v1.ExecuteSqlRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExecuteSqlRequest

Static Fields

DATA_BOOST_ENABLED_FIELD_NUMBER

public static final int DATA_BOOST_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

DIRECTED_READ_OPTIONS_FIELD_NUMBER

public static final int DIRECTED_READ_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER
Field Value
Type Description
int

PARAM_TYPES_FIELD_NUMBER

public static final int PARAM_TYPES_FIELD_NUMBER
Field Value
Type Description
int

PARTITION_TOKEN_FIELD_NUMBER

public static final int PARTITION_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

QUERY_MODE_FIELD_NUMBER

public static final int QUERY_MODE_FIELD_NUMBER
Field Value
Type Description
int

QUERY_OPTIONS_FIELD_NUMBER

public static final int QUERY_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_OPTIONS_FIELD_NUMBER

public static final int REQUEST_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

RESUME_TOKEN_FIELD_NUMBER

public static final int RESUME_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

SEQNO_FIELD_NUMBER

public static final int SEQNO_FIELD_NUMBER
Field Value
Type Description
int

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER
Field Value
Type Description
int

SQL_FIELD_NUMBER

public static final int SQL_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExecuteSqlRequest getDefaultInstance()
Returns
Type Description
ExecuteSqlRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExecuteSqlRequest.Builder newBuilder()
Returns
Type Description
ExecuteSqlRequest.Builder

newBuilder(ExecuteSqlRequest prototype)

public static ExecuteSqlRequest.Builder newBuilder(ExecuteSqlRequest prototype)
Parameter
Name Description
prototype ExecuteSqlRequest
Returns
Type Description
ExecuteSqlRequest.Builder

parseDelimitedFrom(InputStream input)

public static ExecuteSqlRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExecuteSqlRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecuteSqlRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecuteSqlRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExecuteSqlRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExecuteSqlRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecuteSqlRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteSqlRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExecuteSqlRequest> parser()
Returns
Type Description
Parser<ExecuteSqlRequest>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

getDirectedReadOptions()

public DirectedReadOptions getDirectedReadOptions()

Directed read options for this request.

.google.spanner.v1.DirectedReadOptions directed_read_options = 15;

Returns
Type Description
DirectedReadOptions

The directedReadOptions.

getDirectedReadOptionsOrBuilder()

public DirectedReadOptionsOrBuilder getDirectedReadOptionsOrBuilder()

Directed read options for this request.

.google.spanner.v1.DirectedReadOptions directed_read_options = 15;

Returns
Type Description
DirectedReadOptionsOrBuilder

getParamTypes() (deprecated)

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.

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

getParserForType()

public Parser<ExecuteSqlRequest> getParserForType()
Returns
Type Description
Parser<ExecuteSqlRequest>
Overrides

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.

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.

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExecuteSqlRequest.Builder newBuilderForType()
Returns
Type Description
ExecuteSqlRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExecuteSqlRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExecuteSqlRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExecuteSqlRequest.Builder toBuilder()
Returns
Type Description
ExecuteSqlRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException