Struct PartialResultSet

pub struct PartialResultSet {
    pub resume_token: Vec<u8>,
    pub estimated_batch_size: i32,
    pub partial_rows: Option<PartialRows>,
}

A partial result set from the streaming query API. CBT client will buffer partial_rows from result_sets until it gets a resumption_token.

Fields

resume_token: Vec<u8>

An opaque token sent by the server to allow query resumption and signal the client to accumulate partial_rows since the last non-empty resume_token. On resumption, the resumed query will return the remaining rows for this query.

If there is a batch in progress, a non-empty resume_token means that that the batch of partial_rows will be complete after merging the partial_rows from this response. The client must only yield completed batches to the application, and must ensure that any future retries send the latest token to avoid returning duplicate data.

The server may set ‘resume_token’ without a ‘partial_rows’. If there is a batch in progress the client should yield it.

The server will also send a sentinel resume_token when last batch of partial_rows is sent. If the client retries the ExecuteQueryRequest with the sentinel resume_token, the server will emit it again without any partial_rows, then return OK.

estimated_batch_size: i32

Estimated size of a new batch. The server will always set this when returning the first partial_rows of a batch, and will not set it at any other time.

The client can use this estimate to allocate an initial buffer for the batched results. This helps minimize the number of allocations required, though the buffer size may still need to be increased if the estimate is too low.

partial_rows: Option<PartialRows>

Partial Rows in one of the supported formats. It may require many PartialResultSets to stream a batch of rows that can decoded on the client. The client should buffer partial_rows until it gets a resume_token, at which point the batch is complete and can be decoded and yielded to the user. Each sub-message documents the appropriate way to combine results.

Trait Implementations

impl Clone for PartialResultSet

fn clone(&self) -> PartialResultSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PartialResultSet

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

Formats the value using the given formatter.

impl Default for PartialResultSet

fn default() -> Self

Returns the “default value” for a type.

impl Message for PartialResultSet

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for PartialResultSet

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PartialResultSet