Banco de dados de configuração

Restrições

A partir do MongoDB 5.0, leituras que não de transação não são permitidas na collection config.transactions com as seguintes opções e read concerns:

• "snapshot"

• "majority" e a opção afterClusterTime está definida

• Ao usar um driver MongoDB e "majority" em uma sessão causalmente consistente

Collections para dar suporte a operações de cluster fragmentado

Para acessar o banco de dados do config e visualizar a lista de collections que suportam operações de sharding, conecte o mongosh a uma instância do mongos em um agrupamento fragmentado e emita o seguinte:

use config
show collections

O banco de dados de configuração é principalmente para uso interno e, durante operações normais, você nunca deve inserir ou armazenar dados manualmente nele. No entanto, se você precisar verificar a disponibilidade de gravação do servidor de configuração para um cluster fragmentado, poderá inserir um documento em uma collection de teste (depois de verificar se nenhuma collection desse nome já existe):

db.testConfigServerWriteAvail.insertOne( { a : 1 } )

Se a operação for bem-sucedida, o servidor de configuração estará disponível para processar gravações.

Versões futuras do servidor podem incluir collections diferentes no banco de dados de configuração, portanto, tenha cuidado ao selecionar um nome para sua collection de teste.

O MongoDB utiliza as seguintes collections no banco de dados do config para suportar a fragmentação:

config.changelog

Dica

Metadados MongoDB internos

O banco de dados de configuração é interno: aplicativos e administradores não devem modificar ou depender de seu conteúdo durante a operação normal.

A collection changelog armazena um documento para cada alteração nos metadados de uma collection fragmentada.

Exemplo

O exemplo a seguir exibe um único registro de uma dividir de chunk de uma collection changelog :

{
 "_id" : "<hostname>-<timestamp>-<increment>",
 "server" : "<hostname><:port>",
 "clientAddr" : "127.0.0.1:63381",
 "time" : ISODate("2012-12-11T14:09:21.039Z"),
 "what" : "split",
 "ns" : "<database>.<collection>",
 "details" : {
    "before" : {
       "min" : {
          "<database>" : { $minKey : 1 }
       },
       "max" : {
          "<database>" : { $maxKey : 1 }
       },
       "lastmod" : Timestamp(1000, 0),
       "lastmodEpoch" : ObjectId("000000000000000000000000")
    },
    "left" : {
       "min" : {
          "<database>" : { $minKey : 1 }
       },
       "max" : {
          "<database>" : "<value>"
       },
       "lastmod" : Timestamp(1000, 1),
       "lastmodEpoch" : ObjectId(<...>)
    },
    "right" : {
       "min" : {
          "<database>" : "<value>"
       },
       "max" : {
          "<database>" : { $maxKey : 1 }
       },
       "lastmod" : Timestamp(1000, 2),
       "lastmodEpoch" : ObjectId("<...>")
    },
    "owningShard" : "<value>"
 }
}

Cada documento na collection changelog contém os seguintes campos:

config.changelog._id

O valor de changelog._id é: <hostname>-<timestamp>-<increment>.

config.changelog.server

O nome do host do servidor que contém esses dados.

config.changelog.clientAddr

Uma cadeia de caracteres que contém o endereço do cliente, uma instância mongos que inicia essa alteração.

config.changelog.time

Um carimbo de data/hora ISODate que reflete quando a alteração ocorreu.

config.changelog.what

Reflete o tipo de alteração registrada. Os valores possíveis incluem:

• dropCollection

• dropCollection.start

• dropDatabase

• dropDatabase.start

• moveChunk.start

• moveChunk.commit

• split

• multi-split

config.changelog.ns

Namespace onde ocorreu a mudança.

config.changelog.details

Um documento que contém detalhes adicionais sobre a alteração. A estrutura do documento details depende do tipo de alteração.

config.chunks

Dica

Metadados MongoDB internos

O banco de dados de configuração é interno: aplicativos e administradores não devem modificar ou depender de seu conteúdo durante a operação normal.

