renameCollection
定義
renameCollection既存のコレクションの名前を変更します。完全な 名前空間の形式で
renameCollectionにコレクション名を指定します（<database>.<collection>）。Tip
mongoshでは、このコマンドはrenameCollection()ヘルパー メソッドを通じて実行することもできます。ヘルパー メソッドは
mongoshユーザーには便利ですが、データベースコマンドと同じレベルの情報は返されない可能性があります。 便宜上必要ない場合、または追加の戻りフィールドが必要な場合は、 データベースコマンドを使用します。管理データベースに対して
renameCollectionコマンドを発行します。
互換性
このコマンドは、次の環境でホストされている配置で使用できます。
MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです
注意
このコマンドは、すべての MongoDB Atlas クラスターでサポートされています。すべてのコマンドに対する Atlas のサポートについては、「サポートされていないコマンド」を参照してください。
MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン
構文
このコマンドの構文は、次のとおりです。
db.runCommand( { renameCollection: "<source_namespace>", to: "<target_namespace>", dropTarget: <true|false>, writeConcern: <document>, comment: <any> } )
コマンドフィールド
このコマンドには次のフィールドが含まれています。
フィールド | タイプ | 説明 |
|---|---|---|
| string | 名前を変更するコレクションの名前空間。名前空間は、データベース名とコレクションの名前の組み合わせです。 |
| string | コレクションの新しい名前空間。新しい名前空間で別のデータベースが指定されている場合、 |
| ブール値 | オプション。 |
| ドキュメント | 任意。操作の書込み保証（write concern）を表現するドキュメント。デフォルトの書込み保証を使用する場合は省略します。 シャーディングされたシャーディングされたクラスターで発行すると、 |
| any | 任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。
コメントには、有効な BSON 型（string, integer, object, array など）を使用できます。 |
動作
シャーディングされたコレクション
MongoDB 5.0 以降では、renameCollection コマンドを使用してシャーディングされたコレクションの名前を変更できます。ターゲットデータベースはソースデータベースと同じである必要があります。
シャーディングされていないコレクション
ソースデータベースとターゲットデータベースのプライマリシャードが同じであれば、renameCollection を使用してシャーディングされたクラスター内の非シャーディングコレクションの名前を変更できます。
時系列コレクション
renameCollection を使って時系列コレクションの名前を変更することはできません。詳細については「時系列コレクションの制限」を参照してください。
既存のターゲット コレクション
renameCollection は、target が既存のコレクションの名前で、かつ dropTarget: true を指定しない場合失敗します。
パフォーマンス
renameCollection は、ターゲットの名前空間に応じて、異なるパフォーマンスへの影響があります。
ターゲットデータベースがソースデータベースと同じである場合、renameCollection は名前空間を変更します。この操作はすぐに実行されます。
ターゲットデータベースがソースデータベースと異なる場合、renameCollection はソースコレクションからターゲットコレクションにすべてのドキュメントをコピーします。コレクションのサイズによっては、完了まで時間がかかる場合があります。
シャーディングされたクラスターでのリソース ロック
バージョン 5.0 での変更。
シャーディングされたクラスター内のシャーディングされたコレクションまたはシャーディングされていないコレクションの名前を変更すると、ソース コレクションとターゲット コレクションだけがすべてのシャードでロックされます。ソース コレクションとターゲット コレクションでのその後の操作は、名前変更操作が完了するまで待つ必要があります。
MongoDB でのロックの詳細については、「FAQ: 同時実行性」を参照してください。
レプリカセットでのリソース ロック
同じデータベース内のコレクションの名前を変更する場合、renameCollection は操作中にソースコレクションとターゲットコレクションに対して排他ロックを取得します。コレクションでの後続のすべての操作は、renameCollection が完了するまで待機する必要があります。
異なるデータベース間でコレクションの名前を変更する場合、renameCollection はターゲットデータベースで排他（W）ロック、ソースデータベースで意向共有（r）ロック、ソースコレクションで共有（S）ロックを取得します。ターゲットデータベースでのその後の操作は、renameCollection が排他的データベースロックを解放するまで待つ必要があります。
MongoDB でのロックの詳細については、「FAQ: 同時実行性」を参照してください。
local Database
コレクションの名前を、複製されたデータベースから、複製されていない
localデータベースに変更することはできません。コレクションの名前を、複製されていない
localデータベースから複製されたデータベースに変更することはできません。
オープンカーソルと変更ストリーム
警告
db.collection.renameCollection() メソッドと renameCollection コマンドは、オープンカーソルを無効にします。これにより、ソースコレクションまたはターゲットコレクションで開かれている既存の変更ストリームの無効化イベントが作成され、名前が変更されたコレクションから現在データを返しているクエリも中断されます。
相互作用: mongodump
--oplog で開始された mongodump は、ダンプ処理中にクライアントが renameCollection コマンドを発行すると失敗します。詳細については、mongodump.--oplog を参照してください。
例
次の例では、test データベース内の orders という名前のコレクションの名前を、test データベース内のコレクションの orders2014 に変更します。
db.adminCommand( { renameCollection: "test.orders", to: "test.orders2014" } )
mongoshは、db.collection.renameCollection() 同じ データベース内のコレクションの名前を変更するための コマンドの ヘルパーを提供します。次の は、前の例と同等です。
use test db.orders.renameCollection( "orders2014" )