PartitionReadRequest

com.google.spanner.v1.spanner.PartitionReadRequest
See thePartitionReadRequest companion object
final case class PartitionReadRequest(session: String, transaction: Option[TransactionSelector], table: String, index: String, columns: Seq[String], keySet: Option[KeySet], partitionOptions: Option[PartitionOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[PartitionReadRequest]

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

Value parameters

columns

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

index

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

keySet

Required. key_set identifies the rows to be yielded. key_set names the primary keys of the rows in [table][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index] is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names index keys in [index][google.spanner.v1.PartitionReadRequest.index]. 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.

partitionOptions

Additional options that affect how many partitions are created.

session

Required. The session used to create the partitions.

table

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

transaction

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

Attributes

Companion
object
Source
PartitionReadRequest.scala
Graph
Supertypes
trait Updatable[PartitionReadRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addAllColumns(`__vs`: Iterable[String]): PartitionReadRequest

Attributes

Source
PartitionReadRequest.scala
def addColumns(`__vs`: String*): PartitionReadRequest

Attributes

Source
PartitionReadRequest.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
PartitionReadRequest.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
PartitionReadRequest.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
PartitionReadRequest.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
PartitionReadRequest.scala
def withColumns(`__v`: Seq[String]): PartitionReadRequest

Attributes

Source
PartitionReadRequest.scala
def withIndex(`__v`: String): PartitionReadRequest

Attributes

Source
PartitionReadRequest.scala
def withSession(`__v`: String): PartitionReadRequest

Attributes

Source
PartitionReadRequest.scala
def withTable(`__v`: String): PartitionReadRequest

Attributes

Source
PartitionReadRequest.scala
def withUnknownFields(`__v`: UnknownFieldSet): PartitionReadRequest

Attributes

Source
PartitionReadRequest.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
PartitionReadRequest.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala