ibis.backends.bigquery.Backend.connect

Backend.connect(project_id: Optional[str] = None, dataset_id: Optional[str] = None, credentials: Optional[google.auth.credentials.Credentials] = None, application_name: Optional[str] = None, auth_local_webserver: bool = False, auth_external_data: bool = False, auth_cache: str = 'default')ibis.backends.bigquery.client.BigQueryClient

Create a BigQueryClient for use with Ibis.

Parameters
  • project_id (str) – A BigQuery project id.

  • dataset_id (str) – A dataset id that lives inside of the project indicated by project_id.

  • credentials (google.auth.credentials.Credentials) –

  • application_name (str) – A string identifying your application to Google API endpoints.

  • auth_local_webserver (bool) – Use a local webserver for the user authentication. Binds a webserver to an open port on localhost between 8080 and 8089, inclusive, to receive authentication token. If not set, defaults to False, which requests a token via the console.

  • auth_external_data (bool) – Authenticate using additional scopes required to query external data sources, such as Google Sheets, files in Google Cloud Storage, or files in Google Drive. If not set, defaults to False, which requests the default BigQuery scopes.

  • auth_cache (str) –

    Selects the behavior of the credentials cache.

    'default'

    Reads credentials from disk if available, otherwise authenticates and caches credentials to disk.

    'reauth'

    Authenticates and caches credentials to disk.

    'none'

    Authenticates and does not cache credentials.

    Defaults to 'default'.

Returns

Return type

BigQueryClient