Métodos

Nesta página

Métodos de administração

Métodos de índice de pesquisa do Atlas Search
Métodos de operação em massa
Métodos de collection
Métodos de conexão
Métodos de cursor
Métodos do banco de dados
Métodos de criptografia no nível de campo do lado do cliente
Métodos nativos
Métodos de cache do plano de consulta
Métodos de replicação
Métodos de gerenciamento de funções
Métodos de objeto de sessão
Métodos de status do servidor
Métodos de compartilhamento
Métodos de telemetria
Métodos de transação
Métodos de gerenciamento de usuários

O documento a seguir lista os métodos disponíveis no MongoDB Shell. Clique em um método para visualizar sua documentação no Manual do MongoDB, incluindo sintaxe e exemplos.

Importante

Os métodos que redefinem a conexão do shell com o servidor disparam um encerramento de todas as sessões abertas do servidor. Quando uma sessão termina, todas as operações em andamento também são encerradas e o cliente deve se autenticar novamente se a autenticação estiver ativada.

Os métodos a seguir redefinem a conexão do shell:

db.auth
Mongo.setReadPref
Mongo.setReadConcern

Métodos de administração

Método	Descrição
`db.adminCommand()`	Executa um comando no banco de dados do `admin`.
`db.currentOp()`	Informa as operações atuais em andamento.
`db.killOp()`	Termina uma operação especificada.
`db.shutdownServer()`	Desliga o `mongod` ou `mongos` processo atual de forma limpa e segura.
`db.fsyncLock()`	Libera as gravações em disco e trava o banco de dados para evitar operações de gravação e auxiliar nas operações de backup.
`db.fsyncUnlock()`	Permite que as gravações continuem em um banco de dados bloqueado com `db.fsyncLock()`.

Métodos de índice de pesquisa do Atlas Search

Os índices do Atlas Search permitem consultar dados no Atlas Search. Os índices do Atlas Search permitem pesquisa de query de texto de alto desempenho, mapeando termos de pesquisa para os documentos que contêm esses termos.

Use os métodos a seguir para gerenciar índices do Atlas Search.

Importante

Os métodos a seguir só podem ser executados em sistemas hospedados no MongoDB Atlas.

Nome	Descrição
db.collection.createSearchIndex()	Cria um ou mais índices de Pesquisa do Atlas em uma coleção especificada.
db.collection.dropSearchIndex()	Exclui um índice de Pesquisa do Atlas existente.
db.collection.getSearchIndexes()	Retorna informações sobre Atlas Search indexes em uma coleção especificada.
db.collection.updateSearchIndex()	Atualiza um índice existente do Atlas Search.

Métodos de operação em massa

Método	Descrição
`db.collection.initializeOrderedBulkOp()`	Inicializa e retorna um novo construtor de operações do `Bulk()` para uma coleção. O construtor cria uma lista ordenada de operações de gravação que o MongoDB executa em massa.
`db.collection.initializeUnorderedBulkOp()`	Inicializa e retorna um novo construtor de operações do `Bulk()` para uma coleção. O construtor cria uma lista não ordenada de operações de gravação que o MongoDB executa em massa.
`Bulk()`	Cria um construtor de operações em massa utilizado para gerar uma lista de operações de gravação para executar em massa para uma única coleção. Para instanciar o construtor, utilize o método `db.collection.initializeOrderedBulkOp()` ou `db.collection.initializeUnorderedBulkOp()`.
`Bulk.execute()`	Executa a lista de operações construídas pelo construtor de operações do `Bulk()`.
`Bulk.find()`	Especifica uma condição de query para uma atualização ou uma operação de remoção.
`Bulk.find.hint()`	Define a opção dica que especifica o índice para suportar a operação em massa.
`Bulk.find.remove()`	Adiciona uma operação de remoção a uma lista de operações em massa.
`Bulk.find.removeOne()`	Adiciona uma única operação de remoção de documento a uma lista de operações em massa.
`Bulk.find.replaceOne()`	Adiciona uma operação de substituição de documento único a uma lista de operações em massa.
`Bulk.find.updateOne()`	Adiciona uma única operação de atualização de documento a uma lista de operações em massa.
`Bulk.find.update()`	Adiciona uma operação de atualização múltipla a uma lista de operações em massa. O método atualiza campos específicos em documentos existentes.
`Bulk.find.upsert()`	Define a opção upsert para `true` para uma atualização ou uma operação de substituição.
`Bulk.getOperations()`	Retorna uma matriz de operações de gravação executadas por `Bulk.execute()`.
`Bulk.insert()`	Adiciona uma operação de inserção a uma lista de operações em massa.
`Bulk.toJSON()`	Retorna um documento JSON contendo o número de operações e lotes no objeto `Bulk()`.
`Bulk.toString()`	Gera uma string de um documento JSON que contém o número de operações e lotes no objeto `Bulk()`.

