WebStorm 2025.2 Help

ClickHouse

准备工作

本主题介绍在 WebStorm 中为与 ClickHouse 数据库的 连接 创建数据源并运行测试连接的一般过程。 假设您已经拥有必要的连接信息,并且数据库已启动并正在运行。

例如,如果您希望在本机上运行数据库并连接至该数据库,必须先在该主机上安装相应的 DBMS 软件。

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

连接 ClickHouse 数据库

要连接至数据库,请创建一个用于存储连接信息的数据源。

  1. 选择要创建的数据源。 您可以通过以下方式之一进行选择:

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

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

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

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

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

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

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

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

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

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

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

    下载的 JDBC 驱动程序将存储于 WebStorm 配置目录 中。

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

    如果没有 下载缺失的驱动程序文件 链接,说明所需驱动程序已经具备。

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

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

    2. 端口 字段中输入 ClickHouse 的端口号。 默认端口为 8123。

    3. 身份验证 下拉菜单中,选择用于验证连接的身份验证方法。 可用的选项包括:

      • 用户与密码 :使用您的登录名和密码进行身份验证。

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

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

      如需无需密码,请保持 密码 字段为空。

      如需删除已输入的密码,请右键点击 密码 字段并选择 设为空

      “设置为空”右键菜单操作
    5. 数据库 字段中输入要连接的数据库名称。

    6. URL 字段中,WebStorm 将根据其他连接设置的值自动生成 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. 用户密码 字段中输入您的用户凭据。

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

      如需删除已输入的密码,请右键单击 密码 字段并选择 设为空

      “设置为空”右键菜单操作
    3. URL 字段中,WebStorm 会使用其他连接设置的值自动生成 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. 数据库 工具窗口中查找新建的数据源。

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

    • 有关在 WebStorm 中操作数据库对象的更多信息,请参阅 数据库对象

    • 如需编写并运行查询,请单击数据源并按 F4 打开默认的 查询控制台

    • 如需查看和编辑数据库对象的数据,请双击对象以打开 数据编辑器与查看器

最后修改日期: 2025年 9月 26日