readPreference

Modos de preferência de leitura

A tabela a seguir resume os modos de preferência de leitura.

• Para todos os modos, um membro está disponível quando responde às verificações periódicas de monitoramento do cliente, que confirmam que o membro está acessível pela rede e capaz de responder a solicitações.

• Para todos os modos, exceto primary, um membro é elegível se satisfizer a opção maxStalenessSeconds da preferência de leitura e quaisquer listas de conjuntos de tags especificadas.

• Para todos os modos, exceto primary, a opção de string de conexão localThresholdMS define o limite local que o cliente usa para calcular a janela de latência ao escolher entre os membros qualificados.

Para obter uma descrição detalhada dos modos de preferência de leitura, consulte Modos de preferência de leitura.

Comportamento

• All read preference modes except primary may return stale data because secondaries replicate operations from the primary in an asynchronous process. [1] Ensure that your application can tolerate stale data if you choose to use a non-primary mode.

• A preferência de leitura não afeta a visibilidade dos dados. Os clientes podem ver os resultados das gravações antes que elas sejam reconhecidas ou propagadas para a maioria dos membros do conjunto de réplicas. Para obter detalhes, consulte Isolamento de leitura, consistência e recência.

• A read preference não afeta a consistência causal. As garantias de consistência causal fornecidas por sessões causalmente consistentes para operações de leitura com read concern "majority" e operações de gravação com write concern "majority" são mantidas em todos os membros da implantação do MongoDB.

Modos de preferência de leitura

primary

All read operations use only the current replica set primary. [1] This is the default read mode. If the primary is unavailable, read operations produce an error or throw an exception.

O modo de read preference primary não é compatível com modos de read preference que utilizam listas de conjunto de tags ou maxStalenessSeconds. Se você especificar listas de conjuntos de tags ou um valor maxStalenessSeconds com primary, o driver produzirá um erro.

As transações que contêm operações de leitura devem usar a preferência de leitura primary. Todas as operações em uma determinada transação devem ser roteadas para o mesmo nó.

primaryPreferred

As operações são lidas do membro primário do conjunto se ele estiver disponível. Se o primário não estiver disponível, como durante situações de failover, as operações serão lidas de membros secundários que atendam a maxStalenessSeconds e às listas de conjuntos de tags da preferência de leitura.

Quando a preferência de leitura primaryPreferred inclui um valor de maxStalenessSeconds e não há nenhum primário do qual ler, o cliente estima o quão obsoleto cada secundário está comparando a última gravação do secundário com a do secundário com a gravação mais recente. Em seguida, o cliente direcionará a operação de leitura para um secundário cujo atraso estimado seja menor ou igual a maxStalenessSeconds.

Quando a read preference inclui uma lista de conjuntos de tags (um array de conjuntos de tags) e não há um primary do qual ler, o cliente tenta encontrar membros secundários com tags correspondentes (tentando os conjuntos de tags em ordem até encontrar uma correspondência). Quando são encontrados secundários correspondentes, o cliente seleciona um secundário aleatório do grupo mais próximo de secundários correspondentes. Se nenhum secundário tiver tags correspondentes, a operação de leitura produz um erro.

Quando a read preference inclui um valor maxStalenessSeconds e uma lista de conjuntos de tags, o cliente filtra primeiro por obsolescência e, em seguida, pelas tags especificadas.

As operações de leitura utilizando o modo primaryPreferred podem retornar dados obsoletos. Use a opção maxStalenessSeconds para evitar a leitura de secundários que o cliente estima estarem excessivamente obsoletos.

Em clusters fragmentados que habilitam o limitador de taxa de solicitação de entrada, os nós de fragmento que estão reduzindo carga podem retornar erros rotulados como SystemOverloadedError.

Para clusters que têm overloadAwareServerSelectionEnabled definido como true, quando um primário responde com um erro repetível rotulado com SystemOverloadedError, o roteador pode rotear temporariamente as leituras para secundários qualificados em vez do servidor sobrecarregado. Isso se aplica a qualquer preferência de leitura que possa selecionar vários servidores. Por padrão, overloadAwareServerSelectionEnabled está configurado para false.

secondary

As operações são lidas somente dos membros secundários do conjunto. Se nenhum secundário estiver disponível, essa operação de leitura produz um erro ou exceção.

A maioria dos conjuntos de réplicas tem pelo menos um secundário, mas há situações em que pode não haver um secundário disponível. Por exemplo, um conjunto de réplicas com um primário, um secundário e um árbitro pode não ter nenhum secundário se um membro estiver em estado de recuperação ou indisponível.

Quando a preferência de leitura secondary inclui um valor maxStalenessSeconds, o cliente estima a obsolescência de cada secundário comparando a última gravação do secundário com a do primário. Em seguida, o cliente direcionará a operação de leitura para um secundário cujo atraso estimado seja menor ou igual a maxStalenessSeconds. Se não houver um primário, o cliente usará o secundário com a gravação mais recente para comparar.

Quando a read preference inclui uma lista de conjuntos de tags (um array de conjuntos de tags), o cliente tenta encontrar membros secundários com tags correspondentes (tentando os conjuntos de tags em ordem até encontrar uma correspondência). Quando são encontrados secundários correspondentes, o cliente seleciona um secundário aleatório do grupo mais próximo de secundários correspondentes. Se nenhum secundário tiver tags correspondentes, a operação de leitura produz um erro.

