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

パラメーター

db.collection.findAndModify() 次の埋め込みドキュメント フィールドを持つドキュメント パラメータを受け取ります。

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>
}

パフォーマンス

再試行可能な書き込みでは、更新を実行する前に、findAndModify() メソッドを使用してドキュメント全体をレプリカセット内の各ノードの特別なサイドコレクションにコピーする必要があります。そのため、大きな文書や大きなレプリカセットを扱う場合、findAndModify() はコストが大きい操作になる可能性があります。

fields プロジェクション

fieldsオプションは次のような形式のドキュメントを取ります：

{ field1: <value>, field2: <value> ... }

一意なインデックスを使用したアップサート

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

Andy という名前のドキュメントが存在せず、複数のクライアントがほぼ同時に次のコマンドを発行する例を考えます。

db.people.findAndModify(
   {
     query: { name: "Andy" },
     update: { $inc: { score: 1 } },
     upsert: true
   }
)

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

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

• 正確に 1 回のfindOneAndUpdate()操作で新しいドキュメントが正常に挿入されます。

• その他のfindOneAndUpdate()操作は、新しく挿入されたドキュメントを更新するか、一意なキーの競合が原因で失敗します。

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

  • ターゲット コレクションに一意なインデックスがあるため、重複キー エラーが発生。

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

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

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

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

  • 等価述語内のフィールドが、一意なインデックス キー パターン内のフィールドと一致。

  • 更新操作が、一意なインデックス キー パターン内のフィールドを変更しない。

次の表に示す upsert 操作の例では、キーの衝突が発生した場合に更新されるか失敗します。

{ name : 1 }

db.people.updateOne(
   { name: "Andy" },
   { $inc: { score: 1 } },
   { upsert: true }
)

{ name : 1 }

db.people.updateOne(
   { name: { $ne: "Joe" } },
   { $set: { name: "Andy" } },
   { upsert: true }
 )

{ name : 1 }

db.people.updateOne(
  { name: "Andy", email: "andy@xyz.com" },
  { $set: { active: false } },
  { upsert: true }
)

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

シャーディングされたコレクションでfindAndModifyを使用するには、

• 1つのシャードのみをターゲットにする場合は、query フィールドで部分的なシャードキーを使用できます。または

• query フィールドの完全なシャードキーに等価条件を指定できます。

• バージョン7.1以降では、クエリ仕様でシャードキーまたは_idフィールドを指定する必要がありません。

シャーディングされたコレクション内のドキュメントには、シャードキー フィールドがない場合があります。シャードキーがないドキュメントを対象とするには、null の等価一致を別のフィルター条件（_id フィールド上と同様に）と組み合わせて使用できます。例：

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

スキーマ検証

The db.collection.findAndModify() method adds support for the bypassDocumentValidation option, which lets you bypass schema validation when inserting or updating documents in a collection with validation rules.

update メソッドとの比較

ドキュメントを更新する場合の findAndModify() メソッドと updateOne() メソッドの動作は異なります。

• 更新条件に一致するドキュメントが複数ある場合、findAndModify() では、sort を指定することで、更新するドキュメントの選択に関して一定の制御が可能です。

  updateOne() は一致する最初のドキュメントを更新します。

• デフォルトでは、findAndModify()はドキュメントの変更前のバージョンを返します。更新されたドキュメントを取得するには、newオプションを使用します。

  updateOne() メソッドは、操作のステータスを含む WriteResult() オブジェクトを返します。

  更新されたドキュメントを返すには、find() メソッドを使用します。ただし、更新してからドキュメントを取得するまでの間に、他の更新によってドキュメントが変更される可能性があります。また、更新によって 1 つのドキュメントのみが変更されたが、複数のドキュメントが一致した場合は、更新されたドキュメントを識別するために追加のロジックを使用する必要があります。

1 つのドキュメントを変更する場合、findAndModify()メソッドと updateOne() メソッドの両方でドキュメントがアトミックに更新されます。これらのメソッドの相互作用と操作順序の詳細については、 「アトミック性とトランザクション」を参照してください。

トランザクション

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

Oplog エントリ

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

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

6.0 より前のバージョンの MongoDB では、シャーディングされたクラスターで findAndModify コマンドが実行され、シャード応答にエラーが含まれている場合、mongos は writeConcernError ドキュメントを破棄します。MongoDB 6.0 以降では、mongos は writeConcernError を返します。

更新と返却

次のメソッドは、クエリの条件に一致するドキュメントの people コレクション内の既存のドキュメントを更新して返します。

db.people.findAndModify({
    query: { name: "Tom", state: "active", rating: { $gt: 10 } },
    sort: { rating: 1 },
    update: { $inc: { score: 1 } }
})

このメソッドは、次のアクションを実行します。

1. query は、name フィールドの値が Tom、state フィールドの値が active、rating フィールドの値が greater than 10 であるドキュメントを people コレクション内で検索します。

2. sort は、クエリの結果を昇順に並べます。複数のドキュメントが query 条件を満たす場合、メソッドはこの sort の順序に従って最初のドキュメントを変更対象として選択します。

3. incrementsにより、scoreフィールドの値が 1 だけ更新されます。

4. このメソッドは元の（つまり 変更前の）このアップデート用に選択されたドキュメントを返します。

   {
     "_id" : ObjectId("50f1e2c99beb36a0f45c6453"),
     "name" : "Tom",
     "state" : "active",
     "rating" : 100,
     "score" : 5
   }

   更新されたドキュメントを返すには、メソッドにnew:trueオプションを追加します。

   query条件に一致するドキュメントがない場合、メソッドはnullを返します。

アップサート

次のメソッドには、update操作にupsert: trueのオプションが含まれおり、一致するドキュメントをアップデートするか、一致するドキュメントが存在しない場合は新しいドキュメントを作成します。

db.people.findAndModify({
    query: { name: "Gus", state: "active", rating: 100 },
    sort: { rating: 1 },
    update: { $inc: { score: 1 } },
    upsert: true
})

一致するドキュメントが見つかった場合、更新を実行します。

メソッドが一致するドキュメントを見つけられない場合、メソッドは新しいドキュメントを作成します。このメソッドには sort オプションが含まれていたため、元の（変更前の）ドキュメントとして空のドキュメント { } が返されます。

{ }

メソッドに sort オプションが含まれていない場合、メソッドは null を返します。

null

新しいドキュメントの返却

次のメソッドには、 upsert: trueオプションとnew:trueオプションの両方が含まれています。このメソッドは、一致するドキュメントを更新して更新されたドキュメントを返すか、一致するドキュメントが存在しない場合はドキュメントを挿入して value フィールドに新しく挿入されたドキュメントを返します。

次の例では、people コレクション内のどのドキュメントも query 条件に一致しません。

db.people.findAndModify({
    query: { name: "Pascal", state: "active", rating: 25 },
    sort: { rating: 1 },
    update: { $inc: { score: 1 } },
    upsert: true,
    new: true
})

このメソッドは、新しく挿入されたドキュメントを返します。

{
   "_id" : ObjectId("50f49ad6444c11ac2448a5d6"),
   "name" : "Pascal",
   "rating" : 25,
   "score" : 1,
   "state" : "active"
}

並べ替えと削除

次の例では、rating フィールドに sort 仕様を含めることで、state の値が active であり、一致するドキュメントの中で最も rating が低い 1 つのドキュメントを people コレクションから削除します。

db.people.findAndModify(
   {
     query: { state: "active" },
     sort: { rating: 1 },
     remove: true
   }
)

このメソッドは、削除されたドキュメントを返します。

{
   "_id" : ObjectId("52fba867ab5fdca1299674ad"),
   "name" : "XYZ123",
   "score" : 1,
   "state" : "active",
   "rating" : 3
}

照合の指定

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

コレクション myCollは、次のドキュメントを含みます。

{ _id: 1, category: "café", status: "A" }
{ _id: 2, category: "cafe", status: "a" }
{ _id: 3, category: "cafE", status: "a" }

次の操作には照合オプションが含まれます。

db.myColl.findAndModify({
    query: { category: "cafe", status: "a" },
    sort: { category: 1 },
    update: { $set: { status: "Updated" } },
    collation: { locale: "fr", strength: 1 }
});

この操作を実行すると次のドキュメントが返されます。

{ "_id" : 1, "category" : "café", "status" : "A" }

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

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

db.students.insertMany( [
   { "_id" : 1, "grades" : [ 95, 92, 90 ] },
   { "_id" : 2, "grades" : [ 98, 100, 102 ] },
   { "_id" : 3, "grades" : [ 95, 110, 100 ] }
] )

db.students.findAndModify({
   query: { grades: { $gte: 100 } },
   update: { $set: { "grades.$[element]" : 100 } },
   arrayFilters: [ { "element": { $gte: 100 } } ]
})

{ "_id" : 1, "grades" : [ 95, 92, 90 ] }
{ "_id" : 2, "grades" : [ 98, 100, 100 ] }
{ "_id" : 3, "grades" : [ 95, 110, 100 ] }

