final case class PartitionQueryRequest(session: String = "", transaction: Option[TransactionSelector] = _root_.scala.None, sql: String = "", params: Option[Struct] = _root_.scala.None, paramTypes: Map[String, Type] = ..., partitionOptions: Option[PartitionOptions] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[PartitionQueryRequest] with Product with Serializable

The request for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]

session

Required. The session used to create the partitions.

transaction

Read only snapshot transactions are supported, read/write and single use transactions are not.

sql

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.

params

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.

paramTypes

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.

partitionOptions

Additional options that affect how many partitions are created.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[PartitionQueryRequest], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PartitionQueryRequest
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PartitionQueryRequest(session: String = "", transaction: Option[TransactionSelector] = _root_.scala.None, sql: String = "", params: Option[Struct] = _root_.scala.None, paramTypes: Map[String, Type] = ..., partitionOptions: Option[PartitionOptions] = _root_.scala.None, unknownFields: UnknownFieldSet = ...)

    session

    Required. The session used to create the partitions.

    transaction

    Read only snapshot transactions are supported, read/write and single use transactions are not.

    sql

    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.

    params

    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.

    paramTypes

    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.

    partitionOptions

    Additional options that affect how many partitions are created.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllParamTypes(__vs: Iterable[(String, Type)]): PartitionQueryRequest
  5. def addParamTypes(__vs: (String, Type)*): PartitionQueryRequest
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearParamTypes: PartitionQueryRequest
  8. def clearParams: PartitionQueryRequest
  9. def clearPartitionOptions: PartitionQueryRequest
  10. def clearTransaction: PartitionQueryRequest
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. def companion: PartitionQueryRequest.type
    Definition Classes
    PartitionQueryRequest → GeneratedMessage
  13. def discardUnknownFields: PartitionQueryRequest
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    PartitionQueryRequest → GeneratedMessage
  18. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    PartitionQueryRequest → GeneratedMessage
  19. def getParams: Struct
  20. def getPartitionOptions: PartitionOptions
  21. def getTransaction: TransactionSelector
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. val paramTypes: Map[String, Type]
  27. val params: Option[Struct]
  28. val partitionOptions: Option[PartitionOptions]
  29. def serializedSize: Int
    Definition Classes
    PartitionQueryRequest → GeneratedMessage
  30. val session: String
  31. val sql: String
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  34. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  35. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  36. def toProtoString: String
    Definition Classes
    PartitionQueryRequest → GeneratedMessage
  37. val transaction: Option[TransactionSelector]
  38. val unknownFields: UnknownFieldSet
  39. def update(ms: (Lens[PartitionQueryRequest, PartitionQueryRequest]) ⇒ scalapb.lenses.Mutation[PartitionQueryRequest]*): PartitionQueryRequest
    Definition Classes
    Updatable
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  43. def withParamTypes(__v: Map[String, Type]): PartitionQueryRequest
  44. def withParams(__v: Struct): PartitionQueryRequest
  45. def withPartitionOptions(__v: PartitionOptions): PartitionQueryRequest
  46. def withSession(__v: String): PartitionQueryRequest
  47. def withSql(__v: String): PartitionQueryRequest
  48. def withTransaction(__v: TransactionSelector): PartitionQueryRequest
  49. def withUnknownFields(__v: UnknownFieldSet): PartitionQueryRequest
  50. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  51. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    PartitionQueryRequest → GeneratedMessage
  52. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[PartitionQueryRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped