BigQueryGetDataOperator

Google

Fetches the data from a BigQuery table (alternatively fetch data for selected columns) and returns data in a python list. The number of elements in the returned list will be equal to the number of rows fetched. Each element in the list will again be a list where element would represent the columns values for that row.

View on GitHub

Last Updated: Mar. 16, 2023

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

Documentation

Connections

Parameters

dataset_idRequiredThe dataset ID of the requested table. (templated)

table_idRequiredThe table ID of the requested table. (templated)

project_id(Optional) The name of the project where the data will be returned from. (templated)

max_resultsThe maximum number of records (rows) to be fetched from the table. (templated)

selected_fieldsList of fields to return (comma-separated). If unspecified, all fields are returned.

gcp_conn_id(Optional) The connection ID used to connect to Google Cloud.

locationThe location used for the operation.

impersonation_chainOptional 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).

deferrableRun operator in the deferrable mode

delegate_toThe 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. Deprecated.

Documentation

Example Result: [['Tony', '10'], ['Mike', '20'], ['Steve', '15']]

Note

If you pass fields to selected_fields which are in different order than the order of columns already in BQ table, the data will still be in the order of BQ table. For example if the BQ table has 3 columns as [A,B,C] and you pass ‘B,A’ in the selected_fields the data would still be of the form 'A,B'.

Example:

get_data = BigQueryGetDataOperator(
    task_id='get_data_from_bq',
    dataset_id='test_dataset',
    table_id='Transaction_partitions',
    project_id='internal-gcp-project',
    max_results=100,
    selected_fields='DATE',
    gcp_conn_id='airflow-conn-id'
)