public final class PartitionQueryRequest extends GeneratedMessageV3 implements PartitionQueryRequestOrBuilder
The request for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]Protobuf type
google.spanner.v1.PartitionQueryRequest| Modifier and Type | Class and Description |
|---|---|
static class |
PartitionQueryRequest.Builder
The request for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameterAbstractMessageLite.InternalOneOfEnum| Modifier and Type | Field and Description |
|---|---|
static int |
PARAM_TYPES_FIELD_NUMBER |
static int |
PARAMS_FIELD_NUMBER |
static int |
PARTITION_OPTIONS_FIELD_NUMBER |
static int |
SESSION_FIELD_NUMBER |
static int |
SQL_FIELD_NUMBER |
static int |
TRANSACTION_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCode| Modifier and Type | Method and Description |
|---|---|
boolean |
containsParamTypes(String key)
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value.
|
boolean |
equals(Object obj) |
static PartitionQueryRequest |
getDefaultInstance() |
PartitionQueryRequest |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Struct |
getParams()
Parameter names and values that bind to placeholders in the SQL string.
|
StructOrBuilder |
getParamsOrBuilder()
Parameter names and values that bind to placeholders in the SQL string.
|
Map<String,Type> |
getParamTypes()
Deprecated.
|
int |
getParamTypesCount()
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value.
|
Map<String,Type> |
getParamTypesMap()
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value.
|
Type |
getParamTypesOrDefault(String key,
Type defaultValue)
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value.
|
Type |
getParamTypesOrThrow(String key)
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value.
|
Parser<PartitionQueryRequest> |
getParserForType() |
PartitionOptions |
getPartitionOptions()
Additional options that affect how many partitions are created.
|
PartitionOptionsOrBuilder |
getPartitionOptionsOrBuilder()
Additional options that affect how many partitions are created.
|
int |
getSerializedSize() |
String |
getSession()
Required.
|
ByteString |
getSessionBytes()
Required.
|
String |
getSql()
Required.
|
ByteString |
getSqlBytes()
Required.
|
TransactionSelector |
getTransaction()
Read only snapshot transactions are supported, read/write and single use
transactions are not.
|
TransactionSelectorOrBuilder |
getTransactionOrBuilder()
Read only snapshot transactions are supported, read/write and single use
transactions are not.
|
UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
boolean |
hasParams()
Parameter names and values that bind to placeholders in the SQL string.
|
boolean |
hasPartitionOptions()
Additional options that affect how many partitions are created.
|
boolean |
hasTransaction()
Read only snapshot transactions are supported, read/write and single use
transactions are not.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static PartitionQueryRequest.Builder |
newBuilder() |
static PartitionQueryRequest.Builder |
newBuilder(PartitionQueryRequest prototype) |
PartitionQueryRequest.Builder |
newBuilderForType() |
protected PartitionQueryRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) |
static PartitionQueryRequest |
parseDelimitedFrom(InputStream input) |
static PartitionQueryRequest |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static PartitionQueryRequest |
parseFrom(byte[] data) |
static PartitionQueryRequest |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static PartitionQueryRequest |
parseFrom(ByteBuffer data) |
static PartitionQueryRequest |
parseFrom(ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static PartitionQueryRequest |
parseFrom(ByteString data) |
static PartitionQueryRequest |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static PartitionQueryRequest |
parseFrom(CodedInputStream input) |
static PartitionQueryRequest |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static PartitionQueryRequest |
parseFrom(InputStream input) |
static PartitionQueryRequest |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<PartitionQueryRequest> |
parser() |
PartitionQueryRequest.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int SESSION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
public static final int SQL_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER
public static final int PARAM_TYPES_FIELD_NUMBER
public static final int PARTITION_OPTIONS_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class GeneratedMessageV3public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
internalGetMapField in class GeneratedMessageV3protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public String getSession()
Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getSession in interface PartitionQueryRequestOrBuilderpublic ByteString getSessionBytes()
Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getSessionBytes in interface PartitionQueryRequestOrBuilderpublic boolean hasTransaction()
Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;hasTransaction in interface PartitionQueryRequestOrBuilderpublic TransactionSelector getTransaction()
Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;getTransaction in interface PartitionQueryRequestOrBuilderpublic TransactionSelectorOrBuilder getTransactionOrBuilder()
Read only snapshot transactions are supported, read/write and single use transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;getTransactionOrBuilder in interface PartitionQueryRequestOrBuilderpublic 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][google.spanner.v1.Spanner.ExecuteStreamingSql] with a PartitionedDml transaction for large, partition-friendly DML operations.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];getSql in interface PartitionQueryRequestOrBuilderpublic 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][google.spanner.v1.Spanner.ExecuteStreamingSql] with a PartitionedDml transaction for large, partition-friendly DML operations.
string sql = 3 [(.google.api.field_behavior) = REQUIRED];getSqlBytes in interface PartitionQueryRequestOrBuilderpublic 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;hasParams in interface PartitionQueryRequestOrBuilderpublic 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;getParams in interface PartitionQueryRequestOrBuilderpublic 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;getParamsOrBuilder in interface PartitionQueryRequestOrBuilderpublic int getParamTypesCount()
PartitionQueryRequestOrBuilderIt 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][google.spanner.v1.PartitionQueryRequest.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][google.spanner.v1.Type] for more information about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;getParamTypesCount in interface PartitionQueryRequestOrBuilderpublic 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][google.spanner.v1.PartitionQueryRequest.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][google.spanner.v1.Type] for more information about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;containsParamTypes in interface PartitionQueryRequestOrBuilder@Deprecated public Map<String,Type> getParamTypes()
getParamTypesMap() instead.getParamTypes in interface PartitionQueryRequestOrBuilderpublic 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][google.spanner.v1.PartitionQueryRequest.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][google.spanner.v1.Type] for more information about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;getParamTypesMap in interface PartitionQueryRequestOrBuilderpublic 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][google.spanner.v1.PartitionQueryRequest.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][google.spanner.v1.Type] for more information about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;getParamTypesOrDefault in interface PartitionQueryRequestOrBuilderpublic 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][google.spanner.v1.PartitionQueryRequest.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][google.spanner.v1.Type] for more information about SQL types.
map<string, .google.spanner.v1.Type> param_types = 5;getParamTypesOrThrow in interface PartitionQueryRequestOrBuilderpublic boolean hasPartitionOptions()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;hasPartitionOptions in interface PartitionQueryRequestOrBuilderpublic PartitionOptions getPartitionOptions()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;getPartitionOptions in interface PartitionQueryRequestOrBuilderpublic PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 6;getPartitionOptionsOrBuilder in interface PartitionQueryRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static PartitionQueryRequest parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static PartitionQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static PartitionQueryRequest parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static PartitionQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static PartitionQueryRequest parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static PartitionQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static PartitionQueryRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static PartitionQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static PartitionQueryRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static PartitionQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static PartitionQueryRequest parseFrom(CodedInputStream input) throws IOException
IOExceptionpublic static PartitionQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic PartitionQueryRequest.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static PartitionQueryRequest.Builder newBuilder()
public static PartitionQueryRequest.Builder newBuilder(PartitionQueryRequest prototype)
public PartitionQueryRequest.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected PartitionQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static PartitionQueryRequest getDefaultInstance()
public static Parser<PartitionQueryRequest> parser()
public Parser<PartitionQueryRequest> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public PartitionQueryRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.