Package job (3.18.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.