All Superinterfaces:

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

All Known Implementing Classes:

PartitionQueryRequest, PartitionQueryRequest.Builder
```
public interface PartitionQueryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	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()`	Parameter names and values that bind to placeholders in the SQL string.
`com.google.protobuf.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.
`PartitionOptions`	`getPartitionOptions()`	Additional options that affect how many partitions are created.
`PartitionOptionsOrBuilder`	`getPartitionOptionsOrBuilder()`	Additional options that affect how many partitions are created.
`String`	`getSession()`	Required.
`com.google.protobuf.ByteString`	`getSessionBytes()`	Required.
`String`	`getSql()`	Required.
`com.google.protobuf.ByteString`	`getSqlBytes()`	Required.
`TransactionSelector`	`getTransaction()`	Read only snapshot transactions are supported, read/write and single use transactions are not.
`TransactionSelectorOrBuilder`	`getTransactionOrBuilder()`	Read only snapshot transactions are supported, read/write and single use transactions are not.
`boolean`	`hasParams()`	Parameter names and values that bind to placeholders in the SQL string.
`boolean`	`hasPartitionOptions()`	Additional options that affect how many partitions are created.
`boolean`	`hasTransaction()`	Read only snapshot transactions are supported, read/write and single use transactions are not.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getSession
```
String getSession()
```
```
 Required. The session used to create the partitions.
 
```
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns:

The session.

getSessionBytes
```
com.google.protobuf.ByteString getSessionBytes()
```
```
 Required. The session used to create the partitions.
 
```
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns:

The bytes for session.

hasTransaction

boolean hasTransaction()

 Read only snapshot transactions are supported, read/write and single use
 transactions are not.

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

Returns:: Whether the transaction field is set.

getTransaction

TransactionSelector getTransaction()

 Read only snapshot transactions are supported, read/write and single use
 transactions are not.

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

Returns:: The transaction.

getTransactionOrBuilder

TransactionSelectorOrBuilder getTransactionOrBuilder()

 Read only snapshot transactions are supported, read/write and single use
 transactions are not.

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

getSql

String getSql()

 Required. The query request to generate partitions for. The request will fail if
 the query is not root partitionable. The query plan of a root
 partitionable query has a single distributed union operator. A distributed
 union operator conceptually divides one or more tables into multiple
 splits, remotely evaluates a subquery independently on each split, and
 then unions all results.

 This must not contain DML commands, such as INSERT, UPDATE, or
 DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a
 PartitionedDml transaction for large, partition-friendly DML operations.

string sql = 3 [(.google.api.field_behavior) = REQUIRED];

Returns:: The sql.

getSqlBytes

com.google.protobuf.ByteString getSqlBytes()

 Required. The query request to generate partitions for. The request will fail if
 the query is not root partitionable. The query plan of a root
 partitionable query has a single distributed union operator. A distributed
 union operator conceptually divides one or more tables into multiple
 splits, remotely evaluates a subquery independently on each split, and
 then unions all results.

 This must not contain DML commands, such as INSERT, UPDATE, or
 DELETE. Use [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] with a
 PartitionedDml transaction for large, partition-friendly DML operations.

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 can contain
 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 a SQL statement with unbound parameters.

.google.protobuf.Struct params = 4;

Returns:: Whether the params field is set.

getParams

com.google.protobuf.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 can contain
 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 a SQL statement with unbound parameters.

.google.protobuf.Struct params = 4;

Returns:: The params.

getParamsOrBuilder

com.google.protobuf.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 can contain
 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 a SQL statement with unbound parameters.

.google.protobuf.Struct params = 4;