tabsdata.BigQueryConn#

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

Represents a connection configuration to BigQuery.

__init__(
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,
)#
Initializes the BigQueryConn with the configuration desired to connect

to BigQuery.

Parameters:

  • gcs_folder (str) – 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.

  • credentials (GCPCredentials) – The GCP credentials to use for authentication.

  • project (str, 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.

  • dataset (str, 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.

  • enforce_connection_params (bool, 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 overriden by the table names provided in the destination. Defaults to True.

  • cx_dst_configs_gcs (dict, optional) – Additional configuration parameters to pass to the GCS client. Defaults to None.

  • cx_dst_configs_bigquery (dict, optional) – Additional configuration parameters to pass to the BigQuery client. Defaults to None.

Methods

__init__(gcs_folder, credentials[, project, ...])

Initializes the BigQueryConn with the configuration desired to connect

Attributes

credentials

cx_dst_configs_bigquery

cx_dst_configs_gcs

dataset

enforce_connection_params

gcs_folder

project