Métodos de collection

Método	Descrição
`db.collection.aggregate()`	Fornece acesso ao aggregation pipeline.
`db.collection.bulkWrite()`	Fornece funcionalidade de operação para gravação em massa.
`db.collection.count()`	Descontinuado em `mongosh` 1.0.6. Em vez disso , use `db.collection.countDocuments()` ou `db.collection.estimatedDocumentCount()` .
`db.collection.countDocuments()`	Retorna uma contagem do número de documentos em uma coleção ou visualização. Encapsula o estágio de agregação `$group` com uma expressão `$sum`.
`db.collection.estimatedDocumentCount()`	Gera uma contagem aproximada dos documentos em uma coleção ou visualização.
`db.collection.createIndex()`	Constrói um índice em uma coleção.
`db.collection.createIndexes()`	Constrói um ou mais índices em uma coleção.
`db.collection.dataSize()`	Retorna o tamanho da coleção. Encapsula o campo `size` na saída do `collStats`.
`db.collection.deleteOne()`	Exclui um único documento em uma coleção.
`db.collection.deleteMany()`	Exclui vários documentos em uma coleção.
`db.collection.distinct()`	Gera um array de documentos com valores distintos para o campo especificado.
`db.collection.drop()`	Remove a coleção especificada do banco de dados.
`db.collection.dropIndex()`	Remove um índice especificado em uma coleção.
`db.collection.dropIndexes()`	Remove todos os índices de uma coleção.
`db.collection.ensureIndex()`	Descontinuado. Use `db.collection.createIndex()`.
`db.collection.explain()`	Retorna informações sobre a execução de consultas de vários métodos.
`db.collection.find()`	Executa uma consulta em uma coleção ou uma visualização e retorna um objeto do cursor.
`db.collection.findAndModify()`	Modifica atomicamente e retorna um único documento.
`db.collection.findOne()`	Executa uma consulta e retorna um único documento.
`db.collection.findOneAndDelete()`	Localiza um único documento e o exclui.
`db.collection.findOneAndReplace()`	Localiza um único documento e o substitui.
`db.collection.findOneAndUpdate()`	Localiza um único documento e o atualiza.
`db.collection.getIndexes()`	Retorna uma array de documentos que descrevem os índices existentes em uma coleção.
`db.collection.getShardDistribution()`	Imprime as estatísticas de distribuição de dados para uma coleção fragmentada.
`db.collection.getShardVersion()`	Fornece um invólucro para o comando do banco de dados getShardVersion.
`db.collection.insertOne()`	Insere um novo documento em uma coleção.
`db.collection.insertMany()`	Insere vários novos documentos em uma coleção.
`db.collection.isCapped()`	Informa se uma coleção é uma coleção limitada.
`db.collection.mapReduce()`	Executa operações de agregação de map-reduce em uma coleção.
`db.collection.reIndex()`	Reconstrói todos os índices existentes em uma coleção.
`db.collection.renameCollection()`	Altera o nome de uma coleção.
`db.collection.replaceOne()`	Substitui um único documento em uma coleção.
`db.collection.stats()`	Informa sobre o estado de uma coleção. Fornece um encapsulador em torno do `collStats`.
`db.collection.storageSize()`	Informa o tamanho total usado pela coleção em bytes. Fornece um encapsulador em torno do campo `storageSize` da saída `collStats`.
`db.collection.totalIndexSize()`	Relata o tamanho total usado pelos índices em uma coleção. Fornece um encapsulador em torno do campo `totalIndexSize` da saída `collStats`.
`db.collection.totalSize()`	Indica o tamanho total de uma coleção, abrangendo todos os documentos e índices associados.
`db.collection.updateOne()`	Modifica um único documento em uma coleção.
`db.collection.updateMany()`	Modifica vários documentos em uma coleção.
`db.collection.validate()`	Valida uma coleção.
`db.collection.watch()`	Abre um mudar cursor de fluxo na coleção.

