- 3.25.0 (latest)
- 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 for bigquery.job
package.
Classes
Compression
The compression type to use for exported files. The default value is
NONE
.
DEFLATE
and SNAPPY
are
only 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 using
the property name as the name of a keyword argument.
CreateDisposition
Specifies whether the job is allowed to create new tables. The default
value is CREATE_IF_NEEDED
.
Creation, truncation and append actions occur as one atomic update upon job completion.
DestinationFormat
The exported file format. The default value is CSV
.
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 is UTF_8
.
BigQuery decodes the data after the raw, binary data has been split 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 using
the 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 name
as the name of a keyword argument. Values which are unset or :data:None
use the BigQuery REST API default values. See the BigQuery REST API
reference documentation
<https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationLoad>
_
for a list of default values.
Required options differ based on the
source_format value.
For example, the BigQuery API's default value for
source_format is "CSV"
.
When loading a CSV file, either
schema must be set or
autodetect 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 using
the property name as the name of a keyword argument.
QueryPlanEntry
QueryPlanEntry represents a single stage of a query execution plan.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#ExplainQueryStage for 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 is
INTERACTIVE
.
ReservationUsage
Job resource usage for a reservation.
SchemaUpdateOption
Specifies an update to the destination table schema as a side effect of a 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 current evaluation happened.
ScriptStatistics
Statistics for a child job of a script.
SourceFormat
The format of the data files. The default value is CSV
.
Note that the set of allowed values for loading data is different than the set used for external data sources (see ExternalSourceFormat).
TimelineEntry
TimelineEntry represents progress of a query job at a particular point in time.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#querytimelinesample for 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 is WRITE_APPEND
.
Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.