mongosh Ajuda

Ajuda da linha de comando

Para visualizar as opções para executar o executável do mongosh e conectar a uma implantação, utilize a opção --help a partir da linha de comando:

mongosh --help

mongosh Ajuda da Shell

Para ver a lista de comandos disponíveis no console do mongosh, digite help dentro de um console mongosh em execução:

help

Ajuda do Banco de Dados

Você pode visualizar informações de nível do banco de dados de dentro do console do mongosh :

Por padrão, mongosh mostra o banco de dados atual no prompt. Você também pode visualizar o banco de dados atual executando o 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/pt-br/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
}

Ajuda de coleção

Você pode visualizar informações de nível de coleção de dentro do console do mongosh.

Esses métodos de ajuda aceitam um nome de coleção, <collection>, mas você também pode usar o termo genérico, "coleção" ou até mesmo uma coleção que não existe.

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/pt-br/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
}

Ajuda do cursor

Para modificar operações de leitura que usam find(), use métodos de cursor.

Para listar os métodos de manuseio do modificador e cursor disponíveis, utilize o comando db.collection.find().help():

db.collection.find().help()

Esta chamada de ajuda aceita um nome de coleção, <collection>, mas você também pode usar o termo genérico, "coleção", ou até mesmo uma coleção que não existe.

Alguns métodos úteis para lidar com cursores são:

• hasNext() verificar se o cursor tem mais documentos.

• next() retornar o próximo documento e move a posição do cursor para frente por um.

• forEach(<function>) aplica o <function> a cada documento retornado pelo cursor.

Para obter uma lista dos métodos de cursor disponíveis, consulte Cursor.

Ajuda da classe BSON

mongosh fornece métodos de ajuda para classes BSON. Os métodos de ajuda fornecem uma breve visão geral da classe BSON e um link com mais informações.

Para acessar a ajuda para classes BSON, execute o .help() no nome da classe ou em uma instância instantânea da classe:

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

Por exemplo, para visualizar a ajuda da classe ObjectId BSON, execute um dos seguintes comandos:

ObjectId.help()

ObjectId().help()

mongosh retorna a mesma saída para ambos os 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 fornece métodos de ajuda para as seguintes classes BSON:

• BinData

• Code

• DBRef

• MinKey

• MaxKey

• NumberDecimal

• NumberInt

• NumberLong

• ObjectId

• Symbol (Obsoleto)

• Timestamp

Auxiliares de comando

mongosh fornece os seguintes métodos e comando de banco de dados para envolver determinados comandos do banco de dados e obter informações sobre sua implantação:

show log startupWarnings