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

パラメーター

updateMany() メソッドは次のパラメータを取ります。

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

// INVALID
[
  { "x.a": { $gt: 85 } },
  { "x.b": { $gt: 80 } }
]

// Example 1
[
  { $or: [{"x.a": {$gt: 85}}, {"x.b": {$gt: 80}}] }
]
// Example 2
[
  { $and: [{"x.a": {$gt: 85}}, {"x.b": {$gt: 80}}] }
]
// Example 3
[
  { "x.a": { $gt: 85 }, "x.b": { $gt: 80 } }
]

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

戻り値

このメソッドは、次の内容を含むドキュメントを返します。

• 操作が書き込み保証付きで実行された場合はブール値acknowledged（true ）、書き込み保証が無効になっている場合はfalseになります

• matchedCount 一致したドキュメントの数を含みます

• modifiedCount 変更されたドキュメントの数を含みます

• upsertedId 、アップサートされたドキュメントの _id が含まれる

• upsertedCount アップサートされた文書の数を含む

制限

• updateMany() は、冪等操作にのみ使用してください。

アップサート

upsert: true で、filter に一致するドキュメントがない場合、db.collection.updateMany() では filter と update パラメーターに基づき新しいドキュメントが作成されます。

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

「アップサートによる複数のドキュメントの更新」を参照してください。

更新演算子式ドキュメントを使用したアップデート

変更仕様の場合、db.collection.updateMany() メソッドでは更新演算子式のみを含むドキュメントを受け入れることができます。

以下に例を挙げます。

db.collection.updateMany(
   <query>,
   { $set: { status: "D" }, $inc: { quantity: 2 } },
   ...
)

集計パイプラインによる更新

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

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

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

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

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

以下に例を挙げます。

db.collection.updateMany(
   <query>,
   [
      { $set: { status: "Modified", comments: [ "$misc1", "$misc2" ] } },
      { $unset: [ "misc1", "misc2" ] }
   ]
   ...
)

For examples, see Update with Aggregation Pipeline.

上限付きコレクション

更新操作によりドキュメントのサイズが変更された場合、操作は失敗します。

時系列コレクション

updateMany() メソッドは、MongoDB 5.1 以降の時系列コレクションで使用できます。

更新コマンドは、次の要件を満たしている必要があります。

• 照合できるのは、 metaField フィールドの値のみです。

• 変更できるのは、 metaField フィールドの値のみです。

• 更新ドキュメントには、更新演算子式しか含めることができません。

• Your update command must not limit the number of documents to be updated. Set multi: true or use the updateMany() method.

• 更新コマンドでは upsert: true を設定しないでください。

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

updateMany() は、シャーディングされたコレクションで使用すると、次の動作を示します。

• updateMany() upsert: true を含む 操作には、filter に完全なシャードキーを含める必要があります。

• updateMany()範囲移行 またはシャードキー値の更新 中に を実行しようとすると、シナリオによっては操作によってドキュメントが失われる可能性があります。すべてのドキュメントが更新されるようにするには、 冪等更新 を使用し、それ以上の更新が適用されなくなるまでコマンドを再実行します。 updateMany()を使用した冪等更新の詳細については、「 冪等更新 」を参照してください。

• updateMany() がトランザクションの外で実行されると、複数のシャードを対象とする操作は、クラスター内のすべてのシャードに適用されます。

• updateMany() がトランザクション内で実行される場合、複数のシャードを対象とする操作は、関連するシャードのみを対象とします。

説明可能性

updateMany() db.collection.explain()は と互換性がありません。

トランザクション

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

Oplog エントリ

updateMany() は、正常にアップデートされた各ドキュメントのoplog （操作ログ）にエントリを追加します。ドキュメントが更新されていない場合、updateMany() はoplogにエントリを追加しません。

Idempotent Updates

sample_mflix.moviesコレクションには IMDB 評価の映画が含まれています。この冪等更新では、次の操作が実行されます。

• は、 IMDB 評価が 3.0 未満のすべての映画に一致します

• これらの評価は 0.5 ずつ増加します

• ratingBoostedフィールドを true に設定する

db.movies.updateMany(
   { "imdb.rating": { $lt: 3, $type: "number" }, ratingBoosted: { $ne: true } },
   { $inc: { "imdb.rating": 0.5 }, $set: { ratingBoosted: true } }
)

updateMany() は、一致する映画ドキュメントを個別に変更します。個々のドキュメントの更新はアトミック操作ですが、updateMany()操作全体はアトミックではありません。

操作が失敗して一致するすべてのドキュメントのアップデートに失敗した場合は、指定されたフィルターに一致するドキュメントがなくなるまで、冪等コマンドを安全に再実行できます。 この場合、コマンドが冪等であるため、再試行回数に関係なく、各ドキュメントの imdb.ratingフィールドは 1 回だけ更新されます。

複数のドキュメントの更新

sample_mflix.moviesコレクションには、num_mflix_commentsフィールドを持つ映画が含まれています。

次の操作では、100 を超えるコメントがあるすべての映画を検索し、それらの映画に popular フラグを追加します。

db.movies.updateMany( 
   { num_mflix_comments: { $gt: 100 } }, 
   { $set: { "popular" : true } } 
)

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

db.collection.updateMany() can use an aggregation pipeline to express a more complex update, such as a conditional update based on current field values. For the supported pipeline stages, see Update with an Aggregation Pipeline.

db.movies.updateMany(
   { year: { $gte: 2010, $lte: 2019 } },
   [
      { $set: { 
         combinedRatings: [ "$imdb.rating", "$tomatoes.viewer.rating" ], 
         ratingsUpdated: "$$NOW" 
      } },
      { $unset: [ "imdb.rating", "tomatoes.viewer.rating" ] }
   ]
)

db.movies.updateMany(
   { 
      year: { $gte: 2010, $lte: 2019 },
      "imdb.rating": { $exists: true },
      "tomatoes.viewer.rating": { $exists: true }
   },
   [
     { $set: { 
        combinedScore: { $trunc: [ 
           { $avg: [ "$imdb.rating", "$tomatoes.viewer.rating" ] }, 
           1 
        ] },
        scoreUpdated: "$$NOW" 
     } },
     { $set: { 
        ratingGrade: { $switch: {
           branches: [
              { case: { $gte: [ "$combinedScore", 8 ] }, then: "A" },
              { case: { $gte: [ "$combinedScore", 6 ] }, then: "B" },
              { case: { $gte: [ "$combinedScore", 4 ] }, then: "C" },
              { case: { $gte: [ "$combinedScore", 2 ] }, then: "D" }
           ],
           default: "F"
        } } 
     } }
   ]
)

アップサートによる複数のドキュメントの更新

次の操作では、2020 後にリリースされ、クリストファー ノードが管理したすべての映画を更新します。

db.movies.updateMany(
   { 
      year: { $gt: 2020 }, 
      directors: "Christopher Nolan" 
   },
   { $set: { "upcomingRelease": true } },
   { upsert: true }
)

この例では、フィルターに一致するドキュメントがなく、upsert が true であるため、updateMany は生成された _id と filter からの等価条件、および update 修飾子を持つ新しいドキュメントを挿入します。

書き込み保証による更新

３つのノードから成るレプリカセットにおいて、次の操作は w の majority と wtimeout の 100 を指定します。

db.movies.updateMany(
    { title: "The Godfather" },
    { $inc: { num_mflix_comments: 10 }, $set: { trending: true } },
    { w: "majority", wtimeout: 100 }
)

確認応答に wtimeout の制限を超える時間がかかると、 MongoDB は例外をスローします。

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

照合の指定

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

次の操作では、大文字と小文字を区別しない照合を使用して、小文字と大文字の任意の組み合わせを持つ、"drama" というジャンルの映画を照合します。

db.movies.updateMany(
   { genres: "drama" },
   { $set: { genreNormalized: true } },
   { collation: { locale: "en", strength: 1 } }
)

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

配列フィールドを更新するときに、どの配列要素を更新するかを決定するためのarrayFiltersを指定できます。

db.movies.updateMany(
   { 
      "imdb.rating": { $exists: true },
      "tomatoes.viewer.rating": { $exists: true },
      "tomatoes.critic.rating": { $exists: true },
      year: { $gte: 2010, $lte: 2015 }
   },
   [
      { $set: { 
         ratings: [
            { $multiply: ["$imdb.rating", 10] },
            { $multiply: ["$tomatoes.viewer.rating", 10] },
            { $multiply: ["$tomatoes.critic.rating", 10] }
         ]
      } }
   ]
)

db.movies.updateMany(
   { ratings: { $gte: 100 } },
   { $set: { "ratings.$[element]" : 100 } },
   { arrayFilters: [ { "element": { $gte: 100 } } ] }
)

