google.cloud.bigquery.job.ExtractJob#

Methods

add_done_callback(fn)

Add a callback to be executed when the operation is complete.

cancel([client])

API call: cancel job via a POST request

cancelled()

Check if the job has been cancelled.

done([retry])

Refresh the job and checks if it is complete.

exception([timeout])

Get the exception from the operation, blocking if necessary.

exists([client, retry])

API call: test for the existence of the job via a GET request

from_api_repr(resource, client)

Factory: construct a job given its API representation

reload([client, retry])

API call: refresh job properties via a GET request.

result([timeout, retry])

Start the job and wait for it to complete and get the result.

running()

True if the operation is currently running.

set_exception(exception)

Set the Future’s exception.

set_result(result)

Set the Future’s result.

to_api_repr()

Generate a resource for _begin().

Attributes

compression

See google.cloud.bigquery.job.ExtractJobConfig.compression.

created

Datetime at which the job was created.

destination_format

See google.cloud.bigquery.job.ExtractJobConfig.destination_format.

destination_uri_file_counts

Return file counts from job statistics, if present.

ended

Datetime at which the job finished.

error_result

Error information about the job as a whole.

errors

Information about individual errors generated by the job.

etag

ETag for the job resource.

field_delimiter

See google.cloud.bigquery.job.ExtractJobConfig.field_delimiter.

job_id

ID of the job.

job_type

Type of job

labels

Labels for the job.

location

Location where the job runs.

path

URL path for the job’s APIs.

print_header

See google.cloud.bigquery.job.ExtractJobConfig.print_header.

project

Project bound to the job.

self_link

URL for the job resource.

started

Datetime at which the job was started.

state

Status of the job.

user_email

E-mail address of user who submitted the job.


class google.cloud.bigquery.job.ExtractJob(job_id, source, destination_uris, client, job_config=None)[source]#

Bases: google.cloud.bigquery.job._AsyncJob

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

Parameters
  • job_id (str) – the job’s ID

  • source (google.cloud.bigquery.table.TableReference) – Table into which data is to be loaded.

  • destination_uris (list of string) – URIs describing where the extracted data will be written in Cloud Storage, using the format gs://<bucket_name>/<object_name_or_glob>.

  • client (google.cloud.bigquery.client.Client) – A client which holds credentials and project configuration.

  • job_config (ExtractJobConfig) – (Optional) Extra configuration options for the extract job.

add_done_callback(fn)#

Add a callback to be executed when the operation is complete.

If the operation is not already complete, this will start a helper thread to poll for the status of the operation in the background.

Parameters

fn (Callable[Future]) – The callback to execute when the operation is complete.

cancel(client=None)#

API call: cancel job via a POST request

See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/cancel

Parameters

client (Client or NoneType) – the client to use. If not passed, falls back to the client stored on the current dataset.

Return type

bool

Returns

Boolean indicating that the cancel request was sent.

cancelled()#

Check if the job has been cancelled.

This always returns False. It’s not possible to check if a job was cancelled in the API. This method is here to satisfy the interface for google.api_core.future.Future.

Return type

bool

Returns

False

property compression#

See google.cloud.bigquery.job.ExtractJobConfig.compression.

property created#

Datetime at which the job was created.

Return type

datetime.datetime, or NoneType

Returns

the creation time (None until set from the server).

property destination_format#

See google.cloud.bigquery.job.ExtractJobConfig.destination_format.

property destination_uri_file_counts#

Return file counts from job statistics, if present.

See: https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#statistics.extract.destinationUriFileCounts

Returns

a list of integer counts, each representing the number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the ‘destinationUris’ field. Returns None if job is not yet complete.

done(retry=<google.api_core.retry.Retry object>)#

Refresh the job and checks if it is complete.

Parameters

retry (google.api_core.retry.Retry) – (Optional) How to retry the RPC.

Return type

bool

Returns

True if the job is complete, False otherwise.

property ended#

Datetime at which the job finished.

Return type

datetime.datetime, or NoneType

Returns

the end time (None until set from the server).

property error_result#

Error information about the job as a whole.

Return type

mapping, or NoneType

Returns

the error information (None until set from the server).

property errors#

Information about individual errors generated by the job.

Return type

list of mappings, or NoneType

Returns

the error information (None until set from the server).

property etag#

ETag for the job resource.

Return type

str, or NoneType

Returns

the ETag (None until set from the server).

exception(timeout=None)#

Get the exception from the operation, blocking if necessary.

Parameters

timeout (int) – How long to wait for the operation to complete. If None, wait indefinitely.

Returns

The operation’s

error.

Return type

Optional[google.api_core.GoogleAPICallError]

exists(client=None, retry=<google.api_core.retry.Retry object>)#

API call: test for the existence of the job via a GET request

See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/get

Parameters
  • client (Client or NoneType) – the client to use. If not passed, falls back to the client stored on the current dataset.

  • retry (google.api_core.retry.Retry) – (Optional) How to retry the RPC.

Return type

bool

Returns

Boolean indicating existence of the job.

property field_delimiter#

See google.cloud.bigquery.job.ExtractJobConfig.field_delimiter.

classmethod from_api_repr(resource, client)[source]#

Factory: construct a job given its API representation

Parameters
Return type

google.cloud.bigquery.job.ExtractJob

Returns

Job parsed from resource.

property job_id#

ID of the job.

Type

str

property job_type#

Type of job

Return type

str

Returns

one of ‘load’, ‘copy’, ‘extract’, ‘query’

property labels#

Labels for the job.

Type

Dict[str, str]

property location#

Location where the job runs.

Type

str

property path#

URL path for the job’s APIs.

Return type

str

Returns

the path based on project and job ID.

property print_header#

See google.cloud.bigquery.job.ExtractJobConfig.print_header.

property project#

Project bound to the job.

Return type

str

Returns

the project (derived from the client).

reload(client=None, retry=<google.api_core.retry.Retry object>)#

API call: refresh job properties via a GET request.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/get

Parameters
  • client (Client or NoneType) – the client to use. If not passed, falls back to the client stored on the current dataset.

  • retry (google.api_core.retry.Retry) – (Optional) How to retry the RPC.

result(timeout=None, retry=<google.api_core.retry.Retry object>)#

Start the job and wait for it to complete and get the result.

Parameters
Return type

_AsyncJob

Returns

This instance.

Raises

GoogleCloudError if the job failed or concurrent.futures.TimeoutError if the job did not complete in the given timeout.

running()#

True if the operation is currently running.

URL for the job resource.

Return type

str, or NoneType

Returns

the URL (None until set from the server).

set_exception(exception)#

Set the Future’s exception.

set_result(result)#

Set the Future’s result.

property started#

Datetime at which the job was started.

Return type

datetime.datetime, or NoneType

Returns

the start time (None until set from the server).

property state#

Status of the job.

Return type

str, or NoneType

Returns

the state (None until set from the server).

to_api_repr()[source]#

Generate a resource for _begin().

property user_email#

E-mail address of user who submitted the job.

Return type

str, or NoneType

Returns

the URL (None until set from the server).