Crie uma consulta

Construir sua query do Atlas Search.

1. Selecione um aggregation pipeline stage.

   Selecione uma aba correspondente ao aggregation pipeline stage que deseja usar:

   $search

   $searchMeta

   Você pode usar o aggregation pipeline $search para realizar uma full-text search nos campos indexados para obter dados que correspondam à sua consulta.

   {
      $search: {
         "index": "<index-name>",
         ...
      }
   }

   Você pode usar o estágio do pipeline de agregação $searchMeta para retornar metadados sobre seus resultados de pesquisa.

   {
      $searchMeta: {
         "index": "<index-name>",
         ...
      }
   }

   Para saber mais, consulte Escolher o estágio do pipeline de agregação.

2. Especifique os operadores.

   Selecione um ou mais operadores ou coletores para realizar uma pesquisa específica na sua collection.

   $search

   $searchMeta

   {
      $search: {
         "index": "<index-name>",
         "<operator-name>": {
         <operator-specifications>
         },
      }
   }

   {
      $searchMeta: {
         "index": "<index-name>",
         "<operator-name>"|"<collector-name>": {
            <operator-specifications>|<collector-specifications>
         }
      }
   }

   Para saber mais, consulte Usar operadores e coletores nas queries do Atlas Search.

3. (Opcional) Recupere informações adicionais sobre sua consulta de Pesquisa do Atlas.

   $search

   $searchMeta

   Especifique uma ou mais opções para ajustar seus resultados de query do Atlas Search.

   {
      $search: {
         "index": "<index-name>",
         "<operator-name>": {
            <operator-specifications>
         },
         "highlight": {
            <highlight-options>
         }
      }
   }

   Você pode personalizar os resultados da pesquisa das seguintes maneiras:

   Opção	Caso de uso
   pontuação	Modifique o score dos documentos nos resultados para garantir que o Atlas Search retorne resultados relevantes.
   detalhe da pontuação	Recupere um detalhamento detalhado da pontuação para cada documento que a Pesquisa Atlas retorna.
   realçar	Exibir seus termos de pesquisa no contexto original como campos no resultado da query.
   explicar	Recupere informações e estatísticas de execução sobre quais consultas do Lucene o Atlas Search executou para satisfazer sua consulta e quanto tempo sua consulta gasta nos vários estágios de execução.
   returnStoredSource	Execute sua query do Atlas Search com mais eficiência apenas recuperando campos armazenados em mongot conforme especificado em sua definição de índice do Atlas Search para uma coleção.
   contar	Exibe o número de resultados a partir da sua query do Atlas Search.
   sort	Classifique seus resultados de query do Atlas Search por número, string, campos de data e por pontuação.

   Retornar metadados, como o número de resultados, junto com sua query do Atlas Search.

   {
      $searchMeta: {
         "index": "<index-name>",
         "<operator-name>": {
            <operator-specifications>
         },
         "count": {
            <count-options>
         }
      }
   }

   Para saber mais, consulte Definir opções adicionais de pesquisa.

Execute sua consulta no Atlas Search.

Revise sua sintaxe de query do Atlas Search e então execute-a em seu aplicativo utilizando um driver, mongosh, Compass ou o Testador de Pesquisa.