Arquivo de configuração do MongoDB CLI

Nesta página

Local do arquivo de configuração

Perfis
Exemplo

Esta versão da documentação foi arquivada e não é mais suportada. Consulte a documentação atual do para saber como atualizar sua versão do MongoCLI.

O arquivo de configuração MongoDB CLI armazena seus perfis. Você pode atualizar as configurações armazenadas em seu arquivo de configuração editando o arquivo com um editor de texto ou utilizando o comando mongocli config set .

Importante

Suas chaves deAPI do são como senhas. O arquivo de configuração armazena chaves de API em texto simples, portanto, certifique-se de proteger o arquivo de configuração adequadamente.

Local do arquivo de configuração

A primeira vez que você executa o comando de configuração mongocli, o MongoDB CLI cria um arquivo de configuração chamado mongocli.toml. A MongoDB CLI concede ao usuário que executou o comando acesso de leitura e escrita ao arquivo. O MongoDB CLI salva o arquivo de configuração na pasta onde o sistema armazena os arquivos de configuração do aplicação , que é definido pela variável de ambiente do $XDG_CONFIG_HOME. Por padrão, esse local é a pasta /.config do diretório inicial do usuário. Se essa pasta não existir, o MongoDB CLI criará a pasta e concederá ao usuário permissões de leitura, gravação e execução.

Perfis

O arquivo de configuração do MongoDB CLI armazena configurações relacionadas e chaves de API em grupos chamados perfis. Você pode criar ou definir vários perfis para poder usar o MongoDB CLI para acessar diferentes serviços ou projeto do MongoDB a partir do mesmo terminal.

Observação

Todas as configurações armazenadas em variáveis de ambiente têm precedência sobre as configurações armazenadas nos perfis.

Para executar o MongoDB CLI com um perfil específico, anexe a opção --profile <profileName> ao comando.

Perfil padrão

Se você executar um comando sem a opção --profile, o MongoDB CLI utilizará as configurações no perfil padrão. O MongoDB CLI determina o perfil padrão pelo número de perfis que você configurou:

Se você tiver apenas um perfil, o MongoDB CLI utilizará esse perfil como padrão.
Se você tiver vários perfis, o MongoDB CLI usará o perfil chamado default como padrão. Se você não tiver um perfil chamado default e executar um comando que requer determinadas configurações, o MongoDB CLI retornará um erro para as configurações ausentes.

Exemplo

O arquivo de configuração de exemplo a seguir contém o caminho para o MongoDB Shell, mongosh, e dois perfis, default e myOpsManager.

O perfil default se conecta a uma implantação do Atlas e contém as seguintes configurações:

ID da organização
Chaves de API
ID do projeto

O perfil myOpsManager se conecta a uma implantação do Ops Manager e contém as seguintes configurações:

A URL base do Ops Manager .
ID da organização.
Chaves de API .
ID do projeto.
Opcional O caminho completo em seu sistema local até o certificado de Autoridade de Certificação (Certificate Authority ou CA na língua inglesa) codificado em PEM, que é usado para assinar o cliente e os certificados TLS do Ops Manager
Opcional Sinalizador que indica se o certificado CA TLS foi validado.

# ~/.config/mongocli.toml
mongosh_path = "/usr/local/bin/mongosh"
[default]
  organization_id = "qwer5678uiop23jb45lk78mn"
  public_api_key = "ABCDEFG"
  project_id= "5e2f04ecf10fcd33c7d4077e"
  private_api_key = "e750d2bf-1234-4cde-5678-ca4dcbcac9a4"
  service = "cloud"
[myOpsManager]
  ops_manager_ca_certificate = /etc/ssl/certs/ca.pem
  ops_manager_skip_verify = no
  ops_manager_url = "http://localhost:9080/"
  organization_id = "jklsa23123dsdf3jj456hs2"
  public_api_key = "HIJKLMN"
  project_id = "kk12jdn43jd123dkdkf97jg"
  private_api_key = "e750d2bf-9101-4cde-1121-ca4dcbcac9a5"
  service = "ops-manager"

Para usar o MongoDB CLI com o perfil default, omita a opção --profile do comando:

mongocli <command>

Para usar o MongoDB CLI com o perfil myOpsManager, anexe a opção --profile myOpsManager ao comando:

mongocli <command> --profile myOpsManager

Voltar

Configurar o MongoDB CLI

Variáveis de ambiente