Class ExtractJob (3.26.0)

ExtractJob(job_id, source, destination_uris, client, job_config=None)

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

Parameters
Name	Description
`job_id`	`str` the job's ID.
`source`	`Union[ google.cloud.bigquery.table.TableReference, google.cloud.bigquery.model.ModelReference ]` Table or Model from which data is to be loaded or extracted.
`destination_uris`	`List[str]` 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`	`Optional[google.cloud.bigquery.job.ExtractJobConfig]` Extra configuration options for the extract job.

Properties

compression

See compression.

configuration

The configuration for this extract job.

created

Datetime at which the job was created.

Returns
Type	Description
`Optional[datetime.datetime]`	the creation time (None until set from the server).

destination_format

See destination_format.

destination_uri_file_counts

Return file counts from job statistics, if present.

See: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobStatistics4.FIELDS.destination_uri_file_counts

Returns
Type	Description
`List[int]`	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.

destination_uris

List[str]: URIs describing where the extracted data will be written in Cloud Storage, using the format gs://<bucket_name>/<object_name_or_glob>.

ended

Datetime at which the job finished.

Returns
Type	Description
`Optional[datetime.datetime]`	the end time (None until set from the server).

error_result

Error information about the job as a whole.

Returns
Type	Description
`Optional[Mapping]`	the error information (None until set from the server).

errors

Information about individual errors generated by the job.

Returns
Type	Description
`Optional[List[Mapping]]`	the error information (None until set from the server).

etag

ETag for the job resource.

Returns
Type	Description
`Optional[str]`	the ETag (None until set from the server).

field_delimiter

See field_delimiter.

job_id

str: ID of the job.

job_type

Type of job.

Returns
Type	Description
`str`	one of 'load', 'copy', 'extract', 'query'.

labels

Dict[str, str]: Labels for the job.

location

str: Location where the job runs.

num_child_jobs

The number of child jobs executed.

See: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobStatistics.FIELDS.num_child_jobs

parent_job_id

Return the ID of the parent job.

See: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobStatistics.FIELDS.parent_job_id

Returns
Type	Description
`Optional[str]`	parent job id.

path

URL path for the job's APIs.

Returns
Type	Description
`str`	the path based on project and job ID.

print_header

See print_header.

project

Project bound to the job.

Returns
Type	Description
`str`	the project (derived from the client).

reservation_usage

Job resource usage breakdown by reservation.

Returns
Type	Description
`List[google.cloud.bigquery.job.ReservationUsage]`	Reservation usage stats. Can be empty if not set from the server.

script_statistics

Statistics for a child job of a script.

self_link

URL for the job resource.

Returns
Type	Description
`Optional[str]`	the URL (None until set from the server).

session_info

[Preview] Information of the session if this job is part of one.

.. versionadded:: 2.29.0

source

Union[ google.cloud.bigquery.table.TableReference, google.cloud.bigquery.model.ModelReference ]: Table or Model from which data is to be loaded or extracted.

started

Datetime at which the job was started.

Returns
Type	Description
`Optional[datetime.datetime]`	the start time (None until set from the server).

state

Status of the job.

Returns
Type	Description
`Optional[str]`	the state (None until set from the server).

transaction_info

Information of the multi-statement transaction if this job is part of one.

Since a scripting query job can execute multiple transactions, this property is only expected on child jobs. Use the list_jobs method with the parent_job parameter to iterate over child jobs.

.. versionadded:: 2.24.0

user_email

E-mail address of user who submitted the job.

Returns
Type	Description
`Optional[str]`	the URL (None until set from the server).

Methods

add_done_callback

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.

Parameter
Name	Description
`fn`	`Callable[Future]` The callback to execute when the operation is complete.

cancel

cancel(client=None, retry: typing.Optional[google.api_core.retry.retry_unary.Retry] = <google.api_core.retry.retry_unary.Retry object>, timeout: typing.Optional[float] = None) -> bool

API call: cancel job via a POST request

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

Parameters
Name	Description
`client`	`Optional[google.cloud.bigquery.client.Client]` the client to use. If not passed, falls back to the `client` stored on the current dataset.
`retry`	`Optional[google.api_core.retry.Retry]` How to retry the RPC.
`timeout`	`Optional[float]` The number of seconds to wait for the underlying HTTP transport before using `retry`

Returns
Type	Description
`bool`	Boolean indicating that the cancel request was sent.

cancelled

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.

Returns
Type	Description
`bool`	False

done

done(retry: google.api_core.retry.retry_unary.Retry = <google.api_core.retry.retry_unary.Retry object>, timeout: typing.Optional[float] = 128, reload: bool = True) -> bool

Checks if the job is complete.

Parameters
Name	Description
`timeout`	`Optional[float]` The number of seconds to wait for the underlying HTTP transport before using `retry`.
`reload`	`Optional[bool]` If `True`, make an API call to refresh the job state of unfinished jobs before checking. Default `True`.
`retry`	`Optional[google.api_core.retry.Retry]` How to retry the RPC. If the job state is `DONE`, retrying is aborted early, as the job will not change anymore.

Returns
Type	Description
`bool`	True if the job is complete, False otherwise.

exception

exception(timeout=<object object>)

Get the exception from the operation, blocking if necessary.

See the documentation for the result method for details on how this method operates, as both result and this method rely on the exact same polling logic. The only difference is that this method does not accept retry and polling arguments but relies on the default ones instead.

Parameter
Name	Description
`timeout`	`int` How long to wait for the operation to complete.

Returns
Type	Description
`Optional[google.api_core.GoogleAPICallError]`	The operation's error.

exists

exists(client=None, retry: google.api_core.retry.retry_unary.Retry = <google.api_core.retry.retry_unary.Retry object>, timeout: typing.Optional[float] = None) -> bool

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
Name	Description
`timeout`	`Optional[float]` The number of seconds to wait for the underlying HTTP transport before using `retry`.
`client`	`Optional[google.cloud.bigquery.client.Client]` the client to use. If not passed, falls back to the `client` stored on the current dataset.
`retry`	`Optional[google.api_core.retry.Retry]` How to retry the RPC.

Returns
Type	Description
`bool`	Boolean indicating existence of the job.

from_api_repr

from_api_repr(
    resource: dict, client
) -> google.cloud.bigquery.job.extract.ExtractJob

Factory: construct a job given its API representation

Parameters
Name	Description
`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.

Returns
Type	Description
`google.cloud.bigquery.job.ExtractJob`	Job parsed from `resource`.

reload

reload(client=None, retry: google.api_core.retry.retry_unary.Retry = <google.api_core.retry.retry_unary.Retry object>, timeout: typing.Optional[float] = 128)

API call: refresh job properties via a GET request.