Página inicial do Docs → Desenvolver aplicações → Manual do MongoDB

`mongosh` Métodos

Nesta página

Métodos de índice de pesquisa do Atlas Search

Métodos de Atlas Stream Processing
collection
Cursor
Banco de dados
Cache do plano de consulta
Operação de gravação em massa
Gerenciamento de usuários
Gerenciamento de funções
Replicação
Fragmentação
Construtores
Conexão
Criptografia no nível de campo do cliente

Observação

JavaScript no MongoDB

Embora estes métodos utilizem JavaScript, a maioria das interações com MongoDB não utiliza JavaScript, mas utiliza umdriver automático na linguagem do aplicativo de interação.

Observação

Para obter detalhes sobre um método específico, incluindo sintaxe e exemplos, clique no link para a página de referência do método.

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 e exigem uma camada do cluster Atlas de pelo menos M10.

Nome	Descrição
`db.collection.createSearchIndex()`	Criar um índice Atlas Search numa colecçã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 Atlas Stream Processing

Os Atlas Stream Processors permitem executar operações de agregação em relação a fluxos de dados contínuos usando o mesmo modelo de dados e API de consulta usada com dados em repouso.

Use os seguintes métodos para managed processadores de stream:

Importante

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

Nome	Descrição
`sp.createStreamProcessor()`	Cria um processador de stream.
`sp.listConnections()`	Lista todas as conexões existentes no registro de conexão da instância de processamento de fluxo atual.
`sp.listStreamProcessors()`	Lista todos os processadores de fluxo existentes na instância de Atlas Stream Processing atual.
`sp.process()`	Cria um processador de fluxo efêmero.
`sp.processor.drop()`	Exclui um processador de stream existente.
`sp.processor.sample()`	Retorna uma array de amostras de resultados de um processador de stream atualmente em execução.
`sp.processor.start()`	Inicia um processador de stream existente.
`sp.processor.stats()`	Retorna estatísticas resumindo um processador de fluxo existente.
`sp.processor.stop()`	Interrompe um processador de fluxo atualmente em execução.

collection

Nome	Descrição
`db.collection.analyzeShardKey()`	Calcula métricas para avaliar uma chave de fragmento.
`db.collection.aggregate()`	Fornece acesso ao pipeline de agregação.
`db.collection.bulkWrite()`	Fornece funcionalidade de operação para gravação em massa.
`db.collection.compactStructuredEncryptionData()`	Envolve `compactStructuredEncryptionData` para retornar um objeto que indica sucesso ou erro.
`db.collection.configureQueryAnalyzer()`	Configura a amostragem de consulta para uma coleção.
`db.collection.count()`	Envolve `count` para retornar uma contagem do número de documentos em uma coleção ou uma visualização.
`db.collection.countDocuments()`	Envolve o estágio de agregação `$group` com uma expressão `$sum` para retornar uma contagem do número de documentos em uma uma coleção ou uma 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. Envolve o campo `size` na saída de `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 uma matriz 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()`	Removido. Use `db.collection.createIndex()`.
`db.collection.estimatedDocumentCount()`	Envolve `count` para retornar uma contagem aproximada de documentos em uma coleção ou uma visualização.
`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()`	Para coleções em clusters fragmentados, `db.collection.getShardDistribution()` informa dados de distribuição de partes.
`db.collection.getShardVersion()`	Método de diagnóstico interno para cluster fragmentado.
`db.collection.hideIndex()`	Oculta um índice do planejador de consulta.
`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.latencyStats()`	Retorna estatísticas de latência para uma coleção.
`db.collection.mapReduce()`	Executa agregação de dados no estilo map-reduce.
`db.collection.reIndex()`	Reconstrói todos os índices existentes em uma coleção.
`db.collection.remove()`	Exclui documentos de 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 wrapper em torno do `collStats`.
`db.collection.storageSize()`	Informa o tamanho total usado pela coleção em bytes. Fornece um wrapper ao redor do campo `storageSize` da saída `collStats`.
`db.collection.totalIndexSize()`	Relata o tamanho total usado pelos índices em uma coleção. Fornece um wrapper ao redor 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.unhideIndex()`	Exibe um índice do planejador de consultas.
`db.collection.updateOne()`	Modifica um único documento em uma coleção.
`db.collection.updateMany()`	Modifica vários documentos em uma coleção.
`db.collection.watch()`	Estabelece um fluxo de mudança em uma coleção.
`db.collection.validate()`	Executa operações de diagnóstico em uma coleção.

Cursor

Nome	Descrição
`cursor.addOption()`	Adiciona sinalizadores específicos do protocolo de conexão que modificam o comportamento da consulta.
`cursor.allowDiskUse()`	Permite que o MongoDB use arquivos temporários no disco para armazenar dados que excedam o limite de memória do sistema de 100 megabytes durante o processamento de uma operação de classificação por bloqueio.
`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.
`cursor.close()`	Feche um cursor e libere os recursos do servidor associado.
`cursor.isClosed()`	Retorna `true` se o cursor estiver fechado.
`cursor.collation()`	Especifica o agrupamento do cursor retornado por `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 "verdadeiro" se o cursor tiver documentos e eles puderem ser iterados.
`cursor.hint()`	Força o MongoDB a usar um índice específico para uma consulta.
`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.pretty()`	Configura o cursor para exibir os resultados em um formato de leitura fácil.
`cursor.readConcern()`	Especifica uma referência de leitura para uma operação `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.