Métodos de conexão

Método

Descrição

Mongo()

Construtor JavaScript para instanciar uma conexão de banco de dados a partir do shell mongo ou de um arquivo JavaScript.

O método Mongo() tem os seguintes parâmetros:

Parâmetro	Tipo	Descrição
`host`	string	Opcional A string de conexão para a conexão do banco de dados de destino. Se omitido, o `Mongo()` instancia uma conexão com a interface do localhost na porta `27017` padrão.
`autoEncryptionOpts`	Documento	Opcional Novidades na versão 4.2. Parâmetros de configuração para ativar a criptografia de nível de campo do lado do cliente. `autoEncryptionOpts` substitui a configuração de criptografia de nível de campo do lado do cliente existente da conexão do banco de dados. Se omitido, o `Mongo()` herda a configuração de criptografia do nível de campo do lado do cliente da conexão do banco de dados atual. Para obter a documentação de uso e sintaxe, consulte AutoEncryptionOpts.

Mongo.getDB()

Retorna um objeto do banco de dados.

Mongo.setReadPref()

Define a preferência de leitura para a conexão MongoDB.

Mongo.watch()

Abre um cursor de fluxo de alterações para um conjunto de réplicas ou um cluster fragmentado para relatar todas as coleções não relacionadas ao sistema nos seus bancos de dados, com exceção dos bancos de dados admin, local e config.

Métodos de cursor

Método

Descrição

cursor.addOption()

Adiciona sinalizadores de protocolo de fio especiais que modificam o comportamento da consulta.

cursor.allowPartialResults()

Permite que operações db.collection.find() em uma coleção fragmentada retornem resultados parciais, em vez de um erro, se um ou mais fragmentos consultados não estiverem disponíveis.

cursor.batchSize()

Controla o número de documentos que o MongoDB retornará ao cliente em uma única mensagem de rede.

A seguinte consulta de exemplo retorna resultados em lotes de 100:

db.myCollection.find().batchSize(100)

cursor.close()

Feche um cursor e libere os recursos do servidor associado.

cursor.collation()

Especifica o agrupamento do cursor retornado pelo db.collection.find().

cursor.comment()

Adicione um comentário à consulta para permitir o rastreamento nos registros e na coleção system.profile.

cursor.count()

Modifica o cursor para retornar o número de documentos no conjunto de resultados, em vez de retornar os documentos em si.

cursor.explain()

Informa sobre o plano de execução da consulta para um cursor.

cursor.forEach()

Aplica uma função JavaScript para cada documento em um cursor.

cursor.hasNext()

Retorna true se o cursor tiver documentos e puder ser iterado.

cursor.hint()

Força o MongoDB a usar um índice específico para uma consulta.

cursor.isClosed()

Retorna true se o cursor estiver fechado.

cursor.isExhausted()

Retorna true se o cursor estiver fechado e não houver objetos restantes no lote.

cursor.itcount()

Calcula o total de documentos no cursor através da busca e iteração do conjunto de resultados no lado do cliente.

cursor.limit()

Restringe o tamanho do conjunto de resultados de um cursor.

cursor.map()

Aplica uma função em cada documento em um cursor e coleta os resultados em um array.

cursor.max()

Especifica um limite do índice superior exclusivo para um cursor. Para uso com cursor.hint()

cursor.maxTimeMS()

Especifica um limite de tempo cumulativo em milissegundos para operações de processamento em um cursor.

cursor.min()

Especifica um limite do índice inferior inclusivo para um cursor. Para uso com cursor.hint()

cursor.next()

Retorna o próximo documento em um cursor.

cursor.noCursorTimeout()

