MongoDB\Collection::drop()

定義

MongoDB\Collection::drop()

コレクションを削除します。

function drop(array $options = []): array|object

パラメーター

$options : 配列

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

名前	タイプ	説明
comment	混合	データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。 このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバー バージョンで指定すると実行時に例外が発生します。 バージョン1.13の新機能。
暗号化されたフィールド	array|object	Queryable Encryption の暗号化されたフィールドを説明するドキュメント。 省略した場合、 autoEncryptionドライバー オプション内のencryptedFieldsMapオプションが参照されます。 encryptedFieldsMapが定義されていたが、このコレクションを指定していない場合、ライブラリはencryptedFieldsのサーバー側値を参照する最後の試行を行います。 詳細については、MongoDB マニュアルの 「フィールドの暗号化とクエリ可能性」 を参照してください。 このオプションはdropコマンドに渡されません。 ライブラリはそれを使用して、暗号化されたコレクションに加えて削除する必要がある関連メタデータ コレクションを決定します。 バージョン1.13の新機能。
セッション	MongoDB\Driver\Session	操作に関連付けるクライアント セッション。 バージョン1.3の新機能。
typeMap	配列	カーソルに適用するタイプ マップ。BSON ドキュメントをPHP値に変換する方法を決定します。コレクションのタイプ マップがデフォルトになります。 これは返されたコマンドの結果ドキュメントに使用されます。
writeConcern	MongoDB\Driver\WriteConcern	操作に使用する書込み保証 ( write concern )。 コレクションの書込み保証 (write concern) のデフォルトです。 トランザクションの一部である個々の操作に対して書込み保証 (write concern)を指定することはできません。代わりに、トランザクションを開始するときにwriteConcern オプションを設定します。

Return Values

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

エラーと例外

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

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

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

例

次の操作は、 testデータベース内のrestaurantsコレクションを削除します。

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

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

object(MongoDB\Model\BSONDocument)#9 (1) {  ["storage":"ArrayObject":private]=>  array(3) {    ["ns"]=>    string(16) "test.restaurants"    ["nIndexesWas"]=>    int(3)    ["ok"]=>    float(1)  }}

その他の参照

• MongoDB\Database::dropCollection()

• MongoDB マニュアルの削除コマンド参照