Google BigQuery Storage V1 Client - Class TableReadOptions (1.3.2)

Reference documentation and code samples for the Google BigQuery Storage V1 Client class TableReadOptions.

Options dictating how we read a table.

Generated from protobuf message google.cloud.bigquery.storage.v1.ReadSession.TableReadOptions

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ selected_fields array

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.

↳ arrow_serialization_options Google\Cloud\BigQuery\Storage\V1\ArrowSerializationOptions

Optional. Options specific to the Apache Arrow output format.

↳ avro_serialization_options Google\Cloud\BigQuery\Storage\V1\AvroSerializationOptions

Optional. Options specific to the Apache Avro output format

getSelectedFields

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
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSelectedFields

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.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getRowRestriction

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
TypeDescription
string

setRowRestriction

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getArrowSerializationOptions

Optional. Options specific to the Apache Arrow output format.

Returns
TypeDescription
Google\Cloud\BigQuery\Storage\V1\ArrowSerializationOptions|null

hasArrowSerializationOptions

setArrowSerializationOptions

Optional. Options specific to the Apache Arrow output format.

Parameter
NameDescription
var Google\Cloud\BigQuery\Storage\V1\ArrowSerializationOptions
Returns
TypeDescription
$this

getAvroSerializationOptions

Optional. Options specific to the Apache Avro output format

Returns
TypeDescription
Google\Cloud\BigQuery\Storage\V1\AvroSerializationOptions|null

hasAvroSerializationOptions

setAvroSerializationOptions

Optional. Options specific to the Apache Avro output format

Parameter
NameDescription
var Google\Cloud\BigQuery\Storage\V1\AvroSerializationOptions
Returns
TypeDescription
$this

getOutputFormatSerializationOptions

Returns
TypeDescription
string