BigQuery Storage V1 API - Class Google::Cloud::Bigquery::Storage::V1::ReadSession::TableReadOptions (v0.12.0)

Version 0.12.0

• 1.2.0 (latest)
• 1.1.0
• 1.0.1
• 0.27.0
• 0.26.0
• 0.25.2
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.1
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.1
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.1
• 0.9.2

Reference documentation and code samples for the BigQuery Storage V1 API class Google::Cloud::Bigquery::Storage::V1::ReadSession::TableReadOptions.

Options dictating how we read a table.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#arrow_serialization_options

def arrow_serialization_options() -> ::Google::Cloud::Bigquery::Storage::V1::ArrowSerializationOptions

Returns

• (::Google::Cloud::Bigquery::Storage::V1::ArrowSerializationOptions) — Optional. Options specific to the Apache Arrow output format.

#arrow_serialization_options=

def arrow_serialization_options=(value) -> ::Google::Cloud::Bigquery::Storage::V1::ArrowSerializationOptions

Parameter

• value (::Google::Cloud::Bigquery::Storage::V1::ArrowSerializationOptions) — Optional. Options specific to the Apache Arrow output format.

Returns

• (::Google::Cloud::Bigquery::Storage::V1::ArrowSerializationOptions) — Optional. Options specific to the Apache Arrow output format.

#row_restriction

def row_restriction() -> ::String

Returns

• (::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.

#row_restriction=

def row_restriction=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#selected_fields

def selected_fields() -> ::Array<::String>

Returns

• (::Array<::String>) — Names of the fields in the table that should be read. If empty, 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.

#selected_fields=

def selected_fields=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — Names of the fields in the table that should be read. If empty, 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.

Returns

• (::Array<::String>) — Names of the fields in the table that should be read. If empty, 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.