public final class PartitionQueryRequest extends GeneratedMessageV3 implements PartitionQueryRequestOrBuilder
The request for PartitionQuery
Protobuf type google.spanner.v1.PartitionQueryRequest
Fields
PARAMS_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
Field Value
PARAM_TYPES_FIELD_NUMBER
public static final int PARAM_TYPES_FIELD_NUMBER
Field Value
PARTITION_OPTIONS_FIELD_NUMBER
public static final int PARTITION_OPTIONS_FIELD_NUMBER
Field Value
SESSION_FIELD_NUMBER
public static final int SESSION_FIELD_NUMBER
Field Value
SQL_FIELD_NUMBER
public static final int SQL_FIELD_NUMBER
Field Value
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value
Methods
containsParamTypes(String key)
public 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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static PartitionQueryRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public PartitionQueryRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getParamTypes()
public Map<String,Type> getParamTypes()
Returns
getParamTypesCount()
public 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;
getParamTypesMap()
public 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;
getParamTypesOrDefault(String key, Type defaultValue)
public 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;
getParamTypesOrThrow(String key)
public 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;
getParams()
public 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 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;
getParserForType()
public Parser<PartitionQueryRequest> getParserForType()
Returns
Overrides
getPartitionOptions()
public PartitionOptions getPartitionOptions()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
getPartitionOptionsOrBuilder()
public PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSession()
public 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 ByteString getSessionBytes()
Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
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];
getSqlBytes()
public 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];
getTransaction()
public TransactionSelector getTransaction()
Read only snapshot transactions are supported, read/write and single use
transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
getTransactionOrBuilder()
public TransactionSelectorOrBuilder getTransactionOrBuilder()
Read only snapshot transactions are supported, read/write and single use
transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasParams()
public 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 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 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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static PartitionQueryRequest.Builder newBuilder()
Returns
newBuilder(PartitionQueryRequest prototype)
public static PartitionQueryRequest.Builder newBuilder(PartitionQueryRequest prototype)
Parameter
Returns
newBuilderForType()
public PartitionQueryRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PartitionQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static PartitionQueryRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PartitionQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PartitionQueryRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PartitionQueryRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PartitionQueryRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PartitionQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PartitionQueryRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PartitionQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PartitionQueryRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PartitionQueryRequest> parser()
Returns
toBuilder()
public PartitionQueryRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
