Menu Docs
Página inicial do Docs
/
Atlas
/ / / /

Paginar os resultados

Em clusters Atlas executando MongoDB 6.0.13+ ou 7.0.5+, use o Atlas Search para recuperar os resultados da sua query $search sequencialmente depois ou antes de um ponto de referência. Use as opções $search searchAfter ou searchBefore para percorrer os resultados em ordem e criar funções "Próxima página" e "Página anterior" em seu aplicativo.

Para recuperar resultados paginados, execute as seguintes etapas:

  1. Crie um índice nos campos que você deseja consultar.

  2. Execute uma query $search que retorna um ponto de referência. Para saber mais, consulte Recuperar ponto de referência.

  3. Use o ponto de referência em sua query $search subsequente para recuperar o conjunto de documentos seguinte ou anterior nos resultados.

    • Para saber mais sobre como recuperar resultados para criar uma função "Próxima página", consulte Atlas Search após um ponto de referência específico.

    • Para saber mais sobre como recuperar resultados para criar uma função de "Página anterior", consulte Atlas Search antes de um ponto de referência específico.

    • Para ir para uma página em seus resultados, combine $skip e $limit com as opções $search searchAfter ou searchBefore. Por exemplo, para ir para os resultados da página 3 para a página 5, com 10 resultados por página, faça o seguinte:

      1. Recupere resultados usando searchAfter com o ponto de referência do último resultado na página 3 (Result 30).

      2. Use $skip para pular os resultados 10 na página 4 (Resultados 31-40) e $limit para limitar os resultados a 10 documentos.

      3. Retorne resultados para a página 5 (Resultados 41-50).

      Aqui, usar $skip com a opção searchAfter otimiza a query para ignorar somente a página de resultados 1 (documentos 10). Por comparação, se você usar $skip sem a opção $search searchAfter, a query pulará 4 páginas de resultados (40 documentos). Para saber mais, consulte Saltar da página 2 para a página 5 Usando searchAfter e $skip.

Um empate ocorre quando você classifica em um campo para o qual vários documentos têm valores idênticos. O MongoDB não garante a ordenação de resultados de query vinculados, o que pode levar à duplicação e inconsistência quando você usa searchAfter e searchBefore. Aplique os seguintes princípios para garantir um comportamento de pesquisa determinístico:

  • Classifique sua query por um campo exclusivo para evitar empates de pontuação de relevância.

  • Se você quiser classificar principalmente por um campo não exclusivo, adicione uma cláusula de classificação secundária em um campo exclusivo para servir como desempate.

  • Classifique os resultados da consulta por um campo imutável. O Atlas Search reflete as atualizações que você faz em sua collection entre as queries inicial e subsequentes. Se você classificar por um campo mutável como updated_time e atualizar sua coleção entre a primeira e a segunda queries, o Atlas Search poderá ordenar os mesmos documentos de forma diferente.

Para aprender como classificar os resultados da query por um campo imutável ou único, consulte Classificar resultados do Atlas Search.

Se você distribuiu nós de pesquisa, considere o seguinte:

  • Evite classificar os resultados por searchScore porque ele pode ser diferente em todos os nós de pesquisa.

  • Para calcular searchScore, um host leva em consideração todos os documentos existentes nele, incluindo documentos excluídos que ainda não foram removidos do índice. Como a exclusão ocorre de forma independente em cada host, isso pode causar alterações em searchScore dependendo de para qual host a query é roteada.

Para oferecer suporte à paginação ao classificar por searchScore nos nós de pesquisa, vote nesta solicitação no MongoDB Feedback Engine.

Para recuperar resultados de query em um determinado ponto, você deve fornecer o ponto de referência em sua query $search . Você pode recuperar o ponto de referência usando a palavra-chave $meta searchSequenceToken no estágio $project após o estágio $search .

