Package job (3.27.0) Stay organized with collections Save and categorize content based on your preferences.
- 3.39.0 (latest)
- 3.38.0
- 3.37.0
- 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
API documentation forbigquery.job package.
Classes
Compression
The compression type to use for exported files. The default value isNONE.
DEFLATE andSNAPPY areonly supported for Avro.
CopyJob
Asynchronous job: copy data into a table from other tables.
CopyJobConfig
Configuration options for copy jobs.
All properties in this class are optional. Values which are :data:None ->server defaults. Set properties on the constructed configuration by usingthe property name as the name of a keyword argument.
CreateDisposition
Specifies whether the job is allowed to create new tables. The defaultvalue isCREATE_IF_NEEDED.
Creation, truncation and append actions occur as one atomic updateupon job completion.
DestinationFormat
The exported file format. The default value isCSV.
Tables with nested or repeated fields cannot be exported as CSV.
DmlStats
Detailed statistics for DML statements.
https://cloud.google.com/bigquery/docs/reference/rest/v2/DmlStats
Encoding
The character encoding of the data. The default isUTF_8.
BigQuery decodes the data after the raw, binary data has beensplit using the values of the quote and fieldDelimiter properties.
ExtractJob
Asynchronous job: extract data from a table into Cloud Storage.
ExtractJobConfig
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 usingthe property name as the name of a keyword argument.
LoadJob
Asynchronous job for loading data into a table.
Can load from Google Cloud Storage URIs or from a file.
LoadJobConfig
Configuration options for load jobs.
Set properties on the constructed configuration by using the property nameas the name of a keyword argument. Values which are unset or :data:Noneuse the BigQuery REST API default values. See theBigQuery REST APIreference documentation<https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationLoad>_for a list of default values.
Required options differ based on thesource_format value.For example, the BigQuery API's default value forsource_format is"CSV".When loading a CSV file, eitherschema must be set orautodetect must be set to:data:True.
OperationType
Different operation types supported in table copy job.
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#operationtype
QueryJob
Asynchronous job: query tables.
QueryJobConfig
Configuration options for query jobs.
All properties in this class are optional. Values which are :data:None ->server defaults. Set properties on the constructed configuration by usingthe property name as the name of a keyword argument.
QueryPlanEntry
QueryPlanEntry represents a single stage of a query execution plan.
Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/Job#ExplainQueryStagefor the underlying API representation within query statistics.
QueryPlanEntryStep
Map a single step in a query plan entry.
QueryPriority
Specifies a priority for the query. The default value isINTERACTIVE.
ReservationUsage
Job resource usage for a reservation.
SchemaUpdateOption
Specifies an update to the destination table schema as a side effect ofa load job.
ScriptOptions
Options controlling the execution of scripts.
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#ScriptOptions
ScriptStackFrame
Stack frame showing the line/column/procedure name where the currentevaluation happened.
ScriptStatistics
Statistics for a child job of a script.
SourceFormat
The format of the data files. The default value isCSV.
Note that the set of allowed values for loading data is differentthan the set used for external data sources (seeExternalSourceFormat).
TimelineEntry
TimelineEntry represents progress of a query job at a particularpoint in time.
Seehttps://cloud.google.com/bigquery/docs/reference/rest/v2/Job#querytimelinesamplefor the underlying API representation within query statistics.
TransactionInfo
[Alpha] Information of a multi-statement transaction.
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#TransactionInfo
.. versionadded:: 2.24.0
UnknownJob
A job whose type cannot be determined.
WriteDisposition
Specifies the action that occurs if destination table already exists.
The default value isWRITE_APPEND.
Each action is atomic and only occurs if BigQuery is able to completethe job successfully. Creation, truncation and append actions occur as oneatomic update upon job completion.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-16 UTC.