com.google.spanner.v1

Interface PartitionQueryRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

PartitionQueryRequest, PartitionQueryRequest.Builder

public interface PartitionQueryRequestOrBuilder
extends MessageOrBuilder

Method Summary

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.
PartitionOptions	getPartitionOptions() Additional options that affect how many partitions are created.
PartitionOptionsOrBuilder	getPartitionOptionsOrBuilder() Additional options that affect how many partitions are created.
java.lang.String	getSession() Required.
ByteString	getSessionBytes() Required.
java.lang.String	getSql() The query request to generate partitions for.
ByteString	getSqlBytes() The query request to generate partitions for.
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() The SQL query string can contain parameter placeholders.
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.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

java.lang.String getSession()

 Required. The session used to create the partitions.
 

string session = 1;

getSessionBytes

ByteString getSessionBytes()

 Required. The session used to create the partitions.
 

string session = 1;

hasTransaction

boolean hasTransaction()

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

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

getTransaction

TransactionSelector getTransaction()

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

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

getTransactionOrBuilder

TransactionSelectorOrBuilder getTransactionOrBuilder()

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

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

getSql

java.lang.String getSql()

 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.
 

string sql = 3;

getSqlBytes

ByteString getSqlBytes()

 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.
 

string sql = 3;

hasParams

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;

getParams

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;

getParamsOrBuilder

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;

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.PartitionQueryRequest.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;

containsParamTypes

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.PartitionQueryRequest.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;

getParamTypes

@Deprecated
java.util.Map<java.lang.String,Type> getParamTypes()

Deprecated.

Use getParamTypesMap() instead.

getParamTypesMap

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.PartitionQueryRequest.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;

getParamTypesOrDefault

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.PartitionQueryRequest.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;

getParamTypesOrThrow

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.PartitionQueryRequest.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;

hasPartitionOptions

boolean hasPartitionOptions()

 Additional options that affect how many partitions are created.
 

.google.spanner.v1.PartitionOptions partition_options = 6;

getPartitionOptions

PartitionOptions getPartitionOptions()

 Additional options that affect how many partitions are created.
 

.google.spanner.v1.PartitionOptions partition_options = 6;

getPartitionOptionsOrBuilder

PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()

 Additional options that affect how many partitions are created.
 

.google.spanner.v1.PartitionOptions partition_options = 6;