Menu Docs
Página inicial do Docs
/
Manual do MongoDB
/ /

mongo Referência rápida do shell

Nesta página

  • mongo histórico de comandos shell
  • Opções de linha de comando
  • Auxiliares de comando
  • Operações básicas de shell JavaScript
  • Atalhos de teclado
  • Consultas
  • Métodos de verificação de erros
  • Auxiliares de comandos administrativos
  • Abrindo conexões adicionais
  • Diversos
  • Recursos adicionais

Aviso

O documento a seguir pertence ao shell mongo , incluído no Download do MongoDB Server. Para obter informações sobre o novo MongoDB Shell (mongosh), consulte a documentação do mongosh.

Para entender as diferenças entre as duas conchas, consulte Comparação da shell mongo e mongosh.

Você pode recuperar comandos anteriores emitidos na shell mongo com as teclas de seta para cima e para baixo. O histórico de comandos é armazenado no arquivo ~/.dbshell . Consulte .dbshell para mais informações.

O shell mongo pode ser iniciado com diversas opções. Consulte a página de shell do mongo para obter detalhes sobre todas as opções disponíveis.

A tabela a seguir exibe algumas opções comuns para mongo:

Opção
Descrição
Mostrar opções de linha de comando

Inicie o shell mongo sem se conectar a um banco de dados.

Para se conectar mais tarde, consulte Abrir novas conexões.

Usado em conjunto com um arquivo JavaScript (ou seja, <file.js>) para continuar no shell mongo depois de executar o arquivo JavaScript.

Consulte o arquivo JavaScript para obter um exemplo.

O shell mongo fornece várias ajudas. A tabela a seguir exibe alguns métodos e comandos de ajuda comuns:

Métodos e comandos de ajuda
Descrição
help
Mostrar ajuda.
Mostra ajuda para métodos de banco de dados.
Mostrar ajuda sobre métodos de coleção. O <collection> pode ser o nome de uma coleção existente ou de uma coleção não existente.
show dbs

Imprima uma lista de todos os bancos de dados no servidor.

A operação corresponde ao comando listDatabases . Se o sistema for executado com controle de acesso, a operação retornará valores diferentes com base nos privilégios do usuário. Consulte Comportamento do listDatabases para obter detalhes.

use <db>
Mudar banco de dados atual para <db>. A variável de shell mongo db está definida para o banco de dados atual.
show collections
Imprima uma lista de todas as coleções do banco de dados atual.
show users
Imprima uma lista de usuários para o banco de dados atual.
show roles
Imprima uma lista de todos os papéis, definidos pelo usuário e embutidos, para o banco de dados atual.
show profile
Imprima as cinco operações mais recentes que levaram 1 milissegundos ou mais. Consulte a documentação sobre o analisador de banco de dados para obter mais informações.
show databases

Imprima uma lista de todos os bancos de dados disponíveis.

A operação corresponde ao comando listDatabases . Se o sistema for executado com controle de acesso, a operação retornará valores diferentes com base nos privilégios do usuário. Consulte Comportamento do listDatabases para obter detalhes.

load()
Execute um arquivo JavaScript. Consulte Escrever scripts para o shell mongo para obter mais informações.

O shell mongo fornece uma API JavaScript para operações de banco de dados.

Na shell mongo , db é a variável que faz referência ao banco de dados atual. A variável é definida automaticamente para o banco de dados padrão test ou é definida quando você usa o use <db> para alternar o banco de dados atual.

A tabela a seguir exibe algumas operações JavaScript comuns:

Operações do Banco de Dados JavaScript
Descrição
Se estiver executando no modo seguro, autentique o usuário.
coll = db.<collection>

Defina uma coleção específica no banco de dados atual para uma variável coll, como no exemplo a seguir:

coll = db.myCollection;

Você pode executar operações no myCollection utilizando a variável, como no seguinte exemplo:

coll.find();

Localiza todos os documentos na coleção e retorna um cursor.

Consulte o db.collection.find() e os Documentos de query para obter mais informações e exemplos.

Consulte Iterar um cursor no mongosh para obter informações sobre o tratamento do cursor na shell mongo .

Insira um novo documento na coleção.
Insira vários novos documentos na coleção.
Atualizar um único documento existente na coleção.
Atualize vários documentos existentes na coleção.
Exclua um único documento da collection.
Exclua documentos da collection.
Descarta ou remove completamente a coleção.
Criar um novo índice na collection se o índice não existir; caso contrário, a operação não terá efeito.
Retorne uma referência a outro banco de dados usando essa mesma conexão sem alternar explicitamente o banco de dados atual. Isso permite queries entre bancos de dados.

Para obter mais informações sobre como executar operações na shell, consulte:

O shell mongo fornece a maioria dos atalhos de teclado semelhantes aos encontrados no shell bash ou no Emacs. Para algumas funções, o mongo fornece múltiplas vinculações de chave, para acomodar vários paradigmas conhecidos.

A tabela a seguir enumera as teclas suportadas pelo shell mongo :

