Comandos de banco de dados

All command documentation outlined below describes a command and its available parameters and provides a document template or prototype for each command. Some command documentation also includes the relevant mongosh helpers.

Para executar um comando no banco de dados atual, utilize db.runCommand():

db.runCommand( { <command> } )

Para executar um comando administrativo no banco de dados do admin, utilize db.adminCommand():

db.adminCommand( { <command> } )

Observação

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

Sintaxe do comando

Ao executar um comando do banco de dados, você especifica o comando como um documento para db.runCommand(). A chave do documento é o comando a ser executado e o valor é normalmente fornecido como 1. O valor não afeta a saída do comando, por exemplo:

db.runCommand( { hello: 1 } )

Comandos do usuário

Comandos de agregação

Nome	Descrição	Suporte ao MongoDB Atlas
`aggregate`	Executa tarefas de aggregation como `$group` utilizando um aggregation pipeline.	Suporte limitado para clusters Free e Flex.
`count`	Conta o número de documentos em uma collection ou visualização.	Suporte limitado para clusters Free e Flex.
`distinct`	Exibe os valores distintos encontrados para uma chave especificada em uma collection ou visualização.	Suporte limitado para clusters Free e Flex.
`mapReduce`	Executa a aggregation map-reduce para grandes conjuntos de dados.	Não há suporte para clusters Free e Flex.

Comandos de operação de query e gravação

Nome	Descrição	Suporte ao MongoDB Atlas
`bulkWrite`	Executa muitas operações de inserção, atualização e exclusão em várias coleções em uma solicitação. Novidades na versão 8.0.	Sim
`delete`	Exclui um ou mais documentos.	Sim
`find`	Seleciona documentos em uma collection ou visualização.	Suporte limitado para clusters Free e Flex.
`findAndModify`	Retorna e modifica um único documento.	Sim
`insert`	Insere um ou mais documentos.	Sim
`update`	Atualiza um ou mais documentos.	Sim

Comandos de cache do plano de query

Nome	Descrição	Suporte ao MongoDB Atlas
`planCacheClear`	Remove plano(s) de query em cache para uma collection.	Não há suporte para clusters Free e Flex.
`planCacheClearFilters`	Limpa filtro(s) de índice para uma collection.	Não há suporte para clusters Free e Flex.
`planCacheListFilters`	Lista os filtros de índice de uma collection.	Não há suporte para clusters Free e Flex.
`planCacheSetFilter`	Define um filtro de índice para uma collection.	Não há suporte para clusters Free e Flex.

Operações do Banco de Dados

Comandos de autenticação

Nome	Descrição	Suporte ao MongoDB Atlas
`authenticate`	Inicia uma sessão autenticada usando um nome de usuário e uma senha.	Não há suporte para clusters Free e Flex.
`logout`	Termina a sessão autenticada atual.	Sim

Comandos de gerenciamento de usuários

Nome	Descrição	Suporte ao MongoDB Atlas
`createUser`	Cria um novo usuário.	No support for Flex clusters, Free, and M10 clusters.
`dropAllUsersFromDatabase`	Exclui todos os usuários associados a um banco de dados.	Não há suporte para clusters Free e Flex.
`dropUser`	Remove um único usuário.	No support for M10 clusters.
`grantRolesToUser`	Concede uma função e seus privilégios para um usuário.	No support for Flex clusters, Free, and M10 clusters.
`revokeRolesFromUser`	Remove uma função de um usuário.	No support for Flex clusters, Free, and M10 clusters.
`updateUser`	Atualiza os dados de um usuário.	No support for Flex clusters, Free, and M10 clusters.
`usersInfo`	Retorna informações sobre os usuários especificados.	Suporte limitado para clusters Free e Flex.

Comandos de gerenciamento de funções

