/ /

/ /

MongoDB\Database::renameCollection()

バージョン 1.10 の新機能。

定義

MongoDB\Database::renameCollection()

現在のデータベース内のコレクションの名前を変更します。

function renameCollection(
    string $fromCollectionName,
    string $toCollectionName,
    ?string $toDatabaseName = null,
    array $options = []
): void

パラメーター

$fromCollectionName : string

名前を変更するコレクションの名前。

$toCollectionName : string

コレクションの新しい名前。

$toDatabaseName : string

コレクションの新しいデータベース名。新しいデータベース名を指定しない場合は、現在のデータベースが使用されます。新しい名前で別のデータベースが指定されている場合、コマンドはコレクションを新しいデータベースにコピーし、ソースコレクションを削除します。

$options : 配列

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

名前	タイプ	説明
comment	混合	ユーザーが任意のコメントを指定して、データベースプロファイラ、 currentOp出力、ログから操作を追跡できるようにします。このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバーバージョンで指定すると実行時に例外が発生します。バージョン 1.13 の新機能。
dropTarget	ブール値	`true`の場合、MongoDB はコレクションの名前を変更する前にターゲットを削除します。デフォルト値は`false`です。
セッション	MongoDB\Driver\Session	操作に関連付けるクライアントセッション。
typeMap	配列	カーソルに適用するタイプマップ。BSON ドキュメントをPHP値に変換する方法を決定します。データベースのタイプマップがデフォルトで設定されます。これは返されたコマンドの結果ドキュメントに使用されます。
writeConcern	MongoDB\Driver\WriteConcern	操作に使用する書込み保証 ( write concern )。データベースの書込み保証 (write concern) のデフォルト。

エラーと例外

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

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

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

例

次の例では、 testデータベース内のrestaurantsコレクションの名前をplacesに変更します。

<?php
$db = (new MongoDB\Client)->test;
$db->renameCollection('restaurants', 'places');

その他の参照

MongoDB\Collection::rename()
MongoDB マニュアルのrenameCollectionコマンド参照

戻る

ifyCollection()

selectCollection()