MongoDB\Database::drop()

定義

MongoDB\Database::drop()

データベースの削除

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

パラメーター

$options : 配列

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

名前	タイプ	説明
comment	混合	データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。 このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバー バージョンで指定すると実行時に例外が発生します。 バージョン1.13の新機能。
セッション	MongoDB\Driver\Session	操作に関連付けるクライアント セッション。 バージョン1.3の新機能。
typeMap	配列	The type map to apply to cursors, which determines how BSON documents are converted to PHP values. Defaults to the database's type map. これは返されたコマンドの結果ドキュメントに使用されます。
writeConcern	MongoDB\Driver\WriteConcern	操作に使用する書込み保証 ( write concern )。 データベースの書込み保証 (write concern) のデフォルト。

Return Values

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

エラーと例外

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

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

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

例

次の例では、 testデータベースを削除します。

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

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

object(MongoDB\Model\BSONDocument)#8 (1) {
  ["storage":"ArrayObject":private]=>
  array(2) {
    ["dropped"]=>
    string(4) "test"
    ["ok"]=>
    float(1)
  }
}

その他の参照

• MongoDB\Client::dropDatabase()

• MongoDB マニュアルのdropDatabaseコマンドに関する参考資料