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
The examples in this guide use the restaurants collection in the sample_restaurants database from the Atlas sample datasets. To access this collection from your PHP application, instantiate a MongoDB\Client that connects to an Atlas cluster and assign the following value to your $collection variable:
$collection = $client->sample_restaurants->restaurants;
Para aprender a criar uma implantação gratuita do MongoDB e carregar os conjuntos de dados de amostra, consulte o guia Começar do MongoDB.
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; }
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; }
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 |
|---|---|
| O agrupamento a ser usado para a operação. Para saber mais, consulte a seção Agrupamento desta página. |
| A quantidade máxima de tempo em milissegundos que a operação pode ser executada. |
| O comentário a ser anexado à operação. |
| A preferência de leitura a ser usada na operação. Para saber mais, consulte Preferência de leitura no manual do servidor. |
| O índice a ser usado para a operação. |
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; }
Agrupamentos
Para especificar um agrupamento para sua operação, passe um parâmetro de array $options que defina a opção collation para o método de operação. Atribua a opção collation a uma array que configure as regras de agrupamento.
A tabela a seguir descreve os campos que você pode definir para configurar o agrupamento:
Campo | Descrição |
|---|---|
| (Required) Specifies the International Components for Unicode (ICU) locale. For a list of supported locales, see Collation Locales and Default Parameters in the MongoDB Server manual. |
| (Opcional) Especifica se a comparação de caso deve ser incluída. |
| (Opcional) Especifica a ordem de classificação das diferenças de caso durante comparações de nível terciário. |
| (Optional) Specifies the level of comparison to perform, as defined in the ICU documentation. |
| (Opcional) Especifica se o driver compara strings numéricas como números. |
| (Opcional) Especifica se a biblioteca considera espaços em branco e pontuação como caracteres base para fins de comparação. |
| (Opcional) Especifica quais caracteres a biblioteca considera ignoráveis quando o campo |
| (Opcional) Especifica se as strings que contêm diacríticos são ordenadas da parte de trás da string para a frente. |
Para saber mais sobre agrupamento e os possíveis valores para cada campo, consulte a entrada de Agrupamento no manual do MongoDB Server.
Documentação da API
Para saber mais sobre o método distinct() , consulte MongoDB\Collection::distinct() na documentação da API.