Jobs

Define API Jobs.

class google.cloud.bigquery.job.Compression(name)

Bases: google.cloud.bigquery._helpers._EnumProperty

Pseudo-enum for compression properties.

class google.cloud.bigquery.job.CopyJob(name, destination, sources, client)

Bases: google.cloud.bigquery.job._AsyncJob

Asynchronous job: copy data into a table from other tables.

Parameters:

• name (string) – the name of the job
• destination (google.cloud.bigquery.table.Table) – Table into which data is to be loaded.
• sources (list of google.cloud.bigquery.table.Table) – Table into which data is to be loaded.
• client (google.cloud.bigquery.client.Client) – A client which holds credentials and project configuration for the dataset (which requires a project).

create_disposition

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy.createDisposition

classmethod from_api_repr(resource, client)

Factory: construct a job given its API representation

Parameters:

• resource (dict) – dataset job representation returned from the API
• client (google.cloud.bigquery.client.Client) – Client which holds credentials and project configuration for the dataset.

Return type:

google.cloud.bigquery.job.CopyJob

Returns:

Job parsed from resource.

write_disposition

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy.writeDisposition

class google.cloud.bigquery.job.CreateDisposition(name)

Bases: google.cloud.bigquery._helpers._EnumProperty

Pseudo-enum for create_disposition properties.

class google.cloud.bigquery.job.DestinationFormat(name)

Bases: google.cloud.bigquery._helpers._EnumProperty

Pseudo-enum for destination_format properties.

class google.cloud.bigquery.job.Encoding(name)

Bases: google.cloud.bigquery._helpers._EnumProperty

Pseudo-enum for encoding properties.

class google.cloud.bigquery.job.ExtractTableToStorageJob(name, source, destination_uris, client)

Bases: google.cloud.bigquery.job._AsyncJob

Asynchronous job: extract data from a table into Cloud Storage.

Parameters:

• name (string) – the name of the job
• source (google.cloud.bigquery.table.Table) – Table into which data is to be loaded.
• destination_uris (list of string) – URIs describing Cloud Storage blobs into which extracted data will be written, in format gs://<bucket_name>/<object_name_or_glob>.
• client (google.cloud.bigquery.client.Client) – A client which holds credentials and project configuration for the dataset (which requires a project).

compression

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.extracted.compression

destination_format

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.extracted.destinationFormat

field_delimiter

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.extracted.fieldDelimiter

classmethod from_api_repr(resource, client)

Factory: construct a job given its API representation

Parameters:

• resource (dict) – dataset job representation returned from the API
• client (google.cloud.bigquery.client.Client) – Client which holds credentials and project configuration for the dataset.

Return type:

google.cloud.bigquery.job.ExtractTableToStorageJob

Returns:

Job parsed from resource.

print_header

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.extracted.printHeader

class google.cloud.bigquery.job.LoadTableFromStorageJob(name, destination, source_uris, client, schema=())

Bases: google.cloud.bigquery.job._AsyncJob

Asynchronous job for loading data into a table from CloudStorage.

Parameters:

• name (string) – the name of the job
• destination (google.cloud.bigquery.table.Table) – Table into which data is to be loaded.
• source_uris (sequence of string) – URIs of one or more data files to be loaded, in format gs://<bucket_name>/<object_name_or_glob>.
• client (google.cloud.bigquery.client.Client) – A client which holds credentials and project configuration for the dataset (which requires a project).
• schema (list of google.cloud.bigquery.table.SchemaField) – The job’s schema

allow_jagged_rows

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.allowJaggedRows

allow_quoted_newlines

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.allowQuotedNewlines

create_disposition

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.createDisposition

encoding

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.encoding

field_delimiter

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.fieldDelimiter

classmethod from_api_repr(resource, client)

Factory: construct a job given its API representation

Parameters:

• resource (dict) – dataset job representation returned from the API
• client (google.cloud.bigquery.client.Client) – Client which holds credentials and project configuration for the dataset.

Return type:

google.cloud.bigquery.job.LoadTableFromStorageJob

Returns:

Job parsed from resource.

ignore_unknown_values

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.ignoreUnknownValues

input_file_bytes

Count of bytes loaded from source files.

Return type:integer, or NoneType Returns:the count (None until set from the server).

input_files

Count of source files.

Return type:integer, or NoneType Returns:the count (None until set from the server).

max_bad_records

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.maxBadRecords

output_bytes

Count of bytes saved to destination table.

Return type:integer, or NoneType Returns:the count (None until set from the server).

output_rows

Count of rows saved to destination table.

Return type:integer, or NoneType Returns:the count (None until set from the server).

quote_character

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.quote

schema

Table’s schema.

Return type:list of SchemaField Returns:fields describing the schema

skip_leading_rows

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.skipLeadingRows

source_format

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.sourceFormat

write_disposition

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.writeDisposition

class google.cloud.bigquery.job.QueryJob(name, query, client, udf_resources=())

Bases: google.cloud.bigquery.job._AsyncJob

Asynchronous job: query tables.

Parameters:

• name (string) – the name of the job
• query (string) – SQL query string
• client (google.cloud.bigquery.client.Client) – A client which holds credentials and project configuration for the dataset (which requires a project).
• udf_resources (tuple) – An iterable of google.cloud.bigquery._helpers.UDFResource (empty by default)

allow_large_results

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.allowLargeResults

create_disposition

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.createDisposition

default_dataset

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.defaultDataset

destination

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.destinationTable

dry_run

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.dryRun

flatten_results

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.flattenResults

classmethod from_api_repr(resource, client)

Factory: construct a job given its API representation

Parameters:

• resource (dict) – dataset job representation returned from the API
• client (google.cloud.bigquery.client.Client) – Client which holds credentials and project configuration for the dataset.

Return type:

google.cloud.bigquery.job.RunAsyncQueryJob

Returns:

Job parsed from resource.

maximum_billing_tier

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.maximumBillingTier

maximum_bytes_billed

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.maximumBytesBilled

priority

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.priority

results()

Construct a QueryResults instance, bound to this job.

Return type:QueryResults Returns:results instance

use_legacy_sql

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.useLegacySql

use_query_cache

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.useQueryCache

write_disposition

See: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.writeDisposition

class google.cloud.bigquery.job.QueryPriority(name)

Bases: google.cloud.bigquery._helpers._EnumProperty

Pseudo-enum for QueryJob.priority property.

class google.cloud.bigquery.job.SourceFormat(name)

Bases: google.cloud.bigquery._helpers._EnumProperty

Pseudo-enum for source_format properties.

class google.cloud.bigquery.job.WriteDisposition(name)

Bases: google.cloud.bigquery._helpers._EnumProperty

Pseudo-enum for write_disposition properties.