定義
パラメーター
$collectionName: string- 削除するコレクションの名前。
$options: 配列必要なオプションを指定する配列。
名前タイプ説明comment
混合
データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。
このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバー バージョンで指定すると実行時に例外が発生します。
バージョン1.13の新機能。
暗号化されたフィールド
array|object
Queryable Encryption の暗号化されたフィールドを説明するドキュメント。 省略した場合、
autoEncryptionドライバー オプション内のencryptedFieldsMapオプションが参照されます。encryptedFieldsMapが定義されていたが、このコレクションを指定していない場合、ライブラリはencryptedFieldsのサーバー側値を参照する最後の試行を行います。 詳細については、MongoDB マニュアルの 「フィールドの暗号化とクエリ可能性」 を参照してください。このオプションはdropコマンドに渡されません。 ライブラリはそれを使用して、暗号化されたコレクションに加えて削除する必要がある関連メタデータ コレクションを決定します。
バージョン1.13の新機能。
セッション
操作に関連付けるクライアント セッション。
バージョン1.3の新機能。
typeMap
配列
writeConcern
操作に使用する書込み保証 ( write concern )。 データベースの書込み保証 (write concern) のデフォルト。
Return Values
dropコマンドの結果ドキュメントを含む配列またはオブジェクト。 戻り値の型は、 typeMapオプションによって異なります。
エラーと例外
MongoDB\Exception\UnsupportedExceptionオプションが使用され、選択したサーバーでサポートされていない場合（例: collation 、 readConcern 、 writeConcern ）。
MongoDB\Exception\InvalidArgumentException は、パラメータまたはオプションの解析に関連するエラーの場合は です。
MongoDB$Driver\Exception\RuntimeException は、拡張レベルの他のエラーの場合（例:）。
例
次の例では、 testデータベース内のusersコレクションを削除します。
$db = (new MongoDB\Client)->test;
$result = $db->dropCollection('users');
var_dump($result);出力は次のようになります。
object(MongoDB\Model\BSONDocument)#8 (1) { ["storage":"ArrayObject":private]=> array(3) { ["ns"]=> string(10) "test.users" ["nIndexesWas"]=> int(1) ["ok"]=> float(1) }}その他の参照
MongoDB マニュアルの削除コマンド参照