db.movies.updateMany(
   { 
      "imdb.rating": { $exists: true },
      "tomatoes.viewer.rating": { $exists: true },
      year: { $gte: 2010, $lte: 2012 }
   },
   [
      { $set: { 
         ratingDetails: [
            { source: "imdb", score: "$imdb.rating", weight: 10 },
            { source: "tomatoes_viewer", score: "$tomatoes.viewer.rating", weight: 8 },
            { source: "tomatoes_critic", score: "$tomatoes.critic.rating", weight: 7 }
         ]
      } }
   ]
)

db.movies.updateMany(
   { ratingDetails: { $exists: true } },
   { $set: { "ratingDetails.$[elem].weight" : 10 } },
   { arrayFilters: [ { "elem.score": { $gte: 8 } } ] }
)

更新操作に hint を指定する

次のインデックスをコレクションで作成します。

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

次の更新操作は、インデックス{ rated: 1 }を使用することを明示的に示しています。

db.movies.updateMany(
   { "num_mflix_comments": { $lte: 5 }, "rated": "G" }, 
   { $set: { "familyFriendly": true } },
   { hint: { rated: 1 } }
)

ヒントで指定したインデックスが使用されているかどうかを確認するには、$indexStats パイプラインを実行します。

db.movies.aggregate( [ { $indexStats: { } }, { $sort: { name: 1 } }, { $match: {key: { rated: 1 } } } ] )

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

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

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

ユーザーロールとドキュメントの更新

MongoDB 7.0 以降では、新しい USER_ROLES システム変数を使用してユーザー ロールを返すことができます。

このセクションの例では、医療情報を含むコレクション内のフィールドの更新を示します。この例では、USER_ROLES システム変数から現在のユーザー ロールを読み取り、ユーザーが特定のロールを持っている場合にのみ更新を実行します。

システム変数を使用するには、変数名の先頭に $$ を追加します。システム変数 USER_ROLES を $$USER_ROLES として指定します。

この例では、次のユーザーを作成します。

• James Billing ロールの使用

• Michelle Provider ロールの使用

ロール、ユーザー、コレクションを作成するには、次の手順を実行します。

db.createRole( { role: "Billing", privileges: [ { resource: { db: "test",
   collection: "medicalView" }, actions: [ "find" ] } ], roles: [ ] } )
db.createRole( { role: "Provider", privileges: [ { resource: { db: "test",
   collection: "medicalView" }, actions: [ "find" ] } ], roles: [ ] } )

db.createUser( {
   user: "James",
   pwd: "js008",
   roles: [
      { role: "Billing", db: "test" }
   ]
} )
db.createUser( {
   user: "Michelle",
   pwd: "me009",
   roles: [
      { role: "Provider", db: "test" }
   ]
} )

db.medical.insertMany( [
   {
      _id: 0,
      patientName: "Jack Jones",
      diagnosisCode: "CAS 17",
      creditCard: "1234-5678-9012-3456"
   },
   {
      _id: 1,
      patientName: "Mary Smith",
      diagnosisCode: "ACH 01",
      creditCard: "6541-7534-9637-3456"
   }
] )

Provider ロールを持つ Michelle としてログインし、更新を実行します。

db.auth( "Michelle", "me009" )

// Attempt to update many documents
db.medical.updateMany(
   // User must have the Provider role to perform the update
   { $expr: { $ne: [ {
      $setIntersection: [ [ "Provider" ], "$$USER_ROLES.role" ] }, []
   ] } },
   // Update diagnosisCode
   { $set: { diagnosisCode: "ACH 02"} }
)

前の例では、$setIntersection を使用して、"Provider" s文字列と $$USER_ROLES.role のユーザー ロールの共通部分が空ではないドキュメントを返します。Michelle はProvider のロールを持つので、更新が実行されます。

次に、Provider ロールを持たない James としてログインし、同じ更新の実行を試みます。

db.auth( "James", "js008" )

// Attempt to update many documents
db.medical.updateMany(
   // User must have the Provider role to perform the update
   { $expr: { $ne: [ {
      $setIntersection: [ [ "Provider" ], "$$USER_ROLES.role" ] }, []
   ] } },
   // Update diagnosisCode
   { $set: { diagnosisCode: "ACH 02"} }
)

前の例では、ドキュメントは更新されません。