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 | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ selected_fields |
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. |
↳ 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. |
getSelectedFields
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 | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSelectedFields
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getArrowSerializationOptions
Optional. Options specific to the Apache Arrow output format.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BigQuery\Storage\V1\ArrowSerializationOptions|null |
|
hasArrowSerializationOptions
setArrowSerializationOptions
Optional. Options specific to the Apache Arrow output format.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BigQuery\Storage\V1\ArrowSerializationOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOutputFormatSerializationOptions
| Returns | |
|---|---|
| Type | Description |
string |
|