db. コレクション.update()（mongoshメソッド）

パラメーター

db.collection.update() メソッドは次のパラメータを取ります。

{
  <variable_name_1>: <expression_1>,
  ...,
  <variable_name_n>: <expression_n>
}

戻り値

The method returns a WriteResult document that contains the status of the operation.

制限

multi: true を設定した場合、update() メソッドは冪等演算にのみ使用してください。

Upsertを使用した更新で $expr を使用する

Attempting to use the $expr operator with the upsert flag set to true generates an error.

シャーディングされたコレクション

シャーディングされたコレクションで multi: false と一緒に db.collection.update() を使用するには、_id フィールドに完全一致を含めるか、単一のシャードをターゲットにする（シャードキーを含めるなど）必要があります。

db.collection.update() が更新操作（ドキュメント置換操作ではない）を実行する場合、db.collection.update() では複数のシャードをターゲットにできます。

{ _id: <value>, <shardkeyfield>: null } // _id of the document missing shard key

トランザクション

db.collection.update() は分散トランザクション内で使用できます。

Oplog エントリ

db.collection.update() 操作によって 1 つ以上のドキュメントが正常に更新されると、その操作によって oplog（操作ログ）にエントリーが追加されます。操作が失敗した場合、または更新するドキュメントが見つからなかった場合は、その操作によって oplog にエントリーが追加されることはありません。

ドット表記_id クエリによるアップサート

When you execute an update() with upsert: true and the query matches no existing document, MongoDB will refuse to insert a new document if the query specifies conditions on the _id field using dot notation.

この制限により、_id ドキュメントに埋め込まれたフィールドの順序が明確に定義され、クエリで指定された順序に縛られることがなくなります。

この方法でドキュメントを挿入しようとすると、 MongoDB はエラーを発生させます。

重複した値のアップサート

重複を防ぐためのユニークインデックスがない限り、アップサートによって重複したドキュメントが作成されることがあります。

クライアントがデータを正常に挿入する前にすべての db.collection.update() 操作がクエリ フェーズを終了し、かつ nameフィールドにユニークインデックスがない場合、各 db.collection.update()操作によって挿入が行われ、name: Andy を持つ複数のドキュメントが作成される可能性があります。

nameフィールドにユニークインデックスを設定すると、ドキュメントが1 つだけ作成されるようになります。ユニークインデックスが設定されると、複数の db.collection.update() 操作で次の動作が見られるようになります。

• 正確に 1 つの db.collection.update()操作で新しいものを正常に挿入します。

  ドキュメント。

• その他の db.collection.update() 操作は、新しく挿入された

  ドキュメントまたは、一意なキーの競合が原因で失敗します。

  新しく挿入されたドキュメントを更新するための他の db.collection.update() 操作では、次の条件が すべて 満たされている必要があります。

  • ターゲットコレクションにユニークインデックスがあると、

    重複キー エラー。

  • 更新操作がupdateMany ではない、または multi は

    false.

  • アップデートの一致条件は、次のいずれかです。

    • 単一の等価述語。例: { "fieldA" : "valueA" }

    • 等価述語の論理 AND。例: { "fieldA" : "valueA", "fieldB" : "valueB" }

  • 等価述語内のフィールドが次内のフィールドと一致

    ユニークインデックスキー パターン。

  • 更新操作が、 内のフィールドを変更しない。

    ユニークインデックスキー パターン。

配列更新操作

アップデート ドキュメントでは、$[<identifier>] フィルター処理された位置演算子を使用して識別子を定義し、配列フィルター ドキュメントで参照します。識別子がアップデートドキュメントに含まれていない場合、識別子の配列フィルタードキュメントを作成することはできません。

<identifier>は小文字で始まり、含めることができるのは英数字のみです。

アップデートドキュメントには同じ識別子を複数回含めることができます。ただし、 更新ドキュメント内の個別の識別子 ($[identifier]) それぞれに対し、対応する配列フィルタードキュメント を1 つだけ 指定する必要があります。つまり、同じ識別子に対して複数の配列フィルター ドキュメントを指定することはできません。ただし、単一のフィルタードキュメント内の同じ識別子に複合条件を指定できます

正常な結果

db.collection.update() メソッドは、操作のステータスを含む WriteResult() オブジェクトを返します。成功すると、WriteResult() オブジェクトには、クエリ条件に一致したドキュメントの数、更新によって挿入されたドキュメントの数、および変更されたドキュメントの数が含まれます。

