MongoDB Shell

4 min

Resumo

Execute comandos por meio do shell do MongoDB.
Comandos fornecidos com o parâmetro eval ou incluídos em um arquivo Javascript.
Tenta analisar os dados retornados em um formato que pode ser usado pelo Atmosphere.
Módulo atualmente usa o shell mongo por padrão. Isso mudará para mongosh em uma versão futura e o suporte para mongo será eliminado

Parâmetros

Parâmetro	Tipo	Escolhas \| Valores padrão	Comentários
additional_args	dictionary		Argumentos adicionais a serem fornecidos ao comando mongo. Forneça como pares de valores-chave. Se o parâmetro for um sinalizador sem valor, forneça uma string vazia como o valor.
db	string	Padrão: "test"	O banco de dados para executar comandos
debug	boolean	Escolhas: no (padrão) yes	Mostrar informações adicionais de depuração.
eval	string		Um comando MongoDB a ser executado.
file	string		Caminho para um arquivo que contém comandos do MongoDB.
idempotent	boolean	Escolhas: no (padrão) yes	Fornece uma forma de pseudo-idempotência ao módulo. Nós executamos um cálculo de hash no conteúdo da chave eval ou no nome do arquivo fornecido na chave do arquivo. Quando o comando é executado pela primeira vez, um campo chamado <hash>.success será criado. O módulo não executará novamente o comando se este arquivo existir e idempotente for definido como true.
mongo_cmd	string	Padrão: "mongo"	O comando shell MongoDB.
nodb	boolean	Escolhas: no (padrão) yes	Especifique uma codificação não padrão para a saída.
norc	boolean	Escolhas: no (padrão) yes	Evita que o shell forneça e avalie ~/.mongorc.js na inicialização.
quiet	boolean	Escolhas: no yes (padrão)	Silencia a saída do shell durante o processo de conexão.
split_char	string	Padrão: " "	Usado pela ação de divisão na etapa de transformação.
stringify	boolean	Escolhas: no yes	Envolve o comando em eval em JSON.stringify (<js cmd>) (mongo) ou EJSON.stringify (<js cmd>) (mongosh). Útil para documentos de escape que são retornados no formato JSON estendido. Definido automaticamente como false ao usar o mongo. Definido automaticamente como true ao usar mongosh. Configurado explicitamente para substituir a seleção automática.
transform	string	Escolhas: auto (padrão) split json raw	Transforma a saída retornada ao usuário. auto - Tenta decidir automaticamente a melhor transformação. split - Divide a saída em um caractere. json - analise como json. raw - Retorna a saída raw.

Extende fragmentos da documentação do módulo MongoDB Login options.

Exemplos

- name: Executa o comando listDatabases
  mongodb_shell:
    login_user: user
    login_password: secret
    eval: "db.adminCommand('listDatabases')"

- name: Lista coleções e restringir a saída
  mongodb_shell:
    login_user: user
    login_password: secret
    eval: "db.adminCommand('listCollections')"
    stringify: yes

- name: Executa o comando showBuiltinRoles
  mongodb_shell:
    login_user: user
    login_password: secret
    eval: "db.getRoles({showBuiltinRoles: true})"

- name: Executa um arquivo js contendo comandos MongoDB com pseudo-idempotência
  mongodb_shell:
    login_user: user
    login_password: secret
    file: "/path/to/mongo/file.js"
    idempotent: yes

- name: Fornece alguns argumentos cmd adicionais
  mongodb_shell:
    login_user: user
    login_password: secret
    eval: "db.adminCommand('listDatabases')"
    additional_args:
      verbose: True
      networkMessageCompressors: "snappy"

Valores retornados

Chave	Tipo	Retornado quando	Descrição
changed	boolean	sempre	Altera o status.
err	string	quando o debug estiver configurado como true	Stderr bruto de mongo.
failed	boolean	em caso de falha	Algo deu errado.
file	string	quando um arquivo .js é utilizado	Arquivo JS executado com sucesso.
msg	string	sempre	Uma mensagem indicando o que aconteceu.
out	string	quando o debug estiver configurado como true	Stdout bruto de mongo.
rc	integer	quando o debug estiver configurado como true	Código de retorno de mongo.
transformed_output	list	no sucesso	Saída do comando mongo. Tentamos analisar isso em uma lista ou json sempre que possível.

MongoDB Shell

Resumo

Parâmetros

Exemplos﻿﻿

Valores retornados

Exemplos