Definir configurações usando um arquivo de configuração

Nesta página

Formato de arquivo de configuração

Local do arquivo de configuração
Definições configuráveis
Comportamento com a API config

Você pode especificar as configurações do mongosh em um arquivo de configuração global. Quando você especifica as configurações em um arquivo de configuração, essas configurações são aplicadas na inicialização. Depois de criar um arquivo de configuração, as configurações do arquivo entrarão em vigor na próxima vez que você iniciar o mongosh.

Formato de arquivo de configuração

O arquivo de configuração mongosh utiliza o formato YAML. Todas as opções estão no namespace mongosh .

Exemplo de arquivo de configuração

Os seguintes conjuntos de arquivos de configuração:

displayBatchSize para 50
inspectDepth para 20
redactHistory para remove-redact

mongosh:
  displayBatchSize: 50
  inspectDepth: 20
  redactHistory: "remove-redact"

Local do arquivo de configuração

O local do arquivo em que o mongosh procura o arquivo de configuração depende do seu sistema operacional:

Sistema operacional	Localização do arquivo
Windows	`mongosh.cfg`, no mesmo diretório que o binário `mongosh.exe` .
macOS	`mongosh` procura um arquivo de configuração nos seguintes diretórios na ordem em que estão listados: `/usr/local/etc/mongosh.conf` `/opt/homebrew/etc/mongosh.conf` `/etc/mongosh.conf` Depois que `mongosh` lê um arquivo de configuração em um desses diretórios, todos os diretórios restantes na lista não são verificados e os arquivos de configuração nesses diretórios são ignorados.
Linux	`/etc/mongosh.conf`

Definições configuráveis

Você pode especificar as seguintes configurações mongosh no seu arquivo de configuração:

Chave	Tipo	Default	Descrição
`displayBatchSize`	inteiro	20	O número de itens exibidos por iteração do cursor
`enableTelemetry`	booleano	`true`	Permite enviar dados de rastreamento e diagnóstico anônimos para MongoDB.
`editor`	string	`null`	Designa um editor para utilizar dentro do console do `mongosh` . Substitui a variável de ambiente do `EDITOR` se configurada.
`forceDisableTelemetry`	booleano	`false`	Disponível apenas no arquivo de configuração global. Quando verdadeiro, os usuários não podem habilitar a telemetria manualmente.
`historyLength`	inteiro	1000	O número de itens para armazenar no arquivo de histórico do RELP `mongosh`.
`inspectCompact`	inteiro ou booleano	3	O nível de elementos internos que `mongosh` gera em uma única linha. Elementos de array curtos também são agrupados em uma única linha. Se definido como `false`, `mongosh` gera cada campo em sua própria linha.
`inspectDepth`	inteiro ou infinito	6	A profundidade com que os objetos são impressos. Definir `inspectDepth` para `Infinity` (o objeto javascript) imprime todos os objetos aninhados para sua profundidade total.
`redactHistory`	string	`remove`	Controla quais informações são registradas no histórico do shell. Deve ser um dos seguintes: `keep`: Reter todo o histórico. `remove`: Remover linhas que contêm informações confidenciais. `remove-redact`: redigir informações confidenciais.
`showStackTraces`	booleano	`false`	Controla a exibição de um traçado de pilha juntamente com mensagens de erro.
`snippetAutoload`	booleano	`true`	Se `true`, carregue automaticamente snippets instalados na inicialização.
`snippetIndexSourceURLs`	string	Repositório do MongoDB	Uma lista separada por ponto e vírgula de URLs que se vinculam a um registro de snippet.
`snippetRegistryURL`	string	Registro npm	O registro npm usado pelo cliente npm `mongosh` que instala o snippet.

Comportamento com `config` API

Configurações especificadas com a API config:

Substitua as configurações especificadas no arquivo de configuração.
Persistir entre reinicializações.

Exemplo

Considere o seguinte arquivo de configuração que define a configuração inspectDepth como 20:

mongosh:
  inspectDepth: 20

Durante sua sessão do mongosh, você executa o seguinte comando para definir inspectDepth como 10:

config.set( "inspectDepth", 10 )

O valor de inspectDepth se torna 10 e permanecerá 10 mesmo quando mongosh for reiniciado.

Voltar

Usar a API

Personalizar solicitação