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

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
`disableLogging`	booleano	`false`	Especifica se o shell do MongoDB grava entradas de registro.
`disableSchemaSampling`	booleano	`false`	Por padrão, o MongoDB Shell faz uma amostra do esquema do seu banco de dados para habilitar sugestões de preenchimento automático. Se você definir essa configuração como `true`, o MongoDB Shell não coletará amostras do esquema do seu banco de dados e o preenchimento automático se comportará como se a coleção estivesse vazia.
`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.
`logCompressionEnabled`	booleano	false	Especifica se o shell do MongoDB comprime arquivos de log. Quando esse valor é `true`, o shell do MongoDB usa o gzip para comprimir os registros. Consulte Habilitar compactação de registro.
`logLocation`	string	Depende do seu sistema operacional. Consulte Exibir registros de shell.	Diretório onde o shell do MongoDB grava arquivos de log. Especifique um caminho de arquivo absoluto. Consulte Especificar a localização do arquivo de log.
`logMaxFileCount`	inteiro ou infinito	100	Número máximo de arquivos de log que o shell do MongoDB retém. Depois que o shell do MongoDB atinge a contagem máxima de arquivo de log , ele começa a excluir os arquivos de log mais antigos até que a contagem esteja abaixo do limite. Consulte Modificar a contagem máxima de arquivos de log.
`logRetentionDays`	inteiro ou infinito	30	Número de dias em que os arquivos de log do shell do MongoDB são retidos. Se esse valor estiver definido como `Infinity`, os arquivos de log não serão excluídos com base na idade. Para evitar que o armazenamento de registros fique muito grande, especifique sempre pelo menos um critério de retenção de registros. Consulte Retenção de registros.
`logRetentionGB`	float ou Infinity	Desconfigurar	Quantidade máxima de espaço em gigabytes usado para registros de shell MongoDB . Se o tamanho combinado dos registros de shell do MongoDB exceder esse valor, os arquivos de log serão excluídos começando com os registros mais antigos. Se este valor estiver definido para `Infinity`, os arquivos de log não serão excluídos com base no tamanho do armazenamento. Para evitar que o armazenamento de registros fique muito grande, especifique sempre pelo menos um critério de retenção de registros. Consulte Retenção de registros.
`redactHistory`	string	`remove`	Controla quais informações são registradas no histórico de comando `mongosh`. Você pode acessar o histórico de comandos `mongosh` com as teclas para cima e para baixo ou ctrl+R enquanto estiver dentro do shell. Deve ser um dos seguintes valores: `keep`: Reter todo o histórico. `remove`: Remova linhas que contêm comandos confidenciais do histórico. Por exemplo, `remove` remove chamadas para db.auth() ou connect(). `remove-redact`: Remova linhas que contêm comandos confidenciais e edite strings específicas em outras linhas de histórico, como caminhos de arquivo, endereços de e-mail e URLs.
`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