Banco de dados

Nome	Descrição
`db.adminCommand()`	Executa um comando no banco de dados do `admin`.
`db.aggregate()`	Executa o pipeline admin/diagnóstico que não requer uma collection subjacente.
`db.commandHelp()`	Retorna informações de ajuda para um comando de banco de dados.
`db.createCollection()`	Cria uma nova collection ou uma visualização. Normalmente usado para criar uma capped collection.
`db.createView()`	Cria uma visualização.
`db.currentOp()`	Informa as operações atuais em andamento.
`db.dropDatabase()`	Remove o banco de dados atual.
`db.fsyncLock()`	Libera as gravações em disco e bloqueia o banco de dados para evitar operações de gravação e auxiliar nas operações de backup. Envolve `fsync`.
`db.fsyncUnlock()`	Permite que gravações continuem em um banco de dados bloqueado com `db.fsyncLock()`.
`db.getCollection()`	Retorna uma coleção ou objeto de visualização. Usado para acessar collections com nomes que não são válidos em `mongosh`.
`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.getLogComponents()`	Retorna os níveis de verbosidade da mensagem de registro.
`db.getMongo()`	Retorna o objeto de conexão `Mongo()` para a conexão atual.
`db.getName()`	Retorna o nome do banco de dados atual.
`db.getProfilingStatus()`	Retorna um documento que reflete o nível de perfilamento atual e o seu limite.
`db.getReplicationInfo()`	Retorna um documento com estatísticas de replicação.
`db.getSiblingDB()`	Fornece acesso ao banco de dados especificado.
`db.hello()`	Retorna um documento que relata o estado do conjunto de réplicas.
`db.help()`	Exibe descrições de métodos de objeto `db` comuns.
`db.hostInfo()`	Retorna um documento com informações sobre o sistema em que MongoDB é executado. Envolve `hostInfo`
`db.killOp()`	Termina uma operação especificada.
`db.listCommands()`	Exibe uma lista de comandos comuns de banco de dados.
`db.logout()`	Obsoleto. Termina uma sessão autenticada.
`db.printCollectionStats()`	Imprime estatísticas de cada collection. Envolve `db.collection.stats()`.
`db.printReplicationInfo()`	Imprime um relatório do status do conjunto de réplicas sob a perspectiva do primário.
`db.printSecondaryReplicationInfo()`	Imprime o status do conjunto de réplicas sob a perspectiva dos secundários.
`db.printShardingStatus()`	Imprime um relatório da configuração de fragmentação e as faixas de chunks.
`db.resetError()`	Removido no MongoDB 5.0. Redefine o último status de erro.
`db.rotateCertificates()`	Executa rotação de certificado TLS online. Envoltórios `rotateCertificates`.
`db.runCommand()`	Executa um comando do banco de dados.
`db.serverBuildInfo()`	Retorna um documento que exibe os parâmetros de compilação para a instância do `mongod`. Wraps `buildInfo`.
`db.serverCmdLineOpts()`	Retorna um documento com informações sobre o tempo de execução usado para iniciar a instância MongoDB. Envolve `getCmdLineOpts`.
`db.serverStatus()`	Retorna um documento que fornece uma visão geral do estado do processo do banco de dados.
`db.setLogLevel()`	Define um único nível de verbosidade de mensagem de registro.
`db.setProfilingLevel()`	Modifica o nível atual do perfil do banco de dados.
`db.shutdownServer()`	Encerra o processo `mongod` ou `mongos` atual de maneira segura e eficiente.
`db.stats()`	Retorna um documento que informa o estado do banco de dados atual.
`db.version()`	Retorna a versão da instância `mongod`.
`db.watch()`	Abre um cursor de change stream para que um banco de dados informe todas as suas collections fora do sistema `system`. Não pode ser aberto nos bancos de dados `admin`, `local` ou `config`.

