public interface PartitionQueryRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsParamTypes(String key)
public abstract boolean containsParamTypes(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 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.
map<string, .google.spanner.v1.Type> param_types = 5;
| Name | Description |
| key | String |
| Type | Description |
| boolean |
getParamTypes()
public abstract Map<String,Type> getParamTypes()Use #getParamTypesMap() instead.
| Type | Description |
| Map<String,Type> |
getParamTypesCount()
public abstract 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 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.
map<string, .google.spanner.v1.Type> param_types = 5;
| Type | Description |
| int |
getParamTypesMap()
public abstract Map<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 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.
map<string, .google.spanner.v1.Type> param_types = 5;
| Type | Description |
| Map<String,Type> |
getParamTypesOrDefault(String key, Type defaultValue)
public abstract Type getParamTypesOrDefault(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 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.
map<string, .google.spanner.v1.Type> param_types = 5;
| Name | Description |
| key | String |
| defaultValue | Type |
| Type | Description |
| Type |
getParamTypesOrThrow(String key)
public abstract Type getParamTypesOrThrow(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 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.
map<string, .google.spanner.v1.Type> param_types = 5;
| Name | Description |
| key | String |
| Type | Description |
| Type |
getParams()
public abstract 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;
| Type | Description |
| Struct | The params. |
getParamsOrBuilder()
public abstract 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;
| Type | Description |
| StructOrBuilder |
getPartitionOptions()
public abstract PartitionOptions getPartitionOptions()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Type | Description |
| PartitionOptions | The partitionOptions. |
getPartitionOptionsOrBuilder()
public abstract PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Type | Description |
| PartitionOptionsOrBuilder |
getSession()
public abstract String getSession()Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The session. |
getSessionBytes()
public abstract ByteString getSessionBytes()Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| ByteString | The bytes for session. |
getSql()
public abstract 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 with a PartitionedDml transaction for large, partition-friendly DML operations.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The sql. |
getSqlBytes()
public abstract 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 with a PartitionedDml transaction for large, partition-friendly DML operations.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for sql. |
getTransaction()
public abstract TransactionSelector getTransaction()Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Type | Description |
| TransactionSelector | The transaction. |
getTransactionOrBuilder()
public abstract TransactionSelectorOrBuilder getTransactionOrBuilder()Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Type | Description |
| TransactionSelectorOrBuilder |
hasParams()
public abstract 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;
| Type | Description |
| boolean | Whether the params field is set. |
hasPartitionOptions()
public abstract boolean hasPartitionOptions()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Type | Description |
| boolean | Whether the partitionOptions field is set. |
hasTransaction()
public abstract boolean hasTransaction()Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Type | Description |
| boolean | Whether the transaction field is set. |