書込み保証 (write concern) エラー

db.collection.update() メソッドで書込み保証 (write concern) エラーが発生した場合、結果には WriteResult.writeConcernError フィールドが含まれます。

次の表は、WriteResult.writeConcernError.provenanceの値について説明したものです。

書込み保証 (write concern) とは関係のないエラー

db.collection.update() メソッドで書込み保証以外のエラーが発生した場合、結果には WriteResult.writeError フィールドが含まれます。

一致するものが存在しない場合は新しいドキュメントを挿入する（Upsert）

When you specify the option upsert: true:

• ドキュメントがクエリ条件に一致する場合、db.collection.update() は更新を実行します。

• クエリ条件に一致するドキュメントがない場合、db.collection.update() は 1 つのドキュメントを挿入します。

  注意

  If multiple, identical upserts are issued at roughly the same time, it is possible for update() used with upsert: true to create duplicate documents. See Upsert with Duplicate Values for more information.

If you specify upsert: true on a sharded collection, you must include the full shard key in the filter. For additional db.collection.update() behavior on a sharded collection, see Sharded Collections.

次のタブでは、 update()を使用した upsert修飾子の様々な使用方法を紹介します。

db.movies.update(
   { title: "Test Movie 12345" },
   { 
      $set: {
         title: "Test Movie 12345", 
         year: 2024, 
         genres: [ "Documentary" ],
         rated: "NR"
      }
   },
   { upsert: true }
)

db.movies.update(
   { title: "Test Movie 67890" },   // Query parameter
   {                                // Update document
      $set: { rated: "PG" },
      $setOnInsert: { year: 2024, type: "movie" }
   },
   { upsert: true }                 // Options
)

db.movies.update(
   { title: "Test Movie ABC123" },  // Query parameter
   [                                // Aggregation pipeline
      { $set: { 
         year: 2024, 
         type: "movie",
         rated: "NR",
         lastModified: "$$NOW" 
      } }
   ],
   { upsert: true }   // Options
)

db.movies.update(
   { title: { $in: ["The Godfather", "The Matrix"] } },
   { $set: { test_upsert_field: true } },
   { upsert: true, multi: true }
)

db.movies.update(
   { "title": "Test Movie Unique789" },
   { $set: { year: 2024, type: "movie" } },
   { upsert: true, multi: true }
)

集約パイプラインによるアップデート

db.collection.update() メソッドでは、実行する変更を指定する 集計パイプライン [ <stage1>, <stage2>, ... ] を受け入れることができます。パイプラインは次のステージで構成できます。

• $addFields およびそのエイリアス $set

• $project およびそのエイリアス $unset

• $replaceRoot およびそのエイリアス $replaceWith

集計パイプラインを使用すると、現在のフィールド値に基づいて条件付きのアップデートを表現したり、あるフィールドを他のフィールドの値を使用してアップデートするなど、より表現内容の多いアップデート ステートメントが可能になります。

db.movies.update(
   { title: "The Godfather" },
   [
      { $set: { 
            displayTitle: { $concat: [ "$title", " (", { $toString: "$year" }, ")" ] },
            lastModified: "$$NOW" 
         } 
      }
   ]
)

db.movies.update(
   { 
      year: 2015,
      "imdb.rating": { $type: "number" },
      "tomatoes.viewer.rating": { $type: "number" }
   },
   [
      { $set: { 
         combinedScore: { 
            $round: [ 
               { $avg: [ 
               { $multiply: [ "$imdb.rating", 10 ] }, 
               { $multiply: [ "$tomatoes.viewer.rating", 10 ] } 
               ] }, 
               1 
            ] 
         }, 
         lastUpdate: "$$NOW" 
         } 
      },
      { $set: { 
         grade: { 
            $switch: {
               branches: [
               { case: { $gte: [ "$combinedScore", 80 ] }, then: "A" },
               { case: { $gte: [ "$combinedScore", 70 ] }, then: "B" },
               { case: { $gte: [ "$combinedScore", 60 ] }, then: "C" },
               { case: { $gte: [ "$combinedScore", 50 ] }, then: "D" }
               ],
               default: "F"
            } 
         } 
         } 
      }
   ],
   { multi: true }
)

配列更新操作での arrayFilters の指定

db.movies.update(
   { languages: "English" },
   { $set: { "languages.$[element]" : "EN" } },
   {
      arrayFilters: [ { "element": "English" } ],
      multi: true
   }
)

