cursor.comment()

Definição

cursor.comment()

Importante

Método mongosh

Este é um método mongosh . Esta não é a documentação de Node.js ou de outros métodos de driver específicos da linguagem de programação.

Na maioria dos casos, os métodos mongosh funcionam da mesma forma que os métodos legado do shell mongo . No entanto, alguns métodos legado não estão disponíveis em mongosh.

Para a documentação do shell legado mongo, consulte a documentação para a release correspondente do MongoDB Server:

• mongo shell v4.4

• mongo shell v4,2

• mongo shell v4.0

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

Novo na versão 3.2.

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.

Comportamento

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() .

Exemplo

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

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

Exemplos de saída

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

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.restaurants.find(
   { "borough" : "Manhattan" }
).comment("Find all Manhattan restaurants")

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