Docs 菜单
Docs 主页
/
MongoDB Manual
/
参考
/
mongosh 方法
/
Cursors

cursor.comment()

在此页面上

  • 定义
  • 兼容性
  • 行为
  • 例子
  • 输出示例

定义

cursor.comment()

重要

mongosh 方法

这是一个mongosh方法。 这不是Node.js或其他特定于编程语言的驱动程序方法的文档。

在大多数情况下， mongosh方法的工作方式与传统 mongo shell方法相同。 但是，某些旧方法在mongosh中不可用。

有关旧版mongo shell 文档，请参阅相应 MongoDB Server 版本的文档：

有关 MongoDB API 驱动程序，请参阅特定语言的 MongoDB 驱动程序文档。

版本 3.2 中的新增功能。

在查询中添加comment字段。

cursor.comment() 通过以下语法实现：

cursor.comment( <string> )

comment() 有以下参数：

Parameter
类型
说明

comment

字符串

要应用于查询的注释。

兼容性

此方法可用于以下环境中托管的部署：

注意

所有 MongoDB Atlas 集群都支持此命令。有关 Atlas 对所有命令的支持的信息，请参阅不支持的命令。

行为

comment() 将注释字符串与查找操作相关联。 这样可以更轻松地在以下诊断输出中跟踪特定查询：

请参阅配置mongod日志的日志详细程度、数据库分析器教程或db.currentOp()命令。

例子

以下操作将注释附加到查询在restaurants collection：

db.restaurants.find(
   { "borough" : "Manhattan" }
).comment( "Find all Manhattan restaurants" )

输出示例

system.profile

以下是system.profile的摘录：

{
   "op" : "query",
   "ns" : "guidebook.restaurant",
   "query" : {
      "find" : "restaurant",
      "filter" : {
         "borough" : "Manhattan"
      },
      "comment" : "Find all Manhattan restaurants"
   },
   ...
}

mongod log

以下是mongod日志的摘录。 为便于阅读，已对其进行格式化。

重要

QUERY的详细程度必须大于0 。 请参阅配置日志详细程度

2015-11-23T13:09:16.202-05:00 I COMMAND  [conn1]
   command guidebook.restaurant command: find {
      find: "restaurant",
      filter: { "borough" : "Manhattan" },
      comment: "Find all Manhattan restaurants"
   }
   ...

db.currentOp()

假设以下操作当前正在mongod实例上运行：

db.restaurants.find(
   { "borough" : "Manhattan" }
).comment("Find all Manhattan restaurants")

运行db.currentOp()命令会返回以下内容：

{
   "inprog" : [
      {
         "host" : "198.51.100.1:27017",
         "desc" : "conn3",
         "connectionId" : 3,
         ...
         "op" : "query",
         "ns" : "test.$cmd",
         "command" : {
            "find" : "restaurants",
            "filter" : {
               "borough" : "Manhattan"
            },
            "comment" : "Find all Manhattan restaurants",
            "$db" : "test"
         },
         "numYields" : 0,
         ...
      }
   ],
   "ok" : 1
}

后退

游标 ion

来年

游标