Class BigQueryOptions (1.28.0)

Version 1.28.0

• 1.29.0 (latest)
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.1
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.1
• 0.19.2
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.1
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0

BigQueryOptions(
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    project: typing.Optional[str] = None,
    location: typing.Optional[str] = None,
    bq_connection: typing.Optional[str] = None,
    use_regional_endpoints: bool = False,
    application_name: typing.Optional[str] = None,
    kms_key_name: typing.Optional[str] = None,
    skip_bq_connection_check: bool = False,
    *,
    ordering_mode: typing.Literal["strict", "partial"] = "strict",
    client_endpoints_override: dict = {}
)

Encapsulates configuration for working with a session.

Properties

application_name

The application name to amend to the user-agent sent to Google APIs.

The application name to amend to the user agent sent to Google APIs. The recommended format is "application-name/major.minor.patch_version" or "(gpn:PartnerName;)" for official Google partners.

Returns
Type	Description
None or str	Application name as a string if exists; otherwise None.

bq_connection

Name of the BigQuery connection to use in the form <PROJECT_NUMBER/PROJECT_ID>.

You either need to create the connection in a location of your choice, or you need the Project Admin IAM role to enable the service to create the connection for you.

If this option isn't available, or the project or location isn't provided, then the default connection project/location/connection_id is used in the session.

If this option isn't provided, or project or location aren't provided, session will use its default project/location/connection_id as default connection.

Returns
Type	Description
None or str	Name of the BigQuery connection as a string; otherwise None.

client_endpoints_override

Option that sets the BQ client endpoints addresses directly as a dict. Possible keys are "bqclient", "bqconnectionclient", "bqstoragereadclient".

credentials

The OAuth2 credentials to use for this client.

Returns
Type	Description
None or google.auth.credentials.Credentials	google.auth.credentials.Credentials if exists; otherwise None.

kms_key_name

Customer managed encryption key used to control encryption of the data-at-rest in BigQuery. This is of the format projects/PROJECT_ID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY.

For more information, see https://cloud.google.com/bigquery/docs/customer-managed-encryption Customer-managed Cloud KMS keys

Make sure the project used for Bigquery DataFrames has the Cloud KMS CryptoKey Encrypter/Decrypter IAM role in the key's project. For more information, see https://cloud.google.com/bigquery/docs/customer-managed-encryption#assign_role Assign the Encrypter/Decrypter.

Returns
Type	Description
None or str	Name of the customer managed encryption key as a string; otherwise None.

location

Default location for job, datasets, and tables.

For more information, see https://cloud.google.com/bigquery/docs/locations BigQuery locations.

Returns
Type	Description
None or str	Default location as a string; otherwise None.

ordering_mode

Controls whether total row order is always maintained for DataFrame/Series.

Returns
Type	Description
Literal	A literal string value of either strict or partial ordering mode.

project

Google Cloud project ID to use for billing and as the default project.

Returns
Type	Description
None or str	Google Cloud project ID as a string; otherwise None.

skip_bq_connection_check

Forcibly use the BigQuery connection.

Setting this flag to True would avoid creating the BigQuery connection and checking or setting IAM permissions on it. So if the BigQuery connection (default or user-provided) does not exist, or it does not have necessary permissions set up to support BigQuery DataFrames operations, then a runtime error will be reported.

Returns
Type	Description
bool	A boolean value, where True indicates a BigQuery connection is not created or the connection does not have necessary permissions set up; otherwise False.

use_regional_endpoints

Flag to connect to regional API endpoints.

Note: Use of regional endpoints is a feature in Preview and available only in regions "europe-west3", "europe-west8", "europe-west9", "me-central2", "us-central1", "us-central2", "us-east1", "us-east4", "us-east5", "us-east7", "us-south1", "us-west1", "us-west2", "us-west3" and "us-west4".

deprecated: Use of locational endpoints is available only in selected projects.

Requires that location is set. For supported regions, for example europe-west3, you need to specify location='europe-west3' and use_regional_endpoints=True, and then BigQuery DataFrames would connect to the BigQuery endpoint bigquery.europe-west3.rep.googleapis.com. For not supported regions, for example asia-northeast1, when you specify location='asia-northeast1' and use_regional_endpoints=True, a different endpoint (called locational endpoint, now deprecated, used to provide weaker promise on the request remaining within the location during transit) europe-west3-bigquery.googleapis.com would be used.

Returns
Type	Description
bool	A boolean value, where True indicates that regional endpoints would be used for BigQuery and BigQuery storage APIs; otherwise global endpoints would be used.