Package com.google.spanner.v1

Class PartitionQueryRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PartitionQueryRequestOrBuilder, Serializable
    public final class PartitionQueryRequest
extends com.google.protobuf.GeneratedMessageV3
implements PartitionQueryRequestOrBuilder
     The request for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]
    Protobuf type google.spanner.v1.PartitionQueryRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getSession

        public String getSession()
         Required. The session used to create the partitions.
        string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getSession in interface PartitionQueryRequestOrBuilder
        Returns:
        The session.

      • getSessionBytes

        public com.google.protobuf.ByteString getSessionBytes()
         Required. The session used to create the partitions.
        string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getSessionBytes in interface PartitionQueryRequestOrBuilder
        Returns:
        The bytes for session.

      • hasTransaction

        public boolean hasTransaction()
         Read only snapshot transactions are supported, read/write and single use
 transactions are not.
        .google.spanner.v1.TransactionSelector transaction = 2;
        Specified by:
        hasTransaction in interface PartitionQueryRequestOrBuilder
        Returns:
        Whether the transaction field is set.

      • getSql

        public 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];
        Specified by:
        getSql in interface PartitionQueryRequestOrBuilder
        Returns:
        The sql.

      • getSqlBytes

        public com.google.protobuf.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];
        Specified by:
        getSqlBytes in interface PartitionQueryRequestOrBuilder
        Returns:
        The bytes for sql.

      • 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;
        Specified by:
        hasParams in interface PartitionQueryRequestOrBuilder
        Returns:
        Whether the params field is set.

      • getParams

        public com.google.protobuf.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;
        Specified by:
        getParams in interface PartitionQueryRequestOrBuilder
        Returns:
        The params.

      • getParamsOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getParamsOrBuilder in interface PartitionQueryRequestOrBuilder

      • getParamTypesCount

        public int getParamTypesCount()
        Description copied from interface: PartitionQueryRequestOrBuilder
         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;
        Specified by:
        getParamTypesCount in interface PartitionQueryRequestOrBuilder

      • containsParamTypes

        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][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;
        Specified by:
        containsParamTypes in interface PartitionQueryRequestOrBuilder

      • 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][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;
        Specified by:
        getParamTypesMap in interface PartitionQueryRequestOrBuilder

      • getParamTypesOrDefault

        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][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;
        Specified by:
        getParamTypesOrDefault in interface PartitionQueryRequestOrBuilder

      • getParamTypesOrThrow

        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][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;
        Specified by:
        getParamTypesOrThrow in interface PartitionQueryRequestOrBuilder

      • hasPartitionOptions

        public boolean hasPartitionOptions()
         Additional options that affect how many partitions are created.
        .google.spanner.v1.PartitionOptions partition_options = 6;
        Specified by:
        hasPartitionOptions in interface PartitionQueryRequestOrBuilder
        Returns:
        Whether the partitionOptions field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static PartitionQueryRequest parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PartitionQueryRequest parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PartitionQueryRequest parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PartitionQueryRequest parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PartitionQueryRequest parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PartitionQueryRequest parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public PartitionQueryRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public PartitionQueryRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected PartitionQueryRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<PartitionQueryRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public PartitionQueryRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder