db.collection.updateOne()

項目一覧

定義

互換性
構文
アクセス制御
動作
例

MongoDB とドライバー

このページでは、 mongosh メソッドについて説明します。MongoDB ドライバーで同等のメソッドを確認するには、ご使用のプログラミング言語の対応するページを参照してください。

C#Java Sync Node.js PyMongo C C++Go Java RS Kotlin Coroutine Kotlin Sync PHP Mongoid Rust Scala

定義

db.collection.updateOne(filter, update, options): フィルターに基づいてコレクション内の単一のドキュメントを更新します。

互換性

このメソッドは、次の環境でホストされている配置で使用できます。

MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージドサービスです

注意

このコマンドは、すべての MongoDB Atlas クラスターでサポートされています。すべてのコマンドに対する Atlas のサポートについては、「サポートされていないコマンド」を参照してください。

MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

構文

updateOne()メソッドの構文は次のとおりです。

db.collection.updateOne(
   <filter>,
   <update>,
   {
     upsert: <boolean>,
     writeConcern: <document>,
     collation: <document>,
     arrayFilters: [ <filterdocument1>, ... ],
     hint:  <document|string>,
     let: <document>,
     sort: <document>
   }
)

パラメーター

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

Parameter

タイプ

説明

フィルター

ドキュメント

更新の選択基準。find()メソッドと同じクエリセレクターを使用できます。

コレクション内で返される最初のドキュメントを更新するには、空のドキュメント { } を指定します。

update

ドキュメントまたはパイプライン

適用される変更内容。次のいずれかになります。

Update document	更新演算子式のみが含まれます。詳細については、「更新演算子式による更新」ドキュメントを参照してください
Aggregation Pipeline	次の集計ステージのみが含まれます。 `$addFields` およびそのエイリアス `$set` `$project` およびそのエイリアス `$unset` `$replaceRoot`とそのエイリアス`$replaceWith` 。詳細については、「集計パイプラインによる更新」を参照してください。

置き換えドキュメントを使用して更新するには、db.collection.replaceOne()を参照してください。

upsert

ブール値

任意。true の場合、updateOne() は次のいずれかになります。

filter に一致するドキュメントがない場合は、新しいドキュメントを作成します。詳しくは、「アップサートの動作」を参照してください。
filter に一致する 1 つのドキュメントをアップデートします。

複数のアップサートを回避するため、filterフィールドが一意にインデックスされていることを確認します。

デフォルトは false で、一致するものが見つからなくても新しいドキュメントは挿入されません。

writeConcern

ドキュメント

任意。書込み保証（write concern）を表現するドキュメント。デフォルトの書込み保証を使用する場合は省略します。

トランザクションで実行される場合、操作の書込み保証 (write concern)を明示的に設定しないでください。トランザクションで書込み保証を使用するには、「トランザクション書込み保証」を参照してください。

collation

ドキュメント

任意。

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

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

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

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

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

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

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

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

arrayFilters

配列

任意。配列フィールドの更新操作でどの配列要素を変更するかを決定するフィルタードキュメントの配列。

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

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

アップデートドキュメントには同じ識別子を複数回含めることができます。ただし、アップデートドキュメント内の個別の識別子 ($[identifier]) それぞれに対し、対応する配列フィルタードキュメントを 1 つだけ指定する必要があります。つまり、同じ識別子に対して複数の配列フィルタードキュメントを指定することはできません。たとえば、アップデートステートメントに識別子 x が（場合によっては複数回）含まれている場合、x に 2 つの個別のフィルタ　ドキュメントを含む arrayFilters に対して、次のように指定することはできません。

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

例については、「配列更新操作にを指定する」を参照してください。arrayFilters

hint

ドキュメントまたは文字列

任意。クエリ述語をサポートするために使用するインデックスを指定するドキュメントまたは string です。

このオプションには、インデックス仕様ドキュメントまたはインデックス名の文字列を指定できます。

存在しないインデックスを指定した場合、操作はエラーになります。

