LoadJob(job_id, source_uris, destination, client, job_config=None)
Asynchronous job for loading data into a table.
Can load from Google Cloud Storage URIs or from a file.
Properties allow_jagged_rowsSee allow_jagged_rows.
allow_quoted_newlines autodetectSee autodetect.
clustering_fieldsSee clustering_fields.
configurationThe configuration for this load job.
connection_properties create_dispositionSee create_disposition.
create_session createdDatetime at which the job was created.
Returns Type DescriptionOptional[datetime.datetime]
the creation time (None until set from the server). destination destination_encryption_configuration destination_table_description destination_table_friendly_name encoding
See encoding.
endedDatetime at which the job finished.
Returns Type DescriptionOptional[datetime.datetime]
the end time (None until set from the server). error_result
Error information about the job as a whole.
Returns Type DescriptionOptional[Mapping]
the error information (None until set from the server). errors
Information about individual errors generated by the job.
Returns Type DescriptionOptional[List[Mapping]]
the error information (None until set from the server). etag
ETag for the job resource.
Returns Type DescriptionOptional[str]
the ETag (None until set from the server). field_delimiter
See field_delimiter.
ignore_unknown_values input_file_bytesCount of bytes loaded from source files.
Exceptions Type DescriptionValueError
for invalid value types. Returns Type Description Optional[int]
the count (None until set from the server). input_files
Count of source files.
Returns Type DescriptionOptional[int]
the count (None until set from the server). job_id
str: ID of the job.
job_typeType of job.
Returns Type Descriptionstr
one of 'load', 'copy', 'extract', 'query'. labels
Dict[str, str]: Labels for the job.
locationstr: Location where the job runs.
max_bad_recordsSee max_bad_records.
null_markerSee null_marker.
num_child_jobs output_bytesCount of bytes saved to destination table.
Returns Type DescriptionOptional[int]
the count (None until set from the server). output_rows
Count of rows saved to destination table.
Returns Type DescriptionOptional[int]
the count (None until set from the server). parent_job_id Returns Type Description Optional[str]
parent job id. path
URL path for the job's APIs.
Returns Type Descriptionstr
the path based on project and job ID. project
Project bound to the job.
Returns Type Descriptionstr
the project (derived from the client). quote_character
See quote_character.
range_partitioningSee range_partitioning.
reference_file_schema_uriSee: attr:<xref uid="google.cloud.bigquery.job.LoadJobConfig.reference_file_schema_uri">google.cloud.bigquery.job.LoadJobConfig.reference_file_schema_uri</xref>
.
Job resource usage breakdown by reservation.
schemaSee schema.
schema_update_options script_statisticsStatistics for a child job of a script.
self_linkURL for the job resource.
Returns Type DescriptionOptional[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
skip_leading_rowsSee skip_leading_rows.
source_formatSee source_format.
source_urisOptional[Sequence[str]]: URIs of data files to be loaded. See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationLoad.FIELDS.source_uris for supported URI formats. None for jobs that load from a file.
startedDatetime at which the job was started.
Returns Type DescriptionOptional[datetime.datetime]
the start time (None until set from the server). state
Status of the job.
Returns Type DescriptionOptional[str]
the state (None until set from the server). time_partitioning
See time_partitioning.
transaction_infoInformation 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
use_avro_logical_types user_emailE-mail address of user who submitted the job.
Returns Type DescriptionOptional[str]
the URL (None until set from the server). write_disposition
See write_disposition.
Methods add_done_callbackAdd 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 Descriptionfn
Callable[Future]
The callback to execute when the operation is complete.
cancelcancel(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
Parameters Name Description 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
client
Optional[google.cloud.bigquery.client.Client]
the client to use. If not passed, falls back to the client
stored on the current dataset.
bool
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
.
bool
False done
done(retry: google.api_core.retry.retry_unary.Retry = <google.api_core.retry.retry_unary.Retry object>, timeout: typing.Optional[float] = None, reload: bool = True) -> bool
Checks if the job is complete.
Parameters Name Descriptiontimeout
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.
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.
timeout
int
How long to wait for the operation to complete.
Returns Type DescriptionOptional[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
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 Descriptionbool
Boolean indicating existence of the job. from_api_repr
from_api_repr(resource: dict, client) -> google.cloud.bigquery.job.load.LoadJob
Factory: construct a job given its API representation
Note: This method assumes that the project found in the resource matches the client's project. Parameters Name Descriptionresource
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 Descriptiongoogle.cloud.bigquery.job.LoadJob
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] = None)
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.
resultresult(retry: typing.Optional[google.api_core.retry.retry_unary.Retry] = <google.api_core.retry.retry_unary.Retry object>, timeout: typing.Optional[float] = None) -> google.cloud.bigquery.job.base._AsyncJob
Start the job and wait for it to complete and get the result.
Parameters Name Descriptionretry
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.
timeout
Optional[float]
The number of seconds to wait for the underlying HTTP transport before using retry
. If multiple requests are made under the hood, timeout
applies to each individual request.
google.cloud.exceptions.GoogleAPICallError
if the job failed. concurrent.futures.TimeoutError
if the job did not complete in the given timeout. Returns Type Description _AsyncJob
This instance. running
True if the operation is currently running.
set_exceptionSet the Future's exception.
set_resultSet the Future's result.
to_api_reprGenerate a resource for _begin
.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4