/ /

/ /

MongoDB\Collection::dropIndexes()

定義

MongoDB\Collection::dropIndexes()

_idフィールドの必須インデックスを除くコレクション内のすべてのインデックスを削除します。

function dropIndexes(array $options = []): void

パラメーター

$indexName : string| MongoDB\Model\IndexInfo

削除するインデックスの名前またはモデルオブジェクト。コレクションの既存のインデックスを表示するには、 MongoDB\Collection::listIndexes()メソッドを使用します。

$options : 配列

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

名前	タイプ	説明
comment	混合	データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバーバージョンで指定すると実行時に例外が発生します。バージョン1.13の新機能。
maxTimeMS	integer	カーソルに対する情報処理操作の累積時間制限（ミリ秒単位）。MongoDB は、割り込みポイントの後の最も早く操作を中止します。バージョン1.3の新機能。
セッション	MongoDB\Driver\Session	操作に関連付けるクライアントセッション。バージョン1.3の新機能。
typeMap	配列	カーソルに適用する型マップ。これにより BSON ドキュメントが PHP 値に変換される方法が決定されます。デフォルトでは、コレクションのタイプマップになります。これは返されたコマンドの結果ドキュメントに使用されます。
writeConcern	MongoDB\Driver\WriteConcern	操作に使用する書込み保証 ( write concern )。コレクションの書込み保証 (write concern) のデフォルトです。トランザクションの一部である個々の操作に対して書込み保証 (write concern)を指定することはできません。代わりに、トランザクションを開始するときに`writeConcern` オプションを設定します。

エラーと例外

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

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

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

例

以下の例では、 testデータベース内のrestaurantsコレクションからすべてのインデックスを削除します。

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$collection->dropIndexes();

その他の参照

戻る

dropIndex()

dropSearchIndex()