Instrui o servidor para evitar fechar um cursor automaticamente após um período de inatividade.

cursor.objsLeftInBatch()

Retorna o número de documentos deixados no lote do cursor atual.

cursor.readConcern()

Especifica uma preocupação de leitura para uma operação db.collection.find().

cursor.readPref()

Especifica uma preferência de leitura para um cursor para controlar como o cliente direciona as consultas para um conjunto de réplicas.

cursor.returnKey()

Modifica o cursor para retornar as chaves de índice em vez dos documentos.

cursor.showRecordId()

Adiciona um campo de ID do mecanismo de armazenamento interno a cada documento retornado pelo cursor.

cursor.size()

Retorna uma contagem dos documentos no cursor após aplicar os métodos skip() e limit().

cursor.skip()

Retorna um cursor que só começa a retornar resultados após pular ou ignorar vários documentos.

cursor.sort()

Retorna os resultados seguindo uma ordem específica de classificação.

cursor.tailable()

Marca o cursor como rastreável. Válido somente para cursores acima de coleções limitadas.

cursor.toArray()

Retorna um array com todos os documentos obtidos pelo cursor.

Métodos do banco de dados

Método	Descrição
`db.aggregate()`	Executa o pipeline admin/diagnóstico que não requer uma collection subjacente.
`db.createCollection()`	Cria uma nova collection ou visualização.
`db.createView()`	Cria uma exibição como resultado da aplicação do pipeline de agregação especificado à coleção ou exibição de origem.
`db.commandHelp()`	Exibe o texto de ajuda para o comando de banco de dados especificado.
`db.dropDatabase()`	Remove o banco de dados atual.
`db.getCollection()`	Retorna uma coleção ou objeto de visualização. Usado para acessar coleções com nomes que não são válidos no shell `mongo`.
`db.getCollectionInfos()`	Retorna informações de collection para todas as collections e visualizações no banco de dados atual.
`db.getCollectionNames()`	Lista todas as collections e visualizações no banco de dados atual.
`db.getMongo()`	Retorna a conexão do banco de dados atual.
`db.getLogComponents()`	Retorna as configurações atuais de verbosidade de registro.
`db.getName()`	Retorna o nome do banco de dados atual.
`db.getProfilingStatus()`	Retorna a configuração atual do nível de perfil, slowOpThresholdMs e slowOpSampleRate .
`db.getSiblingDB()`	Fornece acesso ao banco de dados especificado.
`db.listCommands()`	Fornece uma lista de todos os comandos do banco de dados.
`db.logout()`	Termina uma sessão autenticada.
`db.printShardingStatus()`	Imprime um relatório formatado da configuração de fragmentação e as informações sobre os chunks existentes em um cluster fragmentado.
`db.runCommand()`	Executa um comando do banco de dados.
`db.setLogLevel()`	Define um único nível de verbosidade para mensagens de registro.
`db.setProfilingLevel()`	Configura o nível do analisador do banco de dados , slowms e sampleRate.
`db.watch()`	Abre um cursor de change stream para que um banco de dados informe todas as suas collections fora do sistema.

Métodos de criptografia no nível de campo do lado do cliente

Observação

Limitações

A criptografia automática só está disponível quando mongosh está conectado a um Atlas cluster ou a um servidor MongoDB Enterprise. Para obter detalhes, consulte Criptografia automática em nível de campo do lado do cliente. Os métodos listados nesta seção são usados para criptografia manual e são compatíveis com servidores não corporativos.
A criptografia automática não está disponível com a instalação em Homebrew do mongosh.
A criptografia em nível de campo só está disponível no binário mongosh e não está disponível no shell incorporado do Compass.

