bigframes._config.BigQueryOptions

class bigframes._config.BigQueryOptions(credentials: Credentials | None = None, project: str | None = None, location: str | None = None, bq_connection: str | None = None, use_regional_endpoints: bool = False, application_name: str | None = None, kms_key_name: str | None = None, skip_bq_connection_check: bool = False, *, allow_large_results: bool = False, ordering_mode: Literal['strict', 'partial'] = 'strict', client_endpoints_override: dict | None = None, requests_transport_adapters: Sequence[Tuple[str, BaseAdapter]] = (), enable_polars_execution: bool = False)

Encapsulates configuration for working with a session.

Attributes

allow_large_results	Checks the legacy global setting for allowing large results.
application_name	The application name to amend to the user-agent sent to Google APIs.
bq_connection	Name of the BigQuery connection to use in the form <PROJECT_NUMBER/PROJECT_ID>.<LOCATION>.<CONNECTION_ID>.
client_endpoints_override	Option that sets the BQ client endpoints addresses directly as a dict.
credentials	The OAuth2 credentials to use for this client.
enable_polars_execution	If True, will use polars to execute some simple query plans locally.
kms_key_name	Customer managed encryption key used to control encryption of the data-at-rest in BigQuery.
location	Default location for job, datasets, and tables.
ordering_mode	Controls whether total row order is always maintained for DataFrame/Series.
project	Google Cloud project ID to use for billing and as the default project.
requests_transport_adapters	Transport adapters for requests-based REST clients such as the google-cloud-bigquery package.
skip_bq_connection_check	Forcibly use the BigQuery connection.
use_regional_endpoints	Flag to connect to regional API endpoints for BigQuery API and BigQuery Storage API.

Methods

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