final case class ReadRequest(session: String = "", transaction: Option[TransactionSelector] = _root_.scala.None, table: String = "", index: String = "", columns: Seq[String] = _root_.scala.Seq.empty, keySet: Option[KeySet] = _root_.scala.None, limit: Long = 0L, resumeToken: ByteString = ..., partitionToken: ByteString = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ReadRequest] with Product with Serializable

The request for [Read][google.spanner.v1.Spanner.Read] and [StreamingRead][google.spanner.v1.Spanner.StreamingRead].

session

Required. The session in which the read should be performed.

transaction

The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.

table

Required. The name of the table in the database to be read.

index

If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.

columns

Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.

keySet

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is not empty, rows will be yielded in an unspecified order. It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

limit

If greater than zero, only the first limit rows are yielded. If limit is zero, the default is no limit. A limit cannot be specified if partition_token is set.

resumeToken

If this request is resuming a previously interrupted read, resume_token should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token.

partitionToken

If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[ReadRequest], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReadRequest
  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 ReadRequest(session: String = "", transaction: Option[TransactionSelector] = _root_.scala.None, table: String = "", index: String = "", columns: Seq[String] = _root_.scala.Seq.empty, keySet: Option[KeySet] = _root_.scala.None, limit: Long = 0L, resumeToken: ByteString = ..., partitionToken: ByteString = ..., unknownFields: UnknownFieldSet = ...)

    session

    Required. The session in which the read should be performed.

    transaction

    The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.

    table

    Required. The name of the table in the database to be read.

    index

    If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.

    columns

    Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.

    keySet

    Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is not empty, rows will be yielded in an unspecified order. It is not an error for the key_set to name rows that do not exist in the database. Read yields nothing for nonexistent rows.

    limit

    If greater than zero, only the first limit rows are yielded. If limit is zero, the default is no limit. A limit cannot be specified if partition_token is set.

    resumeToken

    If this request is resuming a previously interrupted read, resume_token should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token.

    partitionToken

    If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.

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 addAllColumns(__vs: Iterable[String]): ReadRequest
  5. def addColumns(__vs: String*): ReadRequest
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearColumns: ReadRequest
  8. def clearKeySet: ReadRequest
  9. def clearTransaction: ReadRequest
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. val columns: Seq[String]
  12. def companion: ReadRequest.type
    Definition Classes
    ReadRequest → GeneratedMessage
  13. def discardUnknownFields: ReadRequest
  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
    ReadRequest → GeneratedMessage
  18. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ReadRequest → GeneratedMessage
  19. def getKeySet: KeySet
  20. def getTransaction: TransactionSelector
  21. val index: String
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. val keySet: Option[KeySet]
  24. val limit: Long
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. val partitionToken: ByteString
  29. val resumeToken: ByteString
  30. def serializedSize: Int
    Definition Classes
    ReadRequest → GeneratedMessage
  31. val session: String
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. val table: String
  34. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  35. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  36. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  37. def toProtoString: String
    Definition Classes
    ReadRequest → GeneratedMessage
  38. val transaction: Option[TransactionSelector]
  39. val unknownFields: UnknownFieldSet
  40. def update(ms: (Lens[ReadRequest, ReadRequest]) ⇒ scalapb.lenses.Mutation[ReadRequest]*): ReadRequest
    Definition Classes
    Updatable
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  44. def withColumns(__v: Seq[String]): ReadRequest
  45. def withIndex(__v: String): ReadRequest
  46. def withKeySet(__v: KeySet): ReadRequest
  47. def withLimit(__v: Long): ReadRequest
  48. def withPartitionToken(__v: ByteString): ReadRequest
  49. def withResumeToken(__v: ByteString): ReadRequest
  50. def withSession(__v: String): ReadRequest
  51. def withTable(__v: String): ReadRequest
  52. def withTransaction(__v: TransactionSelector): ReadRequest
  53. def withUnknownFields(__v: UnknownFieldSet): ReadRequest
  54. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  55. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ReadRequest → GeneratedMessage
  56. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[ReadRequest]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped