Comandos de banco de dados

Nesta página

Sintaxe do comando

Comandos do usuário
Operações do Banco de Dados
Comandos de auditoria
Comandos de pesquisa do Atlas

Toda documentação de comando descrita abaixo descreve um comando e seus parâmetros disponíveis, bem como fornece um modelo de documento ou protótipo para cada comando. Algumas documentações de comandos também incluem os auxiliares mongosh relevantes.

Para executar um comando no banco de dados atual, use 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 M0, M2, and M5.
`count`	Conta o número de documentos em uma collection ou visualização.	Suporte limitado para clusters M0, M2, and M5.
`distinct`	Exibe os valores distintos encontrados para uma chave especificada em uma collection ou visualização.	Suporte limitado para clusters M0, M2, and M5.
`mapReduce`	Executa a aggregation map-reduce para grandes conjuntos de dados.	Não há suporte para clusters M0, M2 e M5.

Comandos Geoespaciais

Nome	Descrição	Suporte ao MongoDB Atlas
`geoSearch`	Removido no MongoDB 5.0. Executa uma consulta geoespacial que utiliza a funcionalidade de índice do MongoDB.	Nenhuma compatibilidade para instâncias sem servidor.

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.	No
`delete`	Exclui um ou mais documentos.	Sim
`find`	Seleciona documentos em uma collection ou visualização.	Suporte limitado para clusters M0, M2, and M5.
`findAndModify`	Retorna e modifica um único documento.	Sim
`getMore`	Retorna lotes de documentos apontados atualmente pelo cursor.	Sim
`insert`	Insere um ou mais documentos.	Sim
`resetError`	Removido no MongoDB 5.0. Redefine o último status de erro.	No
`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 M0, M2 e M5.
`planCacheClearFilters`	Limpa filtro(s) de índice para uma collection.	Não há suporte para clusters M0, M2 e M5.
`planCacheListFilters`	Lista os filtros de índice de uma collection.	Não há suporte para clusters M0, M2 e M5.
`planCacheSetFilter`	Define um filtro de índice para uma collection.	Não há suporte para clusters M0, M2 e M5.

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 M0, M2 e M5.
`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.	Não há suporte para clusters M0, M2, M5 e M10.
`dropAllUsersFromDatabase`	Exclui todos os usuários associados a um banco de dados.	Não há suporte para clusters M0, M2 e M5.
`dropUser`	Remove um único usuário.	Não há suporte para clusters M10.
`grantRolesToUser`	Concede uma função e seus privilégios para um usuário.	Não há suporte para clusters M0, M2, M5 e M10.
`revokeRolesFromUser`	Remove uma função de um usuário.	Não há suporte para clusters M0, M2, M5 e M10.
`updateUser`	Atualiza os dados de um usuário.	Não há suporte para clusters M0, M2, M5 e M10.
`usersInfo`	Retorna informações sobre os usuários especificados.	Suporte limitado para clusters M0, M2, and M5.

Comandos de gerenciamento de funções

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

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 M0, M2 e M5.
`applyOps`	Comando interno que aplica entradas de oplog ao conjunto de dados atual.	Nenhuma compatibilidade para instâncias sem servidor.
`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.	Não há suporte para clusters M0, M2, M5 e M10.
`replSetGetConfig`	Retorna o objeto de configuração do conjunto de réplicas.	Não há suporte para clusters M0, M2 e M5.
`replSetGetStatus`	Retorna um documento que relata o status do conjunto de réplicas.	Não há suporte para clusters M0, M2 e M5.
`replSetInitiate`	Inicia um novo conjunto de réplicas.	Não há suporte para clusters M0, M2, M5 e M10.
`replSetMaintenance`	Habilita ou desabilita um modo de manutenção, que coloca um nó secundário em um estado `RECOVERING`.	Não há suporte para clusters M0, M2, M5 e M10.
`replSetReconfig`	Aplica uma nova configuração a um conjunto de réplicas existente.	Não há suporte para clusters M0, M2, M5 e M10.
`replSetResizeOplog`	Redimensiona dinamicamente o oplog para um membro do conjunto de réplicas. Disponível apenas para o mecanismo de armazenamento WiredTiger.	Não há suporte para clusters M10.
`replSetStepDown`	Força o atual primary a renunciar e se tornar secundário, forçando uma eleição.	Não há suporte para clusters M0, M2, M5 e M10.
`replSetSyncFrom`	Substitua explicitamente a lógica padrão para selecionar um membro para replicar.	Não há suporte para clusters M0, M2, M5 e M10.

Dica

Veja também:

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

Comandos de fragmentação

Nome	Descrição	Suporte ao MongoDB Atlas
`abortReshardCollection`	Aborta uma operação de refragmentação Novidades na versão 5.0.	Sim
`abortMoveCollection`	Interrompe uma operação `moveCollection` em andamento. Novidades na versão 8.0.	Não há suporte para instâncias sem servidor e nível compartilhado do Atlas.
`abortUnshardCollection`	Interrompe uma operação `unshardCollection` em andamento. Novidades na versão 8.0.	Não há suporte para instâncias sem servidor e nível compartilhado do Atlas.
`addShard`	Adiciona um shard a um cluster fragmentado.	Nenhuma compatibilidade para instâncias sem servidor.
`addShardToZone`	Associa um shard a uma zona. Oferece suporte à configuração de zonas em clusters fragmentados.	Nenhuma compatibilidade para instâncias sem servidor.
`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.	Nenhuma compatibilidade para instâncias sem servidor.
`balancerStart`	Inicia um balancer thread.	Nenhuma compatibilidade para instâncias sem servidor.
`balancerStatus`	Retorna informações sobre o status do balancer.	Nenhuma compatibilidade para instâncias sem servidor.
`balancerStop`	Interrompe o balancer thread.	Nenhuma compatibilidade para instâncias sem servidor.
`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.	Nenhuma compatibilidade para instâncias sem servidor.
`cleanupReshardCollection`	Limpa uma operação de refragmentação com falha. Novidades na versão 5.0.	Sim
`commitReshardCollection`	Força uma operação de refragmentação para bloquear gravações e concluir. Novidades na versão 5.0.	Sim
`configureCollectionBalancing`	Configura as configurações do balanceador em uma collection fragmentada. Novidades na versão 5.3.	Sim
`configureQueryAnalyzer`	Configura a amostragem de consulta para uma coleção. Novidades na versão 7.0.	Sim
`enableSharding`	Cria um banco de dados.	Nenhuma compatibilidade para instâncias sem servidor.
`flushRouterConfig`	Força uma instância `mongod` / `mongos` a atualizar seus metadados de roteamento em cache.	Nenhuma compatibilidade para instâncias sem servidor.
`getShardMap`	Comando interno que informa o estado de um cluster fragmentado.	Não há suporte para clusters M0, M2 e M5 e instâncias sem servidor.
`isdbgrid`	Verifica se um processo é um `mongos`.	Sim
`listShards`	Retorna uma lista de shards configurados.	Nenhuma compatibilidade para instâncias sem servidor.
`moveChunk`	Comando interno que migra chunks entre shards.	Nenhuma compatibilidade para instâncias sem servidor.
`movePrimary`	Reatribui o primary shard ao remover um shard de um cluster fragmentado.	Nenhuma compatibilidade para instâncias sem servidor.
`moveRange`	Move intervalos entre shards.	Sim
`mergeAllChunksOnShard`	Mescla todas as partes mescláveis que um fragmento possui para uma determinada coleção.	Nenhuma compatibilidade para instâncias sem servidor.
`mergeChunks`	Oferece a capacidade de combinar chunks em um único shard.	Nenhuma compatibilidade para instâncias sem servidor.
`refineCollectionShardKey`	Define a chave de shard de uma collection adicionando um sufixo à chave existente.	Não há suporte para clusters M10 e instâncias sem servidor.
`removeShard`	Inicia o processo de remover um shard de um cluster fragmentado.	Não há suporte para clusters M10 e instâncias sem servidor.
`removeShardFromZone`	Remove a associação entre um shard e uma zona. Oferece suporte à configuração de zonas em clusters fragmentados.	Nenhuma compatibilidade para instâncias sem servidor.
`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.	Sim
`setAllowMigrations`	Impede novas migrações automáticas em uma coleção.	Nenhuma compatibilidade para instâncias sem servidor.
`shardCollection`	Ativa a funcionalidade de fragmentação para uma collection, permitindo que a collection seja fragmentada.	Nenhuma compatibilidade para instâncias sem servidor.
`shardingState`	Informa se `mongod` é membro de um cluster fragmentado.	Sim
`split`	Cria um novo chunk.	Nenhuma compatibilidade para instâncias sem servidor.
`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 instâncias sem servidor e nível compartilhado do Atlas.
`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 instâncias sem servidor e nível compartilhado do Atlas.
`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.	Nenhuma compatibilidade para instâncias sem servidor.

Dica

Veja também:

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.	Não há suporte para clusters M0, M2, M5 e M10.
`killAllSessionsByPattern`	Eliminar todas as sessões que correspondem ao padrão especificado	Não há suporte para clusters M0, M2 e M5.
`killSessions`	Elimine sessões especificadas.	Não há suporte para clusters M0, M2 e M5.
`refreshSessions`	Atualizar sessões ociosas.	Sim
`startSession`	Inicia uma nova sessão.	Sim

Comandos de Administração

Nome	Descrição	Suporte ao MongoDB Atlas
`cloneCollectionAsCapped`	Copia uma non-capped collection como uma nova capped collection.	Não há suporte para clusters M0, M2 e M5 e instâncias sem servidor.
`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 M0, M2 e M5.
`compactStructuredEncryptionData`	Compacta documentos especificados nas collections estaduais e exclui documentos redundantes.	Sim
`convertToCapped`	Converte uma non-capped collection em uma capped collection.	Nenhuma compatibilidade para instâncias sem servidor.
`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`	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.	Não há suporte para clusters M0, M2, M5 e M10.
`fsyncUnlock`	Desbloqueia um bloqueio fsync.	Não há suporte para clusters M0, M2 e M5.
`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 M0, M2, and M5.
`killCursors`	Mata os cursores especificados para uma collection.	Sim
`killOp`	Termina uma operação conforme especificado pelo ID da operação.	Suporte limitado para clusters M0, M2, M5 e M10.
`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.	Não há suporte para clusters M0, M2, M5 e M10.
`reIndex`	Reconstrói todos os índices em uma collection.	Não há suporte para clusters M0, M2 e M5.
`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.	Não há suporte para clusters M0, M2, M5 e M10.
`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
`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.	Não há suporte para clusters M0, M2, M5 e M10.
`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`.	Não há suporte para clusters M0, M2, M5 e M10.
`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. Novidades na versão 5.0.	Sim

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 M0, M2 e M5.
`dbHash`	Retorna o valor de hash de um banco de dados e suas collections.	Não há suporte para clusters M0, M2 e M5 e instâncias sem servidor.
`dbStats`	Estatísticas de utilização do armazenamento de relatórios para o banco de dados especificado.	Suporte limitado para clusters M0, M2, and M5.
`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 M0, M2 e M5.
`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 M0, M2 e M5.
`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.	Nenhuma compatibilidade para instâncias sem servidor.
`top`	Retorna estatísticas de uso bruto para cada banco de dados na instância do `mongod`.	Nenhuma compatibilidade para instâncias sem servidor.
`validate`	Comando interno que verifica a exatidão dos dados e índices de uma collection.	Não há suporte para clusters M0, M2 e M5 e instâncias sem servidor.
`whatsmyuri`	Comando interno que retorna informações sobre o cliente atual.	Sim

Comandos de auditoria

Nome	Descrição	Suporte ao MongoDB Atlas
`getAuditConfig`	Recupera configurações de auditoria de instâncias `mongod` e `mongos`. Obsoleto no MongoDB 7.1	No
`logApplicationMessage`	Posta uma mensagem personalizada no registro de auditoria.	Sim
`setAuditConfig`	Define configurações de auditoria para instâncias do `mongod` e `mongos` no tempo de execução. Obsoleto no MongoDB 7.1	No

Comandos de pesquisa do Atlas

Novidade na versão 7.0: (Disponível também a partir de 6.0.7)

Nome	Descrição
`createSearchIndexes`	Cria um ou mais Atlas Search indexes em uma coleção especificada.
`dropSearchIndex`	Exclui um índice de Pesquisa do Atlas existente.
`updateSearchIndex`	Atualiza um Atlas Search existente.

Voltar

Exemplos de connection string

Agregação