mongosh Ayuda

Ayuda de línea de comandos

Para ver las opciones para ejecutar el archivo ejecutable mongosh y conectar con una implementación, utiliza la opción --help desde la línea de comandos:

mongosh --help

mongosh Ayuda de shell

Para ver la lista de comandos disponibles en la consola mongosh, escribe help dentro de una consola mongosh en ejecución:

help

Ayuda de base de datos

Puedes ver información a nivel de base de datos desde dentro de la consola mongosh:

Por defecto, mongosh muestra la base de datos actual en el prompt. También puedes ver la base de datos actual ejecutando el comando db:

db

show dbs

db.help()

Database Class:
  getMongo                      Returns the current database connection
  getName                       Returns the name of the DB
  getCollectionNames            Returns an array containing the names of all collections in the current database.
  getCollectionInfos            Returns an array of documents with collection information, i.e. collection name and options, for the current database.
  runCommand                    Runs an arbitrary command on the database.
  adminCommand                  Runs an arbitrary command against the admin database.
  ...

db.adminCommand.help()

  db.adminCommand({ serverStatus: 1 }):
  Runs an arbitrary command against the admin database.
  For more information on usage: https://www.mongodb.com/es/docs/manual/reference/method/db.adminCommand

db.adminCommand

[Function: adminCommand] AsyncFunction {
  apiVersions: [ 1, Infinity ],
  serverVersions: [ '3.4.0', '999.999.999' ],
  returnsPromise: true,
  topologies: [ 'ReplSet', 'Sharded', 'LoadBalanced', 'Standalone' ],
  returnType: { type: 'unknown', attributes: {} },
  deprecated: false,
  platforms: [ 0, 1, 2 ],
  isDirectShellCommand: false,
  acceptsRawInput: false,
  shellCommandCompleter: undefined,
  help: [Function (anonymous)] Help
}

Ayuda de la colección

Puedes ver información a nivel de colección desde dentro de la consola mongosh.

Estos métodos de ayuda aceptan un nombre de colección, <collection>, pero también puedes usar el término genérico "colección", o incluso una colección que no exista.

show collections

managementFeedback          [view]
survey
weather                     [time-series]
system.buckets.weather
system.views

db.collection.help()

Collection Class:
  aggregate          Calculates aggregate values for the data in a collection or a view.
  bulkWrite          Performs multiple write operations with controls for order of execution.
  count              Returns the count of documents that would match a find() query for the collection or view.
  countDocuments     Returns the count of documents that match the query for a collection or view.
  deleteMany         Removes all documents that match the filter from a collection.
  deleteOne          Removes a single document from a collection.
  ...

db.collection.insertOne.help()

db.collection.insertOne(document, options):
Inserts a document into a collection.
For more information on usage: https://www.mongodb.com/es/docs/manual/reference/method/db.collection.insertOne

db.collection.insertOne

[Function: insertOne] AsyncFunction {
  apiVersions: [ 1, Infinity ],
  serverVersions: [ '3.2.0', '999.999.999' ],
  returnsPromise: true,
  topologies: [ 'ReplSet', 'Sharded', 'LoadBalanced', 'Standalone' ],
  returnType: { type: 'unknown', attributes: {} },
  deprecated: false,
  platforms: [ 0, 1, 2 ],
  isDirectShellCommand: false,
  acceptsRawInput: false,
  shellCommandCompleter: undefined,
  help: [Function (anonymous)] Help
}

Ayuda del cursor

Para modificar las operaciones de lectura que utilizan find(), utiliza los métodos de cursor.

Para enumerar los métodos disponibles de manejo de modificadores y cursores, usa el comando db.collection.find().help():

db.collection.find().help()

Esta llamada de ayuda acepta un nombre de colección, <collection>, pero también puedes usar el término genérico, "colección", o incluso una colección que no exista.

Algunos métodos útiles para manejar cursores son:

• hasNext() verifica si el cursor tiene más documentos.

• next() devuelve el siguiente documento y avanza la posición del cursor una unidad.

• forEach(<function>) aplica el <function> a cada documento devuelto por el cursor.

Para ver una lista de métodos de cursor disponibles, dirígete a Cursors.

Ayuda de la clase BSON

mongosh Proporciona métodos de ayuda para las clases BSON. Los métodos de ayuda proporcionan una breve descripción general de la clase BSON y un enlace con más información.

Para acceder a la ayuda de las clases BSON, ejecuta .help() en el nombre de la clase o en una instancia instanciada de la clase:

<BSON class>.help()
// or
<BSON class>().help()

Por ejemplo, para ver la ayuda de la clase ObjectId BSON, ejecuta uno de los siguientes comandos:

ObjectId.help()

ObjectId().help()

mongosh devuelve la misma salida para ambos métodos .help():

The ObjectId BSON Class:
For more information on usage: https://mongodb.github.io/node-mongodb-native/3.6/api/ObjectID.html

mongosh proporciona métodos de ayuda para las siguientes clases BSON:

• BinData

• Code

• DBRef

• MinKey

• MaxKey

• NumberDecimal

• NumberInt

• NumberLong

• ObjectId

• Symbol (Obsoleto)

• Timestamp

Ayuda del método registro

mongosh proporciona ayuda para los métodos de mensaje de registro . Para ver los métodos de registro de mensajes disponibles, ejecuta el siguiente comando:

log.help()

Asistentes de comandos

mongosh proporciona los siguientes métodos y comandos para envolver ciertos comandos de base de datos y obtener información sobre la implementación:

show log startupWarnings