pandas.read_gbq

熊猫。read_gbq（查询， 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 =无)

从 Google BigQuery 加载数据。

自 2.2.0 版起已弃用：请改用pandas_gbq.read_gbq。

该功能需要pandas-gbq 包。

有关身份验证说明，请参阅如何使用 Google BigQuery 进行 身份验证指南。

参数：

查询字符串

用于返回数据值的类似 SQL 的查询。

project_id str，可选

Google BigQuery 帐户项目 ID。当环境可用时可选。

index_col str，可选

用于结果 DataFrame 中索引的结果列的名称。

col_order列表(str)，可选

按结果 DataFrame 所需顺序排列的 BigQuery 列名称列表。

reauth布尔值，默认 False

强制 Google BigQuery 重新验证用户身份。如果使用多个帐户，这非常有用。

auth_local_webserver布尔值，默认 True

获取用户凭据时，使用本地 Web 服务器流程而不是控制台流程。

pandas-gbq 0.2.0 版本中的新增功能。

版本 1.5.0 中更改：默认值更改为True。 Google 已弃用 “带外”（复制粘贴）流程。auth_local_webserver = False

方言str，默认“legacy”

注意：默认值在未来版本中将更改为“标准”。

要使用的 SQL 语法方言。值可以是以下之一：

'legacy'

使用 BigQuery 的旧版 SQL 方言。有关更多信息，请参阅 BigQuery 旧版 SQL 参考。

'standard'

使用 BigQuery 的标准 SQL，该 SQL 符合 SQL 2011 标准。有关更多信息，请参阅BigQuery 标准 SQL 参考。

位置str，可选

查询作业应运行的位置。有关可用位置的列表，请参阅BigQuery 位置文档。该位置必须与查询中使用的任何数据集的位置相匹配。

pandas-gbq 0.5.0 版本中的新增功能。

配置字典，可选

查询作业处理的配置参数。例如：

配置 = {'query': {'useQueryCache': False}}

有关更多信息，请参阅BigQuery REST API 参考。

凭证google.auth.credentials.Credentials，可选

访问 Google API 的凭据。使用此参数可以覆盖默认凭据，例如直接使用 Compute Engine google.auth.compute_engine.Credentials或服务帐号 google.oauth2.service_account.Credentials。

pandas-gbq 0.8.0 版本中的新增功能。

use_bqstorage_api bool, 默认 False

使用BigQuery Storage API快速下载查询结果，但成本会增加。要使用此 API，请首先在 Cloud Console 中启用它。您还必须 对要对其进行计费查询的项目拥有bigquery.readsessions.create权限。

此功能需要 0.10.0 或更高版本的软件包pandas-gbq 。它还需要google-cloud-bigquery-storage和 fastavro包。

max_results int，可选

如果设置，则限制从查询结果中获取的最大行数。

Progress_bar_type可选，str

如果设置，则使用tqdm库在数据下载时显示进度条。安装该 tqdm软件包以使用此功能。

可能的值progress_bar_type包括：

None

没有进度条。

'tqdm'

使用该tqdm.tqdm()函数将进度条打印到sys.stderr.

'tqdm_notebook'

使用该tqdm.tqdm_notebook()函数将进度条显示为 Jupyter 笔记本小部件。

'tqdm_gui'

使用该tqdm.tqdm_gui()函数将进度条显示为图形对话框。

返回：

df：数据框

表示查询结果的 DataFrame。

也可以看看

pandas_gbq.read_gbq

这个函数在pandas-gbq库中。

DataFrame.to_gbq

将 DataFrame 写入 Google BigQuery。

例子

示例取自Google BigQuery 文档

>>> 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"
...                  )