google.cloud.bigquery.job.LoadJobConfig#
Methods
|
Factory: construct a job configuration given its API representation |
Build an API representation of the job config. |
Attributes
Allow missing trailing optional columns (CSV only). |
|
Allow quoted data containing newline characters (CSV only). |
|
Automatically infer the schema from a sample of the data. |
|
Fields defining clustering for the table |
|
Specifies behavior for creating tables. |
|
Custom encryption configuration for the destination table. |
|
Union[str, None] name given to destination table. |
|
Union[str, None] name given to destination table. |
|
The character encoding of the data. |
|
The separator for fields in a CSV file. |
|
Ignore extra values not represented in the table schema. |
|
Labels for the job. |
|
Number of invalid rows to ignore. |
|
Represents a null value (CSV only). |
|
Character used to quote data sections (CSV only). |
|
Schema of the destination table. |
|
Specifies updates to the destination table schema to allow as a side effect of the load job. |
|
Number of rows to skip when reading data (CSV only). |
|
File format of the data. |
|
Specifies time-based partitioning for the destination table. |
|
For loads of Avro data, governs whether Avro logical types are converted to their corresponding BigQuery types(e.g. |
|
Action that occurs if the destination table already exists. |
-
class
google.cloud.bigquery.job.
LoadJobConfig
(**kwargs)[source]# Bases:
google.cloud.bigquery.job._JobConfig
Configuration options for load jobs.
All properties in this class are optional. Values which are
None
-> server defaults. Set properties on the constructed configuration by using the property name as the name of a keyword argument.-
property
allow_jagged_rows
# Allow missing trailing optional columns (CSV only).
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.allowJaggedRows
- Type
-
property
allow_quoted_newlines
# Allow quoted data containing newline characters (CSV only).
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.allowQuotedNewlines
- Type
-
property
autodetect
# Automatically infer the schema from a sample of the data.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.autodetect
- Type
-
property
clustering_fields
# Fields defining clustering for the table
(Defaults to
None
).Clustering fields are immutable after table creation.
Note
As of 2018-06-29, clustering fields cannot be set on a table which does not also have time partioning defined.
-
property
create_disposition
# Specifies behavior for creating tables.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.createDisposition
-
property
destination_encryption_configuration
# Custom encryption configuration for the destination table.
Custom encryption configuration (e.g., Cloud KMS keys) or
None
if using default encryption.
-
property
destination_table_description
# Union[str, None] name given to destination table.
-
property
destination_table_friendly_name
# Union[str, None] name given to destination table.
-
property
encoding
# The character encoding of the data.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.encoding
-
property
field_delimiter
# The separator for fields in a CSV file.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.fieldDelimiter
- Type
-
classmethod
from_api_repr
(resource)# Factory: construct a job configuration given its API representation
- Parameters
resource (dict) – An extract job configuration in the same representation as is returned from the API.
- Return type
google.cloud.bigquery.job._JobConfig
- Returns
Configuration parsed from
resource
.
-
property
ignore_unknown_values
# Ignore extra values not represented in the table schema.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.ignoreUnknownValues
- Type
-
property
labels
# Labels for the job.
This method always returns a dict. To change a job’s labels, modify the dict, then call
Client.update_job
. To delete a label, set its value toNone
before updating.- Raises
ValueError – If
value
type is invalid.- Type
-
property
max_bad_records
# Number of invalid rows to ignore.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.maxBadRecords
- Type
-
property
null_marker
# Represents a null value (CSV only).
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.nullMarker
- Type
-
property
quote_character
# Character used to quote data sections (CSV only).
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.quote
- Type
-
property
schema
# Schema of the destination table.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.schema
- Type
-
property
schema_update_options
# Specifies updates to the destination table schema to allow as a side effect of the load job.
- Type
-
property
skip_leading_rows
# Number of rows to skip when reading data (CSV only).
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.skipLeadingRows
- Type
-
property
source_format
# File format of the data.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.sourceFormat
-
property
time_partitioning
# Specifies time-based partitioning for the destination table.
-
to_api_repr
()# Build an API representation of the job config.
- Return type
- Returns
A dictionary in the format used by the BigQuery API.
-
property
use_avro_logical_types
# For loads of Avro data, governs whether Avro logical types are converted to their corresponding BigQuery types(e.g. TIMESTAMP) rather than raw types (e.g. INTEGER).
- Type
-
property
write_disposition
# Action that occurs if the destination table already exists.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.writeDisposition
-
property