/ /

MongoDB\Collection::distinct()

定義

MongoDB\Collection::distinct()

コレクション全体で指定されたフィールドの個別の値を検索します。

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

パラメーター

$fieldName : string

個別の値を返すフィールド。

$filter : array|object

個別の値を取得するドキュメントを指定するフィルター基準。

$options : 配列

必要なオプションを指定する配列。

名前	タイプ	説明
collation	array\|object	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 では以前のバージョンで使用されていた単純なバイナリ比較によって string が比較されます。
comment	混合	データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバーバージョンで指定すると実行時に例外が発生します。バージョン1.13の新機能。
hint	string\|オブジェクト	使用するインデックス。インデックス名を string またはインデックスキーパターンをドキュメントとして指定します。指定すると、クエリシステムはヒント指定したインデックスを使用するプランのみを考慮します。バージョン1.21の新機能。
maxTimeMS	integer	カーソルに対する情報処理操作の累積時間制限（ミリ秒単位）。MongoDB は、割り込みポイントの後の最も早く操作を中止します。
ReadConcern	MongoDB\Driver\ReadConcern	操作に使用する読み取り保証。デフォルトはコレクションの読み取り保証 (read concern) です。トランザクションの一部である個々の操作に対して読み取り保証 (read concern)を指定することはできません。代わりに、トランザクションを開始するときに`readConcern` オプションを設定します。
readPreference	MongoDB\Driver\ReadPreference	操作に使用する読み取り設定。コレクションの読み込み設定（read preference）がデフォルトで設定されます。
セッション	MongoDB\Driver\Session	操作に関連付けるクライアントセッション。バージョン1.3の新機能。
typeMap	配列	The type map to apply to cursors, which determines how BSON documents are converted to PHP values. Defaults to the collection's type map. バージョン1.5の新機能。

Return Values

個別の値の配列。

エラーと例外

MongoDB\Exception\UnexpectedValueException サーバーからのコマンド応答が不正な形式であった場合、。

MongoDB\Exception\UnsupportedExceptionオプションが使用され、選択したサーバーでサポートされていない場合（例: collation 、 readConcern 、 writeConcern ）。

MongoDB\Exception\InvalidArgumentException は、パラメータまたはオプションの解析に関連するエラーの場合はです。

MongoDB$Driver\Exception\RuntimeException は、拡張レベルの他のエラーの場合（例:）。

動作

When evaluating query criteria, MongoDB compares types and values according to its own comparison rules for BSON types, which differs from PHP's comparison and type juggling rules. When matching a special BSON type the query criteria should use the respective BSON class in the extension (e.g. use MongoDB\BSON\ObjectId to match an ObjectId).

例

フィールドの個別の値を返す

次の例では、 testデータベース内のrestaurantsコレクション内の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"
}

フィルターを使用して個別の値を返す

次の例では、 boroughがQueensであるドキュメントのtestデータベース内のrestaurantsコレクション内のcuisineフィールドの個別の値を識別します。

<?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"
}

その他の参照

MongoDB マニュアルの個別のコマンド参照

戻る

deleteOne()

drop()