Package com.google.spanner.v1

Interface PartitionQueryRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PartitionQueryRequest, PartitionQueryRequest.Builder
@Generated public interface PartitionQueryRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getSession

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

    • getSessionBytes

      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) = { ... }
      Returns:
      The bytes for session.

    • hasTransaction

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

    • getTransaction

      TransactionSelector getTransaction()
       Read-only snapshot transactions are supported, read and write and
 single-use transactions are not.
      .google.spanner.v1.TransactionSelector transaction = 2;
      Returns:
      The transaction.

    • getTransactionOrBuilder

      TransactionSelectorOrBuilder getTransactionOrBuilder()
       Read-only snapshot transactions are supported, read and write and
 single-use transactions are not.
      .google.spanner.v1.TransactionSelector transaction = 2;

    • getSql

      String getSql()
       Required. The query request to generate partitions for. The request fails
 if the query isn't 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](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel).

 The query request 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];
      Returns:
      The sql.

    • getSqlBytes

      com.google.protobuf.ByteString getSqlBytes()
       Required. The query request to generate partitions for. The request fails
 if the query isn't 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](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel).

 The query request 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];
      Returns:
      The bytes for sql.

    • hasParams

      boolean hasParams()
       Optional. 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's an error to execute a SQL statement with unbound parameters.
      .google.protobuf.Struct params = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the params field is set.

    • getParams

      com.google.protobuf.Struct getParams()
       Optional. 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's an error to execute a SQL statement with unbound parameters.
      .google.protobuf.Struct params = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The params.

    • getParamsOrBuilder

      com.google.protobuf.StructOrBuilder getParamsOrBuilder()
       Optional. 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's an error to execute a SQL statement with unbound parameters.
      .google.protobuf.Struct params = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getParamTypesCount

      int getParamTypesCount()
       Optional. It isn't 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 [(.google.api.field_behavior) = OPTIONAL];

    • containsParamTypes

      boolean containsParamTypes(String key)
       Optional. It isn't 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 [(.google.api.field_behavior) = OPTIONAL];

    • getParamTypes

      @Deprecated Map<String,Type> getParamTypes()
      Deprecated.
      Use getParamTypesMap() instead.

    • getParamTypesMap

      Map<String,Type> getParamTypesMap()
       Optional. It isn't 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 [(.google.api.field_behavior) = OPTIONAL];

    • getParamTypesOrDefault

      Type getParamTypesOrDefault(String key, Type defaultValue)
       Optional. It isn't 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 [(.google.api.field_behavior) = OPTIONAL];

    • getParamTypesOrThrow

      Type getParamTypesOrThrow(String key)
       Optional. It isn't 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 [(.google.api.field_behavior) = OPTIONAL];

    • hasPartitionOptions

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

    • getPartitionOptions

      PartitionOptions getPartitionOptions()
       Additional options that affect how many partitions are created.
      .google.spanner.v1.PartitionOptions partition_options = 6;
      Returns:
      The partitionOptions.

    • getPartitionOptionsOrBuilder

      PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()
       Additional options that affect how many partitions are created.
      .google.spanner.v1.PartitionOptions partition_options = 6;