WebStorm 2025.2 Help

DocumentDB

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

准备工作

本文介绍了一般流程,说明如何在 WebStorm 中为您的 DocumentDB 数据库创建用于 连接的数据源,并运行测试连接。 假设您已有所需的连接详情,并且数据库已启动并可用。

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

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

连接 DocumentDB 数据库

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

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

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

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

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

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

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

      • 默认值 :标准的连接字符串格式(例如, mongodb://localhost:27021/admin)。 有关标准连接字符串格式的更多信息,请参阅 docs.mongodb.com 上的标准连接字符串格式

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

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

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

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

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

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

    您也可以使用自己的数据库驱动程序替代内置驱动程序。 有关使用自定义驱动程序连接数据库的更多信息,请参阅 向现有连接添加用户驱动程序

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

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

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

    2. 端口 字段中,输入 DocumentDB 的端口。 默认端口为 27017。

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

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

      • MongoDB 身份验证选项:

        • SCRAM-SHA-1 :使用 用户密码身份验证数据库 和 SHA-256 哈希函数进行身份验证。

        • SCRAM-SHA-256 :使用 用户密码身份验证数据库 和 SHA-1 哈希函数进行身份验证。

        • AWS IAM :使用 AWS 访问密钥 IDAWS 密钥访问密钥AWS 会话令牌 进行身份验证。

        • x.509 :使用 x.509 证书进行身份验证。

        • GSSAPI (Kerberos) :使用 Kerberos 进行身份验证。

        • 普通(LDAP) :通过将身份验证请求代理至轻型目录访问协议(LDAP)服务进行身份验证。

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

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

      如无需密码,请将 密码 字段留空。

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

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

    6. URL 字段中,WebStorm 会根据其他连接设置的值自动生成 JDBC URL。

      如需使用带有附加设置的 JDBC URL,请将其粘贴到 URL 字段中。 通用 URL 格式如下:

      • 格式: mongodb://⋖host_address⋗:⋖port_number⋗/⋖database_name⋗

      • 示例: mongodb://127.0.0.1:27017/myDatabase

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

    数据库连接详情
    1. 身份验证 下拉列表中选择用于连接身份验证的身份验证方法。 可用选项如下:

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

      • MongoDB 身份验证选项:

        • SCRAM-SHA-1 :使用 用户密码身份验证数据库 和 SHA-256 哈希函数进行身份验证。

        • SCRAM-SHA-256 :使用 用户密码身份验证数据库 和 SHA-1 哈希函数进行身份验证。

        • AWS IAM :使用 AWS 访问密钥 IDAWS 密钥访问密钥AWS 会话令牌 进行身份验证。

        • x.509 :使用 x.509 证书进行身份验证。

        • GSSAPI (Kerberos) :使用 Kerberos 进行身份验证。

        • 普通(LDAP) :通过将身份验证请求代理至轻型目录访问协议(LDAP)服务进行身份验证。

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

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

      如无需密码,请将 密码 字段留空。

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

      “设置为空”上下文菜单操作
    3. URL 字段中,WebStorm 会根据其他连接设置的值自动生成 JDBC URL。

      如需使用带有附加设置的 JDBC URL,请将其粘贴到 URL 字段中。

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

    数据库连接详情

    有关 常规数据源和驱动程序 对话框其他标签页中连接设置与属性的参考信息(Shift+Enter ),请参阅 连接设置与特定 DBMS 属性

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

    测试连接链接

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

  6. (可选)默认情况下,仅默认数据库会被解析并可供使用。 如果希望使用其他数据库,请在 架构 标签页中选择用于解析的数据库。

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

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

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

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

    • 若要编写和运行查询,请点击数据源并按下 F4 打开默认的 查询控制台

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

连接设置与特定 DBMS 属性

连接设置

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

特定 DBMS 属性

常规选项卡

项目

描述

身份验证数据库

与您的用户名关联的身份验证数据库的名称。 如果身份验证数据库不同于您要连接的数据库,请在 URL 中使用 authSource 参数指定身份验证数据库。 如果未指定身份验证数据库,MongoDB 默认使用 admin 数据库。

例如,您希望连接到 local 数据库,但您的身份验证数据库是 admin。 在这种情况下,连接 URL 将如下所示: mongodb://localhost:27017/local?authSource=admin

该属性用于 SCRAM-SHA-1SCRAM-SHA-256 身份验证方法。

AWS 访问密钥 ID

用于 MongoDB AWS IAM 身份验证方法的连接属性。

AWS 会话令牌

AWS 秘密访问密钥

主体

用于 MongoDB GSSAPI (Kerberos) 身份验证方法的连接属性。

有关详细信息,请参阅 MongoDB 此方法的官方文档

服务名称

服务领域

规范化主机名

读取偏好

要启用该选项,请在设置区域右上方的 更多选项 列表中进行选择。

请参阅 MongoDB 关于读取偏好的官方文档

副本集

要启用该选项,请在设置区域右上方的 更多选项 列表中进行选择。

请参阅 MongoDB 关于副本集的官方文档

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