A collection chunks armazena um documento para cada chunk no cluster. Considere o seguinte exemplo de um documento para um chunk denominado mydb.foo-a_\"cat\":

{
   "_id" : "mydb.foo-a_\"cat\"",
   "lastmod" : Timestamp(2, 1),
   "uuid": "c025d039-e626-435e-b2d2-c1d436038041",
   "min" : {
         "animal" : "cat"
   },
   "max" : {
         "animal" : "dog"
   },
   "shard" : "shard0004",
   "history" : [ { "validAfter" : Timestamp(1569368571, 27), "shard" : "shard0004" } ]
}

Esses documentos armazenam o intervalo de valores para a chave de estilhaço que descreve o chunk nos campos min e max . Adicionalmente, o campo shard identifica o fragmento no cluster que "possui" o bloco.

config.collections

Dica

Metadados MongoDB internos

O banco de dados de configuração é interno: aplicativos e administradores não devem modificar ou depender de seu conteúdo durante a operação normal.

A collection collections armazena um documento para cada collection fragmentada no cluster. Considerando uma collection chamada pets no database records , um documento na collection collections seria semelhante ao seguinte:

{
   "_id" : "records.pets",
   "lastmod" : ISODate("2021-07-21T15:48:15.193Z"),
   "timestamp": Timestamp(1626882495, 1),
   "key" : {
         "a" : 1
   },
   "unique" : false,
   "lastmodEpoch" : ObjectId("5078407bd58b175c5c225fdc"),
   "uuid" :  UUID("f8669e52-5c1b-4ea2-bbdc-a00189b341da")
}

config.databases

Dica

Metadados MongoDB internos

O banco de dados de configuração é interno: aplicativos e administradores não devem modificar ou depender de seu conteúdo durante a operação normal.

A collection databases armazena um documento para cada banco de dados no cluster.

Para cada banco de dados, o documento correspondente exibe o nome, o primary shard do banco de dados, o status habilitado de fragmentação do banco de dados e uma versão.

{ "_id" : "test", "primary" : "shardA", "partitioned" : true, "version" : { "uuid" : UUID("516a5f79-5eb9-4844-8ee9-b8e9de91b760"), "timestamp" : Timestamp(1626894204, 1), "lastMod" : 1 } }
{ "_id" : "hr", "primary" : "shardA", "partitioned" : false, "version" : { "uuid" : UUID("8e39d61d-6259-4c33-a5ed-bcd2ae317b6f"), "timestamp" : Timestamp(1626895015, 1), "lastMod" : 1 } }
{ "_id" : "reporting", "primary" : "shardB", "partitioned" : false, "version" : { "uuid" : UUID("07c63242-51b3-460c-865f-a67b3372d792"), "timestamp" : Timestamp(1626895826, 1), "lastMod" : 1 } }

O método sh.status() retorna essas informações na seção Bancos de dados .

config.lockpings

Dica

Metadados MongoDB internos

O banco de dados de configuração é interno: aplicativos e administradores não devem modificar ou depender de seu conteúdo durante a operação normal.

A coleção lockpings mantém o controle dos componentes ativos no cluster fragmentado. Dado um cluster com um mongos em execução em example.com:30000, o documento na coleção lockpings seria semelhante a:

{ "_id" : "example.com:30000:1350047994:16807", "ping" : ISODate("2012-10-12T18:32:54.892Z") }

config.locks

Dica

Metadados MongoDB internos

O banco de dados de configuração é interno: aplicativos e administradores não devem modificar ou depender de seu conteúdo durante a operação normal.

A coleção locks armazena as travas distribuídas. O primário do conjunto de réplicas do servidor de configuração usa um bloqueio inserindo um documento na coleção locks .