Método	Descrição
ClientEncryption.createEncryptedCollection()	Cria uma coleção com campos criptografados.
`ClientEncryption.decrypt()`	Descriptografa o `encryptedValue` especificado se a conexão do banco de dados atual foi configurada com acesso ao Key Management Service (KMS) e ao cofre de chaves utilizado para criptografar o `encryptedValue`.
`ClientEncryption.encrypt()`	Criptografa o valor especificado utilizando o `encryptionKeyId` e `encryptionAlgorithm` especificados.
`getClientEncryption()`	Retorna o objeto `ClientEncryption` para a coleção de banco de dados atual.
`getKeyVault()`	Retorna o objeto `KeyVault` para a conexão de banco de dados atual.
`KeyVault.addKeyAlternateName()`	Adiciona o `keyAltName` à array `keyAltNames` da chave de encriptação de dados com o UUID especificado.
`KeyVault.createKey()`	Adiciona uma chave de criptografia de dados ao cofre de chave associado à conexão do banco de dados.
`KeyVault.deleteKey()`	Exclui uma chave de encriptação de dados com o UUID especificado do cofre de chave associado à conexão do banco de dados.
`KeyVault.getKey()`	Obtém uma chave de criptografia de dados com o UUID especificado. A chave de criptografia de dados deve existir no cofre de chave associado à conexão do banco de dados.
`KeyVault.getKeyByAltName()`	Obtém todas as chaves de criptografia de dados com o `keyAltName` especificado.
`KeyVault.getKeys()`	Retorna todas as chaves de criptografia de dados armazenadas no cofre de chaves associado à conexão do banco de dados.
`KeyVault.removeKeyAlternateName()`	Remove o `keyAltName` especificado da chave de encriptação de dados com o UUID especificado. A chave de encriptação de dados deve existir no cofre de chave associado à conexão do banco de dados.

Métodos nativos

Método

Descrição

buildInfo()

Retorna o seguinte documento em formato JSON que descreve suas dependências de compilação e driver mongosh:

{
  version: '1.10.1',
  distributionKind: 'packaged',
  buildArch: 'x64',
  buildPlatform: 'linux',
  buildTarget: 'unknown',
  buildTime: '2023-06-21T09:49:37.225Z',
  gitVersion: '05ad91b4dd40382a13f27abe1ae8c3f9f52a38f7',
  nodeVersion: 'v16.20.1',
  opensslVersion: '3.1.1',
  sharedOpenssl: true,
  runtimeArch: 'x64',
  runtimePlatform: 'darwin',
  deps: {
     nodeDriverVersion: '5.6.0',
     libmongocryptVersion: undefined,
     libmongocryptNodeBindingsVersion: undefined
   }
}

cd()

Altera o diretório de trabalho atual para o caminho especificado.

isInteractive()

Retorna um booleano indicando se o mongosh está sendo executado no modo interativo ou de script.

load()

Carrega e executa um arquivo JavaScript na shell.

No mongosh, scripts carregados com o método load() suportam as variáveis __filename e __dirname Node.js. Essas variáveis retornam o nome do arquivo e o diretório do script carregado, respectivamente. Os valores retornados são sempre caminhos absolutos.

No shell legado, você não pode acessar o nome do arquivo ou diretório do roteiro usando o método load().

print()

Imprima o texto ou variável especificada. print() e printjson() são nomes alternativos para console.log().

> print("hello world")
hello world
> x = "example text"
> print(x)
example text

pwd()

Retorna o diretório de trabalho atual da sessão de shell ativa.

quit()

Sai da sessão de shell atual.

sleep()

Suspende o shell mongo por um determinado período.

version()

Retorna a versão atual da instância do mongosh.

Métodos de cache do plano de consulta

Método	Descrição
`db.collection.getPlanCache()`	Retorna uma interface para acessar o objeto de cache do plano de consulta e os métodos `PlanCache` associados para uma coleção.
`PlanCache.clear()`	Remove todos os planos de consulta em cache para uma coleção.
`PlanCache.clearPlansByQuery()`	Limpa os planos de consulta armazenados em cache para a plano de consulta especificado.
`PlanCache.help()`	Lista os métodos disponíveis para visualizar e modificar o cache do plano de consulta de uma coleção.
`PlanCache.list()`	Retorna uma matriz de entradas de cache de plano para uma coleta.

Métodos de replicação

Método

Descrição

rs.add()

Adiciona um membro ao conjunto de réplicas. Você deve se conectar à primária do conjunto de réplicas para executar este método.

rs.addArb()

Adiciona um árbitro a um conjunto de réplicas existente.

rs.config()

