- 3.37.0 (latest)
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.27.0
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.1
- 3.22.0
- 3.21.0
- 3.20.1
- 3.19.0
- 3.18.0
- 3.17.2
- 3.16.0
- 3.15.0
- 3.14.1
- 3.13.0
- 3.12.0
- 3.11.4
- 3.4.0
- 3.3.6
- 3.2.0
- 3.1.0
- 3.0.1
- 2.34.4
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.1
- 2.29.0
- 2.28.1
- 2.27.1
- 2.26.0
- 2.25.2
- 2.24.1
- 2.23.3
- 2.22.1
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.1
- 2.15.0
- 2.14.0
- 2.13.1
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.2
- 2.5.0
- 2.4.0
- 2.3.1
- 2.2.0
- 2.1.0
- 2.0.0
- 1.28.2
- 1.27.2
- 1.26.1
- 1.25.0
- 1.24.0
- 1.23.1
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
ExtractJobConfig(**kwargs)
Configuration options for extract jobs.
All properties in this class are optional. Values which are :data:None
->
server defaults. Set properties on the constructed configuration by using
the property name as the name of a keyword argument.
Properties
compression
google.cloud.bigquery.job.Compression: Compression type to use for exported files.
destination_format
google.cloud.bigquery.job.DestinationFormat: Exported file format.
field_delimiter
str: Delimiter to use between fields in the exported data.
job_timeout_ms
Optional parameter. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job. https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfiguration.FIELDS.job_timeout_ms e.g.
job_config = bigquery.QueryJobConfig( job_timeout_ms = 5000 )
or
job_config.job_timeout_ms = 5000
Exceptions | |
---|---|
Type | Description |
ValueError |
If value type is invalid. |
labels
Dict[str, str]: Labels for the job.
This method always returns a dict. Once a job has been created on the server, its labels cannot be modified anymore.
Exceptions | |
---|---|
Type | Description |
ValueError |
If value type is invalid. |
max_slots
The maximum rate of slot consumption to allow for this job.
If set, the number of slots used to execute the job will be throttled to try and keep its slot consumption below the requested rate. This feature is not generally available.
print_header
bool: Print a header row in the exported data.
reservation
str: Optional. The reservation that job would use.
User can specify a reservation to execute the job. If reservation is not set, reservation is determined based on the rules defined by the reservation assignments. The expected format is projects/{project}/locations/{location}/reservations/{reservation}.
Exceptions | |
---|---|
Type | Description |
ValueError |
If value type is not None or of string type. |
use_avro_logical_types
bool: For loads of Avro data, governs whether Avro logical types are converted to their corresponding BigQuery types (e.g. TIMESTAMP) rather than raw types (e.g. INTEGER).
Methods
__setattr__
__setattr__(name, value)
Override to be able to raise error if an unknown property is being set
from_api_repr
from_api_repr(resource: dict) -> google.cloud.bigquery.job.base._JobConfig
Factory: construct a job configuration given its API representation
Parameter | |
---|---|
Name | Description |
resource |
Dict
A job configuration in the same representation as is returned from the API. |
Returns | |
---|---|
Type | Description |
google.cloud.bigquery.job._JobConfig |
Configuration parsed from resource . |
to_api_repr
to_api_repr() -> dict
Build an API representation of the job config.
Returns | |
---|---|
Type | Description |
Dict |
A dictionary in the format used by the BigQuery API. |