BigQueryConn

classView source ↗

class BigQueryConn(
    gcs_folder: str,
    credentials: GCPCredentials,
    project: str = None,
    dataset: str = None,
    enforce_connection_params: bool = True,
    cx_dst_configs_gcs: dict = None,
    cx_dst_configs_bigquery: dict = None,
)

Bases: Conn

Categories: connections

For connection configuration to BigQueryDest.

Initializes the BigQueryConn with the configuration desired to connect to BigQuery.

Parameters

parameter

gcs_folderstr

A gcs:// URI indicating the folder where the table(s) will be staged before being uploaded to BigQuery. After the upload is done, the files created in this folder will be deleted.

parameter

credentialsGCPCredentials

The GCP credentials to use for authentication.

parameter

projectstr, optional

The default GCP project to use. If not provided, the project must be specified in the table names provided in the destination. Defaults to None.

parameter

datasetstr, optional

The default BigQuery dataset to use. If not provided, the dataset must be specified in the table names provided in the destination. Defaults to None.

parameter

enforce_connection_paramsbool, optional

If True, enforce that project and dataset are used to fully qualify table names in the destination if provided. If set to False, the connection will allow the project and/or dataset to be overridden by the table names provided in the destination. Defaults to True.

parameter

cx_dst_configs_gcsdict, optional

Additional configuration parameters to pass to the GCS client. Defaults to None.

parameter

cx_dst_configs_bigquerydict, optional

Additional configuration parameters to pass to the BigQuery client. Defaults to None.

Properties

property

credentialsGCPCredentials

property

cx_dst_configs_bigquerydict

property

cx_dst_configs_gcsdict

property

datasetstr | None

property

enforce_connection_paramsbool

property

gcs_folderstr

property

projectstr | None