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.
Parameters |
|
|---|---|
| Name | Description |
job_id |
str
the job's ID |
source_uris |
Optional[Sequence[str]]
URIs of one or more data files to be loaded. See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationLoad.FIELDS.source_uris for supported URI formats. Pass None for jobs that load from a file. |
destination |
google.cloud.bigquery.table.TableReference
reference to 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). |
Properties
allow_jagged_rows
See allow_jagged_rows.
allow_quoted_newlines
autodetect
See autodetect.
clustering_fields
See clustering_fields.
configuration
The configuration for this load job.
connection_properties
.. versionadded:: 3.7.0
create_disposition
See create_disposition.
create_session
See create_session.
.. versionadded:: 3.7.0
destination
google.cloud.bigquery.table.TableReference: table where loaded rows are written
destination_encryption_configuration
google.cloud.bigquery.encryption_configuration.EncryptionConfiguration: Custom encryption configuration for the destination table.
Custom encryption configuration (e.g., Cloud KMS keys)
or :data:None if using default encryption.
destination_table_description
Optional[str] name given to destination table.
destination_table_friendly_name
Optional[str] name given to destination table.
encoding
See encoding.
field_delimiter
See field_delimiter.
ignore_unknown_values
input_file_bytes
Count of bytes loaded from source files.
| Exceptions | |
|---|---|
| Type | Description |
ValueError |
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 | Description |
Optional[int] |
the count (None until set from the server). |
max_bad_records
See max_bad_records.
null_marker
See null_marker.
output_bytes
Count of bytes saved to destination table.
| Returns | |
|---|---|
| Type | Description |
Optional[int] |
the count (None until set from the server). |
output_rows
Count of rows saved to destination table.
| Returns | |
|---|---|
| Type | Description |
Optional[int] |
the count (None until set from the server). |
quote_character
See quote_character.
range_partitioning
See range_partitioning.
reference_file_schema_uri
See:
attr:<xref uid="google.cloud.bigquery.job.LoadJobConfig.reference_file_schema_uri">google.cloud.bigquery.job.LoadJobConfig.reference_file_schema_uri</xref>.
schema
See schema.
schema_update_options
skip_leading_rows
See skip_leading_rows.
source_format
See source_format.
source_uris
Optional[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.
time_partitioning
See time_partitioning.
use_avro_logical_types
write_disposition
See write_disposition.
Methods
from_api_repr
from_api_repr(resource: dict, client) -> google.cloud.bigquery.job.load.LoadJobFactory: 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.LoadJob |
Job parsed from resource. |
to_api_repr
to_api_repr()Generate a resource for _begin.