MongoDB\Database::renameCollection()
バージョン 1.10 の新機能。
定義
パラメーター
$fromCollectionName
: string- 名前を変更するコレクションの名前。
$toCollectionName
: string- コレクションの新しい名前。
$toDatabaseName
: string- コレクションの新しいデータベース名。 新しいデータベース名を指定しない場合は、現在のデータベースが使用されます。 新しい名前で別のデータベースが指定されている場合、コマンドはコレクションを新しいデータベースにコピーし、ソース コレクションを削除します。
$options
: 配列必要なオプションを指定する配列。
名前タイプ説明comment
混合
ユーザーが任意のコメントを指定して、 データベースプロファイラ、 currentOp出力、ログから操作を追跡できるようにします。
このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバー バージョンで指定すると実行時に例外が発生します。
バージョン 1.13 の新機能。
dropTarget
ブール値
true
の場合、MongoDB はコレクションの名前を変更する前にターゲットを削除します。 デフォルト値はfalse
です。セッション
操作に関連付けるクライアント セッション。
typeMap
配列
型マップ カーソルに適用される 。これは、BSON ドキュメントが PHP 値に変換される方法を決定します。データベースのタイプ マップがデフォルトで設定されます。
これは返されたコマンドの結果ドキュメントに使用されます。
writeConcern
操作に使用する書込み保証 ( write concern )。 データベースの書込み保証 (write concern) のデフォルト。
Return Values
renameCollectionコマンドの結果ドキュメントを含む配列またはオブジェクト。 戻り値の型は、 typeMap
オプションによって異なります。
エラーと例外
MongoDB\Exception\UnsupportedException
オプションが使用され、選択したサーバーでサポートされていない場合(例: collation
、 readConcern
、 writeConcern
)。
MongoDB\Exception\InvalidArgumentException
は、パラメータまたはオプションの解析に関連するエラーの場合は です。
MongoDB\Driver\Exception\RuntimeException 拡張レベルのその他のエラー(例:)。
例
次の例では、 test
データベース内のrestaurants
コレクションの名前をplaces
に変更します。
$db = (new MongoDB\Client)->test; $result = $db->renameCollection('restaurants', 'places'); var_dump($result);
出力は次のようになります。
object(MongoDB\Model\BSONDocument)#8 (1) { ["storage":"ArrayObject":private]=> array(1) { ["ok"]=> float(1) } }
その他の参照
MongoDB マニュアルのrenameCollectionコマンド参照