GCSToBigQueryOperator

Google

Loads files from Google Cloud Storage into BigQuery.

View Source

Last Updated: Mar. 22, 2021

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

bucketstrThe bucket to load from. (templated)
source_objectslist[str]List of Google Cloud Storage URIs to load from. (templated) If source_format is 'DATASTORE_BACKUP', the list must only contain a single URI.
destination_project_dataset_tablestrThe dotted (.|:). BigQuery table to load data into. If is not included, project will be the project defined in the connection json. (templated)
schema_fieldslistIf set, the schema field list as defined here: https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load Should not be set when source_format is 'DATASTORE_BACKUP'. Parameter must be defined if 'schema_object' is null and autodetect is False.
schema_objectstrIf set, a GCS object path pointing to a .json file that contains the schema for the table. (templated) Parameter must be defined if 'schema_fields' is null and autodetect is False.
source_formatstrFile format to export.
compressionstr[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
create_dispositionstrThe create disposition if the table doesn't exist.
skip_leading_rowsintNumber of rows to skip when loading from a CSV.
write_dispositionstrThe write disposition if the table already exists.
field_delimiterstrThe delimiter to use when loading from a CSV.
max_bad_recordsintThe maximum number of bad records that BigQuery can ignore when running the job.
quote_characterstrThe value that is used to quote data sections in a CSV file.
ignore_unknown_valuesbool[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result.
allow_quoted_newlinesboolWhether to allow quoted newlines (true) or not (false).
allow_jagged_rowsboolAccept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. Only applicable to CSV, ignored for other formats.
encodingThe character encoding of the data. See: https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).csvOptions.encoding https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.csvOptions.encoding
max_id_keystrIf set, the name of a column in the BigQuery table that's to be loaded. This will be used to select the MAX value from BigQuery after the load occurs. The results will be returned by the execute() command, which in turn gets stored in XCom for future operators to use. This can be helpful with incremental loads--during future executions, you can pick up from the max ID.
bigquery_conn_idstr(Optional) The connection ID used to connect to Google Cloud and interact with the BigQuery service.
google_cloud_storage_conn_idstr(Optional) The connection ID used to connect to Google Cloud and interact with the Google Cloud Storage service.
delegate_tostrThe account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.
schema_update_optionslistAllows the schema of the destination table to be updated as a side effect of the load job.
src_fmt_configsdictconfigure optional fields specific to the source format
external_tableboolFlag to specify if the destination table should be a BigQuery external table. Default Value is False.
time_partitioningdictconfigure optional time partitioning fields i.e. partition by field, type and expiration as per API specifications. Note that 'field' is not available in concurrency with dataset.table$partition.
cluster_fieldslist[str]Request that the result of this load be stored sorted by one or more columns. BigQuery supports clustering for both partitioned and non-partitioned tables. The order of columns given determines the sort order. Not applicable for external tables.
autodetectbool[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources. (Default: True). Parameter must be setted to True if 'schema_fields' and 'schema_object' are undefined. It is suggested to set to True if table are create outside of Airflow.
encryption_configurationdict[Optional] Custom encryption configuration (e.g., Cloud KMS keys). Example:encryption_configuration = { "kmsKeyName": "projects/testp/locations/us/keyRings/test-kr/cryptoKeys/test-key" }
locationstr[Optional] The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location
impersonation_chainUnion[str, Sequence[str]]Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

Documentation

Loads files from Google Cloud Storage into BigQuery.

The schema to be used for the BigQuery table may be specified in one of two ways. You may either directly pass the schema fields in, or you may point the operator to a Google Cloud Storage object name. The object in Google Cloud Storage must be a JSON file with the schema fields in it.

See also

For more information on how to use this operator, take a look at the guide: GCSToBigQueryOperator

Was this page helpful?