Nome	Descrição	Suporte ao MongoDB Atlas
`createRole`	Cria uma função e especifica seus privilégios.	No support for Flex clusters, Free, and M10 clusters.
`dropRole`	Exclui a função definida pelo usuário.	No support for Flex clusters, Free, and M10 clusters.
`dropAllRolesFromDatabase`	Exclui todas as roles definidas pelo usuário de um banco de dados.	Não há suporte para clusters Free e Flex.
`grantPrivilegesToRole`	Atribui privilégios a uma função definida pelo usuário.	Não há suporte para clusters Free e Flex.
`grantRolesToRole`	Especifica funções a partir dos quais uma função definida pelo usuário herda privilégios.	Não há suporte para clusters Free e Flex.
`invalidateUserCache`	Libera o cache da memória de informações do usuário, incluindo credenciais e roles.	Não há suporte para clusters Free e Flex.
`revokePrivilegesFromRole`	Remove os privilégios especificados de uma função definida pelo usuário.	Não há suporte para clusters Free e Flex.
`revokeRolesFromRole`	Remove roles herdadas especificadas de uma role definida pelo usuário.	Não há suporte para clusters Free e Flex.
`rolesInfo`	Retorna informações para a role ou roles especificadas.	Sim
`updateRole`	Atualiza uma função definida pelo usuário.	No support for Flex clusters, Free, and M10 clusters.

Comandos de replicação

Nome	Descrição	Suporte ao MongoDB Atlas
`appendOplogNote`	Grava uma entrada não operacional no oplog.	Não há suporte para clusters Free e Flex.
`applyOps`	Comando interno que aplica entradas de oplog ao conjunto de dados atual.	Sim
`hello`	Exibe informações sobre a role desse membro no conjunto de réplicas, incluindo se ele é o primary.	Sim
`replSetAbortPrimaryCatchUp`	Força o primary eleito a abortar a sincronização (atualizar) e, em seguida, concluir a transição para o primary.	Sim
`replSetFreeze`	Impede que o membro atual busque a eleição como primary por um período de tempo.	No support for Flex clusters, Free, and M10 clusters.
`replSetGetConfig`	Retorna o objeto de configuração do conjunto de réplicas.	Não há suporte para clusters Free e Flex.
`replSetGetStatus`	Retorna um documento que relata o status do conjunto de réplicas.	Não há suporte para clusters Free e Flex.
`replSetInitiate`	Inicia um novo conjunto de réplicas.	No support for Flex clusters, Free, and M10 clusters.
`replSetMaintenance`	Habilita ou desabilita um modo de manutenção, que coloca um nó secundário em um estado `RECOVERING`.	No support for Flex clusters, Free, and M10 clusters.
`replSetReconfig`	Aplica uma nova configuração a um conjunto de réplicas existente.	No support for Flex clusters, Free, and M10 clusters.
`replSetResizeOplog`	Redimensiona dinamicamente o oplog para um membro do conjunto de réplicas. Disponível apenas para o mecanismo de armazenamento WiredTiger.	No support for M10 clusters.
`replSetStepDown`	Força o atual primary a renunciar e se tornar secundário, forçando uma eleição.	No support for Flex clusters, Free, and M10 clusters.
`replSetSyncFrom`	Substitua explicitamente a lógica padrão para selecionar um membro para replicar.	No support for Flex clusters, Free, and M10 clusters.

Dica

Replicação para obter mais informações sobre replicação.

Comandos de fragmentação

