Struct gcp_client::google::spanner::v1::PartitionReadRequest

pub struct PartitionReadRequest {
    pub session: String,
    pub transaction: Option<TransactionSelector>,
    pub table: String,
    pub index: String,
    pub columns: Vec<String>,
    pub key_set: Option<KeySet>,
    pub partition_options: Option<PartitionOptions>,
}

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

Fields

session: String

Required. The session used to create the partitions.

transaction: Option<TransactionSelector>

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

table: String

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

index: String

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.

columns: Vec<String>

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

key_set: Option<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.

partition_options: Option<PartitionOptions>

Additional options that affect how many partitions are created.

Trait Implementations

impl Clone for PartitionReadRequest

fn clone(&self) -> PartitionReadRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PartitionReadRequest

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for PartitionReadRequest

fn default() -> PartitionReadRequest

Returns the "default value" for a type.

impl Message for PartitionReadRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<PartitionReadRequest> for PartitionReadRequest

fn eq(&self, other: &PartitionReadRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PartitionReadRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for PartitionReadRequest