Recuperar valores de campo distintos

Nesta página

Visão geral

Dados de amostra
MongoDB\Collection::distinct() Método
Recuperar valores distintos em uma collection
Recuperar valores distintos em documentos especificados
Modificar comportamento distinto
Documentação da API

Visão geral

Neste guia, você pode aprender a usar a biblioteca PHP do MongoDB para recuperar os valores distintos de um campo especificado em uma coleção.

Dentro de uma coleção, documentos diferentes podem conter valores diferentes para um único campo. Por exemplo, um documento em uma coleção restaurants tem um valor borough de 'Manhattan' e outro tem um valor borough de 'Queens'. Ao usar a Biblioteca PHP do MongoDB , você pode recuperar todos os valores exclusivos que um campo contém em vários documentos em uma coleção.

Dados de amostra

Os exemplos neste guia utilizam a coleção do restaurants no banco de dados de dados do sample_restaurants a partir dos conjuntos de dados de amostra do Atlas. Para acessar essa coleção a partir do seu aplicação PHP , instancie um MongoDB\Client que se conecte a um Atlas cluster e atribua o seguinte valor à sua variável $collection :

$collection = $client->sample_restaurants->restaurants;

Para saber como criar um cluster MongoDB Atlas gratuito e carregar os conjuntos de dados de amostra, consulte o guia Iniciar com Atlas .

`MongoDB\Collection::distinct()` Método

Para recuperar os valores distintos para um campo especificado, chame o método MongoDB\Collection::distinct() e passe o nome do campo para o qual você deseja encontrar valores distintos.

Recuperar valores distintos em uma collection

O exemplo seguinte recupera os valores distintos do campo borough na coleção restaurants :

$results = $collection->distinct('borough', []);
foreach ($results as $value) {
    echo json_encode($value), PHP_EOL;
}

"Bronx"
"Manhattan"
"Missing"
"Queens"
"Staten Island"

A operação retorna uma array que armazena cada valor de campo borough distinto. Embora vários documentos tenham o mesmo valor no campo borough , cada valor aparece nos resultados apenas uma vez.

Recuperar valores distintos em documentos especificados

Você pode fornecer um filtro de query para o método distinct() para localizar os valores de campo distintos em um subconjunto de documentos em uma coleção. Um filtro de query é uma expressão que especifica os critérios de pesquisa usados para corresponder a documentos em uma operação. Para obter mais informações sobre como criar um filtro de query, consulte o guia Especificar uma query .

O exemplo a seguir recupera os valores distintos do campo borough para todos os documentos que têm um valor de campo cuisine de 'Italian':

$results = $collection->distinct('borough', ['cuisine' => 'Italian']);
foreach ($results as $value) {
    echo json_encode($value), PHP_EOL;
}

"Bronx"
"Manhattan"
"Queens"
"Staten Island"

Modificar comportamento distinto

Você pode modificar o comportamento do método distinct() passando uma array que especifica valores de opção. A tabela a seguir descreve algumas opções que você pode definir para personalizar a operação:

Opção	Descrição
`collation`	The collation to use for the operation. Type: `array\|object`
`maxTimeMS`	The maximum amount of time in milliseconds that the operation can run. Type: `integer`
`comment`	The comment to attach to the operation. Type: any valid BSON type
`readPreference`	The read preference to use for the operation. To learn more, see Read Preference in the Server manual. Type: `MongoDB\Driver\ReadPreference`

O exemplo a seguir recupera os valores distintos do campo name para todos os documentos que têm um valor de campo borough de 'Bronx' e um valor de campo cuisine de 'Pizza'. Ele também especifica o campo comment em uma array de opções para adicionar um comentário à operação:

$query = ['borough' => 'Bronx', 'cuisine' => 'Pizza'];
$options = ['comment' => 'Bronx pizza restaurants'];
$results = $collection->distinct('name', $query, $options);
foreach ($results as $value) {
    echo json_encode($value), PHP_EOL;
}

"$1.25 Pizza"
"18 East Gunhill Pizza"
"2 Bros"
"Aenos Pizza"
"Alitalia Pizza Restaurant"
"Amici Pizza And Pasta"
"Angie'S Cafe Pizza"
...

Documentação da API

Para saber mais sobre o método distinct() , consulte MongoDB\Collection::distinct() na documentação da API.

Voltar

Especificar uma query

Monitore alterações