JetBrains Rider 2025.2 Help

ClickHouse

启用 Database Tools and SQL 插件

此功能依赖于 Database Tools and SQL 插件,该插件在 JetBrains Rider 中默认捆绑并启用。 如果相关功能不可用,请确保您未禁用该插件。

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

  2. 打开 已安装 选项卡,找到 Database Tools and SQL插件,然后选择插件名称旁边的复选框。

开始之前

本主题介绍了如何为 连接到您的 ClickHouse 数据库在 JetBrains Rider 中创建数据源,并运行测试连接的一般步骤。 假设您已经拥有必要的连接详细信息,并且数据库已启动并运行。

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

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

连接到 ClickHouse 数据库

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

  1. 数据库 工具窗口中,单击 新图标新建 并选择 连接到数据库

  2. 如果您的解决方案或其他地方定义了数据库的连接字符串,请保持 使用连接字符串 选项选中,并在 数据库类型 选择器中选择 ClickHouse

    使用 字符串 选择器从您的解决方案中选择所需的连接字符串,或手动输入,然后点击 连接

  3. 您还可以选择 手动添加数据源 ,点击 下一步 并在 数据库源 选择器中选择 ClickHouse。 按照向导步骤,通过配置各个选项来形成连接字符串。

  4. 要访问新数据库连接的所有可用选项,请在 数据库 窗口中点击 ,然后点击 新图标新建 并选择 ClickHouse

  5. 常规 标签的 数据源和驱动程序 对话框右侧窗格中,指定驱动程序和连接类型。

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

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

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

      • URL only :仅使用 URL 连接。

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

      对于其他连接类型,JDBC URL 被分解为连接详情。 您可以分别指定它们并使用自动生成的 URL,也可以直接在相应字段中输入 URL。

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

    下载缺失的驱动文件链接

    下载的 JDBC 驱动程序的位置是 JetBrains Rider 配置目录

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

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

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

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

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

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

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

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

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

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

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

      将集合设置为空上下文菜单操作
    5. 数据库 字段中,输入您想要连接的数据库名称。

    6. URL 字段中,JetBrains Rider使用其他连接设置的值自动生成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 字段中,JetBrains Rider使用其他连接设置的值自动生成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 )中连接设置(例如, 主机端口 等)的参考信息,请参阅 数据源

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

    测试连接链接

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

  9. (可选)默认情况下,仅检查默认架构并可供使用。 如果您还想使用其他架构,请在 架构 选项卡中选择它们以进行检查。

    数据源和驱动程序对话框的 Schemas 选项卡
  10. 请点击 确定 以创建数据源。

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

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

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

    • 要编写并运行查询,请点击数据源并按 F4 ,以打开默认的 query console

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

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