Cache do plano de consulta

Nome	Descrição
`db.collection.getPlanCache()`	Retorna uma interface para acessar o objeto de cache do plano de consulta e os métodos associados do PlanCache para uma coleção.
`PlanCache.clear()`	Limpa todo o cache dos planos de consulta para uma coleção. Acessível por meio do objeto de cache do plano de uma coleção específica, ou seja, `db.collection.getPlanCache().clear()`.
`PlanCache.clearPlansByQuery()`	Limpa os planos de consulta em cache para a forma de consulta especificada. Acessível por meio do objeto de cache do plano de uma coleção específica, ou seja, `db.collection.getPlanCache().clearPlansByQuery()`
`PlanCache.help()`	Exibe os métodos disponíveis para o cache do plano de consulta de uma coleção. Acessível por meio do objeto de cache do plano de uma coleção específica, ou seja, `db.collection.getPlanCache().help()`.
`PlanCache.list()`	Retorne as informações do cache de planos para uma coleção específica. Acessível por meio do objeto de cache do plano de uma coleção específica, ou seja, `db.collection.getPlanCache().list()`.

Operação de gravação em massa

Nome	Descrição
`db.collection.initializeOrderedBulkOp()`	Inicializa um construtor de operações `Bulk()` para uma lista ordenada de operações.
`db.collection.initializeUnorderedBulkOp()`	Inicializa um construtor de operações `Bulk()` para uma lista não ordenada de operações.
`Bulk()`	Construtor de operações em massa.
`Bulk.execute()`	Executa uma série de operações em massa.
`Bulk.find()`	Especifica a condição de consulta para uma atualização ou uma operação de remoção.
`Bulk.find.arrayFilters()`	Define os filtros para selecionar os elementos do array que serão atualizados em uma operação `update` ou `updateOne`.
`Bulk.find.collation()`	Define o agrupamento para a condição de consulta.
`Bulk.find.delete()`	Adiciona uma operação de exclusão de vários documentos a uma lista de operações.
`Bulk.find.deleteOne()`	Adiciona uma única operação de exclusão de documento a uma lista de operações.
`Bulk.find.hint()`	Especifica o índice a ser usado para a operação de atualização/substituição.
`Bulk.find.remove()`	Um alias para `Bulk.find.delete()`.
`Bulk.find.removeOne()`	Um alias para `Bulk.find.deleteOne()`.
`Bulk.find.replaceOne()`	Adiciona uma operação de substituição de documento único a uma lista de operações.
`Bulk.find.updateOne()`	Adiciona uma única operação de atualização de documento a uma lista de operações.
`Bulk.find.update()`	Adiciona uma operação de atualização `multi` a uma lista de operações.
`Bulk.find.upsert()`	Especifica `upsert: true` para uma operação de atualização.
`Bulk.getOperations()`	Retorna um array de operações de gravação executadas no objeto de operações `Bulk()`.
`Bulk.insert()`	Adiciona uma operação de inserção a uma lista de operações.
`Bulk.toJSON()`	Retorna um documento JSON que contém o número de operações e lotes no objeto de operações `Bulk()`.
`Bulk.toString()`	Retorna os resultados de `Bulk.toJSON()` como uma string.