{
   "_id" : "test.myShardedCollection",
   "state" : 2,
   "process" : "ConfigServer",
   "ts" : ObjectId("5be0b9ede46e4f441a60d891"),
   "when" : ISODate("2018-11-05T21:52:00.846Z"),
   "who" : "ConfigServer:Balancer",
   "why" : "Migrating chunk(s) in collection test.myShardedCollection"
}

A partir da versão 3.4, o campo state sempre terá um valor 2 para impedir que quaisquer instâncias mongos legado executem a operação de balanceamento. O campo when especifica a hora em que o membro do servidor de configuração se tornou o primary.

Na versão 3.4, quando o balanceador está ativo, o balanceador recebe um bloqueio, como no 3 a seguir. exemplo 4 :

{
   "_id" : "balancer",
   "state" : 2,
   "ts" : ObjectId("5be0bc6cb20effa83b15baa8"),
   "who" : "ConfigServer:Balancer",
   "process" : "ConfigServer",
   "when" : ISODate("2018-11-05T21:56:13.096Z"),
   "why" : "CSRS Balancer"
}

A partir da versão 3.6, o balanceador não aceita mais "bloqueio". Se você atualizou do 3.4 a 3.6, você pode optar por excluir quaisquer documentos "_id" : "balancer" residuais.

config.migrationCoordinators

A collection migrationCoordinators existe em cada shard e armazena um documento para cada migração de chunk em andamento deste shard para outro shard. A migração de chunk falha se o documento não puder ser gravado para a maioria dos membros do conjunto de réplica do shard.

Quando uma migração é concluída, o documento que descreve a migração é excluído da collection.

config.mongos

Dica

Metadados MongoDB internos

O banco de dados de configuração é interno: aplicativos e administradores não devem modificar ou depender de seu conteúdo durante a operação normal.

A collection mongos armazena um documento para cada instância mongos afiliada ao cluster. As instâncias mongos enviam pings para todos os membros do cluster a cada 30 segundos para que o cluster possa verificar se o mongos está ativo. O campo ping mostra o tempo do último ping, enquanto o campo up relata o tempo de atividade do mongos a partir do último ping. O cluster mantém essa coleção para fins de relatório.

O documento a seguir mostra o status do mongos em execução no example.com:27017.

{
   "_id" : "example.com:27017",
   "advisoryHostFQDNs" : [
      "example.com"
   ],
   "mongoVersion" : "4.2.0",
   "ping" : ISODate("2019-09-25T19:26:52.360Z"),
   "up" : NumberLong(50),
   "waiting" : true
}

config.rangeDeletions

A collection rangeDeletions existe em cada shard e armazena um documento para cada faixa de chunk que contém documentos órfãos. A migração de chunk falha se o documento não puder ser gravado para a maioria dos membros do conjunto de réplica do shard.

Quando a faixa de chunks órfãos é limpa, o documento que descreve a faixa é excluído da collection.

config.settings

Dica

Metadados MongoDB internos

O banco de dados de configuração é interno: aplicativos e administradores não devem modificar ou depender de seu conteúdo durante a operação normal.

A collection settings contém as seguintes configurações de fragmentação:

• Tamanho da parte. Para alterar o tamanho da parte, consulte Modificar o Tamanho da Parte em um Cluster Fragmentado. O valor chunksize especificado está em megabytes.

• Configurações do Balanceador. Para alterar as configurações do balanceador, incluindo o status do balanceador, consulte Gerenciar balanceador de cluster fragmentado.

  Começando no MongoDB 4.2:

  • balancerStart também permite a divisão automática para o cluster fragmentado.

  • balancerStop também desabilita a divisão automática para o cluster fragmentado.

• Autosplit. Para habilitar ou desabilitar o sinalizador de divisão automática, use o método sh.enableAutoSplit() ou o método sh.disableAutoSplit() correspondente.

  Começando no MongoDB 4.2:

  • balancerStart também permite a divisão automática para o cluster fragmentado.

  • balancerStop também desabilita a divisão automática para o cluster fragmentado.

A seguir estão alguns documentos de exemplo na collection settings :

