Configurações do arquivo de configuração

Nesta página

Local do arquivo de configuração

Sintaxe
Configurações
Exemplo
Saiba mais

Você pode usar um arquivo de configuração para personalizar as configurações do MongoDB Compass na inicialização. Você não pode substituir nenhuma configuração que tenha sido definida por um arquivo de configuração na interface do Compass.

Local do arquivo de configuração

Para macOS e Linux, o arquivo de configuração está localizado em /etc/mongodb-compass.conf.
Para Windows, o arquivo de configuração está localizado em <path\to\compass>\..\mongodb-compass.cfg.

Sintaxe

Você pode definir as configurações do arquivo de configuração do Compass no formato EJSON ou YAML.

EJSON

{
  "setting": value,
  "setting": value,
  ...
}

YAML

setting option: value
setting option: value
...

Configurações

Contexto	Definição
autoUpdates	Permita que o Compass verifique periodicamente novas atualizações.
enableGenAIFeatures	Permita que o Compass use IA generativa para query de linguagem natural. Esse recurso requer um login no Atlas e um cluster Atlas implantado.
enableGenAISampleDocumentPassing	Permita que o MongoDB Compass envie valores de campo de amostra com solicitações de geração de query e agregação . Esses valores podem melhorar os resultados da IA. Se `true`, essa configuração define implicitamente a configuração `enableGenAIFeatures` como `true`.
enableDevtools	Ative o Chrome DevTools no Compass. Para saber mais, consulte Alternar o Chrome DevTools.
enableMaps	Permita que o Compass faça solicitações para serviços de mapeamento de terceiros.
Ativar o Shell	Habilite ou desabilite o MongoDB Shell integrado no Compass. Para saber mais, consulte Desativar o shell do MongoDB incorporado.
forceConnectionOptions	Atribua valores deopção de conexão para quando você se conectar à implantação do MongoDB por meio do Compass. Essas opções de conexão não podem ser substituídas por conexões da interface do Compass ou uma string de conexão de linha de comando.
ignoreAdditionalCommandLineFlags	Permitir ou não permitir sinalizadores de opção de linha de comando adicionais.
installURLHandlers	Registre o Compass como manipulador para URLs mongodb:// e mongodb+srv://. Se Install Compass as URL Protocol Handler estiver habilitado, você poderá abrir o Compass navegando até um URL mongodb:// ou mongodb+srv:// em seu navegador de internet. Disponível no macOS e Windows.
maxTimeMS	Especifique um limite de tempo superior para todas as operações do banco de dados do Compass.
networkTraffic	Impedir que o MongoDB Compass realize operações de rede de saída diferentes daquelas para o banco de dados.
protectConnectionStrings	Define todas as connection strings como somente leitura. Senhas em connection strings são exibidas como `*****`. Se `protectConnectionStrings` estiver ativado, o Compass desativará a opção Edit connection string e ocultará a alternância Edit connection string.
protectConnectionStringsForNewConnections	Define connection strings para novas conexões como somente leitura por padrão. As senhas em novas connection strings são exibidas como `*****`. Se `protectConnctionStringsForNewConnections` estiver habilitado, o Compass desabilitará a opção Edit connection string, mas não impedirá que os usuários ativem manualmente a opção com a opção Edit connection string.
Somente leitura	Impeça que os usuários executem operações de gravação em sua deployment do MongoDB por meio do Compass. Para saber mais, consulte Restringir operações de gravação ao MongoDB.
showKerberosPasswordField	Mostre ou oculte o campo de senha Kerberos no formulário de conexão do Compass. Para saber mais, consulte Exibir o campo de senha Kerberos.
tema	Especifique o tema da interface do usuário do MongoDB Compass. Os temas suportados são `DARK`, `LIGHT` e `OS_THEME`.
trackUsageStatistics	Permitir que o Compass envie estatísticas de uso anônimas. Para saber mais, consulte Configurar opções de telemetria.

Observação

Para visualizar todas as opções de configuração do Compass disponíveis, execute o seguinte comando na pasta que contém o executável do MongoDB Compass:

<path-to-Compass-executable> --help

Exemplo

Para visualizar um arquivo de configuração de amostra do Compass, execute o seguinte comando:

<path-to-Compass-executable> --show-example-config

Se você ainda não tiver um arquivo de configuração, execute o seguinte comando para criar um arquivo de configuração que use as definições de configuração de exemplo:

<path-to-Compass-executable> --show-example-config > /etc/mongodb-compass.conf

Saiba mais

Voltar

Opções de linha de comando

Bloquear conexões de saída