cursor.comment()

Definición

cursor.comment()

Importante

Método mongosh

Este es un método.mongosh Esta no es la documentación de Node.js ni de otros métodos de controlador específicos del lenguaje de programación.

En la mayoría de los casos, los métodos mongosh funcionan de la misma manera que los métodos tradicionales mongo Métodos de shell. Sin embargo, algunos métodos heredados no están disponibles mongosh en.

Para la documentación heredada de mongo shell, revisa la documentación de la versión correspondiente de MongoDB Server:

• mongo shell v4.4

• Mongo Shell v4.2

• mongo shell v4.0

Para los controladores de la API de MongoDB, consultar la documentación específica del controlador de MongoDB para cada lenguaje.

Novedad en la versión 3.2.

Agrega un campo comment a la query.

cursor.comment() tiene la siguiente sintaxis:

cursor.comment( <string> )

comment() tiene el siguiente parámetro:

Parameter	Tipo	Descripción
comment	string	El comentario que se aplicará a la query.

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

• MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

• MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB

• MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Comportamiento

comment() asocia un string de comentarios con la operación de búsqueda. Esto puede facilitar el rastrear una particular query en los siguientes resultados de diagnóstico:

• La system.profile

• El componente QUERY de registro

• db.currentOp()

Consulta configurar el nivel de verbosidad de los registros para el mongod registro, el Tutorial del perfilador de base de datos o el comando db.currentOp().

Ejemplo

La siguiente operación adjunta un comentario a una query en la colección restaurants:

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

Ejemplos de salida

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