Retorna um documento que contém a configuração do conjunto de réplicas atual.

rs.freeze()

Torna o nó do conjunto de réplicas ao qual o mongosh é conectado não qualificado para se tornar primary pela duração especificada. Você deve especificar a duração em segundos.

db.getReplicationInfo()

Gera o status do conjunto de réplicas a partir dos dados do oplog.

rs.initiate()

Inicia um novo conjunto de réplicas.

db.printReplicationInfo()

Retorna o registro de opção do membro do conjunto de réplicas ao qual o mongosh está conectado.

rs.printReplicationInfo()

Retorna o registro de opção do membro do conjunto de réplicas ao qual o mongosh está conectado.

db.printSecondaryReplicationInfo

Retorna o status dos membros secundários do conjunto de réplicas.

Isto é idêntico ao método rs.printSecondaryReplicationInfo(). A saída desse método é semelhante ao método db.printSlaveReplicationInfo(). O método db.printSlaveReplicationInfo() é preterido no mongosh. Use db.printSecondaryReplicationInfo() em vez disso.

O seguinte é uma saída de exemplo do método rs.printSecondaryReplicationInfo() emitido em um conjunto de réplica com dois membros secundários:

source: rs2.example.net:27017
{
  syncedTo: 'Tue Oct 13 2020  09:37:28 GMT-0700 (Pacific Daylight Time)',
  replLag: '0 secs (0 hrs) behind the primary '
}
---
source: rs3.example.net:27017
{
  syncedTo: 'Tue Oct 13 2020  09:37:28 GMT-0700 (Pacific Daylight Time)',
  replLag: '0 secs (0 hrs) behind the primary '
}

rs.printSecondaryReplicationInfo

Retorna o status dos membros secundários do conjunto de réplicas.

Isto é idêntico ao método db.printSecondaryReplicationInfo(). A saída desse método é semelhante ao método rs.printSlaveReplicationInfo() na shell mongo legado. O método rs.printSlaveReplicationInfo() foi descontinuado no mongosh. Em vez disso, use rs.printSecondaryReplicationInfo() .

O seguinte é uma saída de exemplo do método rs.printSecondaryReplicationInfo() emitido em um conjunto de réplica com dois membros secundários:

source: rs2.example.net:27017
{
  syncedTo: 'Tue Oct 13 2020 09:42:18 GMT-0700 (Pacific Daylight Time)',
  replLag: '0 secs (0 hrs) behind the primary '
}
---
source: rs3.example.net:27017
{
  syncedTo: 'Tue Oct 13 2020 09:42:18 GMT-0700 (Pacific Daylight Time)',
  replLag: '0 secs (0 hrs) behind the primary '
}

rs.reconfig()

Modifica a configuração de um conjunto de réplicas existente.

rs.remove()

Remove o membro especificado pelo nome de host do conjunto de réplicas.

rs.status()

Retorna o status do membro do conjunto de réplicas ao qual o mongosh está conectado.

rs.stepDown()

Torna o principal do conjunto de réplicas um secundário. Você deve estar conectado ao principal para executar este método.

rs.syncFrom()

Redefine o destino de sincronização para o membro do conjunto de réplica especificado pelo nome de host do membro do conjunto de réplica ao qual o mongosh está conectado.

Métodos de gerenciamento de funções

Método	Descrição
`db.createRole()`	Cria uma função e especifica seus privilégios.
`db.dropRole()`	Exclui uma função definida pelo usuário.
`db.dropAllRoles()`	Exclui todas as funções definidas pelo usuário associados a um banco de dados.
`db.getRole()`	Retorna informações para a função especificada.
`db.getRoles()`	Retorna informações para todas as funções definidas pelo usuário em um banco de dados.
`db.grantPrivilegesToRole()`	Atribui privilégios a uma função definida pelo usuário.
`db.revokePrivilegesFromRole()`	Remove os privilégios especificados de uma função definida pelo usuário.
`db.grantRolesToRole()`	Especifica funções a partir dos quais uma função definida pelo usuário herda privilégios.
`db.revokeRolesFromRole()`	Remove as funções herdadas de uma função.
`db.updateRole()`	Atualiza uma função definida pelo usuário.

