$comment (クエリコメント)
最終更新：2026-10-09
$comment (クエリコメント)
$comment はクエリに説明文を付与し、currentOp、スロークエリログ、プロファイラーでクエリの発信元を追跡できるようにします。`{ $comment: 'checkout-cart-query' }` のように書くか、db.coll.find(...).comment('checkout') のようにチェーンします。結果やインデックス選択には影響しません。運用上の診断のためにクエリにタグを付ける用途に使います。
| カテゴリ | 投影 |
|---|---|
| MongoDB バージョン | 4.4+ |
| 例の言語 | mongosh（シェル） |
📝 構文
{ $comment: <comment string> }⚙️ パラメータ
| コメント文字列 | 診断情報に表示される任意のテキスト。 |
|---|
戻り値：クエリ結果（コメントの影響を受けません）
▶ 例
以下のコマンドをローカルの mongosh で実行してください（mongod が起動済みである必要があります）：
// $comment: 運用診断用にクエリへタグを付ける
db.orders.find(
{ status: 'pending' },
{ _id: 1 }
).comment('checkout-pending-orders')出力：
// 結果は変わらない。コメントは診断情報に記録される📌 注意事項
- 結果や実行プランは変わらない
- スロークエリログ、currentOp、プロファイルで確認できる
- 集計パイプラインにも comment オプションを指定できる
🏷️ 関連タグ
💡 関連ケース
さらなる実践ケースを近日公開予定。
📚 関連チュートリアル
❓ よくある質問
Q$comment はクエリ結果を変えますか？
Aいいえ。メタデータのみで、結果やインデックス選択には影響しません。
Qコメントはどこで確認できますか？
AcurrentOp とスロークエリログ（system.profile）で確認できます。
Q集計クエリにもコメントを付けられますか？
Aはい。db.coll.aggregate([...], { comment: '...' }) のように指定します。
