setQuerySettings (comando de banco de dados)

Configurações de query e filtros de índice

A partir do MongoDB 8.0, os filtros de índice estão obsoletos. Em vez disso, use as configurações de query.

As configurações de query têm mais funcionalidades do que os filtros de índice. Os filtros de índice não são persistentes e não é possível criar facilmente filtros de índice para todos os nós do cluster.

Definir configurações de query passando uma query

Na seguinte sintaxe, você fornece:

• Os mesmos campos que um comando find, distinct ou aggregate . Consulte as seções de sintaxe nas páginas dos comandos para os campos que você pode incluir em setQuerySettings.

• Um campo $db para especificar o banco de dados de dados para as configurações da query.

• Um documento settings com indexHints e outros campos.

db.adminCommand( {
   setQuerySettings: {
      <fields>,  // Provide fields for
                 // find, distinct, or aggregate command
      $db: <string>  // Provide a database name
   },
   // Provide a settings document with indexHints and other fields
   settings: {
      indexHints: [ {
         ns: { db: <string>, coll: <string> },
         allowedIndexes: <array>
      }, ... ],
      queryFramework: <string>,
      reject: <boolean>,
      comment: <BSON type>,
      queryKnobs: <document>,
      maxTimeMS: <non-negative integer>
   }
} )

Definir configurações de query passando um hash de forma de query

Você pode fornecer uma string de hash de forma de query existente em setQuerySettings e um documento settings atualizado com indexHints e outros campos:

db.adminCommand( {
   setQuerySettings: <string>,  // Provide an existing query shape hash string
   // Provide a settings document with indexHints and other fields
   settings: {
      indexHints: [ {
         ns: { db: <string>, coll: <string> },
         allowedIndexes: <array>
      }, ... ],
      queryFramework: <string>,
      reject: <boolean>,
      comment: <BSON type>,
      queryKnobs: <document>,
      maxTimeMS: <non-negative integer>
   }
} )

Um hash de forma de query é uma string que identifica exclusivamente a forma de query. Um exemplo de hash de forma de query é "F42757F1AEB68B4C5A6DE6182B29B01947C829C926BCC01226BDA4DDE799766C".

Nas versões atuais suportadas, espera-se que a mesma forma de query produza o mesmo hash de forma de query entre nós e tipos de sistema. Para saber como o hash se comporta entre nós, tipos de implantação e clusters, consulte Estabilidade do hash de forma de query.

Para obter a string de hash da forma de query , faça qualquer um destes:

• Use um estágio $querySettings em um pipeline de agregação e examine o campo queryShapeHash .

• Examine a saída do profiler de banco de dados de dados.

• Visualize os registros de consulta lentos.

Se você definir as configurações de query usando uma string de hash, o campo representativeQuery estará inicialmente ausente da saída do estágio de agregação $querySettings.

A partir do MongoDB 8.3, se o FCV for 8.3 ou posterior, o MongoDB preencherá o campo representativeQuery para as configurações de query que você definiu com um hash de forma de query . Quando o MongoDB executa uma query que corresponde à forma de query, ele agenda o preenchimento. O preenchimento não exige nenhuma ação sua.

O preenchimento é executado de forma assíncrona na base do melhor esforço possível para limitar o impacto no desempenho em suas queries. Não é garantido que uma configuração de query seja preenchida na primeira vez que uma query correspondente for executada. Se um preenchimento não for concluído, o MongoDB tentará novamente da próxima vez que uma query correspondente for executada.

Para manter as queries representativas adicionais, o MongoDB 8.3 também aumenta a capacidade de armazenamento para queries representativas em configurações de query além do limite original do documento 16 MB BSON.

Knobs de query

A partir do MongoDB 9.0, você pode usar a configuração queryKnobs para substituir os parâmetros internos do servidor para uma única forma de query em vez de toda a instância. Defina o campo queryKnobs para queries direcionadas para mitigar o impacto de uma forma regredida sem alterar o comportamento de outras cargas de trabalho na mesma implantação.

Por exemplo, você pode substituir o parâmetro de servidor notablescan para uma única forma de query em vez de toda a instância definindo queryKnobs como { noTableScan: true }.

Cada botão mantém o tipo, os limites e o padrão de seu parâmetro de servidor subjacente, e setQuerySettings executa a mesma validação que setParameter executa. setQuerySettings rejeita os seguintes valores:

• Botões desconhecidos

• Botões que não estão marcados como configuráveis por meio de configurações de query

• Tipos de BSON incorretos

• Strings de enumeração inválidas

• Valores fora do intervalo

• Botões cujo requisito mínimo de FCV excede o FCV do cluster

O valor efetivo de um botão segue esta precedência, do mais alto para o mais baixo:

1. Valor por forma definido com queryKnobs

2. Valor para toda a instância definido com setParameter

3. Valor padrão compilado

Os botões de query fazem parte das configurações de query com hash, portanto, também fazem parte da chave de cache do plano. Se você alterar um valor de botão, o MongoDB produz uma nova chave de cache do plano, para que o planejador crie um novo plano em vez de reutilizar um plano obsoleto em cache.

Ao contrário do setParameter, que se aplica por processo e pode diferir entre os nós, o MongoDB aplica os mesmos valores queryKnobs em todo o cluster para a forma de query correspondente.