findAndModify

lastErrorObject

lastErrorObject 埋め込みドキュメントには、次のフィールドが含まれています。

value

remove 操作では、クエリがドキュメントと一致する場合、value には削除されたドキュメントが入ります。クエリが削除するドキュメントと一致しない場合、value には null が入ります。

update 操作の場合、value 埋め込みドキュメントには次の内容が含まれます。

• new パラメーターがセットされていないか、false の場合

  • クエリがドキュメントにマッチした場合、変更前のドキュメント。

  • それ以外の場合は、null。

• newがtrueの場合

  • クエリが一致を返した場合、更新されたドキュメント。

  • upsert: trueでクエリに一致するドキュメントがない場合、挿入されたドキュメント。

  • それ以外の場合は、null。

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

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

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

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

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

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

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

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

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

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

  • 更新操作が 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

ドキュメントの検証

findAndModifyコマンドはbypassDocumentValidationオプションのサポートを追加します。これにより、検証ルールを使用してコレクションにドキュメントを挿入または更新するときにドキュメント検証をバイパスできます。

メソッドとの比較<a class=\" \" href=\" \" title=\" \"><svg xmlns=\" \" width=\" \" height=\" \" fill=\" \" viewbox=\" \"update class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">

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

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

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

• デフォルトでは、findAndModify で、変更前のドキュメントと操作のステータスが含まれたオブジェクトが返されます。更新済みのドキュメントを取得するには、new オプションを使用します。

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

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

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

トランザクション

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

更新と返却

次のコマンドは、people コレクション内の既存のドキュメントで、ドキュメントが query 条件に一致するものを更新します。

db.runCommand(
   {
     findAndModify: "people",
     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. update は score フィールドの値を 1 ずつ increments します。

4. このコマンドは、次のフィールドを含むドキュメントを返します。

   • コマンドの詳細を含むlastErrorObjectフィールド（ trueであるフィールドupdatedExistingを含む）と

   • この更新で選択された元の（つまり、変更前の）ドキュメントを含む value 値フィールド

     {
       "lastErrorObject" : {
          "connectionId" : 1,
          "updatedExisting" : true,
          "n" : 1,
          "syncMillis" : 0,
          "writtenTo" : null,
          "err" : null,
          "ok" : 1
       },
       value" : {
         "_id" : ObjectId("54f62d2885e4be1f982b9c9c"),
         "name" : "Tom",
         "state" : "active",
         "rating" : 100,
         "score" : 5
       },
       "ok" : 1
     }

更新されたドキュメントを value フィールドに返すには、コマンドに new:true オプションを追加します。

query 条件に一致するドキュメントがない場合、コマンドは value フィールドに null を含むドキュメントを返します。

{ "value" : null, "ok" : 1 }

mongosh および多くのドライバーでは findAndModify() ヘルパー メソッドを提供します。シェルヘルパーを使用すると、前述の操作は次の形式になります。

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

ただし、findAndModify() シェルヘルパー メソッドは変更されていないドキュメントのみを返します。または、new が true の場合には、更新されたドキュメントを返します。

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

upsert: true

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

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

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

一致するドキュメントが見つからない場合、upsert: true の update 操作によって挿入が行われ、次のフィールドを含むドキュメントが返されます。

• コマンドの詳細を含む lastErrorObject フィールド（新しく挿入されたドキュメントの _id 値を含むフィールド upserted など）と

• null を含む value フィールド。

{
  "value" : null,
  "lastErrorObject" : {
     "updatedExisting" : false,
     "n" : 1,
     "upserted" : ObjectId("54f62c8bc85d4472eadea26f")
  },
  "ok" : 1
}

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

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

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

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

このコマンドは、value フィールドに新しく挿入されたドキュメントを返します。

{
  "lastErrorObject" : {
     "connectionId" : 1,
     "updatedExisting" : false,
     "upserted" : ObjectId("54f62bbfc85d4472eadea26d"),
     "n" : 1,
     "syncMillis" : 0,
     "writtenTo" : null,
     "err" : null,
     "ok" : 1
  },
  "value" : {
     "_id" : ObjectId("54f62bbfc85d4472eadea26d"),
     "name" : "Pascal",
     "rating" : 25,
     "state" : "active",
     "score" : 1
  },
  "ok" : 1
}

並べ替えと削除

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

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

このコマンドは、次のように、削除されたドキュメントを返します。

{
  "lastErrorObject" : {
     "connectionId" : 1,
     "n" : 1,
     "syncMillis" : 0,
     "writtenTo" : null,
     "err" : null,
     "ok" : 1
  },
  "value" : {
     "_id" : ObjectId("54f62a6785e4be1f982b9c9b"),
     "name" : "XYZ123",
     "score" : 1,
     "state" : "active",
     "rating" : 3
  },
  "ok" : 1
}

照合の指定

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

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

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

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

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

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

{
   "lastErrorObject" : {
      "updatedExisting" : true,
      "n" : 1
   },
   "value" : {
      "_id" : 1,
      "category" : "café",
      "status" : "A"
   },
   "ok" : 1
}

次を使用して配列更新操作を行います: arrayFilters

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

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

db.runCommand(
   {
     findAndModify: "students",
     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.runCommand(
   {
     findAndModify: "students2",
     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 }
   ]
}

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

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.runCommand(
   {
     findAndModify: "students2",
     query: {  "_id" : 1 },
     update: [ { $set: { "total" : { $sum: "$grades.grade" } } } ],
     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
}
{
   "_id" : 2,
   "grades" : [ { "grade" : 90, "mean" : 75, "std" : 6 }, { "grade" : 87, "mean" : 90, "std" : 3 }, { "grade" : 85, "mean" : 85,"std" : 4 } ]
}

操作での の指定<a class=\" \" href=\" \" title=\" \"><svg xmlns=\" \" width=\" \" height=\" \" fill=\" \" viewbox=\" \" class=\"hint findAndModify\" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">

mongosh で、次のドキュメントを含む members コレクションを作成します。

db.members.insertMany( [
   { "_id" : 1, "member" : "abc123", "status" : "P", "points" :  0,  "misc1" : null, "misc2" : null },
   { "_id" : 2, "member" : "xyz123", "status" : "A", "points" : 60,  "misc1" : "reminder: ping me at 100pts", "misc2" : "Some random comment" },
   { "_id" : 3, "member" : "lmn123", "status" : "P", "points" :  0,  "misc1" : null, "misc2" : null },
   { "_id" : 4, "member" : "pqr123", "status" : "D", "points" : 20,  "misc1" : "Deactivated", "misc2" : null },
   { "_id" : 5, "member" : "ijk123", "status" : "P", "points" :  0,  "misc1" : null, "misc2" : null },
   { "_id" : 6, "member" : "cde123", "status" : "A", "points" : 86,  "misc1" : "reminder: ping me at 100pts", "misc2" : "Some random comment" }
] )

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

db.members.createIndex( { status: 1 } )
db.members.createIndex( { points: 1 } )

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

db.runCommand({
   findAndModify: "members",
   query: { "points": { $lte: 20 }, "status": "P" },
   remove: true,
   hint: { status: 1 }
})

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

db.runCommand(
   {
     explain: {
       findAndModify: "members",
       query: { "points": { $lte: 20 }, "status": "P" },
       remove: true,
       hint: { status: 1 }
     },
     verbosity: "queryPlanner"
   }
)

変数の使用 let

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

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

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

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

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