Métodos de objeto de sessão

Método	Descrição
`Mongo.startSession()`	Inicia uma sessão para a conexão.
Session.advanceOperationTime()	Atualiza o tempo de operação.
Session.endSession()	Termina a sessão.
Session.getClusterTime()	Retorna o tempo de agrupamento mais recente como visto pela sessão.
Session.getDatabase()	Acesse o banco de dados especificado a partir da sessão no shell.
Session.getOperationTime()	Gera o registro de data/hora da última operação reconhecida para a sessão.
Session.getOptions()	Gera as opções da sessão.
Session.hasEnded()	Gera um boolean que especifica se a sessão terminou.
`SessionOptions()`	As opções para uma sessão na shell. Para acessar o objeto `SessionOptions()`, use `Session.getOptions()`.

Métodos de status do servidor

Método	Descrição
`db.hello()`	Retorna um documento que descreve a função da instância `mongod`. Se o `mongod` for um membro de um conjunto de réplicas, os campos `isWritablePrimary` e `secondary` reportarão se a instância for o primário ou se for um membro secundário do conjunto de réplicas.
`db.hostInfo()`	Retorna um documento com informações sobre o sistema que executa a instância do MongoDB.
`db.collection.latencyStats()`	Retorna estatísticas de latência para uma coleção especificada.
`db.printCollectionStats()`	Retorna estatísticas de cada coleção.
`db.serverBuildInfo()`	Retorna um documento que exibe os parâmetros de compilação para a instância `mongod`.
`db.serverCmdLineOpts()`	Retorna um documento com informações sobre as opções de tempo de execução usadas para iniciar a instância do MongoDB.
`db.serverStatus()`	Retorna um documento que fornece uma visão geral do processo do banco de dados.
`db.stats()`	Retorna um documento que informa o estado do banco de dados atual.
`db.version()`	Retorna a versão da instância `mongod`.

Métodos de compartilhamento

Método	Descrição
`sh.addShard()`	Adiciona um fragmento a um cluster fragmentado.
`sh.addShardTag()`	Aliases para `sh.addShardToZone()`.
`sh.addShardToZone()`	Associa um fragmento a uma zona. Suporta a configuração de zonas em clusters fragmentados.
`sh.addTagRange()`	Aliases para `sh.updateZoneKeyRange()`.
`sh.balancerCollectionStatus()`	Retorna informações sobre se as partes de uma coleção fragmentada estiverem balanceadas. Novidades na versão 4.4.
sh.disableAutoMerger()	Desativa mesclagens automáticas de partes para um namespace. Novidades na versão 7.0.
`sh.disableAutoSplit()`	Desabilita a divisão automática do cluster fragmentado.
`sh.disableBalancing()`	Desabilita o equilíbrio em uma única coleção em um banco de dados fragmentado. Não afeta o equilíbrio de outras coleções em um cluster fragmentado.
sh.enableAutoMerger()	Permite mesclagens automáticas de partes para um namespace. Novidades na versão 7.0.
`sh.enableAutoSplit()`	Habilita a divisão automática para o cluster fragmentado.
`sh.enableBalancing()`	Ativa o processo de balanceamento de coleção fragmentado se tiver sido desabilitado anteriormente usando `sh.disableBalancing()`.
`sh.enableSharding()`	Habilita o compartilhamento em um banco de dados específico.
`sh.getBalancerState()`	Retorna um booleano para reportar se o balanceador está habilitado no momento.
`sh.getShardedDataDistribution()`	Retorna informações de distribuição de dados sobre coleções fragmentadas. `sh.getShardedDataDistribution()` é um método auxiliar de shell para o estágio do pipeline de agregação `$shardedDataDistribution`.
`sh.isBalancerRunning()`	Retorna um booleano para relatar se o processo do balanceador está migrando partes no momento.
`sh.moveChunk()`	Migra uma parte em um cluster fragmentado.
`sh.removeRangeFromZone()`	Remove a associação entre um intervalo de valores da chave de fragmento e uma zona.
`sh.removeShardFromZone()`	Remove a associação entre um fragmento e uma zona.
`sh.removeShardTag()`	Remove a associação entre uma tag e um fragmento.
`sh.removeTagRange()`	Remove um intervalo de valores da chave de fragmento para uma tag de fragmento criada usando o método `sh.addShardTag()`. Este método faz aliases para `sh.removeRangeFromZone()` no MongoDB 3.4.
`sh.setBalancerState()`	Habilita ou desabilita o balanceador que migra partes entre fragmentos.
`sh.shardCollection()`	Ativa a fragmentação de uma coleção.
`sh.splitAt()`	Divide um parte existente em duas partes usando um valor específico da chave de fragmentação como ponto de divisão.
`sh.splitFind()`	Divide um parte existente que contém um documento correspondente a uma consulta em dois partes aproximadamente iguais.
sh.startAutoMerger()	Habilita a fusão automática. Novidades na versão 7.0.
`sh.startBalancer()`	Habilita o balanceador.
`sh.status()`	Relata sobre o status de um cluster fragmentado.
sh.stopAutoMerger()	Desabilita a fusão automática. Novidades na versão 7.0.
`sh.stopBalancer()`	Desabilita o balanceador. Essa operação não espera que o balanceador conclua nenhuma operação em andamento e pode encerrar as atuais.
`sh.updateZoneKeyRange()`	Associa uma variedade de teclas de fragmento a uma zona. Suporta a configuração de zonas em clusters fragmentados.

