MongoDB\Database::dropCollection()

項目一覧

定義

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

定義

MongoDB\Database::dropCollection()

現在のデータベース内のコレクションを削除します。

function dropCollection(
    string $collectionName,
    array $options = []
): array|object

パラメーター

$collectionName : string

削除するコレクションの名前。

$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) のデフォルト。

Return Values

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

エラーと例外

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

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

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

例

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

<?php
$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\Collection::drop()
MongoDB マニュアルの削除コマンド参照

戻る

drop()

getDatabaseName()