MongoDB\Collection::distinct()

定义

MongoDB\Collection::distinct()

查找collection中指定字段的非重复值。

function distinct(
        string $fieldName,
        array|object $filter = [],
        array $options = []
): mixed[]

参数

$fieldName ：细绳

要针对该字段返回非重复值。

$filter : array|object

筛选条件，指定要从中检索非重复值的文档。

$options : array

指定所需选项的数组。

名称	类型	说明
排序规则	数组\|对象	Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the `locale` field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document. 如果未指定排序规则但集合具有默认排序规则，则操作将使用为集合指定的排序规则。如果没有为集合或操作指定排序规则，MongoDB 将使用先前版本中用于字符串比较的简单二进制比较。
comment	混合	使用户可以指定任意注释来帮助通过数据库分析器、currentOp 输出和日志来跟踪操作。
提示	string\|对象	要使用的索引。将索引名称指定为字符串或将索引键模式指定为文档。如果指定，查询系统将只考虑使用提示索引的计划。
maxTimeMS	整型	The cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.
事务外的	MongoDB\Driver\ReadConcern	Read concern to use for the operation. Defaults to the collection's read concern.
readPreference	MongoDB\Driver\ReadPreference	Read preference to use for the operation. Defaults to the collection's read preference.
会话	MongoDB\Driver\Session	与操作相关联的客户端会话。
typeMap	阵列	应用游标的类型映射，决定如何将BSON文档转换为PHP值。默认为集合的类型映射。

Return Values

由不同值组成的数组。

错误/异常

MongoDB\Exception\UnexpectedValueException ，如果来自服务器的命令响应格式错误。

MongoDB\Exception\UnsupportedException，如果所选服务器使用了选项但不支持选项（例如collation、readConcern、writeConcern）。

MongoDB\Exception\InvalidArgumentException 用于与参数或选项解析相关的错误。

MongoDB\ 驱动程序\Exception\RuntimeException 用于扩展级别的其他错误（例如连接错误）。

行为

在评估查询条件时， MongoDB会根据自己的BSON 类型比较规则来比较类型和值，这与 PHP 的比较和类型规则不同。匹配特殊BSON类型时，查询条件应使用扩展中相应的BSON类（例如使用MongoDB\BSON\ObjectId来匹配ObjectId）。

示例

返回字段的非重复值

以下示例标识了test数据库中restaurantscollection中borough字段的非重复值。

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$distinct = $collection->distinct('borough');
var_dump($distinct);

而输出将类似如下所示：

array(6) {
      [0]=>
      string(5) "Bronx"
      [1]=>
      string(8) "Brooklyn"
      [2]=>
      string(9) "Manhattan"
      [3]=>
      string(7) "Missing"
      [4]=>
      string(6) "Queens"
      [5]=>
      string(13) "Staten Island"
}

使用筛选器返回非重复值

以下示例标识了cuisine restaurantstest数据库中为的文档的collection集合中borough Queens字段的非重复值：

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$distinct = $collection->distinct('cuisine', ['borough' => 'Queens']);
var_dump($distinct);

而输出将类似如下所示：

array(75) {
      [0]=>
      string(6) "Afghan"
      [1]=>
      string(7) "African"
      [2]=>
      string(9) "American "
      [3]=>
      string(8) "Armenian"
      [4]=>
      string(5) "Asian"
      [5]=>
      string(10) "Australian"
      [6]=>
      string(15) "Bagels/Pretzels"
      [7]=>
      string(6) "Bakery"
      [8]=>
      string(11) "Bangladeshi"
      [9]=>
      string(8) "Barbecue"
      [10]=>
      string(55) "Bottled beverages, including water, sodas, juices, etc."
      [11]=>
      string(9) "Brazilian"
      [12]=>
      string(4) "Cafe"
      [13]=>
      string(16) "Café/Coffee/Tea"
      [14]=>
      string(5) "Cajun"
      [15]=>
      string(9) "Caribbean"
      [16]=>
      string(7) "Chicken"
      [17]=>
      string(7) "Chinese"
      [18]=>
      string(13) "Chinese/Cuban"
      [19]=>
      string(16) "Chinese/Japanese"
      [20]=>
      string(11) "Continental"
      [21]=>
      string(6) "Creole"
      [22]=>
      string(5) "Czech"
      [23]=>
      string(12) "Delicatessen"
      [24]=>
      string(6) "Donuts"
      [25]=>
      string(16) "Eastern European"
      [26]=>
      string(8) "Egyptian"
      [27]=>
      string(7) "English"
      [28]=>
      string(8) "Filipino"
      [29]=>
      string(6) "French"
      [30]=>
      string(17) "Fruits/Vegetables"
      [31]=>
      string(6) "German"
      [32]=>
      string(5) "Greek"
      [33]=>
      string(10) "Hamburgers"
      [34]=>
      string(16) "Hotdogs/Pretzels"
      [35]=>
      string(31) "Ice Cream, Gelato, Yogurt, Ices"
      [36]=>
      string(6) "Indian"
      [37]=>
      string(10) "Indonesian"
      [38]=>
      string(5) "Irish"
      [39]=>
      string(7) "Italian"
      [40]=>
      string(8) "Japanese"
      [41]=>
      string(13) "Jewish/Kosher"
      [42]=>
      string(30) "Juice, Smoothies, Fruit Salads"
      [43]=>
      string(6) "Korean"
      [44]=>
      string(64) "Latin (Cuban, Dominican, Puerto Rican, South & Central American)"
      [45]=>
      string(13) "Mediterranean"
      [46]=>
      string(7) "Mexican"
      [47]=>
      string(14) "Middle Eastern"
      [48]=>
      string(8) "Moroccan"
      [49]=>
      string(25) "Not Listed/Not Applicable"
      [50]=>
      string(18) "Nuts/Confectionary"
      [51]=>
      string(5) "Other"
      [52]=>
      string(9) "Pakistani"
      [53]=>
      string(16) "Pancakes/Waffles"
      [54]=>
      string(8) "Peruvian"
      [55]=>
      string(5) "Pizza"
      [56]=>
      string(13) "Pizza/Italian"
      [57]=>
      string(6) "Polish"
      [58]=>
      string(10) "Portuguese"
      [59]=>
      string(7) "Russian"
      [60]=>
      string(6) "Salads"
      [61]=>
      string(10) "Sandwiches"
      [62]=>
      string(30) "Sandwiches/Salads/Mixed Buffet"
      [63]=>
      string(7) "Seafood"
      [64]=>
      string(9) "Soul Food"
      [65]=>
      string(18) "Soups & Sandwiches"
      [66]=>
      string(12) "Southwestern"
      [67]=>
      string(7) "Spanish"
      [68]=>
      string(5) "Steak"
      [69]=>
      string(5) "Tapas"
      [70]=>
      string(7) "Tex-Mex"
      [71]=>
      string(4) "Thai"
      [72]=>
      string(7) "Turkish"
      [73]=>
      string(10) "Vegetarian"
      [74]=>
      string(29) "Vietnamese/Cambodian/Malaysia"
}

另请参阅

distinct command reference in the MongoDB manual