例については、「 hint更新操作でのの指定」を参照してください。

let

ドキュメント

任意。

変数のリストを含むドキュメントを指定します。これにより、変数をクエリテキストから分離することで、コマンドの読みやすさを向上させることができます。

ドキュメントの構文は次のとおりです。

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

変数は式によって返された値に設定され、その後は変更できません。

コマンド内の変数の値にアクセスするには、二重ドル記号の接頭辞（$$）を $$<variable_name> 形式にした変数名とともに使用します。たとえば次のとおりです。$$targetTotal

結果のフィルタリングに変数を使用するには、$expr 演算子内の変数にアクセスする必要があります。

letと変数を使用した例については、let 変数を使用した更新を参照してください。

sort

ドキュメント

任意。

クエリで複数のドキュメントが選択された場合に、その操作で更新するドキュメントを決定します。updateOne は、この引数で指定されたソート順で、最初のドキュメントを更新します。

ソート引数がドキュメントでない場合、操作はエラーになります。

MongoDB では、コレクション内のドキュメントを特定の順序で保存することはありません。重複する値を含むフィールドでソートする場合、それらの値を含むドキュメントは任意の順序で返されます。

一貫したソート順序が必要な場合は、一意の値を含むフィールドを少なくとも 1 つ含めてソートしてください。これを保証する最も簡単な方法は、_idフィールドをソートのクエリに含めることです。

詳細については、「ソートの整合性」を参照してください。

バージョン8.0の新機能。

戻り値

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

matchedCount 一致したドキュメントの数を含みます
modifiedCount 変更されたドキュメントの数を含みます
upsertedId 、アップサートされたドキュメントの _id が含まれる
upsertedCount アップサートされた文書の数を含む
操作が書き込み保証付きで実行された場合はブール値acknowledged（true ）、書き込み保証が無効になっている場合はfalseになります

アクセス制御

authorizationを使用して実行されている配置では、ユーザーには次の特権を含むアクセス権が必要です。

update 指定したコレクションに対するアクション。
find 指定したコレクションに対するアクション。
insert 操作の結果がアップサートになる場合、指定されたコレクションに対して実行されるアクション。

組み込みロール readWrite は必要な特権を提供します。

動作

単一ドキュメントの更新

db.collection.updateOne() はフィルターに一致する最初のドキュメントを検索し、指定された更新の変更を適用します。

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

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

以下に例を挙げます。

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

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

db.collection.updateOne() メソッドでは、集計パイプライン [ <stage1>, <stage2>, ... ] を受け入れて、実行する変更を指定できます。このパイプラインには次のステージが含まれる可能性があります。

$addFields およびそのエイリアス $set
$project およびそのエイリアス $unset
$replaceRootとそのエイリアス$replaceWith 。

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

以下に例を挙げます。

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

注意

パイプライン内で使用される $set と $unset は、集計ステージの$set と $unset をそれぞれ示しており、アップデートの演算子の$set と$unset ではありません。

例については、「集計パイプラインによる更新」を参照してください。

アップサート

MongoDB 7.1以降では、シャーディングされたコレクションでupsert: trueを指定する場合、フィルターに完全なシャードキーを含める必要はありません。
upsert: true で、filter に一致するドキュメントがない場合、db.collection.updateOne() では filter 条件と update の変更に基づいて新しいドキュメントが作成されます。詳細については、「アップサートによる更新」を参照してください。
シャーディングされたコレクションにおける追加のdb.collection.updateOne()動作については、シャーディングされたコレクションを参照してください。

上限付きコレクション

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

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

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

シャーディングされたコレクションでdb.collection.updateOne()を使用するには、次の手順に従います。

MongoDB 7.1以降では、シャーディングされたコレクションでupsert: trueを指定する場合、フィルターに完全なシャードキーを含める必要はありません。
upsert: trueを指定しない場合は、 _idフィールドに完全一致を含めるか、単一のシャードをターゲットにする（フィルターにシャードキーを含めるなど）必要があります。

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

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

シャードキーの変更

