ExecuteSqlRequestOrBuilder (Google Cloud Spanner Parent 6.25.1 API)

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

ExecuteSqlRequest, ExecuteSqlRequest.Builder
```
public interface ExecuteSqlRequestOrBuilder
extends MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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.
`Struct`	`getParams()` Parameter names and values that bind to placeholders in the SQL string.
`StructOrBuilder`	`getParamsOrBuilder()` Parameter names and values that bind to placeholders in the SQL string.
`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.
`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].
`ExecuteSqlRequest.QueryOptions`	`getQueryOptions()` Query optimizer configuration to use for the given query.
`ExecuteSqlRequest.QueryOptionsOrBuilder`	`getQueryOptionsOrBuilder()` Query optimizer configuration to use for the given query.
`RequestOptions`	`getRequestOptions()` Common options for this request.
`RequestOptionsOrBuilder`	`getRequestOptionsOrBuilder()` Common options for this request.
`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.
`ByteString`	`getSessionBytes()` Required.
`String`	`getSql()` Required.
`ByteString`	`getSqlBytes()` Required.
`TransactionSelector`	`getTransaction()` The transaction to use.
`TransactionSelectorOrBuilder`	`getTransactionOrBuilder()` The transaction to use.
`boolean`	`hasParams()` Parameter names and values that bind to placeholders in the SQL string.
`boolean`	`hasQueryOptions()` Query optimizer configuration to use for the given query.
`boolean`	`hasRequestOptions()` Common options for this request.
`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 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns:

The session.

getSessionBytes
```
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:

The bytes for session.

hasTransaction

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:: Whether the transaction field is set.

getTransaction

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:: The transaction.

getTransactionOrBuilder

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;

getSql
```
String getSql()
```
```
 Required. The SQL string.
 
```
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
Returns:

The sql.

getSqlBytes
```
ByteString getSqlBytes()
```
```
 Required. The SQL string.
 
```
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
Returns:

The bytes for sql.

hasParams

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:: Whether the params field is set.

getParams

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:: The params.

getParamsOrBuilder

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;