db.students2.insertMany( [
   {
      "_id" : 1,
      "grades" : [
         { "grade" : 80, "mean" : 75, "std" : 6 },
         { "grade" : 85, "mean" : 90, "std" : 4 },
         { "grade" : 85, "mean" : 85, "std" : 6 }
      ]
   },
   {
      "_id" : 2,
      "grades" : [
         { "grade" : 90, "mean" : 75, "std" : 6 },
         { "grade" : 87, "mean" : 90, "std" : 3 },
         { "grade" : 85, "mean" : 85, "std" : 4 }
      ]
   }
] )

db.students2.findAndModify({
   query: { _id : 1 },
   update: { $set: { "grades.$[elem].mean" : 100 } },
   arrayFilters: [ { "elem.grade": { $gte: 85 } } ]
})

{
   "_id" : 1,
   "grades" : [
      { "grade" : 80, "mean" : 75, "std" : 6 },
      { "grade" : 85, "mean" : 100, "std" : 4 },
      { "grade" : 85, "mean" : 100, "std" : 6 }
   ]
}
{
   "_id" : 2,
   "grades" : [
      { "grade" : 90, "mean" : 75, "std" : 6 },
      { "grade" : 87, "mean" : 90, "std" : 3 },
      { "grade" : 85, "mean" : 85, "std" : 4 }
   ]
}

更新に集計パイプラインを使用

db.collection.findAndModify() は、更新の集計パイプラインを受け入れることができます。このパイプラインには次のステージが含まれる可能性があります。

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

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

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

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

たとえば、次のドキュメントを含むコレクション students2 を作成します。

db.students2.insertMany( [
   {
      "_id" : 1,
      "grades" : [
         { "grade" : 80, "mean" : 75, "std" : 6 },
         { "grade" : 85, "mean" : 90, "std" : 4 },
         { "grade" : 85, "mean" : 85, "std" : 6 }
      ]
   },
   {
      "_id" : 2,
      "grades" : [
         { "grade" : 90, "mean" : 75, "std" : 6 },
         { "grade" : 87, "mean" : 90, "std" : 3 },
         { "grade" : 85, "mean" : 85, "std" : 4 }
      ]
   }
] )

次の操作では、_id フィールドが 1 に等しいドキュメントを検索し、集計パイプラインを使用して grades フィールドから新しいフィールド total を計算します。

db.students2.findAndModify( {
   query: {  "_id" : 1 },
   update: [ { $set: { "total" : { $sum: "$grades.grade" } } } ],  // The $set stage is an alias for ``$addFields`` stage
   new: true
} )

この操作は更新されたドキュメントを返します。

{
   "_id" : 1,
   "grades" : [ { "grade" : 80, "mean" : 75, "std" : 6 }, { "grade" : 85, "mean" : 90, "std" : 4 }, { "grade" : 85, "mean" : 85, "std" : 6 } ],
   "total" : 250
}

変数の使用 let

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

コレクション cakeFlavors を以下ように作成します。

db.cakeFlavors.insertMany( [
   { _id: 1, flavor: "chocolate" },
   { _id: 2, flavor: "strawberry" },
   { _id: 3, flavor: "cherry" }
] )

次の例では、let に targetFlavor 変数を定義し、その変数を使用してケーキのフレーバーをチェリーからオレンジに変更します。

db.cakeFlavors.findAndModify( {
   query: {
      $expr: { $eq: [ "$flavor", "$$targetFlavor" ] }
   },
   update: { flavor: "orange" },
   let: { targetFlavor: "cherry" }
} )

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

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 find and modify document
db.medical.findAndModify( {
   query:
      { $and: [
         {
            // Only update the document for Mary Smith
            patientName: { $eq: "Mary Smith" }
         },
         {
            // User must have the Provider role to perform the update
            $expr: { $ne: [ {
               $setIntersection: [ [ "Provider" ], "$$USER_ROLES.role" ]
            }, [] ] }
         }
      ]
   },
   // Update document
   update: {
      patientName: "Mary Smith",
      diagnosisCode: "ACH 03",
      creditCard: "6541-7534-9637-3456"
   }
} )

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

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

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

// Attempt to find and modify document
db.medical.findAndModify( {
   query:
      { $and: [
         {
            // Only update the document for Mary Smith
            patientName: { $eq: "Mary Smith" }
         },
         {
            // User must have the Provider role to perform the update
            $expr: { $ne: [ {
               $setIntersection: [ [ "Provider" ], "$$USER_ROLES.role" ]
            }, [] ] }
         }
      ]
   },
   // Update document
   update: {
      patientName: "Mary Smith",
      diagnosisCode: "ACH 03",
      creditCard: "6541-7534-9637-3456"
   }
} )

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