シャードキーフィールドが不変の _id フィールドでない限り、ドキュメントのシャードキー値を更新できます。

警告

シャーディングされたコレクション内のドキュメントには、シャードキーフィールドがないことがあります。ドキュメントのシャードキーの値を変更するときに、誤ってシャードキーを削除しないように注意してください。

既存のシャードキー値をdb.collection.updateOne()で変更するには

必ず mongos 上で使用します。シャードに直接操作を実行しないでください。
トランザクション内で、または再試行可能な書き込みとして実行する必要があります。
完全なシャードキーに等価フィルターを含める必要があります。

「シャーディングされたコレクションの upsert」も参照してください。

欠落しているシャードキー

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

シャーディングされたコレクション内のドキュメントには、シャードキーフィールドがないことがあります。db.collection.updateOne() を使って欠落しているシャードキーを設定するには、mongos で実行する必要があります。この操作を直接シャード上で実行しないでください。

さらに、次の要件も適用されます。

タスク	要件
設定するには `null`	`upsert: true`の場合は、シャードキー全体に等価フィルターが必要です。
`null`以外の値に設定するには	トランザクション内で、または再試行可能な書き込みとして実行する必要があります。 `upsert: true`の場合は、シャードキー全体に等価フィルターが必要です。

Tip

欠落しているキー値は NULL 等価一致の一部として返されるため、NULL 値のキーが更新されないように、必要に応じて追加のクエリ条件（_id フィールドなど）を追加します。

以下も参照してください。

説明可能性

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

トランザクション

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

重要

ほとんどの場合、分散トランザクションでは 1 つのドキュメントの書き込み (write) よりもパフォーマンスコストが高くなります。分散トランザクションの可用性は、効果的なスキーマ設計の代わりにはなりません。多くのシナリオにおいて、非正規化されたデータモデル（埋め込みドキュメントと配列）が引き続きデータやユースケースに最適です。つまり、多くのシナリオにおいて、データを適切にモデリングすることで、分散トランザクションの必要性を最小限に抑えることができます。

トランザクションの使用に関するその他の考慮事項（ランタイム制限や oplog サイズ制限など）については、「本番環境での考慮事項」も参照してください。

トランザクション内のアップサート

トランザクションがクロスシャード間書き込みトランザクション（write transaction）でない場合に、分散トランザクション内にコレクションとインデックスを作成できます。

db.collection.updateOne() と upsert: trueは、既存のコレクションまたは存在しないコレクションで実行できます。存在しないコレクションに対して実行すると、操作によってコレクションが作成されます。

Tip

以下も参照してください。

トランザクション内でのコレクションとインデックスの作成

書込み保証とトランザクション

Oplog エントリ

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

例

更新演算子式を使用して更新

restaurant コレクションには次のドキュメントが含まれます。

{ "_id" : 1, "name" : "Central Perk Cafe", "Borough" : "Manhattan" },
{ "_id" : 2, "name" : "Rock A Feller Bar and Grill", "Borough" : "Queens", "violations" : 2 },
{ "_id" : 3, "name" : "Empire State Pub", "Borough" : "Brooklyn", "violations" : 0 }

次の操作は、 name: "Central Perk Cafe"がviolationsフィールドで単一のドキュメントを更新します。

try {
   db.restaurant.updateOne(
      { "name" : "Central Perk Cafe" },
      { $set: { "violations" : 3 } }
   );
} catch (e) {
   print(e);
}

この操作では以下が返されます。

{ "acknowledged" : true, "matchedCount" : 1, "modifiedCount" : 1 }

一致するものが見つからなかった場合、以下の結果が返されます。

{ "acknowledged" : true, "matchedCount" : 0, "modifiedCount" : 0 }

upsert: trueを設定すると、一致するものが見つからない場合にはドキュメントが挿入されます。「アップサートによる更新」を参照してください。

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

db.collection.updateOne()は、更新に集計パイプラインを使用できます。パイプラインは、次のステージで設定できます。

