public final class ExecuteSqlRequest extends GeneratedMessageV3 implements ExecuteSqlRequestOrBuilder
The request for ExecuteSql and
ExecuteStreamingSql.
Protobuf type google.spanner.v1.ExecuteSqlRequest
Fields
PARAMS_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
Field Value
PARAM_TYPES_FIELD_NUMBER
public static final int PARAM_TYPES_FIELD_NUMBER
Field Value
PARTITION_TOKEN_FIELD_NUMBER
public static final int PARTITION_TOKEN_FIELD_NUMBER
Field Value
QUERY_MODE_FIELD_NUMBER
public static final int QUERY_MODE_FIELD_NUMBER
Field Value
QUERY_OPTIONS_FIELD_NUMBER
public static final int QUERY_OPTIONS_FIELD_NUMBER
Field Value
REQUEST_OPTIONS_FIELD_NUMBER
public static final int REQUEST_OPTIONS_FIELD_NUMBER
Field Value
RESUME_TOKEN_FIELD_NUMBER
public static final int RESUME_TOKEN_FIELD_NUMBER
Field Value
SEQNO_FIELD_NUMBER
public static final int SEQNO_FIELD_NUMBER
Field Value
SESSION_FIELD_NUMBER
public static final int SESSION_FIELD_NUMBER
Field Value
SQL_FIELD_NUMBER
public static final int SQL_FIELD_NUMBER
Field Value
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value
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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static ExecuteSqlRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public ExecuteSqlRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getParamTypes()
public Map<String,Type> getParamTypes()
Returns
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;
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;
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;
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;
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;
| 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;
getParserForType()
public Parser<ExecuteSqlRequest> getParserForType()
Returns
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;
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;
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;
| 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;
getQueryOptionsOrBuilder()
public ExecuteSqlRequest.QueryOptionsOrBuilder getQueryOptionsOrBuilder()
Query optimizer configuration to use for the given query.
.google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
getRequestOptions()
public RequestOptions getRequestOptions()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
getRequestOptionsOrBuilder()
public RequestOptionsOrBuilder getRequestOptionsOrBuilder()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
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;
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;
| Type | Description |
| long | The seqno.
|
getSerializedSize()
public int getSerializedSize()
Returns
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) = { ... }
| 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) = { ... }
getSql()
Required. The SQL string.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
getSqlBytes()
public ByteString getSqlBytes()
Required. The SQL string.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
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;
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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| 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;
| 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;
| 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;
| Type | Description |
| boolean | Whether the transaction field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static ExecuteSqlRequest.Builder newBuilder()
Returns
newBuilder(ExecuteSqlRequest prototype)
public static ExecuteSqlRequest.Builder newBuilder(ExecuteSqlRequest prototype)
Parameter
Returns
newBuilderForType()
public ExecuteSqlRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExecuteSqlRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static ExecuteSqlRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ExecuteSqlRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ExecuteSqlRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExecuteSqlRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ExecuteSqlRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExecuteSqlRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExecuteSqlRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ExecuteSqlRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ExecuteSqlRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ExecuteSqlRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ExecuteSqlRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExecuteSqlRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ExecuteSqlRequest> parser()
Returns
toBuilder()
public ExecuteSqlRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