{ "_id" : "chunksize", "value" : 64 }
{ "_id" : "balancer", "mode" : "full", "stopped" : false }
{ "_id" : "autosplit", "enabled" : true }

config.shards

Dica

Metadados MongoDB internos

O banco de dados de configuração é interno: aplicativos e administradores não devem modificar ou depender de seu conteúdo durante a operação normal.

A collection shards representa cada shard no cluster em um documento separado, como a seguir:

{ "_id" : "shard0000", "host" : "localhost:30000", "state" : 1 }

Se o shard for um conjunto de réplicas, o campo host exibirá o nome do conjunto de réplicas, depois uma barra e, em seguida, uma lista separada por vírgulas dos nomes de host de cada membro do conjunto de réplicas, como no exemplo a seguir:

{ "_id" : "shard0001", "host" : "shard0001/localhost:27018,localhost:27019,localhost:27020", "state" : 1 }

Se o shard tiver zonas atribuídas, este documento terá um campo tags , que contém uma array das zonas às quais está atribuído, como no exemplo a seguir:

{ "_id" : "shard0002", "host" : "localhost:30002", "state" : 1, "tags": [ "NYC" ] }

config.tags

Dica

Metadados MongoDB internos

O banco de dados de configuração é interno: aplicativos e administradores não devem modificar ou depender de seu conteúdo durante a operação normal.

A collection tags contém documentos para cada intervalo de zona no cluster. Os documentos na coleção tags se assemelham ao seguinte:

{
    "_id" : { "ns" : "records.users", "min" : { "zipcode" : "10001" } },
    "ns" : "records.users",
    "min" : { "zipcode" : "10001" },
    "max" : { "zipcode" : "10281" },
    "tag" : "NYC"
}

config.version

Dica

Metadados MongoDB internos

O banco de dados de configuração é interno: aplicativos e administradores não devem modificar ou depender de seu conteúdo durante a operação normal.

A collection version mantém o número da versão de metadados atual. Esta collection contém apenas um documento. Por exemplo:

{ "_id" : 1, "minCompatibleVersion" : 5, "currentVersion" : 6, "clusterId" : ObjectId("5d8bc01a690d8abbd2014ddd") }

Para acessar a collection version , você deve usar o método db.getCollection() . Por exemplo, para recuperar o documento da collection:

db.getCollection("version").find()

Collections para apoiar sessões

A partir do MongoDB 3.6, o config banco de dados contém as collections internas para suportar sessões causalmente consistentes para autônomos, conjuntos de réplicas e clusters fragmentados e retryable writes e transações para conjuntos de réplicas e clusters fragmentados.

Para acessar essas collections para uma instância mongod ou mongos , conecte mongosh à instância.

config.system.sessions

A collection do system.sessions armazena registros de sessão que estão disponíveis para todos os membros do sistema.

Quando um usuário cria uma sessão em uma instância mongod ou mongos, o registro da sessão existe inicialmente apenas na memória da instância. Periodicamente, a instância sincronizará suas sessões em cache com a collection system.sessions; nesse momento, elas estarão visíveis para todos os membros da implantação.

Para visualizar registros na collection system.sessions, utilize $listSessions.

Aviso

Não modifique ou elimine manualmente a collection system.sessions.

Em um cluster fragmentado, a collection system.sessions é fragmentada.

• Ao adicionar um shard ao cluster fragmentado, se o shard a ser adicionado já contiver sua própria collection system.sessions, o MongoDB soltará a collection system.sessions do novo shard durante o processo de adição.

• A partir da versão 4.4 (e 4.2.7), MongoDB divide automaticamente a coleção system.sessions em pelo menos 1024 blocos e distribui os blocos uniformemente entre os fragmentos no cluster.

config.transactions

A collection transactions armazena registros usados para suportar retryable writes e transações que podem ser repetidas para conjuntos de réplicas e cluster fragmentados .

Aviso

Não modifique ou elimine manualmente a collection transactions.