Atlas Search

Visão geral

Neste guia, você pode aprender como realizar pesquisas em seus documentos usando o recurso Atlas Search. A biblioteca PHP permite que você execute queries de pesquisa do Atlas usando o construtor de agregação.

Para aprender mais sobre o Atlas Search, consulte a Visão geral do Atlas Search. A implementação do Atlas Search para a biblioteca PHP utiliza internamente o operador de agregação $search para executar consultas. Para aprender mais sobre este operador, consulte a referência de $search na documentação do Atlas.

Estágio de agregação de pesquisa

Importe as seguintes classes para o seu aplicação para executar queries do Atlas Search usando o Aggregation Builder:

use MongoDB\Builder\Pipeline;
use MongoDB\Builder\Search;
use MongoDB\Builder\Stage;

Para criar um estágio $search em seu pipeline de agregação , execute as seguintes ações:

1. Crie uma instância Pipeline para armazenar os estágios do pipeline.

2. Chame o método Stage::search() para criar o estágio Atlas Search .

3. Dentro do corpo do método search(), use métodos da classe de construtores Search para construir seus critérios da query de pesquisa.

O seguinte código demonstra o modelo para construir queries básicas do Atlas Search :

$pipeline = new Pipeline(
    Stage::search(
        /* Atlas Search query specifications
        Search::compound(...) */
    ),
);

Exemplos de query do Atlas Search

Nesta seção, você pode aprender a executar diferentes tipos de queries de pesquisa do Atlas Search usando o construtor de agregação. Os exemplos nesta seção usam dados de amostra da coleção sample_restaurants.restaurants.

$pipeline = new Pipeline(
    Stage::search(
        Search::compound(
            must: [
                Search::text(
                    query: 'kitchen',
                    path: 'name',
                ),
            ],
            should: [
                Search::text(
                    query: 'american',
                    path: 'cuisine',
                ),
            ],
            filter: [
                Search::text(
                    query: 'Queens',
                    path: 'borough',
                ),
            ],
        ),
    ),
    Stage::project(
        borough: 1,
        cuisine: 1,
        name: 1
    ),
    Stage::limit(3)
);
$cursor = $collection->aggregate($pipeline);
foreach ($cursor as $doc) {
    echo json_encode($doc), PHP_EOL;
}

{"_id":...,"borough":"Queens","cuisine":"American","name":"Kitchen Door"}
{"_id":...,"borough":"Queens","cuisine":"American","name":"Cc Kitchen"}
{"_id":...,"borough":"Queens","cuisine":"American","name":"Suite Kitchen"}
// Results truncated

$pipeline = new Pipeline(
    Stage::search(
        Search::autocomplete(
            query: 'Lucy',
            path: 'name',
        ),
    ),
    Stage::limit(3),
    Stage::project(_id: 0, name: 1),
);
$cursor = $collection->aggregate($pipeline);
foreach ($cursor as $doc) {
    echo json_encode($doc), PHP_EOL;
}

{"name":"Juicy Lucy"}
{"name":"Lucy'S Vietnamese Kitchen"}
{"name":"Lucy'S Cantina Royale"}
// Results Truncated

opções de pesquisa

Você pode usar o método search() para executar diversos tipos de queries de pesquisa do Atlas Search. Dependendo da consulta que você deseja, é possível passar os seguintes parâmetros opcionais para search():

Para saber mais sobre esses parâmetros, consulte a seção Campos da referência do operador $search na documentação do Atlas.