public final class PartitionQueryRequest extends GeneratedMessageV3 implements PartitionQueryRequestOrBuilder
The request for PartitionQuery
Protobuf type google.spanner.v1.PartitionQueryRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
PARAMS_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARAM_TYPES_FIELD_NUMBER
public static final int PARAM_TYPES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARTITION_OPTIONS_FIELD_NUMBER
public static final int PARTITION_OPTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SESSION_FIELD_NUMBER
public static final int SESSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SQL_FIELD_NUMBER
public static final int SQL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static PartitionQueryRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PartitionQueryRequest.Builder newBuilder()
newBuilder(PartitionQueryRequest prototype)
public static PartitionQueryRequest.Builder newBuilder(PartitionQueryRequest prototype)
public static PartitionQueryRequest parseDelimitedFrom(InputStream input)
public static PartitionQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PartitionQueryRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PartitionQueryRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryRequest parseFrom(CodedInputStream input)
public static PartitionQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryRequest parseFrom(InputStream input)
public static PartitionQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PartitionQueryRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PartitionQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PartitionQueryRequest> parser()
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;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public PartitionQueryRequest getDefaultInstanceForType()
getParamTypes() (deprecated)
public Map<String,Type> getParamTypes()
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;
| Returns |
| Type |
Description |
int |
|
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;
| Parameters |
| Name |
Description |
key |
String
|
defaultValue |
Type
|
| Returns |
| Type |
Description |
Type |
|
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;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
Type |
|
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;
| Returns |
| 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()
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 |
| Type |
Description |
int |
|
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) = { ... }
| Returns |
| 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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for session.
|
getSql()
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()
public ByteString getSqlBytes()
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()
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;
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;
| Returns |
| 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;
| Returns |
| 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;
| Returns |
| Type |
Description |
boolean |
Whether the transaction field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PartitionQueryRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PartitionQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public PartitionQueryRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
