$comment(查询注释)
最后更新:2026-10-09
$comment(查询注释)
$comment 给查询附加说明文字,方便在 currentOp、慢查询日志和 profile 中定位查询来源。`{ $comment: 'checkout-cart-query' }` 或链式 `db.coll.find(...).comment('checkout')`。不影响查询结果与执行计划(不参与索引选择)。适合标注业务用途便于运维诊断。
| 分类 | 投影 |
|---|---|
| MongoDB 版本 | 4.4+ |
| 示例语言 | mongosh (Shell) |
📝 语法
{ $comment: <注释字符串> }
⚙️ 参数
| 注释字符串 | 任意说明文字,会出现在诊断信息中。 |
|---|
返回值:查询结果(不受注释影响)
▶ 示例
请在本地安装的 mongosh 中执行以下命令(需已启动 mongod):
// $comment:标注查询业务来源
// 注释会出现在慢日志与 currentOp
db.orders.find(
{ status: 'pending' },
{ _id: 1 }
).comment('checkout-pending-orders')
运行结果:
// 查询结果不受影响,注释记录在诊断信息中
📌 注意事项
- 不改变查询结果与执行计划
- 慢查询日志、currentOp、profile 中可见
- 聚合管道也可用 comment 选项注释
🏷️ 相关标签
💡 相关案例
更多实战案例即将上线,敬请期待。
📚 相关教程
❓ 常见问题
Q$comment 会改变查询结果吗?
A不会,它只是附加元数据,不影响结果与索引选择。
Q$comment 在哪能看到?
AcurrentOp、慢查询日志(system.profile)里能看到注释。
Q聚合查询能加注释吗?
A能,db.coll.aggregate([...], { comment: '...' })。