Module client (3.36.0)

Client for interacting with the Google BigQuery API.

Classes

Client

Client(project:typing.Optional[str]=None,credentials:typing.Optional[google.auth.credentials.Credentials]=None,_http:typing.Optional[requests.sessions.Session]=None,location:typing.Optional[str]=None,default_query_job_config:typing.Optional[google.cloud.bigquery.job.query.QueryJobConfig]=None,default_load_job_config:typing.Optional[google.cloud.bigquery.job.load.LoadJobConfig]=None,client_info:typing.Optional[google.api_core.client_info.ClientInfo]=None,client_options:typing.Optional[typing.Union[google.api_core.client_options.ClientOptions,typing.Dict[str,typing.Any]]]=None,default_job_creation_mode:typing.Optional[str]=None,)

Client to bundle configuration needed for API requests.

Parameters
NameDescription
projectOptional[str]

Project ID for the project which the client acts on behalf of. Will be passed when creating a dataset / job. If not passed, falls back to the default inferred from the environment.

credentialsOptional[google.auth.credentials.Credentials]

The OAuth2 Credentials to use for this client. If not passed (and if no_http object is passed), falls back to the default inferred from the environment.

_httpOptional[requests.Session]

HTTP object to make requests. Can be any object that definesrequest() with the same interface asrequests.Session.request. If not passed, an_http object is created that is bound to thecredentials for the current object. This parameter should be considered private, and could change in the future.

locationOptional[str]

Default location for jobs / datasets / tables.

default_query_job_configOptional[google.cloud.bigquery.job.QueryJobConfig]

DefaultQueryJobConfig. Will be merged into job configs passed into thequery method.

default_load_job_configOptional[google.cloud.bigquery.job.LoadJobConfig]

DefaultLoadJobConfig. Will be merged into job configs passed into theload_table_* methods.

client_infoOptional[google.api_core.client_info.ClientInfo]

The client info used to send a user-agent string along with API requests. IfNone, then default info will be used. Generally, you only need to set this if you're developing your own library or partner tool.

client_optionsOptional[Union[google.api_core.client_options.ClientOptions, Dict]]

Client options used to set user options on the client. API Endpoint should be set through client_options.

default_job_creation_modeOptional[str]

Sets the default job creation mode used by query methods such as query_and_wait(). For lightweight queries, JOB_CREATION_OPTIONAL is generally recommended.

Exceptions
TypeDescription
google.auth.exceptions.DefaultCredentialsErrorRaised ifcredentials is not specified and the library fails to acquire default credentials.

Project

Project(project_id,numeric_id,friendly_name)

Wrapper for resource describing a BigQuery project.

Parameters
NameDescription
project_idstr

Opaque ID of the project

numeric_idint

Numeric ID of the project

friendly_namestr

Display name of the project

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-16 UTC.