db.movies.update(
   { title: "The Godfather" },
   { $set: { "writers.$[elem]" : { $concat: [ "$elem", " - UPDATED" ] } } },
   {
      arrayFilters: [ { "elem": { $regex: /screenplay/ } } ]
   }
)

更新操作に hint を指定する

hintオプションは、MongoDB が更新操作に使用するインデックスを指定します。複数のドキュメントを更新する場合は、インデックスを指定してコンシステントなクエリプランを確保します。この例では、sample_mflix データベースの既存のmoviesコレクションを使用します。

まず、yearフィールドにインデックスを作成します。

db.movies.createIndex( { year: 1 } )

The following update operation explicitly hints to use the { year: 1 } index to update all movies from 2010-2015:

db.movies.update(
   { year: { $gte: 2010, $lte: 2015 } },  // Query parameter
   { $set: { decade: "2010s" } },             // Update document
   { multi: true, hint: { year: 1 } }          // Options
)

使用されたインデックスを確認するには、次の操作で explain を実行します。

db.movies.explain().update(
   { title: "The Godfather", year: { $gte: 1970 } },
   { $set: { test_hint_field: true } },
   { hint: { year: 1 } }
)

db.collection.explain().update()はドキュメントを変更しません。

変数の使用 let

コマンド内の他の場所からアクセスできる変数を定義するには、 letオプションを使用します。

例：

• let オプションで 2 つの変数を定義します: targetTitle（「Atlas マトリクス」に設定）と newTitle（「Atlas Reloaded」に設定）

• クエリフィルターで $expr を使用して、ドキュメントの titleフィールドと $$targetTitle 変数を比較します

• $set で集計パイプラインを使用して、titleフィールドを $$newTitle の値に更新します

db.movies.update(
   { $expr: { $eq: [ "$title", "$$targetTitle" ] } },
   [ { $set: { sequel: "$$sequelTitle" } } ],
   { let : { targetTitle: "The Matrix", sequelTitle: "The Matrix Reloaded" } }
)

デフォルトの書込み保証 (write concern) の上書き

次のレプリカセットに対する操作では、w: 2 の書込み保証 (write concern)を指定し、タイムアウトを wtimeout で5000 ミリ秒に設定しています。この操作は、書き込み (write) がプライマリと1つのセカンダリの両方に伝達された後に返すか、5 秒後にタイムアウトします。

db.movies.update(
   { num_mflix_comments: { $lte: 10 } },
   { $set: { featured: true } },
   {
      multi: true,
      writeConcern: { w: 2, j: true, wtimeout: 5000 }
   }
)

w: 2 で指定されたプライマリと少なくとも 1 つのセカンダリによって書き込み (write) が確認された後に、操作は正常に完了します。

シャーディングされたクラスターでの書込み保証 (write concern) エラー

db.collection.update() がシャーディングされたクラスター内の mongos で実行されると、他のエラーが 1 つ以上発生した場合でも、レスポンスには常に writeConcernError が報告されます。以前のリリースでは、他のエラーによって db.collection.update() が書込み保証 (write concern)エラーを報告しないことがあります。

例、ドキュメントが検証に失敗して DocumentValidationFailed エラーが発生し、書込み保証 (write concern)エラーも発生した場合、DocumentValidationFailed エラーと writeConcernError の両方が応答の最上位フィールドに返されます。

照合の指定

任意。操作に使用する照合を指定します。

照合を指定すると、大文字・小文字やアクセント記号など、文字列を比較するための言語独自のルールを指定できます。

照合オプションの構文は次のとおりです。

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

照合を指定する場合、locale フィールドは必須ですが、その他の照合フィールドはすべて任意です。フィールドの説明については、照合ドキュメントを参照してください。

照合が指定されていなくても、コレクションにデフォルトの照合が設定されている場合（db.createCollection() を参照）には、コレクションの照合が使用されます。

コレクションにも操作にも照合が指定されていない場合、MongoDB では以前のバージョンで使用されていた単純なバイナリ比較によって文字列が比較されます。

1 つの操作に複数の照合は指定できません。たとえば、フィールドごとに異なる照合を指定できません。また、ソートと検索を一度に実行する場合、検索とソートで別の照合を使用できません。

この操作は、night で始まるタイトルを持つすべての映画を更新し、大文字と小文字を区別しない比較に strength: 1 を使用する

db.movies.update(
   { title: /^night/i },
   { $set: { updated: true } },
   {
      collation: { locale: "en", strength: 1 },
      multi: true
   }
)