Version History (fa4563d)
Report an Issue

BigQuery Client#

gcloud bigquery client for interacting with API.

class gcloud.bigquery.client.Client(project=None, credentials=None, http=None)[source]#

Bases: gcloud.client.JSONClient

Client to bundle configuration needed for API requests.

Parameters:
  • project (string) – 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 (oauth2client.client.OAuth2Credentials or NoneType) – The OAuth2 Credentials to use for the connection owned by this client. If not passed (and if no http object is passed), falls back to the default inferred from the environment.
  • http (httplib2.Http or class that defines request().) – An optional HTTP object to make requests. If not passed, an http object is created that is bound to the credentials for the current object.
copy_table(name, destination, *sources)[source]#

Construct a job for copying one or more tables into another table.

Parameters:
Return type:

gcloud.bigquery.job.CopyJob
Returns:

a new CopyJob instance
dataset(name)[source]#

Construct a dataset bound to this client.

Parameters:name (string) – Name of the dataset.
Return type:gcloud.bigquery.dataset.Dataset
Returns:a new Dataset instance
extract_table_to_storage(name, source, *destination_uris)[source]#

Construct a job for extracting a table into Cloud Storage files.

Parameters:
  • name (string) – Name of the job.
  • source (gcloud.bigquery.table.Table) – table to be extracted.
  • destination_uris (sequence of string) – URIs of CloudStorage file(s) into which table data is to be extracted.
Return type:

gcloud.bigquery.job.ExtractTableToStorageJob
Returns:

a new ExtractTableToStorageJob instance
list_datasets(include_all=False, max_results=None, page_token=None)[source]#

List datasets for the project associated with this client.

See: https://cloud.google.com/bigquery/docs/reference/v2/datasets/list

Parameters:
  • include_all (boolean) – True if results include hidden datasets.
  • max_results (int) – maximum number of datasets to return, If not passed, defaults to a value set by the API.
  • page_token (string) – opaque marker for the next “page” of datasets. If not passed, the API will return the first page of datasets.
Return type:

tuple, (list, str)
Returns:

list of gcloud.bigquery.dataset.Dataset, plus a “next page token” string: if the token is not None, indicates that more datasets can be retrieved with another call (pass that value as page_token).
load_table_from_storage(name, destination, *source_uris)[source]#

Construct a job for loading data into a table from CloudStorage.

Parameters:
  • name (string) – Name of the job.
  • destination (gcloud.bigquery.table.Table) – Table into which data is to be loaded.
  • source_uris (sequence of string) – URIs of data files to be loaded.
Return type:

gcloud.bigquery.job.LoadTableFromStorageJob
Returns:

a new LoadTableFromStorageJob instance
run_query(name, query)[source]#

Construct a job for running a SQL query.

Parameters:
  • name (string) – Name of the job.
  • query (string) – SQL query to be executed
Return type:

gcloud.bigquery.job.RunQueryJob
Returns:

a new RunQueryJob instance

Connection#

Create / interact with gcloud bigquery connections.

class gcloud.bigquery.connection.Connection(credentials=None, http=None)[source]#

Bases: gcloud.connection.JSONConnection

A connection to Google Cloud Pubsub via the JSON REST API.

API_BASE_URL = 'https://www.googleapis.com'#

The base of the API call URL.

API_URL_TEMPLATE = '{api_base_url}/bigquery/{api_version}{path}'#

A template for the URL of a particular API call.

API_VERSION = 'v2'#

The version of the API, used in building the API call’s URL.

gcloud.bigquery.connection.SCOPE = ('https://www.googleapis.com/auth/bigquery', 'https://www.googleapis.com/auth/cloud-platform')#

The scopes required for authenticating as a Cloud BigQuery consumer.