Class BigQueryOptions (0.25.0)

Version 0.25.0

• 1.27.0 (latest)
• 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,
)

Encapsulates configuration for working with a session.

Properties

application_name

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

Recommended format is "appplication-name/major.minor.patch_version" or "(gpn:PartnerName;)" for official Google partners.

bq_connection

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

You should either have the connection already created in the location you have chosen, or you should have the Project IAM Admin role to enable the service to create the connection for you if you need it.

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.

credentials

The OAuth2 Credentials to use for this client.

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

See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more details.

Please make sure the project used for Bigquery DataFrames has "Cloud KMS CryptoKey Encrypter/Decrypter" role in the key's project, See https://cloud.google.com/bigquery/docs/customer-managed-encryption#assign_role for steps on how to ensure that.

location

Default location for job, datasets, and tables.

See: https://cloud.google.com/bigquery/docs/locations

project

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

use_regional_endpoints

Flag to connect to regional API endpoints.

deprecated: Use of regional endpoints is a feature in preview and available only in selected regions and projects.

Requires location to also be set. For example, set location='asia-northeast1' and use_regional_endpoints=True to connect to asia-northeast1-bigquery.googleapis.com.