PyCharm 2025.3 Help

Google BigQuery

启用 数据库工具和 SQL 插件

此功能依赖 数据库工具和 SQL 插件,该插件在 PyCharm 中默认随附并启用。 如果相关功能不可用,请确保未禁用该插件。

  1. Ctrl+Alt+S 打开设置,然后选择 插件

  2. 打开 已安装 选项卡,找到 数据库工具和 SQL 插件,并选中插件名称旁的复选框。

  • 有关 Google BigQuery 的完整信息,请参阅 官方文档

开始之前

本主题介绍如何在 PyCharm 中为与 Google BigQuery 数据库的 连接 创建数据源,并运行测试连接的一般过程。 假定您已经拥有必要的连接详细信息,并且数据库已启动并正在运行。

如需了解您的 DBMS 软件,请参阅其 官方文档

先决条件

身份验证方法

先决条件

Google 服务帐户

  • 项目 ID

  • 服务帐户电子邮件标识符

  • 包含私钥的 JSON 文件

访问令牌和刷新令牌

  • 访问令牌和刷新令牌

  • 客户端 ID

  • 客户端密钥

连接到 Google BigQuery 数据库

要连接到数据库,请创建一个数据源以存储您的连接详细信息。

  1. 选择您要创建的数据源。 您可以通过以下任一方式执行此操作:

    • 在主菜单中,转到 文件(F) | 新建(N) | 数据源 ,然后选择 Google BigQuery

    • 数据库 工具窗口中,点击工具栏上的 新建图标新建。 导航到 数据源 ,然后选择 Google BigQuery

    创建新的数据源
  2. 数据源和驱动程序 对话框右侧窗格的 常规 选项卡中,指定驱动程序和连接类型。

    1. 驱动程序 列表中,保留默认驱动程序选项,除非您的连接需要其他驱动程序。

    2. 连接类型 列表中,根据您掌握的连接详细信息选择连接类型:

      • 默认 :使用 主机端口项目 ID默认数据集URL 进行连接。

      • 仅 URL :仅使用 URL 进行连接。

      对于 仅 URL 连接类型 ,将按原样使用您输入的 JDBC URL,包括数据库凭据。

      对于其他连接类型,JDBC URL 会被拆分为连接详细信息。 您可以分别指定这些信息并使用自动生成的 URL,也可以在相应字段中直接输入 URL。

    数据源和驱动程序对话框的常规选项卡
  3. 检查连接设置区域底部是否存在 下载缺失的驱动程序文件 链接。 点击此链接下载与数据库交互所需的驱动程序。 如需直接下载链接,请参阅 JetBrains JDBC 驱动程序 页面。

    下载缺失的驱动程序文件链接

    下载的 JDBC 驱动程序的位置为 PyCharm 配置目录

    您也可以使用您自己的数据库驱动程序来代替提供的驱动程序。 有关使用您的驱动程序连接到数据库的更多信息,请参阅 将用户驱动程序添加到现有连接

    如果没有 下载缺失的驱动程序文件 链接,则表示您已经拥有所需的驱动程序。

  4. 指定数据库连接详细信息。 或者,在 URL 字段中粘贴 JDBC URL。

    1. 主机 字段中,输入服务器地址。

    2. 端口 字段中,输入 Google BigQuery 的端口。 默认端口为 443。

    3. 身份验证 下拉列表中,选择用于对该连接进行身份验证的身份验证方法。 可用的选项如下:

    4. 项目ID 字段中,输入项目的唯一标识符。

    5. 根据所选身份验证方法,指定以下连接设置:

      Google 服务帐户
      • 服务帐户电子邮件 :您的 Google 服务帐户电子邮件地址。

      • 密钥文件 :服务帐户私钥文件的完整路径。

      访问令牌和刷新令牌
      • 访问令牌 :您的访问令牌。

      • 刷新令牌 :您的刷新令牌。

      • 客户端ID :您的客户端 ID。

      • 客户端密钥 :您的客户端密钥。

      应用默认凭据
      • 服务帐户密钥文件 :服务帐户私钥文件的完整路径。

    6. 默认数据集 字段中,指定要连接的默认数据集名称。

    7. URL 字段中,PyCharm 生成的 JDBC URL 会自动使用其他连接设置的值。

      如果您需要使用带有某些附加设置的 JDBC URL,请将其粘贴到 URL 字段中。 要使用的通用 URL 如下:

      • 格式: jdbc:bigquery://https://<host_address>:<port_number>;DefaultDataset=<dataset_name>

      • 示例: jdbc:bigquery://https://www.googleapis.com/bigquery/v2:443;DefaultDataset=myDataset

      有关 URL 格式的更多信息,请参阅 Google BigQuery 官方文档

    数据库连接详细信息
    1. 身份验证 下拉列表中,选择用于对该连接进行身份验证的身份验证方法。 可用的选项如下:

    2. 项目ID 字段中,输入项目的唯一标识符。

    3. 根据所选身份验证方法,指定以下连接设置:

      Google 服务帐户
      • 服务帐户电子邮件 :您的 Google 服务帐户电子邮件地址。

      • 密钥文件 :服务帐户私钥文件的完整路径。

      访问令牌和刷新令牌
      • 访问令牌 :您的访问令牌。

      • 刷新令牌 :您的刷新令牌。

      • 客户端ID :您的客户端 ID。

      • 客户端密钥 :您的客户端密钥。

      应用默认凭据
      • 服务帐户密钥文件 :服务帐户私钥文件的完整路径。

    4. URL 字段中,PyCharm 生成的 JDBC URL 会自动使用其他连接设置的值。

      如果您需要使用带有某些附加设置的 JDBC URL,请将其粘贴到 URL 字段中。 要使用的通用 URL 如下:

      • 格式: jdbc:bigquery://https://<host_address>:<port_number>;DefaultDataset=<dataset_name>

      • 示例: jdbc:bigquery://https://www.googleapis.com/bigquery/v2:443;DefaultDataset=myDataset

      有关 URL 格式的更多信息,请参阅 Google BigQuery 官方文档

    数据库连接详细信息

    有关在 常规 以及 数据源和驱动程序 对话框(Shift+Enter )的其他选项卡上的连接设置和属性的参考信息,请参见 连接设置和 DBMS 特定属性

  5. 确保可以使用提供的详细信息建立数据库连接。 为此,请点击连接详细信息部分底部的 测试连接 链接。

    测试连接链接

    如果遇到任何连接问题,请参阅 无法连接到数据库 页面。

  6. (可选)默认情况下,仅内省默认项目和数据集,并可供使用。 如果还希望使用其他项目和数据集,请在 架构 选项卡中选择它们进行内省。

    数据源和驱动程序对话框的架构选项卡
  7. 点击 确定 创建数据源。

  8. 数据库 工具窗口中找到您的新数据源。

    • 有关 数据库 工具窗口的更多信息,请参阅相应的 参考主题

    • 有关在 PyCharm 中处理数据库对象的更多信息,请参阅 数据库对象

    • 要写和运行查询,打开默认 查询文件 ,方法是点击数据源并按 F4

    • 要查看和编辑数据库对象的数据,打开 数据编辑器和查看器 ,方法是双击该对象。

连接设置和 DBMS 特定属性

连接设置

有关在 数据源和驱动程序 对话框(Shift+Enter )的 常规 及其他选项卡上的连接设置(例如, 主机端口 等)的参考信息,请参见 数据源

DBMS 特定属性

常规选项卡

描述

身份验证方法

项目ID

项目的唯一标识符。

  • Google 服务帐号

  • Google 用户帐号

  • 访问和刷新令牌

  • 应用程序默认凭据

服务帐户电子邮件

Google 服务帐户电子邮件地址。

Google 服务帐号

密钥文件 和 服务帐户密钥文件

服务帐户私钥文件的完整路径。

  • Google 服务帐号

  • 应用程序默认凭据

访问令牌

生成的访问令牌。

访问和刷新令牌

刷新令牌

生成的刷新令牌。

客户端ID

生成的 Google 客户端 ID。

客户端密钥

生成的 Google 客户端密钥。

默认数据集

默认数据集的名称。

  • Google 服务帐号

  • Google 用户帐号

  • 访问和刷新令牌

  • 应用程序默认凭据

最后修改日期: 2025年 12月 2日