Docs 菜单

Docs 主页开发应用程序MongoDB for VS Code

使用 Playgrounds 探索您的数据

在此页面上

  • 先决条件
  • 打开 Playground
  • 运行 Playground
  • 代码格式化和代码检查工具
  • 从 Playground 登录控制台
  • 教程
  • 身份验证注意事项

MongoDB Playground 是 JavaScript 环境,您可以在其中借助有用的语法高亮显示功能对查询、聚合和 MongoDB 命令进行原型设计。

MongoDB Playgrounds 为以下内容提供智能自动完成:

  • Mongo Shell API

  • MongoDB 关键字、运算符、聚合阶段、数据库、集合、和字段名称。

  • 任何 JavaScript 变量或关键字。

您可以将 Playground 保存在工作区中,并使用它们记录应用程序如何与 MongoDB 交互。MongoDB for VS Code 将扩展名为 .mongodb.js 的文件解读为 Playground。

从版本 0.11.0 开始,MongoDB Playgrounds 文件的默认文件扩展名是 .mongodb.js。上一个版本的 MongoDB Playgrounds 使用默认文件扩展名 .mongodb。MongoDB Playgrounds 支持这两种文件扩展名。

注意

您还可以在自己的应用程序中使用相应的 驱动程序对文档执行增删改查操作。 Playgrounds 旨在帮助您在开发应用程序时对数据库操作进行原型设计。

MongoDB for VS Code 会拆分 Playground 窗口,以在右侧窗格中显示 Playground Result。根据在 Playground 中运行的查询,您可以对结果执行两个操作之一。

  • 您可以将任何 Playground Result 保存到文件中。

  • 您可以编辑 MongoDB for VS Code 在Playground Result中从 findOne 或 find 查询返回的任何 JSON 文档

    MongoDB for VS Code 会以 JSON 格式返回这些结果,并具有 JSON 语法突出显示效果。每个 JSON 文档的顶部都有一个 Edit Document 链接。

    1. 单击要编辑的文档顶部的 Edit Document(编辑文档)。

      MongoDB for VS Code 会在一个新窗口中将这个 JSON 文档作为可编辑文档打开。

    2. 根据需要进行任何更改。

    3. Ctrl+S(在 macOS 上为 Cmd+S)将这些更改保存到数据库中。

要运行 Playground,您必须使用 MongoDB for VS Code 连接到 MongoDB 部署。要了解如何连接到部署,请参阅以下项目之一:

您可以通过 面板、MongoDB for VS Code 概述 页面或 Microsoft Visual Studio Code 创建新的 PlaygroundPlaygrounds 命令面板。

如果您的 Visual Studio Code 工作区中有扩展名为 .mongodb.js.mongodb 的文件,MongoDB for VS Code 就会在 Playgrounds 面板中显示这些文件。

双击文件以打开该 Playground。

要运行 Playground,请单击 VS Code 顶部导航栏中的 Play Button“播放”按钮。Playground 根据活动连接中指定的部署运行。

如果 MongoDB for VS Code 未连接到 MongoDB 部署,您可以为要运行 Playground 的部署指定连接字符。

如果您在 Visual Studio Code 中打开了 Playground 文件并且没有活动连接,则 MongoDB for VS Code 会在 Playground 顶部显示 Click here to add connection

1

单击 Click here to add connection 后,MongoDB for VS Code 显示连接字符串下拉菜单。

从 Playground 添加连接的链接
点击放大
2

在连接字符串下拉菜单中选择 Add new connection,输入新的连接字符串。如果您之前已通过其他部署连接到 Playground,则下拉菜单会显示该连接字符串,作为一个选项。

3

输入连接字符串以连接到您的部署。

注意

如果连接字符串指定了数据库,则默认情况下,Playground 会针对该数据库运行。要切换数据库,请调用 use('<database_name>')

如果已连接到默认数据库,则 Playground 只为该数据库上可用的集合名称提供自动补全功能。

4

输入连接字符串后, CodeLens 替换Click here to add connection 链接。 CodeLens 包含有关已连接部署的信息以及当前数据库(如果适用)的信息。

5

注意

通过 Playground 连接对话框连接到部署时,该连接将被添加到 MongoDB for VS Code Connections Connections 列表中。

如果您在您的 Playground 选取了一段代码,您可以选择只运行这选定的部分。您可以运行 Playground 中的单行或多行代码。

MongoDB for VS Code 在您所选部分的正上方显示Run Selected Lines from Playground链接。单击此链接可对 Playground 的特定线路或各个部分进行测试和故障排除。

MongoDB Playgrounds 是 JavaScript 文件,可以与流行的 Visual Studio Code 格式化和检查扩展一起使用,例如 Prettier ESLint

如果您使用代码格式设置扩展,则 MongoDB Playground 为以下内容提供自动完成和代码检查提示建议:

  • 系统变量,例如 $$ROOT$$NOW

  • usedb 命令

  • 集合名称,用括号表示,例如 db["collection"].find({})

  • MongoDB Playground 不支持 shell 命令的替代命令,例如 show users

有关自动完成和检查改进的完整列表,请参阅 v0 。11 。1 发布说明

MongoDB for VS Code 支持使用以下方法将消息记录到控制台。记录的消息显示在 VSCode 的 Output 面板中。

  • console.log()

  • print()

  • printjson()

将消息记录到控制台对于追踪 Playground 中某些命令的输出非常有用,例如特定查询或聚合后的结果。

  • 要了解如何使用 MongoDB Playground 进行 CRUD 操作,请参阅执行 CRUD 操作

  • 要了解如何使用 MongoDB Playground 运行聚合管道,请参阅运行聚合管道

如果您的部署需要身份验证,则您的数据库用户权限可能会影响您使用 MongoDB for VS Code 可以执行的操作。

← 浏览数据