Module client (3.25.0)

Version 3.25.0

• 3.27.0 (latest)
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.1
• 3.22.0
• 3.21.0
• 3.20.1
• 3.19.0
• 3.18.0
• 3.17.2
• 3.16.0
• 3.15.0
• 3.14.1
• 3.13.0
• 3.12.0
• 3.11.4
• 3.4.0
• 3.3.6
• 3.2.0
• 3.1.0
• 3.0.1
• 2.34.4
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.1
• 2.29.0
• 2.28.1
• 2.27.1
• 2.26.0
• 2.25.2
• 2.24.1
• 2.23.3
• 2.22.1
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.2
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.0
• 2.0.0
• 1.28.2
• 1.27.2
• 1.26.1
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0

Client for interacting with the Google BigQuery API.

Classes

Client

Client(
    project=None,
    credentials=None,
    _http=None,
    location=None,
    default_query_job_config=None,
    default_load_job_config=None,
    client_info=None,
    client_options=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.

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