Métodos de telemetria

Estes métodos configuram se o mongosh rastreia dados de telemetria anônimos. A telemetria está habilitada por padrão.

Para mais informações sobre quais dados o mongosh rastreia com telemetria, consulte Configurar Opções de Telemetria.

Método	Descrição
`disableTelemetry()`	Desativar telemetria para `mongosh`.
`enableTelemetry()`	Ativar telemetria para `mongosh`.

Métodos de transação

Método	Descrição
`Session.abortTransaction()`	Encerra uma transação multidocumento e reverte todas as alterações de dados feitas pelas operações dentro da transação.
`Session.commitTransaction()`	Salva as alterações feitas pelas operações em uma transação de vários documentos e termina a transação.
`Session.startTransaction()`	Inicia uma transação de vários documentos associada à sessão.

Métodos de gerenciamento de usuários

Importante

O método passwordPrompt() não é atualmente compatível no mongosh. Por isso, ao usar os seguintes métodos, você deve especificar a senha como um parâmetro:

Método	Descrição
`db.auth()`	Autentica um usuário para um banco de dados.
`db.changeUserPassword()`	Altera a senha de um usuário existente.
`db.createUser()`	Cria um novo usuário.
`db.dropAllUsers()`	Exclui todos os usuários associados a um banco de dados.
`db.dropUser()`	Exclui um único usuário.
`db.getUser()`	Retorna informações sobre o usuário especificado.
`db.getUsers()`	Retorna informações sobre todos os usuários associados a um banco de dados.
`db.updateUser()`	Atualiza os dados de um usuário especificado.
`db.grantRolesToUser()`	Concede uma função e seus privilégios para um usuário.
`db.revokeRolesFromUser()`	Remove uma função de um usuário.

← Tipos de dados

EJSON →

Métodos.leafygreen-ui-m0pgrr{-webkit-align-self:center;-ms-flex-item-align:center;align-self:center;padding:0 10px;visibility:hidden;}.leafygreen-ui-a30zj9{color:#889397;vertical-align:middle;margin-top:-2px;}.css-1l4s55v{margin-top:-175px;position:absolute;padding-bottom:2px;}

Importante

Métodos de administração

Métodos de índice de pesquisa do Atlas Search

Importante

Métodos de operação em massa

Métodos de collection

Métodos de conexão

Métodos de cursor

Métodos do banco de dados

Métodos de criptografia no nível de campo do lado do cliente

Observação

Limitações

Métodos nativos

Métodos de cache do plano de consulta

Métodos de replicação

Métodos de gerenciamento de funções

Métodos de objeto de sessão

Métodos de status do servidor

Métodos de compartilhamento

Métodos de telemetria

Métodos de transação

Métodos de gerenciamento de usuários

Importante

Métodos