Gerenciamento de usuários

Nome	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.dropUser()`	Remove um único usuário.
`db.dropAllUsers()`	Exclui todos os usuários associados a um banco de dados.
`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.grantRolesToUser()`	Concede uma função e seus privilégios para um usuário.
`db.removeUser()`	Preterido. Remove um usuário de um banco de dados.
`db.revokeRolesFromUser()`	Remove uma função de um usuário.
`db.updateUser()`	Atualiza os dados do usuário.
`passwordPrompt()`	Solicita a senha como uma alternativa para definir senhas diretamente em vários métodos de autenticação/gerenciamento de usuários `mongosh` .

Gerenciamento de funções

Nome	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.

Replicação

Nome	Descrição
`rs.add()`	Adiciona um membro a um conjunto de réplicas.
`rs.addArb()`	Adiciona um árbitro a um conjunto de réplicas.
`rs.conf()`	Retorna o documento de configuração do conjunto de réplicas.
`rs.freeze()`	Impede que o membro atual busque a eleição como primário por um período de tempo.
`rs.help()`	Retorna textos básicos de ajuda para funções do conjunto de réplicas.
`rs.initiate()`	Inicia um novo conjunto de réplicas.
`rs.printReplicationInfo()`	Imprime um relatório formatado do status do conjunto de réplicas da perspectiva do primary.
`rs.printSecondaryReplicationInfo()`	Imprime um relatório formatado do status do conjunto de réplicas da perspectiva dos secundários.
`rs.reconfig()`	Reconfigura um conjunto de réplicas aplicando um novo objeto de configuração do conjunto de réplicas.
`rs.remove()`	Remove um nó de um conjunto de réplicas.
`rs.status()`	Retorna um documento com informações sobre o estado do conjunto de réplicas.
`rs.stepDown()`	Transforma o primário atual em secundário, forçando uma eleição.
`rs.syncFrom()`	Define o nó específico com o qual este nó do conjunto de réplicas se sincronizará, substituindo a lógica de escolha de destino de sincronização padrão.

Fragmentação

Nome	Descrição
`sh.abortReshardCollection()`	Aborta uma operação de refragmentação Novidades na versão 5,0.
`sh.addShard()`	Adiciona um fragmento a um cluster fragmentado.
`sh.addShardTag()`	No MongoDB 3.4, este método é um alias para `sh.addShardToZone()`.
`sh.addShardToZone()`	Associa um fragmento a uma zona. Oferece suporte à configuração de zonas em clusters fragmentados.
`sh.addTagRange()`	No MongoDB 3.4, este método é um alias para `sh.updateZoneKeyRange()`.
`sh.balancerCollectionStatus()`	Retorna informações sobre se as partes de uma coleção fragmentada estiverem balanceadas.
`sh.commitReshardCollection()`	Força uma operação de refragmentação para bloquear gravações e concluir. Novidades na versão 5,0.
`sh.disableBalancing()`	Desativa o balanceamento em uma única coleção em um banco de dados fragmentado. Não afeta o balanceamento de outras coleções em um cluster fragmentado.
`sh.enableBalancing()`	Ativa o processo de balanceamento de coleções fragmentadas se ele foi desativado anteriormente usando `sh.disableBalancing()`.
`sh.disableAutoMerger()`	Desabilita 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. A partir do MongoDB 6.0.3, a divisão automática de chunks não é executada. Isso se deve às melhorias no balanceamento das políticas. Os comandos de divisão automática ainda existem, mas não executam uma operação.
`sh.enableAutoMerger()`	Habilita 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. A partir do MongoDB 6.0.3, a divisão automática de chunks não é executada. Isso se deve às melhorias no balanceamento das políticas. Os comandos de divisão automática ainda existem, mas não executam uma operação.
`sh.enableSharding()`	Cria um banco de dados.
`sh.getBalancerState()`	Retorna um valor booleano indicando se o balanceador está ativo no momento.
`sh.getShardedDataDistribution()`	Retorna informações de distribuição de dados sobre coleções fragmentadas. `sh.getShardedDataDistribution()` é um assistente de shell para a fase `$shardedDataDistribution` do pipeline de agregação.
`sh.removeTagRange()`	No MongoDB 3.4, este método é um alias para `sh.removeRangeFromZone()`.
`sh.removeRangeFromZone()`	Remove uma associação entre uma faixa de chaves de fragmento e uma zona. Oferece suporte à configuração de zonas em clusters fragmentados.
`sh.help()`	Retorna o texto de ajuda para os métodos `sh`.
`sh.isBalancerRunning()`	Retorna um documento descrevendo o status do balanceador.
`sh.moveChunk()`	Migra uma parte em um cluster fragmentado.
`sh.removeShardTag()`	No MongoDB 3.4, este método é um alias para `sh.removeShardFromZone()`.
`sh.removeShardFromZone()`	Remove a associação entre um fragmento e uma zona. Use para gerenciar a fragmentação de zonas.
`sh.reshardCollection()`	Inicia uma operação de refragmentação para alterar a chave de fragmento de uma coleção, mudando a distribuição de seus dados. Novidades na versão 5,0.
`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 uma parte existente em duas partes usando um valor específico da chave de fragmento como ponto de divisão.
`sh.splitFind()`	Divide uma parte existente que contém um documento correspondente a uma consulta em duas partes aproximadamente iguais.
`sh.startAutoMerger()`	Habilita o AutoMerger. Novidades na versão 7,0.
`sh.startBalancer()`	Habilita o balanceador e aguarda o início do balanceamento.
`sh.status()`	Relatórios sobre o status de um agrupamento compartilhado, como `db.printShardingStatus()`.
`sh.stopAutoMerger()`	Desabilita o AutoMerger. Novidades na versão 7,0.
`sh.stopBalancer()`	Desabilita o balanceador e aguarda a conclusão de qualquer balanceamento em andamento.
`sh.waitForBalancer()`	Interno. Aguarde até que o estado do balanceador mude.
`sh.waitForBalancerOff()`	Interno. Aguarde até que o balanceador pare de funcionar.
`sh.waitForPingChange()`	Interno. Aguarda uma mudança no estado de ping de um dos `mongos` no cluster fragmentado.
`sh.updateZoneKeyRange()`	Associa uma faixa de chaves de fragmento a uma zona. Oferece suporte à configuração de zonas em clusters fragmentados.
`convertShardKeyToHashed()`	Retorna o valor hasheado para a entrada.