$addFields およびそのエイリアス $set
$project およびそのエイリアス $unset
$replaceRootとそのエイリアス$replaceWith 。

例 1

次の例では、集計パイプラインを使用して、ドキュメント内の他のフィールドの値を使用してフィールドを変更します。

次のドキュメントを使用して students コレクションを作成します。

db.students.insertMany( [
   { "_id" : 1, "student" : "Skye", "points" : 75, "commentsSemester1" : "great at math", "commentsSemester2" : "loses temper", "lastUpdate" : ISODate("2019-01-01T00:00:00Z") },
   { "_id" : 2, "student" : "Elizabeth", "points" : 60, "commentsSemester1" : "well behaved", "commentsSemester2" : "needs improvement", "lastUpdate" : ISODate("2019-01-01T00:00:00Z") }
] )

最初のドキュメントで commentsSemester1 フィールドと commentsSemester2 フィールドを分ける代わりに、2 番目のドキュメントのように comments フィールドにまとめたいと仮定します。次の更新操作では、集計パイプラインを使用して操作を行います。

新しいcommentsフィールドを追加し、 lastUpdateフィールドを設定します。
コレクション内にあるすべてのドキュメントのcommentsSemester1フィールドとcommentsSemester2フィールドを削除します。

Update コマンドのフィルターが一意のドキュメントをターゲットにしていることを確認してください。以下のコードの id フィールドは、そのようなフィルターの例です。

db.students.updateOne(
   { _id: 1 },
   [
      { $set: { status: "Modified", comments: [ "$commentsSemester1", "$commentsSemester2" ], lastUpdate: "$$NOW" } },
      { $unset: [ "commentsSemester1", "commentsSemester2" ] }
   ]
)

注意

第 1 ステージ

$set段階:

新しい配列フィールドcommentsを作成します。その要素としてmisc1フィールドとmisc2フィールドの現在の内容を含めます。
フィールドlastUpdateを集計変数NOWの値に設定します。集計変数 NOW は現在の日時値に変換され、パイプライン全体で維持されます。集計変数にアクセスするには、変数の前に二重ドル記号$$を付け、引用符で囲みます。

第 2 ステージ

$unsetステージでは、 commentsSemester1フィールドとcommentsSemester2フィールドが削除されます。

コマンドの実行後、コレクションには次のドキュメントが含まれます。

{ "_id" : 2, "student" : "Elizabeth", "status" : "Modified", "points" : 60, "lastUpdate" : ISODate("2020-01-23T05:11:45.784Z"), "comments" : [ "well behaved", "needs improvement" ] }
{ _id: 1, student: 'Skye', points: 75, commentsSemester1: 'great at math', commentsSemester2: 'loses temper', lastUpdate: ISODate("2019-01-01T00:00:00.000Z") }

ソートを導入すると、ソート順で最初に見つかったドキュメントのみが変更され、残りのドキュメントはそのままにされることに注意してください。

例 2

集計パイプラインを使用すると、現在のフィールド値に基づく条件付きアップデートを実行したり、アップデート時に別個のフィールド値の計算に現在のフィールド値を使用することができます。

たとえば、以下のドキュメントでstudents3コレクションを作成する場合、

db.students3.insertMany( [
   { "_id" : 1, "tests" : [ 95, 92, 90 ], "average" : 92, "grade" : "A", "lastUpdate" : ISODate("2020-01-23T05:18:40.013Z") },
   { "_id" : 2, "tests" : [ 94, 88, 90 ], "average" : 91, "grade" : "A", "lastUpdate" : ISODate("2020-01-23T05:18:40.013Z") },
   { "_id" : 3, "tests" : [ 70, 75, 82 ], "lastUpdate" : ISODate("2019-01-01T00:00:00Z") }
] )

3 番目のドキュメント_id: 3には、 averageフィールドとgradeフィールドがありません。集計パイプラインを使用して、計算された成績の平均およびレターグレードでドキュメントを更新することができます。