Nome	Descrição	Suporte ao MongoDB Atlas
`abortMoveCollection`	Interrompe uma operação `moveCollection` em andamento. Novidades na versão 8.0.	Não há suporte para os níveis Atlas Free e Flex.
`abortReshardCollection`	Aborta uma operação de refragmentação	Sim
`abortRewriteCollection`	Interrompe uma operação `rewriteCollection` em andamento. Novidades na versão 8.3.	Sim
`abortUnshardCollection`	Interrompe uma operação `unshardCollection` em andamento. Novidades na versão 8.0.	Não há suporte para os níveis Atlas Free e Flex.
`addShard`	Adiciona um shard a um cluster fragmentado.	Sim
`addShardToZone`	Associa um shard a uma zona. Oferece suporte à configuração de zonas em clusters fragmentados.	Sim
`analyzeShardKey`	Calcula métricas para avaliar uma chave de fragmento. Novidades na versão 7.0.	Sim
`balancerCollectionStatus`	Retorna informações sobre se as partes de uma coleção fragmentada estiverem balanceadas.	Sim
`balancerStart`	Inicia um balancer thread.	Sim
`balancerStatus`	Retorna informações sobre o status do balancer.	Sim
`balancerStop`	Interrompe o balancer thread.	Sim
`checkMetadataConsistency`	Executa uma série de verificações de consistência sobre a fragmentação de metadados. Novidades na versão 7.0.	Sim
`clearJumboFlag`	Limpa o sinalizador `jumbo` de um chunk.	Sim
`cleanupOrphaned`	Remove documentos órfãos de um shard sem desabilitar o balanceador. Obsoleto desde a versão 8.0.	Não há suporte para clusters Free e Flex.
`cleanupReshardCollection`	Limpa uma operação de refragmentação com falha.	Sim
`commitReshardCollection`	Força uma operação de refragmentação para bloquear gravações e concluir.	Sim
`commitShardRemoval`	Remove um fragmento de um cluster. Novidades na versão 8.3.	No
`commitTransitionToDedicatedConfigServer`	Compromete a transição de um servidor de configuração incorporado para um servidor de configuração dedicado . Novidades na versão 8.3.	No
`configureCollectionBalancing`	Configura as configurações do balanceador em uma collection fragmentada.	Sim
`configureQueryAnalyzer`	Configura a amostragem de consulta para uma coleção. Novidades na versão 7.0.	Sim
`enableSharding`	Cria um banco de dados.	Sim
`flushRouterConfig`	Força uma instância `mongod` / `mongos` a atualizar seus metadados de roteamento em cache.	Sim
`getShardMap`	Comando interno que informa o estado de um cluster fragmentado.	Não há suporte para clusters Free e Flex.
`getTransitionToDedicatedConfigServerStatus`	Mostra o status da transição de um servidor de configuração incorporado para um servidor de configuração dedicado . Novidades na versão 8.3.	No
`isdbgrid`	Verifica se um processo é um `mongos`.	Sim
`listShards`	Retorna uma lista de shards configurados.	Sim
`moveChunk`	Comando interno que migra chunks entre shards.	Sim
`moveCollection`	Move uma única collection não fragmentada para um shard diferente.	Sim
`movePrimary`	Reatribui o primary shard ao remover um shard de um cluster fragmentado.	Sim
`moveRange`	Move intervalos entre shards.	Sim
`mergeAllChunksOnShard`	Mescla todas as partes mescláveis que um fragmento possui para uma determinada coleção.	Sim
`mergeChunks`	Oferece a capacidade de combinar chunks em um único shard.	Sim
`refineCollectionShardKey`	Define a chave de shard de uma collection adicionando um sufixo à chave existente.	No support for M10 clusters.
`removeShard`	Inicia o processo de remover um shard de um cluster fragmentado.	No support for M10 clusters.
`removeShardFromZone`	Remove a associação entre um shard e uma zona. Oferece suporte à configuração de zonas em clusters fragmentados.	Sim
`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.	Sim
`rewriteCollection`	Recompõe uma collection fragmentada no disco usando a mesma chave de fragmento. Novidades na versão 8.3.	Sim
`setAllowMigrations`	Impede novas migrações automáticas em uma coleção.	Sim
`shardCollection`	Ativa a funcionalidade de fragmentação para uma collection, permitindo que a collection seja fragmentada.	Sim
`shardDrainingStatus`	Mostra o status de um fragmento de drenagem, se o balanceador ainda está movendo partes para outros fragmentos no cluster ou se o processo está concluído. Novidades na versão 8.3.	No
`shardingState`	Informa se `mongod` é membro de um cluster fragmentado.	Sim
`split`	Cria um novo chunk.	Sim
`startShardDraining`	Inicia o processo de drenagem de partes de um fragmento para prepará-lo para a remoção de um cluster. Novidades na versão 8.3.	No
`startTransitionToDedicatedConfigServer`	Inicia a transição de um servidor de configuração incorporado para um servidor de configuração dedicado . Novidades na versão 8.3.	No
`stopShardDraining`	Impede que o balanceador drenagem partes do fragmento fornecido. Novidades na versão 8.3.	No
`stopTransitionToDedicatedConfigServer`	Interrompe a transição em andamento de um servidor de configuração incorporado para um servidor de configuração dedicado . Novidades na versão 8.3.	No
`transitionFromDedicatedConfigServer`	Configura um servidor de configuração dedicado para ser executado como um fragmento de configuração. Novidades na versão 8.0.	Não há suporte para os níveis Atlas Free e Flex.
`transitionToDedicatedConfigServer`	Configura um fragmento de configuração para ser executado como um servidor de configuração dedicado. Novidades na versão 8.0.	Não há suporte para os níveis Atlas Free e Flex.
`unsetSharding`	Removido no MongoDB 5.0. Comando interno que afeta conexões entre instâncias em um MongoDB deployment.	Sim
`unshardCollection`	Desfaz a fragmentação de uma coleção fragmentada existente e move os dados da coleção para um único fragmento. Quando você desfragmenta uma coleção, a coleção não pode ser particionada em vários fragmentos, e a chave de fragmento é removida. Novidades na versão 8.0.	Sim
`updateZoneKeyRange`	Adiciona ou remove a associação entre uma faixa de dados fragmentados e uma zona. Oferece suporte à configuração de zonas em clusters fragmentados.	Sim

Dica

Fragmentação para obter mais informações sobre a funcionalidade de fragmentação do MongoDB.

Comandos de sessão

Comando	Descrição	Suporte Atlas
`abortTransaction`	Abortar transação.	Sim
`commitTransaction`	Confirmar transação.	Sim
`endSessions`	Expire as sessões antes do período de tempo limite das sessões.	Sim
`killAllSessions`	Elimine todas as sessões.	No support for Flex clusters, Free, and M10 clusters.
`killAllSessionsByPattern`	Eliminar todas as sessões que correspondem ao padrão especificado	Não há suporte para clusters Free e Flex.
`killSessions`	Elimine sessões especificadas.	Não há suporte para clusters Free e Flex.
`refreshSessions`	Atualizar sessões ociosas.	Sim
`startSession`	Inicia uma nova sessão.	Sim

Comandos de Administração

Nome	Descrição	Suporte ao MongoDB Atlas
`autoCompact`	Habilita a compactação de background. Novidades na versão 8.0.	Não há suporte para clusters Free e Flex.
`cloneCollectionAsCapped`	Copia uma non-capped collection como uma nova capped collection.	Não há suporte para clusters Free e Flex.
`collMod`	Adicione opções a uma collection ou modifique uma definição de visualização.	Sim
`compact`	Desfragmenta uma collection e reconstrói os índices.	Não há suporte para clusters Free e Flex.
`compactStructuredEncryptionData`	Compacta documentos especificados nas collections estaduais e exclui documentos redundantes.	Sim
`convertToCapped`	Converte uma non-capped collection em uma capped collection.	Sim
`create`	Cria uma collection ou uma visualização.	Sim
`createIndexes`	Cria um ou mais índices para uma collection.	Sim
`currentOp`	Retorna um documento que contém informações sobre operações em andamento para a instância do banco de dados.	Sim
`drop`	Remove a coleção especificada do banco de dados.	Sim
`dropDatabase`	Remove o banco de dados atual.	Sim
`dropConnections`	Descarta as conexões de saída para a lista especificada de hosts.	Sim
`dropIndexes`	Remove índices de uma collection.	Sim
`filemd5`	Obsoleto. Retorna o hash md5 para arquivos armazenados usando o GridFS.	Sim
`fsync`	Libera gravações pendentes na camada de armazenamento e bloqueia o banco de dados para permitir cópias de segurança.	No support for Flex clusters, Free, and M10 clusters.
`fsyncUnlock`	Desbloqueia um bloqueio fsync.	Não há suporte para clusters Free e Flex.
`getAuditConfig`	Descontinuado na versão 7.1: em vez disso, use o parâmetro de cluster `auditConfig` . Recupera configurações de auditoria de instâncias `mongod` e `mongos`.	No
`getDefaultRWConcern`	Recupera as opções globais read e write concern padrão para o sistema.	Sim
`getClusterParameter`	Recupera valores de parâmetro do cluster de todos os nós em um cluster. Novidades na versão 6.0.	Sim
`getParameter`	Retrieves configuration options.	Suporte limitado para clusters Free e Flex.
`killCursors`	Mata os cursores especificados para uma collection.	Sim
`killOp`	Termina uma operação conforme especificado pelo ID da operação.	Limited support for Free, M10, and Flex clusters.
`listCollections`	Retorna uma lista de collections no banco de dados atual.	Sim
`listDatabases`	Retorna um documento que lista todos os bancos de dados e retorna estatísticas básicas do banco de dados.	Sim
`listIndexes`	Lista todos os índices de uma collection.	Sim
`logRotate`	Gira os logs MongoDB para evitar que um único arquivo tenha muito espaço.	No support for Flex clusters, Free, and M10 clusters.
`reIndex`	Reconstrói todos os índices em uma collection.	Não há suporte para clusters Free e Flex.
`removeQuerySettings`	Remove as configurações de query para uma forma de query. Novidades na versão 8.0.	Sim
`renameCollection`	Altera o nome de uma collection existente.	Sim
`rotateCertificates`	Executa rotação de certificado TLS online.	Sim
`setFeatureCompatibilityVersion`	Habilita ou desabilita feições que persistem dados que são incompatíveis.	No support for Flex clusters, Free, and M10 clusters.
`setIndexCommitQuorum`	Altera o número mínimo de membros portadores de dados (ou seja, quorum de commit), incluindo o primário, que deve votar para cometer uma construção de índice em andamento antes que o primário marque esses índices como prontos.	Sim
`setAuditConfig`	Descontinuado na versão 7.1: em vez disso, use o parâmetro de cluster `auditConfig` . Define configurações de auditoria para instâncias do `mongod` e `mongos` no tempo de execução.	No
`setClusterParameter`	Modifica as opções de configuração para todos os nós em um conjunto de réplica ou cluster fragmentado. Novidades na versão 6.0.	Sim
`setParameter`	Modifica as opções de configuração.	No support for Flex clusters, Free, and M10 clusters.
`setQuerySettings`	Define configurações de query para uma forma de query. Novidades na versão 8.0.	Sim
`setDefaultRWConcern`	Define as opções de write concern padrão globais para o sistema.	Sim
`setUserWriteBlockMode`	Bloqueia e desbloqueia gravações em todo o cluster.	No
`shutdown`	Desliga o processo `mongod` ou `mongos`.	No support for Flex clusters, Free, and M10 clusters.

Comandos de diagnóstico

Nome	Descrição	Suporte ao MongoDB Atlas
`buildInfo`	Exibe estatísticas sobre a compilação do MongoDB.	Sim
`collStats`	Relata estatísticas de utilização de armazenamento para uma collection especificada.	Sim
`connPoolStats`	Relata estatísticas sobre as conexões de saída dessa instância do MongoDB para outras instâncias do MongoDB no sistema.	Sim
`connectionStatus`	Relata o estado de autenticação da conexão atual.	Sim
`dataSize`	Retorna o tamanho dos dados para um intervalo de dados. Para uso interno.	Não há suporte para clusters Free e Flex.
`dbHash`	Retorna o valor de hash de um banco de dados e suas collections.	Não há suporte para clusters Free e Flex.
`dbStats`	Estatísticas de utilização do armazenamento de relatórios para o banco de dados especificado.	Suporte limitado para clusters Free e Flex.
`explain`	Retorna informações sobre a execução de várias operações.	Sim
`getCmdLineOpts`	Retorna um documento com os argumentos de tempo de execução para a instância MongoDB e suas opções analisadas.	Sim
`getLog`	Retorna mensagens de log recentes.	Sim
`hostInfo`	Retorna dados que refletem o sistema de host subjacente.	Não há suporte para clusters Free e Flex.
`listCommands`	Lista todos os comandos do banco de dados fornecidos pela instância `mongod` atual.	Sim
`lockInfo`	Comando interno que retorna informações sobre travas que estão retidas ou pendentes. Disponível apenas para instâncias `mongod`.	Não há suporte para clusters Free e Flex.
`ping`	Comando interno que testa a conectividade intra-implantação.	Sim
`profile`	Interface para o perfil do banco de dados.	Sim
`serverStatus`	Retorna uma métrica de collection sobre a utilização e o status de recursos em toda a instância.	Sim
`shardConnPoolStats`	Removido no MongoDB 5.0. Use `connPoolStats` em vez disso.	Sim
`top`	Retorna estatísticas de uso bruto para cada banco de dados na instância do `mongod`.	Sim
`validate`	Comando interno que verifica a exatidão dos dados e índices de uma collection.	Não há suporte para clusters Free e Flex.
`validateDBMetadata`	Verifica se os metadados armazenados de um banco de dados ou de uma coleção são válidos em uma determinada versão da API.	Sim
`whatsmyuri`	Comando interno que retorna informações sobre o cliente atual.	Sim

Comandos de auditoria

Nome	Descrição	Suporte ao MongoDB Atlas
`logApplicationMessage`	Posta uma mensagem personalizada no registro de auditoria.	Sim

Atlas Search

Novidade na versão 7.0: (Também disponível a partir da versão 6.0.7)

Nome	Descrição
`createSearchIndexes`	Cria um ou mais índices do MongoDB Search em uma collection ou visualização especificada.
`dropSearchIndex`	Exclui um índice de pesquisa MongoDB existente.
`updateSearchIndex`	Atualiza um índice de pesquisa MongoDB existente.

Voltar

Locais e Parâmetros Padrão

planCacheClear