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

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

#arrow_serialization_options=

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

#avro_serialization_options

def avro_serialization_options() -> ::Google::Cloud::Bigquery::Storage::V1::AvroSerializationOptions
Returns

#avro_serialization_options=

def avro_serialization_options=(value) -> ::Google::Cloud::Bigquery::Storage::V1::AvroSerializationOptions
Parameter
Returns

#response_compression_codec

def response_compression_codec() -> ::Google::Cloud::Bigquery::Storage::V1::ReadSession::TableReadOptions::ResponseCompressionCodec
Returns

#response_compression_codec=

def response_compression_codec=(value) -> ::Google::Cloud::Bigquery::Storage::V1::ReadSession::TableReadOptions::ResponseCompressionCodec
Parameter
Returns

#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.

#sample_percentage

def sample_percentage() -> ::Float
Returns
  • (::Float) — 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)

#sample_percentage=

def sample_percentage=(value) -> ::Float
Parameter
  • value (::Float) — 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)
Returns
  • (::Float) — 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)

#selected_fields

def selected_fields() -> ::Array<::String>
Returns
  • (::Array<::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.

#selected_fields=

def selected_fields=(value) -> ::Array<::String>
Parameter
  • value (::Array<::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.

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