db.students3.updateOne(
   { _id: 3 },
   [
     { $set: { average: { $trunc: [  { $avg: "$tests" }, 0 ] }, lastUpdate: "$$NOW" } },
     { $set: { grade: { $switch: {
                           branches: [
                               { case: { $gte: [ "$average", 90 ] }, then: "A" },
                               { case: { $gte: [ "$average", 80 ] }, then: "B" },
                               { case: { $gte: [ "$average", 70 ] }, then: "C" },
                               { case: { $gte: [ "$average", 60 ] }, then: "D" }
                           ],
                           default: "F"
     } } } }
   ]
)

注意

パイプラインで使用される$setは、アップデートオペレーターの $set ではなく、集計ステージ $setを参照します。

第 1 ステージ

$set段階:

testsフィールドの平均に基づいて新しいフィールドaverageを計算します。$avg集計演算子の詳細については$avgを参照してください。 $trunc切り捨て集計演算子の詳細については$truncを参照してください。
フィールドlastUpdateを集計変数NOWの値に設定します。集計変数 NOW は現在の日時値に変換され、パイプライン全体で維持されます。集計変数にアクセスするには、変数の前に二重ドル記号$$を付け、引用符で囲みます。

第 2 ステージ

$setステージでは、前のステージで計算されたaverageフィールドに基づいて新しいフィールドgradeが計算されます。集計演算子 $switch の詳細については、$switch を参照してください。

コマンドの実行後、コレクションには次のドキュメントが含まれます。

{ "_id" : 1, "tests" : [ 95, 92, 90 ], "average" : 92, "grade" : "A", "lastUpdate" : ISODate("2020-01-23T05:18:40.013Z") }
{ "_id" : 2, "tests" : [ 94, 88, 90 ], "average" : 91, "grade" : "A", "lastUpdate" : ISODate("2020-01-23T05:18:40.013Z") }
{ "_id" : 3, "tests" : [ 70, 75, 82 ], "lastUpdate" : ISODate("2020-01-24T17:33:30.674Z"), "average" : 75, "grade" : "C" }

Tip

以下も参照してください。

集計パイプラインの更新

アップサートによる更新

restaurant コレクションには次のドキュメントが含まれます。

{ "_id" : 1, "name" : "Central Perk Cafe", "Borough" : "Manhattan", "violations" : 3 },
{ "_id" : 2, "name" : "Rock A Feller Bar and Grill", "Borough" : "Queens", "violations" : 2 },
{ "_id" : 3, "name" : "Empire State Pub", "Borough" : "Brooklyn", "violations" : "0" }

次の操作は、upsert: trueの間にname : "Pizza Rat's Pizzaria"を使用してドキュメントを更新しようとしています。

try {
   db.restaurant.updateOne(
      { "name" : "Pizza Rat's Pizzaria" },
      { $set: {"_id" : 4, "violations" : 7, "borough" : "Manhattan" } },
      { upsert: true }
   );
} catch (e) {
   print(e);
}

upsert:trueなので、ドキュメントはfilterおよびupdate基準に基づいてinsertedになります。この操作では以下を返します。

{
   "acknowledged" : true,
   "matchedCount" : 0,
   "modifiedCount" : 0,
   "upsertedId" : 4,
   "upsertedCount": 1
}

コレクションには、次のドキュメントが含まれています。

{ "_id" : 1, "name" : "Central Perk Cafe", "Borough" : "Manhattan", "violations" : 3 },
{ "_id" : 2, "name" : "Rock A Feller Bar and Grill", "Borough" : "Queens", "violations" : 2 },
{ "_id" : 3, "name" : "Empire State Pub", "Borough" : "Brooklyn", "violations" : 4 },
{ "_id" : 4, "name" : "Pizza Rat's Pizzaria", "Borough" : "Manhattan", "violations" : 7 }

name フィールドは filter 基準を使用して入力され、update 演算子を使用してドキュメントの残りの部分が作成されました。

次の操作では、10より大きいviolationsを持つ最初のドキュメントを更新します。

