Menu Docs
Página inicial do Docs
/
Manual do MongoDB
/ / /

cursor.comment()

Nesta página

  • Definição
  • Comportamento
  • Exemplo
  • Exemplos de saída
cursor.comment()

Importante

Método mongosh

Esta página documenta um método mongosh. Esta não é a documentação de um driver de idioma específico, como Node.js.

Para drivers de API do MongoDB, consulte a documentação do driver do MongoDB específica da linguagem.

Adiciona um campo comment à query.

cursor.comment() tem a seguinte sintaxe:

cursor.comment( <string> )

comment() tem o seguinte parâmetro:

Parâmetro
Tipo
Descrição
comment
string
O comentário a aplicar à query.

comment() associa uma string de comentário à operação de localização. Isso pode facilitar o rastreamento de uma query específica nas seguintes saídas de diagnóstico:

  • O system.profile

  • O componente de registro QUERY

  • db.currentOp()

Consulte configurar verbosidade de registro para o registro mongod , o tutorial de implantação de banco de dados ou o comando db.currentOp() .

A seguinte operação anexa um comentário a uma query na collection restaurants :

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

O seguinte é um trecho do system.profile :

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

O seguinte é um trecho do log mongod . Foi formatado para legibilidade.

Importante

O nível de verbosidade para QUERY deve ser maior que 0. Consulte Configurar níveis de verbosidade de registro

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"
}
...

Suponha que a seguinte operação esteja atualmente sendo executada em uma instância mongod :

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

A execução do comando db.currentOp() retorna o seguinte:

{
"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
}

Voltar

cursor.collation