Construtores

Nome	Descrição
`Binary.createFromBase64()`	Cria um objeto binário a partir de um valor base64.
`Binary.createFromHexString()`	Cria um objeto binário a partir de um valor hexadecimal.
`BinData()`	Retorna um objeto de dados binários.
`BulkWriteResult()`	Adiciona um wrapper ao redor do conjunto de resultados de `Bulk.execute()`.
`Date()`	Cria um objeto de data. Por padrão, cria um objeto de data, incluindo a data atual.
`ObjectId()`	Retorna um ObjectId.
`ObjectId.createFromBase64()`	Cria um ObjectId a partir de um valor base64.
`ObjectId.createFromHexString()`	Cria um ObjectId a partir de um valor hexadecimal.
`ObjectId.getTimestamp()`	Retorna a parte do registro de data/hora de um ObjectId.
`ObjectId.toString()`	Exibe a representação de string de um ObjectId.
`ObjectId.valueOf()`	Exibe o atributo `str` de um ObjectId como uma string hexadecimal.
UUID()	Converte uma string hexadecimal de 32 bytes no subtipo UUID BSON.
`WriteResult()`	Adiciona um wrapper ao redor do conjunto de resultados dos métodos de gravação.
`WriteResult.hasWriteError()`	Retorna um valor booleano especificando se os resultados incluem `WriteResult.writeError`.
`WriteResult.hasWriteConcernError()`	Retorna um valor booleano especificando se os resultados incluem `WriteResult.writeConcernError`.