Sintaxe do searchSequenceToken
1[{
2 "$search": {
3 "index": "<index-name>",
4 "<operator-name>"|"<collector-name>": {
5 <operator-specification>|<collector-specification>
6 }
7 "sort": {
8 "score": {
9 "$meta": "searchScore", _id:1
10 }
11 }
12 ...
13 },
14 {
15 "$project": {
16 { "paginationToken" : { "$meta" : "searchSequenceToken" } }
17 },
18 ...
19}]

O searchSequenceToken gera um token codificado de Base64para cada documento nos resultados. O comprimento do token aumenta com o número de campos especificados na opção de classificação da sua query. O token não está vinculado a um snapshot do banco de dados.

Os documentos nos resultados são classificados na ordem padrão, a menos que você especifique a opção sort em sua query. Para saber mais sobre como classificar seus resultados, consulte Classificar resultados do Atlas Search.

Para pesquisar um ponto de referência, você deve especificar o ponto de referência em sua query $search usando a opção searchAfter com o token gerado por searchSequenceToken. Você pode usar o token gerado por searchSequenceToken somente ao executar novamente a query $search para a qual searchSequenceToken gerou o token. A semântica (campos e valores de pesquisa) da query $search subsequente na qual você usa o token deve ser idêntica à query para a qual searchSequenceToken gerou o token.

Você pode utilizar a opção searchAfter para construir uma função "Próxima Página" em seu aplicativo. Para uma demonstração disso, consulte o exemplo nesta página.

Sintaxe searchAfter
1{
2 "$search": {
3 "index": "<index-name>",
4 "<operator-name>"|"<collector-name>": {
5 <operator-specification>|<collector-specification>
6 },
7 "searchAfter": "<base64-encoded-token>",
8 "sort": {
9 "score": {
10 "$meta": "searchScore", _id:1
11 }
12 }
13 ...
14 },
15 "$project": {
16 { "paginationToken" : { "$meta" : "searchSequenceToken" } }
17 },
18 ...
19}

O Atlas Search retorna os documentos nos resultados após o token especificado. O Atlas Search retorna os tokens gerados para os documentos nos resultados porque você especificou o searchSequenceToken no estágio $project após o estágio $search (como mostrado na linha 11). Esses tokens podem ser usados como ponto de referência para outra query com a mesma semântica.

Os documentos nos resultados são classificados na ordem padrão, a menos que você especifique a opção sort em sua query. Para saber mais sobre como classificar seus resultados, consulte Classificar resultados do Atlas Search.

Para o Atlas Search antes de um ponto de referência, você deve especificar o ponto de referência em sua query do $search utilizando a opção searchBefore com o token gerado pelo searchSequenceToken. Você pode usar o token gerado por searchSequenceToken somente quando executar novamente a query $search para a qual searchSequenceToken gerou o token. A semântica (campos e valores do Atlas Search ) da query subsequente do $search subsequente na qual você usa o token deve ser idêntica à query para a qual o searchSequenceToken gerou o token.

Você pode criar uma função "Página anterior" em seu aplicativo usando a opção searchBefore . Para criar uma função "Página anterior", combine o seguinte:

Para uma demonstração disso, veja exemplos de query searchBefore nesta página.

Sintaxe searchBefore
1{
2 "$search": {
3 "index": "<index-name>",
4 "<operator-name>"|"<collector-name>": {
5 <operator-specification>|<collector-specification>
6 },
7 "searchBefore": "<base64-encoded-token>",
8 "sort": {
9 "score": {
10 "$meta": "searchScore", _id:1
11 }
12 }
13 ...
14 },
15 "$project": {
16 { "paginationToken" : { "$meta" : "searchSequenceToken" } }
17 },
18 ...
19}

O Atlas Search retorna documentos nos resultados anteriores ao token especificado na ordem inversa. O Atlas Search também retorna os tokens gerados para os documentos nos resultados porque você especificou o searchSequenceToken no estágio $project após o estágio $search (conforme mostrado na linha 11). Esses tokens podem ser usados como um ponto de referência para outra query com a mesma semântica.

Os exemplos a seguir usam a coleção sample-mflix.movies, que tem um índice do Atlas Search chamado default com mapeamentos dinâmicos. Se você carregar a coleção e criar o índice, poderá executar as seguintes queries na coleção.

As queries demonstram como recuperar um ponto de referência, que você então usa nas queries subsequentes para recuperar resultados adicionais para o mesmo termo antes e depois do ponto de referência especificado.

Estes exemplos demonstram como executar as seguintes tarefas:

  1. Obter a página 1 e gerar tokens de paginação

  2. Recuperar página 2 usando searchAfter

  3. Retornar à página 1 Usando o searchBefore

  4. Pule da página 2 para a página 5 usando searchAfter e $skip

  5. Usar faceta com os resultados paginados

Observação

Por padrão, o Atlas Search classifica os documentos nos resultados pela pontuação de relevância dos documentos. Se vários documentos nos resultados tiverem pontuações idênticas, o Atlas Search retornará resultados ordenados arbitrariamente. Para retornar documentos em uma determinada ordem, as queries especificam um campo exclusivo, released, para classificar os resultados.

Voltar

contar