try {
   db.restaurant.updateOne(
      { "violations" : { $gt: 10} },
      { $set: { "Closed" : true } },
      { upsert: true }
   );
} catch (e) {
   print(e);
}

この操作では以下が返されます。

{
   "acknowledged" : true,
   "matchedCount" : 0,
   "modifiedCount" : 0,
   "upsertedId" : ObjectId("56310c3c0c5cbb6031cafaea")
}

コレクションには、次のドキュメントが含まれています。

{ "_id" : 1, "name" : "Central Perk Cafe", "Borough" : "Manhattan", "violations" : 3 },
{ "_id" : 2, "name" : "Rock A Feller Bar and Grill", "Borough" : "Queens", "violations" : 2 },
{ "_id" : 3, "name" : "Empire State Pub", "Borough" : "Brooklyn", "violations" : 4 },
{ "_id" : 4, "name" : "Pizza Rat's Pizzaria", "Borough" : "Manhattan", "grade" : 7 }
{ "_id" : ObjectId("56310c3c0c5cbb6031cafaea"), "Closed" : true }

フィルターに一致するドキュメントがなく、 upsertがtrueであったため、 updateOne()は生成された_idとupdate条件のみを持つドキュメントを挿入しました。

書き込み保証による更新

3 つのノードからなるレプリカセットがある場合、次の操作では majority を w と、100 を wtimeout と指定します。

try {
   db.restaurant.updateOne(
       { "name" : "Pizza Rat's Pizzaria" },
       { $inc: { "violations" : 3}, $set: { "Closed" : true } },
       { w: "majority", wtimeout: 100 }
   );
} catch (e) {
   print(e);
}

プライマリと少なくとも 1 つのセカンダリが 100 ミリ秒以内に各書き込み操作を確認すると、次の値が返されます。

{ "acknowledged" : true, "matchedCount" : 1, "modifiedCount" : 1 }

承認に wtimeout 制限時間を超える時間がかかると、次の例外が発生します。

WriteConcernError({
   "code" : 64,
   "errmsg" : "waiting for replication timed out",
   "errInfo" : {
     "wtimeout" : true,
     "writeConcern" : {
       "w" : "majority",
       "wtimeout" : 100,
       "provenance" : "getLastErrorDefaults"
     }
   }
})

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

出所	説明
`clientSupplied`	書き込み保証（write concern）がアプリケーションで指定されました。
`customDefault`	書込み保証 (write concern) は、カスタム定義されたデフォルト値に基づきます。`setDefaultRWConcern` を参照してください。
`getLastErrorDefaults`	書込み保証 (write concern) は、レプリカセットの `settings.getLastErrorDefaults` のフィールドに基づきます。
`implicitDefault`	他の書き込み保証（write concern）が一切指定されていない状態で、サーバーから発生した書き込み保証。

ソートによる更新

バージョン8.0の新機能。

次の例では、評価が最も低いアクティブなユーザーを無効化します。

db.people.updateOne(
   { state: "active" },
   { $set: { state: "inactive" } },
   { sort: { rating: 1 }
)

照合の指定

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

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

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

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

db.myColl.updateOne(
   { category: "cafe" },
   { $set: { status: "Updated" } },
   { collation: { locale: "fr", strength: 1 } }
);

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

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

`arrayFilters` 条件に一致する要素を更新する

次のドキュメントを使用してコレクション students を作成します。

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

grades配列にある100以上の要素をすべて変更するには、フィルタリングされた位置演算子$[<identifier>]をdb.collection.updateOne()メソッドでarrayFiltersオプションとともに使用します。

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

この操作により 1 つのドキュメントの grades フィールドが更新され、操作後にコレクションには次のドキュメントが含まれます。

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

ドキュメントの配列の特定の要素を更新する

次のドキュメントを使用してコレクション 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 }
      ]
   }
] )

grades 配列のすべての要素のうち、グレードが 85 以上のもので mean フィールドの値を変更するには、フィルタリングされた位置演算子 $[<identifier>] を arrayFilters とともに、db.collection.updateOne() メソッドで使用します。