Quando a read preference inclui um valor maxStalenessSeconds e uma lista de conjuntos de tags, o cliente filtra primeiro por obsolescência e, em seguida, pelas tags especificadas.

As operações de leitura utilizando o modo secondary podem retornar dados obsoletos. Use a opção maxStalenessSeconds para evitar a leitura de secundários que o cliente estima estarem excessivamente obsoletos.

secondaryPreferred

As operações leem dados de membros secundários qualificados do conjunto de réplicas. Se não houver secundários qualificados disponíveis, as operações lerão do membro primário.

Quando a preferência de leitura secondaryPreferred inclui um valor maxStalenessSeconds, o cliente estima a obsolescência de cada secundário comparando a última gravação do secundário com a do primário. Em seguida, o cliente direcionará a operação de leitura para um secundário cujo atraso estimado é menor ou igual a maxStalenessSeconds. Se não houver um primário, o cliente usará o secundário com a gravação mais recente para a comparação. Se não houver secundários com atraso estimado menor ou igual a maxStalenessSeconds, o cliente direcionará a operação de leitura para o primário do conjunto de réplicas.

Quando a read preference inclui uma lista de conjuntos de tags (um array de conjuntos de tags), o cliente tenta encontrar membros secundários com tags correspondentes (tentando os conjuntos de tags em ordem até encontrar uma correspondência). Quando são encontrados secundários correspondentes, o cliente seleciona um secundário aleatório do grupo mais próximo de secundários correspondentes. Se nenhum secundário tiver tags correspondentes, o cliente ignora as tags e leituras do primary.

Quando a read preference inclui um valor maxStalenessSeconds e uma lista de conjuntos de tags, o cliente filtra primeiro por obsolescência e, em seguida, pelas tags especificadas.

As operações de leitura utilizando o modo secondaryPreferred podem retornar dados obsoletos. Use a opção maxStalenessSeconds para evitar a leitura de secundários que o cliente estima estarem excessivamente obsoletos.

nearest

O driver lê de um membro cuja latência de rede recai dentro da janela de latência aceitável. As leituras no modo nearest não consideram se um membro é um primário ou secundário ao rotear operações de leitura: primários e secundários são tratados de forma equivalente.

Defina esse modo para minimizar o efeito da latência de rede nas operações de leitura sem preferência por dados atuais ou obsoletos.

Quando a read preference inclui um valor maxStalenessSeconds, o cliente estima o quanto cada secundário está obsoleto comparando a última gravação do secundário com a do primary, se disponível, ou com o secundário com a gravação mais recente se não houver nenhum primary. Em seguida, o cliente filtra qualquer secundário cuja defasagem estimada seja maior que maxStalenessSeconds e direciona aleatoriamente a leitura para um membro restante (primary ou secundário) cuja latência de rede esteja dentro da janela de latência aceitável.

Se você especificar uma lista de conjuntos de tags, o cliente tentará encontrar um membro do conjunto de réplicas que corresponda às listas de conjuntos de tags especificadas e direcionará as leituras para um membro arbitrário do grupo mais próximo.

Quando a read preference inclui um valor maxStalenessSeconds e uma lista de conjuntos de tags, o cliente filtra primeiro por obsolescência e, em seguida, pelas tags especificadas. Das instâncias mongod restantes, o cliente direciona aleatoriamente a leitura para uma instância que esteja dentro da janela de latência aceitável. A documentação da seleção de membro da read preference descreve o processo em detalhes.

As operações de leitura utilizando o modo nearest podem retornar dados obsoletos. Use a opção maxStalenessSeconds para evitar a leitura de secundários que o cliente estima estarem excessivamente obsoletos.

Configurar read preference

Ao usar um driver do MongoDB, é possível especificar a preferência de leitura usando a API de preferência de leitura do driver. Consulte a documentação da API do driver. Você também pode definir a preferência de leitura ao se conectar ao conjunto de réplicas ou ao cluster fragmentado. Por exemplo,consulte string de conexão.

Para uma determinada preferência de leitura, os drivers MongoDB usam a mesma lógica de seleção de membros.

Ao usar mongosh, consulte cursor.readPref() e Mongo.setReadPref().

Read preference e transações

As transações que contêm operações de leitura devem usar a preferência de leitura primary. Todas as operações em uma determinada transação devem ser roteadas para o mesmo nó.

Considerações adicionais

Considere os seguintes pontos ao usar os estágios $merge ou $out em um pipeline de agregação:

• A partir do MongoDB 5.0, os pipelines com um estágio $merge poderão ser executados em nós secundários do conjunto de réplicas se todos os nós do cluster tiverem a featureCompatibilityVersion definida como 5.0 ou superior e a preferência de leitura permitir leituras secundárias.

  • $merge e os estágios $out são executados em nós secundários, mas as operações de gravação são enviadas para o nó primário.

  • Nem todas as versões do driver suportam operações $merge enviadas aos nós secundários. Para obter detalhes, consulte a documentação do driver.

• nas versões anteriores do MongoDB , os pipelines com estágios $out ou $merge sempre são executados no nó principal, e a preferência de leitura não é considerada.

Para as operações mapReduce, somente as operações "inline" mapReduce que não gravam dados são compatíveis com a read preference. Caso contrário, as operações mapReduce serão executadas no membro principal.