MongoDB\Collection::dropIndex()

項目一覧

定義

パラメーター
Return Values
エラーと例外
例
その他の参照

定義

MongoDB\Collection::dropIndex()

コレクションからインデックスを削除します。

function dropIndex(
    string|MongoDB\Model\IndexInfo $indexName,
    array $options = []
): array|object

パラメーター

$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` オプションを設定します。

Return Values

dropIndexesコマンドの結果ドキュメントを含む配列またはオブジェクト。戻り値の型は、 typeMapオプションによって異なります。

エラーと例外

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

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

MongoDB\Driver\Exception\RuntimeException 拡張レベルのその他のエラー（例:）。

例

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

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$result = $collection->dropIndex('borough_1');
var_dump($result);

出力は次のようになります。

object(MongoDB\Model\BSONDocument)#9 (1) {
  ["storage":"ArrayObject":private]=>
  array(2) {
    ["nIndexesWas"]=>
    int(2)
    ["ok"]=>
    float(1)
  }
}

その他の参照

MongoDB\Collection::dropIndexes()
Indexes
MongoDB マニュアルのdropIndexesコマンド参照
MongoDB マニュアルのインデックスに関するドキュメント

戻る

drop()

dropIndexes()