MongoDB\Collection::rename()

バージョン 1.10 の新機能。

定義

MongoDB\Collection::rename()

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

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

$toCollectionName : string

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

$toDatabaseName : string

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

$options : 配列

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

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

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

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

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

次の操作では、 testデータベース内のrestaurantsコレクションの名前がplacesに変更されます。

<?php
$collection = (new MongoDB\Client)->test->restaurants;
$collection->rename('places');

戻る

listSearchIndexes()

replaceOne()