com.google.api.services.spanner.v1.model

Class PartitionQueryRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.PartitionQueryRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PartitionQueryRequest
extends com.google.api.client.json.GenericJson

The request for PartitionQuery

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
PartitionQueryRequest()

Method Summary

Modifier and Type	Method and Description
PartitionQueryRequest	clone()
Map<String,Object>	getParams() Parameter names and values that bind to placeholders in the SQL string.
Map<String,Type>	getParamTypes() It isn't 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.
String	getSql() Required.
TransactionSelector	getTransaction() Read-only snapshot transactions are supported, read and write and single-use transactions are not.
PartitionQueryRequest	set(String fieldName, Object value)
PartitionQueryRequest	setParams(Map<String,Object> params) Parameter names and values that bind to placeholders in the SQL string.
PartitionQueryRequest	setParamTypes(Map<String,Type> paramTypes) It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value.
PartitionQueryRequest	setPartitionOptions(PartitionOptions partitionOptions) Additional options that affect how many partitions are created.
PartitionQueryRequest	setSql(String sql) Required.
PartitionQueryRequest	setTransaction(TransactionSelector transaction) Read-only snapshot transactions are supported, read and write and single-use transactions are not.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

PartitionQueryRequest

public PartitionQueryRequest()

Method Detail

getParamTypes

public Map<String,Type> getParamTypes()

It isn't 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 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 for more information about SQL types.

Returns:

value or null for none

setParamTypes

public PartitionQueryRequest setParamTypes(Map<String,Type> paramTypes)

It isn't 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 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 for more information about SQL types.

Parameters:

paramTypes - paramTypes or null for none

getParams

public Map<String,Object> 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's an error to execute a SQL statement with unbound parameters.

Returns:

value or null for none

setParams

public PartitionQueryRequest setParams(Map<String,Object> params)

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's an error to execute a SQL statement with unbound parameters.

Parameters:

params - params or null for none

getPartitionOptions

public PartitionOptions getPartitionOptions()

Additional options that affect how many partitions are created.

Returns:

value or null for none

setPartitionOptions

public PartitionQueryRequest setPartitionOptions(PartitionOptions partitionOptions)

Additional options that affect how many partitions are created.

Parameters:

partitionOptions - partitionOptions or null for none

getSql

public String getSql()

Required. The query request to generate partitions for. The request fails if the query isn't root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as `INSERT`, `UPDATE`, or `DELETE`. Use `ExecuteStreamingSql` with a `PartitionedDml` transaction for large, partition-friendly DML operations.

Returns:

value or null for none

setSql

public PartitionQueryRequest setSql(String sql)

Required. The query request to generate partitions for. The request fails if the query isn't root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as `INSERT`, `UPDATE`, or `DELETE`. Use `ExecuteStreamingSql` with a `PartitionedDml` transaction for large, partition-friendly DML operations.

Parameters:

sql - sql or null for none

getTransaction

public TransactionSelector getTransaction()

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

Returns:

value or null for none

setTransaction

public PartitionQueryRequest setTransaction(TransactionSelector transaction)

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

Parameters:

transaction - transaction or null for none

set

public PartitionQueryRequest set(String fieldName,
                                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public PartitionQueryRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson