Struct bigquery_storage::client::ReadSessionBuilder

pub struct ReadSessionBuilder<'a, T> { /* fields omitted */ }

A builder for ReadSession. When in doubt about what a field does, please refer to CreateReadSessionRequest and the official API documentation.

Methods

impl<'a, T> ReadSessionBuilder<'a, T>

pub fn data_format(self, data_format: DataFormat) -> Self

Sets the data format of the output data. Defaults to Arrow if not set.

pub fn snapshot_time(self, snapshot_time: Timestamp) -> Self

Sets the snapshot time of the table. If not set, interpreted as now.

pub fn selected_fields(self, selected_fields: Vec<String>) -> Self

Names of the fields in the table that should be read. If empty or not set, all fields will be read. If the specified field is a nested field, all the sub-fields in the field will be selected. The output field order is unrelated to the order of fields in selected_fields.

pub fn row_restriction(self, row_restriction: String) -> Self

SQL text filtering statement, similar to a WHERE clause in a query. Aggregates are not supported.

Examples:

• int_field > 5

• date_field = CAST('2014-9-27' as DATE)

• nullable_field is not NULL

• st_equals(geo_field, st_geofromtext("POINT(2, 2)"))

• numeric_field BETWEEN 1.0 AND 5.0

pub fn max_stream_count(self, max_stream_count: i32) -> Self

Max initial number of streams. If unset or zero, the server will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table. Error will be returned if the max count is greater than the current system max limit of 1,000.

pub fn parent_project_id(self, parent_project_id: String) -> Self

The request project that owns the session. If not set, defaults to the project owning the table to be read.

impl<'a, C> ReadSessionBuilder<'a, C> where
    C: Connect + Clone + Send + Sync + 'static, 

pub async fn build(self) -> Result<ReadSession<'a, C>, Error>

Build the ReadSession. This will hit Google's API and prepare the desired read streams.