Conexão

Nome	Descrição
conectar()	Conecta-se a uma instância do MongoDB e ao banco de dados específico nesta instância.
`Mongo()`	Cria um novo objeto de conexão.
`Mongo.getDB()`	Retorna um objeto do banco de dados.
`Mongo.getReadPrefMode()`	Retorna o modo de preferência de leitura atual para a conexão do MongoDB.
`Mongo.getReadPrefTagSet()`	Retorna o conjunto de tags da preferência de leitura para a conexão do MongoDB.
`Mongo.setCausalConsistency()`	Habilita ou desabilita a consistência causal no objeto de conexão.
`Mongo.setReadPref()`	Define a preferência de leitura para a conexão do MongoDB.
`Mongo.startSession()`	Inicia uma sessão no objeto de conexão.
`Mongo.watch()`	Abre um cursor do fluxo de alterações para que uma implantação informe todas as suas coleções não `system` em todos os seus bancos de dados, exceto a `admin` interna, `local`, e os bancos de dados `config`.
`Session()`	O objeto da sessão.
`SessionOptions()`	O objeto de opções da sessão.

Criptografia no nível de campo do cliente

Observação

Os métodos de criptografia de nível de campo do lado do cliente mongosh exigem uma conexão de banco de dados com a criptografia de nível de campo do lado do cliente ativada. Se a conexão atual do banco de dados não tiver sido iniciada com a criptografia em nível de campo do lado do cliente ativada, faça o seguinte:

Use o construtor Mongo() do mongosh para estabelecer uma conexão com as opções necessárias de criptografia de nível de campo no lado do cliente. O método Mongo() suporta os seguintes fornecedores de serviço de gerenciamento de chaves (KMS) para gerenciamento da chave mestra do cliente (CMK):
ou
Utilize as mongosh opções da linha de comando para estabelecer uma conexão com as opções exigidas. As opções de linha de comando são compatíveis apenas com o fornecedor Amazon Web Services KMS para gerenciamento da chave mestra do cliente.

Nome	Descrição
`getKeyVault()`	Retorna o objeto cofre de chaves da conexão do MongoDB atual.
`KeyVault.createDataKey()`	Um alias para `KeyVault.createKey()`.
`KeyVault.createKey()`	Cria uma chave de criptografia de dados para uso na criptografia no nível do campo no lado do cliente.
`KeyVault.deleteKey()`	Exclui a chave de criptografia de dados especificada do cofre de chaves.
`KeyVault.getKey()`	Recupera a chave de criptografia de dados especificada do cofre de chaves.
`KeyVault.getKeys()`	Recupera todas as chaves no cofre de chaves.
`KeyVault.addKeyAlternateName()`	Associa um nome alternativo de uma chave à chave de criptografia de dados especificada.
`KeyVault.addKeyAltName()`	Um alias para `KeyVault.addKeyAlternateName()`.
`KeyVault.removeKeyAlternateName()`	Remove um nome alternativo de uma chave da chave de criptografia de dados especificada.
`KeyVault.removeKeyAltName()`	Um alias para `KeyVault.removeKeyAlternateName()`.
`KeyVault.getKeyByAltName()`	Recupera chaves com o nome alternativo de chave especificado.
`KeyVault.rewrapManyDataKey()`	Descriptografa várias chaves de dados e as criptografa novamente.
`getClientEncryption()`	Retorna o objeto de criptografia do cliente para oferecer suporte à criptografia/descriptografia explícita de campos.
`ClientEncryption.createEncryptedCollection()`	Cria uma coleção com campos criptografados.
`ClientEncryption.encrypt()`	Criptografa um campo usando uma chave de criptografia de dados especificada e o algoritmo de criptografia.
`ClientEncryption.decrypt()`	Descriptografa um campo usando a chave de criptografia de dados associada e o algoritmo de criptografia.

← Códigos operacionais legados

Métodos de índice de pesquisa do Atlas Search →