publicinterfacePartitionQueryRequestOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsParamTypes(String key)
publicabstractbooleancontainsParamTypes(Stringkey) 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;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getParamTypes() (deprecated)
publicabstractMap<String,Type>getParamTypes()Use #getParamTypesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Type> | |
getParamTypesCount()
publicabstractintgetParamTypesCount() 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;
| Returns | |
|---|---|
| Type | Description |
int | |
getParamTypesMap()
publicabstractMap<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;
| Returns | |
|---|---|
| Type | Description |
Map<String,Type> | |
getParamTypesOrDefault(String key, Type defaultValue)
publicabstractTypegetParamTypesOrDefault(Stringkey,TypedefaultValue) 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;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | Type |
| Returns | |
|---|---|
| Type | Description |
Type | |
getParamTypesOrThrow(String key)
publicabstractTypegetParamTypesOrThrow(Stringkey) 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;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Type | |
getParams()
publicabstractStructgetParams()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 | |
|---|---|
| Type | Description |
Struct | The params. |
getParamsOrBuilder()
publicabstractStructOrBuildergetParamsOrBuilder()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 | |
|---|---|
| Type | Description |
StructOrBuilder | |
getPartitionOptions()
publicabstractPartitionOptionsgetPartitionOptions()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Returns | |
|---|---|
| Type | Description |
PartitionOptions | The partitionOptions. |
getPartitionOptionsOrBuilder()
publicabstractPartitionOptionsOrBuildergetPartitionOptionsOrBuilder()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Returns | |
|---|---|
| Type | Description |
PartitionOptionsOrBuilder | |
getSession()
publicabstractStringgetSession()Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The session. |
getSessionBytes()
publicabstractByteStringgetSessionBytes()Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for session. |
getSql()
publicabstractStringgetSql()Required. The query request to generate partitions for. The request will fail if the query is not 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.
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.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String | The sql. |
getSqlBytes()
publicabstractByteStringgetSqlBytes()Required. The query request to generate partitions for. The request will fail if the query is not 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.
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.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sql. |
getTransaction()
publicabstractTransactionSelectorgetTransaction()Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Returns | |
|---|---|
| Type | Description |
TransactionSelector | The transaction. |
getTransactionOrBuilder()
publicabstractTransactionSelectorOrBuildergetTransactionOrBuilder()Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Returns | |
|---|---|
| Type | Description |
TransactionSelectorOrBuilder | |
hasParams()
publicabstractbooleanhasParams()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 | |
|---|---|
| Type | Description |
boolean | Whether the params field is set. |
hasPartitionOptions()
publicabstractbooleanhasPartitionOptions()Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the partitionOptions field is set. |
hasTransaction()
publicabstractbooleanhasTransaction()Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the transaction field is set. |
