Docs Menu
Docs Home
/
言語
/
PHP
/
PHP ライブラリ マニュアル
/
API ドキュメント
/
MongoDB\Client クラス

MongoDB\Client::dropDatabase()

項目一覧

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

定義

MongoDB\Client::dropDatabase()

サーバー上のデータベースを削除します。

function dropDatabase(string $databaseName, array $options = []): array|object

パラメーター

$databaseName : string
削除するデータベースの名前。
$options : 配列

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

名前
タイプ
説明
comment
混合

ユーザーが任意のコメントを指定して、 データベースプロファイラ、 currentOp出力、ログから操作を追跡できるようにします。

このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバー バージョンで指定すると実行時に例外が発生します。

バージョン 1.13 の新機能。

セッション

操作に関連付けるクライアント セッション。

バージョン 1.3 で追加。

typeMap
配列

型マップ カーソルに適用される 。これは、BSON ドキュメントが PHP 値に変換される方法を決定します。クライアントのタイプ マップにデフォルト設定されます。

これは返されたコマンドの結果ドキュメントに使用されます。

writeConcern

操作に使用する書込み保証 ( write concern )。 クライアントの書込み保証 (write concern) のデフォルト値。

Return Values

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

エラーと例外

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

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

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

例

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

<?php
$client = new MongoDB\Client;
$result = $client->dropDatabase('test');
var_dump($result);

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

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

その他の参照

  • MongoDB\Database::drop()

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

戻る

createClientEncryption()