db.students2.updateOne(
   { },
   { $set: { "grades.$[elem].mean" : 100 } },
   { arrayFilters: [ { "elem.grade": { $gte: 85 } } ] }
)

この操作により 1 つのドキュメントの配列が更新され、操作後にコレクションには次のドキュメントが含まれます。

{
   "_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 }
   ]
}

更新操作に `hint` を指定する

次のドキュメントを使用してサンプルstudents コレクションを作成します。

db.students.insertMany( [
   { "_id" : 1, "student" : "Richard", "grade" : "F", "points" :  0,  "comments1" : null, "comments2" : null },
   { "_id" : 2, "student" : "Jane", "grade" : "A", "points" : 60,  "comments1" : "well behaved", "comments2" : "fantastic student" },
   { "_id" : 3, "student" : "Ronan", "grade" : "F", "points" :  0,  "comments1" : null, "comments2" : null },
   { "_id" : 4, "student" : "Noah", "grade" : "D", "points" : 20,  "comments1" : "needs improvement", "comments2" : null },
   { "_id" : 5, "student" : "Adam", "grade" : "F", "points" :  0,  "comments1" : null, "comments2" : null },
   { "_id" : 6, "student" : "Henry", "grade" : "A", "points" : 86,  "comments1" : "fantastic student", "comments2" : "well behaved" }
] )

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

db.students.createIndex( { grade: 1 } )
db.students.createIndex( { points: 1 } )

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

注意

存在しないインデックスを指定した場合、操作はエラーになります。

db.students.updateOne(
   { "points": { $lte: 20 }, "grade": "F" },
   { $set: { "comments1": "failed class" } },
   { hint: { grade: 1 } }
)

update コマンドは次を返します。

{ "acknowledged" : true, "matchedCount" : 1, "modifiedCount" : 1 }

注意

3 つのドキュメントが更新の基準に一致しているにもかかわらず、updateOneは、最初に見つけたドキュメントのみを変更します。したがって、リチャード、ロナン、アダムのすべての学生が基準を満たしていても、リチャードだけが更新されます。

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

db.students.explain().update(
   { "points": { $lte: 20 }, "grade": "F" },
   { $set: { "comments1": "failed class" } },
   { multi: true, hint: { grade: 1 } }
)

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

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

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

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

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

James Billing ロールの使用
Michelle Provider ロールの使用

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

ロールの作成

必要な権限とリソースを持つ Billing および 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: [ ] } )

ユーザーの作成

必要なロールを持つ James および Michelle という名前のユーザーを作成します。

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 としてログインし、更新を実行します。

次の名前でログイン: `Michelle`

実行:

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

更新の実行

実行:

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

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

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

次の名前でログイン: `James`

実行:

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

更新の試行

実行:

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

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

Tip

以下も参照してください。

複数のドキュメントを更新する方法については、db.collection.updateMany()を参照してください。

戻る

db.collection.updateMany

db.collection.validate

定義

互換性

注意

構文

パラメーター

戻り値

アクセス制御

動作

単一ドキュメントの更新

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

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

注意

アップサート

上限付きコレクション

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

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

シャードキーの変更

警告

欠落しているシャードキー

Tip

説明可能性

トランザクション

重要

トランザクション内のアップサート

Tip

以下も参照してください。

書込み保証とトランザクション

Oplog エントリ

例

更新演算子式を使用して更新

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

例 1

注意

例 2

注意

Tip

以下も参照してください。

アップサートによる更新

書き込み保証による更新

ソートによる更新

照合の指定

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

arrayFilters 条件に一致する要素を更新する

ドキュメントの配列の特定の要素を更新する

更新操作に hint を指定する

注意

注意

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

ロールの作成

ユーザーの作成

コレクションの作成

次の名前でログイン: Michelle

更新の実行

次の名前でログイン: James

更新の試行

Tip

以下も参照してください。

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

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

`arrayFilters` 条件に一致する要素を更新する

更新操作に `hint` を指定する

次の名前でログイン: `Michelle`

次の名前でログイン: `James`