atoti_directquery_bigquery.BigqueryConnectionInfo#

class atoti_directquery_bigquery.BigqueryConnectionInfo#

Information needed to connect to a BigQuery database.

__init__(credentials=None, /, *, auto_multi_column_array_conversion=None, lookup_mode='warn', max_sub_queries=500, query_timeout=datetime.timedelta(seconds=3600), time_travel=True)#

Create a BigQuery connection info.

Parameters:

  • credentials (str | Path | None) – The path to the BigQuery credentials file. If None, the application default credentials will be used.

  • auto_multi_column_array_conversion (AutoMultiColumnArrayConversion | None) – When not None, multi column array conversion will be performed automatically.

  • lookup_mode (Literal['allow', 'warn', 'deny']) – Whether lookup queries on the external database are allowed. Lookup can be very slow and expensive as the database may not enforce primary keys.

  • max_sub_queries (int) – Maximum number of subqueries performed when splitting a query into multi-steps queries.

  • query_timeout (timedelta) – Timeout for queries performed on the external database.

  • time_travel (bool) – Whether to use time travel in queries.

Example

>>> from atoti_directquery_bigquery import BigqueryConnectionInfo
>>> connection_info = BigqueryConnectionInfo()
>>> external_database = session.connect_to_external_database(
...     connection_info
... )