ドキュメントの変更

ドキュメントパターンの更新

MongoDB では、ドキュメントを変更するためのすべての方法は同じパターンに従います。

これらのメソッドは、次のパラメーターを取ります。

• 変更する 1 つ以上のドキュメントに一致するクエリフィルター

• フィールドと値の変更を指定する 更新ドキュメント

• （任意）メソッドのデフォルトの動作を変更するオプションの型

Rust ドライバーは、ドキュメントを変更するための次のメソッドを提供します。

• update_one()

• update_many()

• replace_one()

複合操作を使用すると、1 回のアクションでデータを検索して変更できます。 詳細については、複合演算子 に関するガイドを参照してください。

_id フィールド

MongoDB コレクション内の各ドキュメントには、一意かつ不変の_idフィールドがあります。 更新操作または置換操作を通じて_idフィールドを変更しようとすると、ドライバーはWriteErrorを発生させ、更新を実行しません。

パラメーター

各メソッドは、クエリフィルターと、少なくとも 1 つの更新演算子を含む更新ドキュメントを受け取ります。 更新演算子は、実行する更新のタイプを指定し、変更を説明するフィールドと値を含めます。 更新ドキュメントは、次の形式を使用します。

doc! { "<update operator>": doc! { "<field>": <value> } }

1 つの更新ドキュメントで複数の更新を指定するには、次の形式を使用します。

doc! {
    "<update operator>": doc!{"<field>": <value>},
    "<update operator>": doc!{"<field>": <value>},
    ...
}

更新演算子と説明の完全なリストについては、 MongoDBサーバーのマニュアルを参照してください。

更新操作にはUpdateOptionsパラメータも必要です。 更新メソッドの動作の変更の詳細については、このガイドの「更新と置換の動作の変更 」セクションを参照してください。

戻り値

操作が成功した場合、 update_one()メソッドとupdate_many()メソッドはUpdateResultタイプを返します。 UpdateResult型には、操作を記述する次のプロパティが含まれています。

UpdateOne()に渡すクエリフィルターに一致するドキュメントが複数ある場合、メソッドは最初に一致したドキュメントを選択してアップデートします。 クエリフィルターに一致するドキュメントがない場合、アップデート操作では変更は行われません。

更新例

次のドキュメントは、会社の従業員について説明しています。

{
  "_id": ObjectId('4337'),
  "name": "Shelley Olson",
  "department": "Marketing",
  "role": "Director",
  "bonus": 3000
},
{
  "_id": ObjectId('4902'),
  "name": "Remi Ibrahim",
  "department": "Marketing",
  "role": "Consultant",
  "bonus": 1800
}

この例では、 update_many()メソッドを使用してアップデート操作を実行しています。 update_many()メソッドは次のパラメータを取ります。

• departmentフィールドの値が"Marketing"であるドキュメントを一致させるクエリフィルター

• 次の更新を含む更新ドキュメント。

  • departmentの値を"Business Operations"に、 roleの値を"Analytics Specialist"に変更する$set演算子

  • bonusの値を500増やす$inc演算子

let update_doc = doc! {
        "$set": doc! { "department": "Business Operations",
                      "role": "Analytics Specialist" },
        "$inc": doc! { "bonus": 500 }
};
let res = my_coll
    .update_many(doc! { "department": "Marketing" }, update_doc, None)
    .await?;
println!("Modified documents: {}", res.modified_count);

Modified documents: 2

次のドキュメントは、前回の更新操作によって発生した変更を反映しています。

{
  "_id": ObjectId('4337'),
  "name": "Shelley Olson",
  "department": "Business Operations",
  "role": "Analytics Specialist",
  "bonus": 3500
},
{
  "_id": ObjectId('4902'),
  "name": "Remi Ibrahim",
  "department": "Business Operations",
  "role": "Analytics Specialist",
  "bonus": 2300
}

ObjectId による更新の例

次のドキュメントでは、会社の従業員について説明しています。

{
  "_id": ObjectId('4274'),
  "name": "Jill Millerton",
  "department": "Marketing",
  "role": "Consultant"
}

この例では、ドキュメントの一意の_id値に一致するクエリフィルターを指定して、前述のドキュメントをクエリします。 次に、コードはupdate_one()メソッドを使用して更新操作を実行します。 update_one()メソッドは次のパラメータを取ります。

• _idフィールドの値がObjectId('4274')であるドキュメントに一致するクエリフィルター

• nameの値を"Jill Gillison"に設定する手順を作成する更新ドキュメント

let id = ObjectId::from_str("4274").expect("Could not convert to ObjectId");
let filter_doc = doc! { "_id": id };
let update_doc = doc! {
        "$set": doc! { "name": "Jill Gillison" }
};
let res = my_coll
    .update_one(filter_doc, update_doc, None)
    .await?;
println!("Modified documents: {}", res.modified_count);

Modified documents: 1

次のドキュメントには、前述の更新操作によって発生した変更が反映されています。

{
  "_id": ObjectId('4274'),
  "name": "Jill Gillison",
  "department": "Marketing",
  "role": "Consultant"
}

パラメーター

replace_one()メソッドはクエリフィルターと置換ドキュメントを受け取ります。このドキュメントには、既存のドキュメントを置き換えるフィールドと値が含まれます。 置換ドキュメントは以下の形式を使用します。

doc! { "<field>": <value>, "<field>": <value>, ... }

置き換え操作にはUpdateOptionsパラメーターも必要です。 replace_one()メソッドの動作の変更の詳細については、このガイドの「更新と置換の動作の変更 」セクションを参照してください。

Return Values

操作が成功した場合、 replace_oneメソッドはUpdateResultタイプを返します。 UpdateResult型には、操作を説明する次のプロパティが含まれています。

replace_one()に渡したクエリフィルターに一致するドキュメントが複数ある場合、メソッドは最初に一致したドキュメントを選択して置き換えます。 クエリフィルターに一致するドキュメントがない場合、置換操作では変更は行われません。

置き換えの例

次のドキュメントでは、会社の従業員について説明しています。

{
  "_id": ObjectId('4501'),
  "name": "Matt DeGuy",
  "role": "Consultant",
  "team_members": [ "Jill Gillison", "Susan Lee" ]
}

この例では、 replace_one()メソッドを使用して、前のドキュメントを次のフィールドを持つドキュメントに置き換えます。

• "Susan Lee"のname値

• "Lead Consultant"のrole値

• [ "Jill Gillison" ]のteam_members値

let replace_doc = doc! {
    "name": "Susan Lee",
    "role": "Lead Consultant",
    "team_members": vec! [ "Jill Gillison" ]
};
let res = my_coll
    .replace_one(doc! { "name": "Matt DeGuy" }, replace_doc, None)
    .await?;
println!(
    "Matched documents: {}\nModified documents: {}",
    res.matched_count, res.modified_count
);

Matched documents: 1
Modified documents: 1

置換されたドキュメントには、置換ドキュメントの内容と不変の_idフィールドが含まれます。

{
  "_id": ObjectId('4501'),
  "name": "Susan Lee",
  "role": "Lead Consultant",
  "team_members": [ "Jill Gillison" ]
}

API ドキュメント

このガイドで言及されているメソッドとタイプの詳細については、次のAPIドキュメントを参照してください。

• update_one()

• update_many()

• UpdateResult

• UpdateOptions

• replace_one()

• ReplaceOptions

• WriteError