com.google.spanner.v1

Interface ExecuteSqlRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ExecuteSqlRequest, ExecuteSqlRequest.Builder

public interface ExecuteSqlRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsParamTypes(String key) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
com.google.protobuf.Struct	getParams() The SQL string can contain parameter placeholders.
com.google.protobuf.StructOrBuilder	getParamsOrBuilder() The SQL string can contain parameter placeholders.
Map<String,Type>	getParamTypes() Deprecated.
int	getParamTypesCount() It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Map<String,Type>	getParamTypesMap() It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Type	getParamTypesOrDefault(String key, Type defaultValue) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
Type	getParamTypesOrThrow(String key) It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.
com.google.protobuf.ByteString	getPartitionToken() If present, results will be restricted to the specified partition previously created using PartitionQuery().
ExecuteSqlRequest.QueryMode	getQueryMode() Used to control the amount of debugging information returned in [ResultSetStats][google.spanner.v1.ResultSetStats].
int	getQueryModeValue() Used to control the amount of debugging information returned in [ResultSetStats][google.spanner.v1.ResultSetStats].
com.google.protobuf.ByteString	getResumeToken() If this request is resuming a previously interrupted SQL statement execution, `resume_token` should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption.
long	getSeqno() A per-transaction sequence number used to identify this request.
String	getSession() Required.
com.google.protobuf.ByteString	getSessionBytes() Required.
String	getSql() Required.
com.google.protobuf.ByteString	getSqlBytes() Required.
TransactionSelector	getTransaction() The transaction to use.
TransactionSelectorOrBuilder	getTransactionOrBuilder() The transaction to use.
boolean	hasParams() The SQL string can contain parameter placeholders.
boolean	hasTransaction() The transaction to use.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSession

String getSession()

 Required. The session in which the SQL query should be performed.
 

string session = 1;

getSessionBytes

com.google.protobuf.ByteString getSessionBytes()

 Required. The session in which the SQL query should be performed.
 

string session = 1;

hasTransaction

boolean hasTransaction()

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.
 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 ReadWrite transaction. Single-use
 transactions are not supported (to avoid replay).  The caller must
 either supply an existing transaction ID or begin a new transaction.
 Partitioned DML requires an existing PartitionedDml transaction ID.
 

.google.spanner.v1.TransactionSelector transaction = 2;

getTransaction

TransactionSelector getTransaction()

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.
 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 ReadWrite transaction. Single-use
 transactions are not supported (to avoid replay).  The caller must
 either supply an existing transaction ID or begin a new transaction.
 Partitioned DML requires an existing PartitionedDml transaction ID.
 

.google.spanner.v1.TransactionSelector transaction = 2;

getTransactionOrBuilder

TransactionSelectorOrBuilder getTransactionOrBuilder()

 The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.
 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 ReadWrite transaction. Single-use
 transactions are not supported (to avoid replay).  The caller must
 either supply an existing transaction ID or begin a new transaction.
 Partitioned DML requires an existing PartitionedDml transaction ID.
 

.google.spanner.v1.TransactionSelector transaction = 2;

getSql

String getSql()

 Required. The SQL string.
 

string sql = 3;

getSqlBytes

com.google.protobuf.ByteString getSqlBytes()

 Required. The SQL string.
 

string sql = 3;

hasParams

boolean hasParams()

 The SQL string can contain parameter placeholders. A parameter
 placeholder consists of `'@'` followed by the parameter
 name. Parameter names consist of any combination of letters,
 numbers, and underscores.
 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 an SQL statement with unbound parameters.
 Parameter values are specified using `params`, which is a JSON
 object whose keys are parameter names, and whose values are the
 corresponding parameter values.
 

.google.protobuf.Struct params = 4;

getParams

com.google.protobuf.Struct getParams()

 The SQL string can contain parameter placeholders. A parameter
 placeholder consists of `'@'` followed by the parameter
 name. Parameter names consist of any combination of letters,
 numbers, and underscores.
 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 an SQL statement with unbound parameters.
 Parameter values are specified using `params`, which is a JSON
 object whose keys are parameter names, and whose values are the
 corresponding parameter values.
 

.google.protobuf.Struct params = 4;

getParamsOrBuilder

com.google.protobuf.StructOrBuilder getParamsOrBuilder()

 The SQL string can contain parameter placeholders. A parameter
 placeholder consists of `'@'` followed by the parameter
 name. Parameter names consist of any combination of letters,
 numbers, and underscores.
 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 an SQL statement with unbound parameters.
 Parameter values are specified using `params`, which is a JSON
 object whose keys are parameter names, and whose values are the
 corresponding parameter values.
 

.google.protobuf.Struct params = 4;

getParamTypesCount

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][google.spanner.v1.ExecuteSqlRequest.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][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

containsParamTypes

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][google.spanner.v1.ExecuteSqlRequest.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][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

getParamTypes

@Deprecated
Map<String,Type> getParamTypes()

Deprecated.

Use getParamTypesMap() instead.

getParamTypesMap

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][google.spanner.v1.ExecuteSqlRequest.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][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

getParamTypesOrDefault

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][google.spanner.v1.ExecuteSqlRequest.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][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

getParamTypesOrThrow

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][google.spanner.v1.ExecuteSqlRequest.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][google.spanner.v1.Type] for more information
 about SQL types.
 

map<string, .google.spanner.v1.Type> param_types = 5;

getResumeToken

com.google.protobuf.ByteString getResumeToken()

 If this request is resuming a previously interrupted SQL statement
 execution, `resume_token` should be copied from the last
 [PartialResultSet][google.spanner.v1.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;

getQueryModeValue

int getQueryModeValue()

 Used to control the amount of debugging information returned in
 [ResultSetStats][google.spanner.v1.ResultSetStats]. If
 [partition_token][google.spanner.v1.ExecuteSqlRequest.partition_token] is
 set, [query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] can only
 be set to
 [QueryMode.NORMAL][google.spanner.v1.ExecuteSqlRequest.QueryMode.NORMAL].
 

.google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7;

getQueryMode

ExecuteSqlRequest.QueryMode getQueryMode()

 Used to control the amount of debugging information returned in
 [ResultSetStats][google.spanner.v1.ResultSetStats]. If
 [partition_token][google.spanner.v1.ExecuteSqlRequest.partition_token] is
 set, [query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] can only
 be set to
 [QueryMode.NORMAL][google.spanner.v1.ExecuteSqlRequest.QueryMode.NORMAL].
 

.google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7;

getPartitionToken

com.google.protobuf.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;

getSeqno

long getSeqno()

 A per-transaction sequence number used to identify this request. This
 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;