Struct TableReadOptions 

#[non_exhaustive]
pub struct TableReadOptions {
    pub selected_fields: Vec<String>,
    pub row_restriction: String,
    pub sample_percentage: Option<f64>,
    pub response_compression_codec: Option<ResponseCompressionCodec>,
    pub output_format_serialization_options: Option<OutputFormatSerializationOptions>,
    /* private fields */
}

Options dictating how we read a table.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

selected_fields: Vec<String>

Optional. The names of the fields in the table to be returned. If no field names are specified, then all fields in the table are returned.

Nested fields – the child elements of a STRUCT field – can be selected individually using their fully-qualified names, and will be returned as record fields containing only the selected nested fields. If a STRUCT field is specified in the selected fields list, all of the child elements will be returned.

As an example, consider a table with the following schema:

{ “name”: “struct_field”, “type”: “RECORD”, “mode”: “NULLABLE”, “fields”: [ { “name”: “string_field1”, “type”: “STRING”, . “mode”: “NULLABLE” }, { “name”: “string_field2”, “type”: “STRING”, “mode”: “NULLABLE” } ] }

Specifying “struct_field” in the selected fields list will result in a read session schema with the following logical structure:

struct_field { string_field1 string_field2 }

Specifying “struct_field.string_field1” in the selected fields list will result in a read session schema with the following logical structure:

struct_field { string_field1 }

The order of the fields in the read session schema is derived from the table schema and does not correspond to the order in which the fields are specified in this list.

row_restriction: String

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”

Restricted to a maximum length for 1 MB.

sample_percentage: Option<f64>

Optional. Specifies a table sampling percentage. Specifically, the query planner will use TABLESAMPLE SYSTEM (sample_percentage PERCENT). The sampling percentage is applied at the data block granularity. It will randomly choose for each data block whether to read the rows in that data block. For more details, see https://cloud.google.com/bigquery/docs/table-sampling)

response_compression_codec: Option<ResponseCompressionCodec>

Optional. Set response_compression_codec when creating a read session to enable application-level compression of ReadRows responses.

output_format_serialization_options: Option<OutputFormatSerializationOptions>

Implementations

impl TableReadOptions

pub fn new() -> Self

Creates a new default instance.

pub fn set_selected_fields<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of selected_fields.

Example

let x = TableReadOptions::new().set_selected_fields(["a", "b", "c"]);

pub fn set_row_restriction<T: Into<String>>(self, v: T) -> Self

Sets the value of row_restriction.

Example

let x = TableReadOptions::new().set_row_restriction("example");

pub fn set_sample_percentage<T>(self, v: T) -> Self

where T: Into<f64>,

Sets the value of sample_percentage.

Example

let x = TableReadOptions::new().set_sample_percentage(42.0);

pub fn set_or_clear_sample_percentage<T>(self, v: Option<T>) -> Self

where T: Into<f64>,

Sets or clears the value of sample_percentage.

Example

let x = TableReadOptions::new().set_or_clear_sample_percentage(Some(42.0));
let x = TableReadOptions::new().set_or_clear_sample_percentage(None::<f32>);

pub fn set_response_compression_codec<T>(self, v: T) -> Self

where T: Into<ResponseCompressionCodec>,

Sets the value of response_compression_codec.

Example

use google_cloud_bigquery::model::read_session::table_read_options::ResponseCompressionCodec;
let x0 = TableReadOptions::new().set_response_compression_codec(ResponseCompressionCodec::Lz4);

pub fn set_or_clear_response_compression_codec<T>(self, v: Option<T>) -> Self

where T: Into<ResponseCompressionCodec>,

Sets or clears the value of response_compression_codec.

Example

use google_cloud_bigquery::model::read_session::table_read_options::ResponseCompressionCodec;
let x0 = TableReadOptions::new().set_or_clear_response_compression_codec(Some(ResponseCompressionCodec::Lz4));
let x_none = TableReadOptions::new().set_or_clear_response_compression_codec(None::<ResponseCompressionCodec>);

pub fn set_output_format_serialization_options<T: Into<Option<OutputFormatSerializationOptions>>>( self, v: T, ) -> Self

Sets the value of output_format_serialization_options.

Note that all the setters affecting output_format_serialization_options are mutually exclusive.

Example

use google_cloud_bigquery::model::ArrowSerializationOptions;
let x = TableReadOptions::new().set_output_format_serialization_options(Some(
    google_cloud_bigquery::model::read_session::table_read_options::OutputFormatSerializationOptions::ArrowSerializationOptions(ArrowSerializationOptions::default().into())));

pub fn arrow_serialization_options( &self, ) -> Option<&Box<ArrowSerializationOptions>>

The value of output_format_serialization_options if it holds a ArrowSerializationOptions, None if the field is not set or holds a different branch.

pub fn set_arrow_serialization_options<T: Into<Box<ArrowSerializationOptions>>>( self, v: T, ) -> Self

Sets the value of output_format_serialization_options to hold a ArrowSerializationOptions.

Note that all the setters affecting output_format_serialization_options are mutually exclusive.

Example

use google_cloud_bigquery::model::ArrowSerializationOptions;
let x = TableReadOptions::new().set_arrow_serialization_options(ArrowSerializationOptions::default()/* use setters */);
assert!(x.arrow_serialization_options().is_some());
assert!(x.avro_serialization_options().is_none());

pub fn avro_serialization_options( &self, ) -> Option<&Box<AvroSerializationOptions>>

The value of output_format_serialization_options if it holds a AvroSerializationOptions, None if the field is not set or holds a different branch.

pub fn set_avro_serialization_options<T: Into<Box<AvroSerializationOptions>>>( self, v: T, ) -> Self

Sets the value of output_format_serialization_options to hold a AvroSerializationOptions.

Note that all the setters affecting output_format_serialization_options are mutually exclusive.

Example

use google_cloud_bigquery::model::AvroSerializationOptions;
let x = TableReadOptions::new().set_avro_serialization_options(AvroSerializationOptions::default()/* use setters */);
assert!(x.avro_serialization_options().is_some());
assert!(x.arrow_serialization_options().is_none());

Trait Implementations

impl Clone for TableReadOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableReadOptions

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

Formats the value using the given formatter.

impl Default for TableReadOptions

fn default() -> Self

Returns the “default value” for a type.

impl Message for TableReadOptions

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TableReadOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TableReadOptions