PyCharm 2025.3 Help

ClickHouse

启用 数据库工具和 SQL 插件

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

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

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

开始之前

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

例如,如果您要在本机上运行数据库并连接到该数据库,则必须先在该计算机上安装相应的 DBMS 软件。

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

连接到 ClickHouse 数据库

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

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

    • 在主菜单中,转到 文件(F) | 新建(N) | 数据源 并选择 ClickHouse

    • 数据库 工具窗口中,点击工具栏上的 New 图标新建。 导航到 数据源 并选择 ClickHouse

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

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

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

      • 默认 :使用 主机端口数据库URL 进行连接。

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

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

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

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

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

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

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

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

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

    1. 主机 字段中,键入您的服务器地址。

    2. 端口 字段中,键入 ClickHouse 的端口。 默认端口是 8123。

    3. 身份验证 下拉列表中,选择您要用于验证连接的身份验证方法。 以下选项可用:

      • 用户与密码 :使用您的登录名和密码。

      • 无身份验证 :无需身份验证。

    4. 用户密码 字段中,键入您的用户凭据。

      要不使用密码,请将 密码 字段留空。

      要删除曾经输入的密码,请右键点击 密码 字段并选择 设为空

      上下文菜单中的 Set Empty 操作
    5. 数据库 字段中,键入您要连接的数据库名称。

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

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

      • 格式: jdbc:clickhouse://<host_address>:<port_number>/<database_name>

      • 示例: jdbc:clickhouse://127.0.0.1:8123/myDatabase

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

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

      • 用户与密码 :使用您的登录名和密码。

      • 无身份验证 :无需身份验证。

    2. 用户密码 字段中,键入您的用户凭据。

      要不使用密码,请将 密码 字段留空。

      要删除曾经输入的密码,请右键点击 密码 字段并选择 设为空

      上下文菜单中的 Set Empty 操作
    3. URL 字段中,PyCharm 会使用其他连接设置的值自动生成 JDBC URL。

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

      • 格式: jdbc:clickhouse://<host_address>:<port_number>/<database_name>

      • 示例: jdbc:clickhouse://127.0.0.1:8123/myDatabase

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

    数据库连接详细信息

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

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

    测试连接 链接

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

  6. (可选)默认情况下,只对默认架构进行内省并可供使用。 如果您还想处理其他架构,请在 架构 选项卡中选择它们进行内省。

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

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

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

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

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

    • 要查看并编辑数据库对象的数据,请通过双击该对象打开 数据编辑器和查看器

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