$comment (Comentário de Consulta)
Última atualização: 2026-10-09
$comment (Comentário de Consulta)
$comment anexa texto explicativo a uma consulta para que você possa rastrear sua origem em currentOp, no log de consultas lentas e no profiler. `{ $comment: 'checkout-cart-query' }` ou encadeado como db.coll.find(...).comment('checkout'). Ele não afeta resultados nem a seleção de índices. Use-o para marcar consultas para diagnóstico de operações.
| Categoria | Projeção |
|---|---|
| Versão do MongoDB | 4.4+ |
| Idioma do Exemplo | mongosh (Shell) |
📝 Sintaxe
{ $comment: <string de comentário> }⚙️ Parâmetros
| string de comentário | Texto arbitrário que aparece nos diagnósticos. |
|---|
Retorno：Resultados da consulta (não afetados pelo comentário)
▶ Exemplo
Execute os comandos abaixo no seu mongosh local (requer um mongod em execução):
// $comment: marca a consulta para operações
db.orders.find(
{ status: 'pending' },
{ _id: 1 }
).comment('checkout-pending-orders')Saída：
// Os resultados não mudam; o comentário é registrado nos diagnósticos📌 Notas
- Não altera resultados nem o plano de execução
- Visível em logs de consultas lentas, currentOp e profile
- Pipelines de agregação também aceitam uma opção comment
🏷️ Tags Relacionados
💡 Casos Relacionados
Mais casos práticos em breve.
📚 Tutoriais Relacionados
❓ Perguntas Frequentes
Q$comment altera os resultados da consulta?
ANão, é apenas metadado e não afeta resultados nem a seleção de índices.
QOnde posso ver o comentário?
AEm currentOp e no log de consultas lentas (system.profile).
QConsultas de agregação podem carregar comentários?
ASim, db.coll.aggregate([...], { comment: '...' }).
