pandas.read_gbq#

pandas.read_gbq(query,project_id=None,index_col=None,col_order=None,reauth=False,auth_local_webserver=True,dialect=None,location=None,configuration=None,credentials=None,use_bqstorage_api=None,max_results=None,progress_bar_type=None)[source]#

Load data from Google BigQuery.

Deprecated since version 2.2.0:Please usepandas_gbq.read_gbq instead.

This function requires thepandas-gbq package.

See theHow to authenticate with Google BigQueryguide for authentication instructions.

Parameters:

querystr

SQL-Like Query to return data values.

project_idstr, optional

Google BigQuery Account project ID. Optional when available fromthe environment.

index_colstr, optional

Name of result column to use for index in results DataFrame.

col_orderlist(str), optional

List of BigQuery column names in the desired order for resultsDataFrame.

reauthbool, default False

Force Google BigQuery to re-authenticate the user. This is usefulif multiple accounts are used.

auth_local_webserverbool, default True

Use thelocal webserver flow instead of theconsole flowwhen getting user credentials.

New in version 0.2.0 of pandas-gbq.

Changed in version 1.5.0:Default value is changed toTrue. Google has deprecated theauth_local_webserver=False“out of band” (copy-paste)flow.

dialectstr, default ‘legacy’

Note: The default value is changing to ‘standard’ in a future version.

SQL syntax dialect to use. Value can be one of:

'legacy'

Use BigQuery’s legacy SQL dialect. For more information seeBigQuery Legacy SQL Reference.

'standard'

Use BigQuery’s standard SQL, which iscompliant with the SQL 2011 standard. For more informationseeBigQuery Standard SQL Reference.

locationstr, optional

Location where the query job should run. See theBigQuery locationsdocumentation for alist of available locations. The location must match that of anydatasets used in the query.

New in version 0.5.0 of pandas-gbq.

configurationdict, optional

Query config parameters for job processing.For example:

configuration = {‘query’: {‘useQueryCache’: False}}

For more information seeBigQuery REST API Reference.

credentialsgoogle.auth.credentials.Credentials, optional

Credentials for accessing Google APIs. Use this parameter to overridedefault credentials, such as to use Compute Enginegoogle.auth.compute_engine.Credentials or Service Accountgoogle.oauth2.service_account.Credentials directly.

New in version 0.8.0 of pandas-gbq.

use_bqstorage_apibool, default False

Use theBigQuery Storage API todownload query results quickly, but at an increased cost. To use thisAPI, firstenable it in the Cloud Console.You must also have thebigquery.readsessions.createpermission on the project you are billing queries to.

This feature requires version 0.10.0 or later of thepandas-gbqpackage. It also requires thegoogle-cloud-bigquery-storage andfastavro packages.

max_resultsint, optional

If set, limit the maximum number of rows to fetch from the queryresults.

progress_bar_typeOptional, str

If set, use thetqdm library todisplay a progress bar while the data downloads. Install thetqdm package to use this feature.

Possible values ofprogress_bar_type include:

None

No progress bar.

'tqdm'

Use thetqdm.tqdm() function to print a progress bartosys.stderr.

'tqdm_notebook'

Use thetqdm.tqdm_notebook() function to display aprogress bar as a Jupyter notebook widget.

'tqdm_gui'

Use thetqdm.tqdm_gui() function to display aprogress bar as a graphical dialog box.

Returns:

df: DataFrame

DataFrame representing results of query.

See also

pandas_gbq.read_gbq

This function in the pandas-gbq library.

DataFrame.to_gbq

Write a DataFrame to Google BigQuery.

Examples

Example taken fromGoogle BigQuery documentation

>>>sql="SELECT name FROM table_name WHERE state = 'TX' LIMIT 100;">>>df=pd.read_gbq(sql,dialect="standard")>>>project_id="your-project-id">>>df=pd.read_gbq(sql,...project_id=project_id,...dialect="standard"...)