Toque de tecla
Função
Seta para cima
história anterior
Seta para baixo
Next-history
Início
início de linha
End
end-of-line
Tab
autocompletar
Seta para a esquerda
caractere inverso
Seta para a direita
caractere direto
ctrl-seta para a esquerda
palavra de trás para frente
ctrl-seta para a direita
palavra avançada
Seta para a esquerda
palavra de trás para frente
Seta para a direita
palavra avançada
ctrl-A
início de linha
ctrl-B
caracteres inversos
ctrl-C
saída-shell
ctrl-D
delete-char (ou sair do shell)
ctrl-E
end-of-line
ctrl-F
forward-char
ctrl-G
abortar
ctrl-J
accept-line
ctrl-K
kill-line
ctrl-L
tela limpa
ctrl-M
accept-line
ctrl-N
Next-history
ctrl-P
história anterior
ctrl-R
verse-search-history
ctrl-S
forward-search-history
ctrl-T
transpose-chars
ctrl-U
unix-line-discard
ctrl-W
unix-word-rubout
Ctrl-Y
puxar
ctrl-Z
Suspender (o controle de tarefas funciona no Linux)
ctrl-H (ou seja, Backspace)
back-delete-char
ctrl-I (ou seja, Tab)
completo
Meta-B
palavra de trás para frente
Meta-C
palavras maiúsculas
Meta-D
palavra final
Meta-F
palavra avançada
Meta-L
downcase-word
Meta-U
upcase-word
Meta-Y
ianque-pop
Meta-[Backspace]
back-kill-word
Meta-<
início da história
Meta->
fim da história

No shell mongo , execute operações de leitura usando os métodos find() e findOne() .

O método find() retorna um objeto do cursor que o shell mongo itera para imprimir documentos na tela. Por padrão, mongo imprime o primeiro 20. O shell mongo solicitará ao usuário "Type it" para continuar iterando os próximos resultados 20 .

A tabela a seguir fornece algumas operações de leitura comuns no shell mongo :

Ler operações
Descrição

Encontre os documentos que correspondam aos critérios <query> na coleção. Se o critério <query> não for especificado ou estiver vazio (ou seja, {} ), a operação de leitura selecionará todos os documentos na collection.

O exemplo a seguir seleciona os documentos na collection users com o campo name igual a "Joe":

coll = db.users;
coll.find( { name: "Joe" } );

Para obter mais informações sobre como especificar os critérios <query> , consulte Especificar condição de igualdade.

Encontre documentos que correspondam aos critérios <query> e retorne apenas campos específicos no <projection>.

O exemplo a seguir seleciona todos os documentos da collection, mas retorna apenas o campo name e o campo _id . O _id é sempre retornado, a menos que seja explicitamente especificado para não retornar.

coll = db.users;
coll.find( { }, { name: true } );

Para obter mais informações sobre como especificar o <projection>, consulte Campos do projeto a serem retornados da query.

Retornar resultados no <sort order> especificado.

O exemplo a seguir seleciona todos os documentos da collection e retorna os resultados classificados pelo campo name em ordem crescente (1). Use -1 para ordem decrescente:

coll = db.users;
coll.find().sort( { name: 1 } );
Retornar os documentos que correspondem aos critérios <query> no <sort order> especificado.
Limite o resultado a <n> linhas. Altamente recomendado se você precisar de apenas um determinado número de linhas para obter o melhor desempenho.
Ignorar <n> resultados.
Retorna o número total de documentos na coleção.

Retorna o número total de documentos que correspondem à query.

O count() ignora limit() e skip(). Por exemplo, se 100 registros corresponderem, mas o limite for 10, count() retornará 100. Isso será mais rápido do que iterar você mesmo, mas ainda assim levará tempo.

Encontre e devolva um único documento. Retorna nulo se não for encontrado.

O exemplo a seguir seleciona um único documento na collection users com o campo name correspondente a "Joe":

coll = db.users;
coll.findOne( { name: "Joe" } );

Internamente, o método findOne() é o método find() com um limit(1).

Consulte a documentação de documentos de query para obter mais informações e exemplos. Consulte Operadores de Query e Projeção para especificar outros operadores de query.

O método de escrita de shell mongo integra a Write Concern diretamente na execução do método e retorna um objeto WriteResult() que contém os resultados da operação, incluindo quaisquer erros de escrita e erros de write concern.

A tabela a seguir lista alguns métodos comuns para dar suporte à administração do banco de dados:

Métodos de administração de banco de dados JavaScript
Descrição
Renomear coleção de fromColl para <toColl>. Consulte Restrições de nomenclatura.
Obtenha a lista de todas as collections no banco de dados atual.
Descarta o banco de dados atual.

Consulte também métodos administrativos do banco de dados para obter uma lista completa dos métodos.

Você pode criar novas conexões dentro do shell mongo .

A tabela a seguir exibe os métodos para criar as conexões:

Métodos de criação de conexão JavaScript
Descrição
db = connect("<host><:port>/<dbname>")
Abra uma nova conexão do banco de dados.
conn = new Mongo()
db = conn.getDB("dbname")

Abra uma conexão com um novo servidor usando new Mongo().

Utilize o método getDB() da conexão para selecionar um banco de dados.

Consulte também Abrir novas conexões para obter mais informações sobre a abertura de novas conexões a partir do shell mongo .

A tabela a seguir exibe alguns métodos diversos:

Método
Descrição
Object.bsonsize(<document>)
Imprime o tamanho BSON de um <document> em bytes

Considere o seguinte material de referência que aborda o shell mongo e sua interface:

Além disso, o repositório de código fonte do MongoDB inclui um diretório jstests que contém vários scripts de shell mongo .

Voltar

_rand()