public interface ExecuteSqlRequestOrBuilder extends MessageOrBuilder
Modifier and Type | Method and Description |
---|---|
boolean |
containsParamTypes(java.lang.String key)
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value.
|
Struct |
getParams()
The SQL query string can contain parameter placeholders.
|
StructOrBuilder |
getParamsOrBuilder()
The SQL query string can contain parameter placeholders.
|
java.util.Map<java.lang.String,Type> |
getParamTypes()
Deprecated.
|
int |
getParamTypesCount()
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value.
|
java.util.Map<java.lang.String,Type> |
getParamTypesMap()
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value.
|
Type |
getParamTypesOrDefault(java.lang.String key,
Type defaultValue)
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value.
|
Type |
getParamTypesOrThrow(java.lang.String key)
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value.
|
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].
|
ByteString |
getResumeToken()
If this request is resuming a previously interrupted SQL query
execution, `resume_token` should be copied from the last
[PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption.
|
java.lang.String |
getSession()
Required.
|
ByteString |
getSessionBytes()
Required.
|
java.lang.String |
getSql()
Required.
|
ByteString |
getSqlBytes()
Required.
|
TransactionSelector |
getTransaction()
The transaction to use.
|
TransactionSelectorOrBuilder |
getTransactionOrBuilder()
The transaction to use.
|
boolean |
hasParams()
The SQL query string can contain parameter placeholders.
|
boolean |
hasTransaction()
The transaction to use.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
isInitialized
java.lang.String getSession()
Required. The session in which the SQL query should be performed.
string session = 1;
ByteString getSessionBytes()
Required. The session in which the SQL query should be performed.
string session = 1;
boolean hasTransaction()
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
.google.spanner.v1.TransactionSelector transaction = 2;
TransactionSelector getTransaction()
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
.google.spanner.v1.TransactionSelector transaction = 2;
TransactionSelectorOrBuilder getTransactionOrBuilder()
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
.google.spanner.v1.TransactionSelector transaction = 2;
java.lang.String getSql()
Required. The SQL query string.
string sql = 3;
ByteString getSqlBytes()
Required. The SQL query string.
string sql = 3;
boolean hasParams()
The SQL query 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 query 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;
Struct getParams()
The SQL query 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 query 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;
StructOrBuilder getParamsOrBuilder()
The SQL query 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 query 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;
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 query 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;
boolean containsParamTypes(java.lang.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 query 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;
@Deprecated java.util.Map<java.lang.String,Type> getParamTypes()
getParamTypesMap()
instead.java.util.Map<java.lang.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 query 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;
Type getParamTypesOrDefault(java.lang.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 query 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;
Type getParamTypesOrThrow(java.lang.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 query 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;
ByteString getResumeToken()
If this request is resuming a previously interrupted SQL query execution, `resume_token` should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new SQL query 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;
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;
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;
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;