Struct google_api_proto::google::spanner::v1::ReadRequest
source · pub struct ReadRequest {
pub session: String,
pub transaction: Option<TransactionSelector>,
pub table: String,
pub index: String,
pub columns: Vec<String>,
pub key_set: Option<KeySet>,
pub limit: i64,
pub resume_token: Bytes,
pub partition_token: Bytes,
pub request_options: Option<RequestOptions>,
pub directed_read_options: Option<DirectedReadOptions>,
pub data_boost_enabled: bool,
}
Expand description
The request for [Read][google.spanner.v1.Spanner.Read] and [StreamingRead][google.spanner.v1.Spanner.StreamingRead].
Fields§
§session: String
Required. The session in which the read should be performed.
transaction: Option<TransactionSelector>
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
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.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: Vec<String>
Required. The columns of [table][google.spanner.v1.ReadRequest.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.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: i64
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.
resume_token: Bytes
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.
partition_token: Bytes
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.
request_options: Option<RequestOptions>
Common options for this request.
directed_read_options: Option<DirectedReadOptions>
Directed read options for this request.
data_boost_enabled: bool
If this is for a partitioned read and this field is set to true
, the
request is executed with Spanner Data Boost independent compute resources.
If the field is set to true
but the request does not set
partition_token
, the API returns an INVALID_ARGUMENT
error.
Trait Implementations§
source§impl Clone for ReadRequest
impl Clone for ReadRequest
source§fn clone(&self) -> ReadRequest
fn clone(&self) -> ReadRequest
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ReadRequest
impl Debug for ReadRequest
source§impl Default for ReadRequest
impl Default for ReadRequest
source§impl Message for ReadRequest
impl Message for ReadRequest
source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
source§fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
source§fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
source§fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
source§fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
source§fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
source§fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
source§fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
self
. Read moresource§fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
self
.source§impl PartialEq for ReadRequest
impl PartialEq for ReadRequest
source§fn eq(&self, other: &ReadRequest) -> bool
fn eq(&self, other: &ReadRequest) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ReadRequest
Auto Trait Implementations§
impl !Freeze for ReadRequest
impl RefUnwindSafe for ReadRequest
impl Send for ReadRequest
impl Sync for ReadRequest
impl Unpin for ReadRequest
impl UnwindSafe for ReadRequest
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request