Module client (3.41.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
Name Description
project Optional[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.
credentials Optional[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.
_http Optional[requests.Session]

HTTP object to make requests. Can be any object that defines request() with the same interface as requests.Session.request. If not passed, an _http object is created that is bound to the credentials for the current object. This parameter should be considered private, and could change in the future.
location Optional[str]

Default location for jobs / datasets / tables.
default_query_job_config Optional[google.cloud.bigquery.job.QueryJobConfig]

Default QueryJobConfig. Will be merged into job configs passed into the query method.
default_load_job_config Optional[google.cloud.bigquery.job.LoadJobConfig]

Default LoadJobConfig. Will be merged into job configs passed into the load_table_* methods.
client_info Optional[google.api_core.client_info.ClientInfo]

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own library or partner tool.
client_options Optional[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_mode Optional[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
Type Description
google.auth.exceptions.DefaultCredentialsError Raised if credentials 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
Name Description
project_id str

Opaque ID of the project
numeric_id int

Numeric ID of the project
friendly_name str

Display name of the project