Docs Menu
Docs Home
/
MongoDBマニュアル
/
集計操作
/
参照
/
ステージ

$set（集計）

項目一覧

  • 定義
  • 互換性
  • 構文
  • 動作
  • 例

定義

注意

曖昧さ回避

次のページでは、集計ステージ $setについて説明しています。 更新演算子 $setについて詳しくは、 $setを参照してください。

$set

ドキュメントに新しいフィールドを追加します。$set は、入力ドキュメントの既存の全フィールドと、新しく追加されたフィールドを含むドキュメントを出力します。

$setステージは$addFieldsのエイリアスです。

どちらのステージも、入力ドキュメント内の既存のフィールドをすべて明示的に指定し、新しいフィールドを追加する $project ステージと同等です。

互換性

次の環境でホストされる配置には $set を使用できます。

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

  • MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

  • MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

構文

$set の形式は次のとおりです。

{ $set: { <newField>: <expression>, ... } }

追加する各フィールドの名前を指定し、その値を集計式または空のオブジェクトに設定します。式の詳細については、「式演算子」を参照してください。

重要

新しいフィールドの名前が既存のフィールド名（_id など）と同じ場合、$set はそのフィールドの既存の値を、指定された式の値で上書きします。

動作

  • $setは既存のドキュメントに新しいフィールドを追加します。 集計操作には、1 つ以上の$setステージを含めることができます。

  • $set は、集計式または空のオブジェクトに値を設定できるオブジェクトの埋め込みを受け入れます。たとえば、以下のようなネストされたオブジェクトを受け入れられます。

    {$set: { a: { b: { } } } }

    埋め込みドキュメント (配列内のドキュメントを含む) に 1 つまたは複数のフィールドを追加するには、ドット表記を使用します。 例 を参照してください。

  • $set を使用して既存の配列フィールドに要素を追加するには、$concatArrays を使用します。例を参照してください。

例

2 つの$set ステージを使用します

次のように、サンプル scores コレクションを作成します。

db.scores.insertMany( [
   { _id: 1, student: "Maya", homework: [ 10, 5, 10 ], quiz: [ 10, 8 ], extraCredit: 0 },
   { _id: 2, student: "Ryan", homework: [ 5, 6, 5 ], quiz: [ 8, 8 ], extraCredit: 8 }
] )

次の操作では、2 つの$setステージを使用して、出力ドキュメントに 3 つの新しいフィールドを含めます。

db.scores.aggregate( [
   {
     $set: {
        totalHomework: { $sum: "$homework" },
        totalQuiz: { $sum: "$quiz" }
     }
   },
   {
     $set: {
        totalScore: { $add: [ "$totalHomework", "$totalQuiz", "$extraCredit" ] } }
   }
] )

この操作により、次のドキュメントが返されます。

[
   {
      _id: 1,
      student: "Maya",
      homework: [ 10, 5, 10 ],
      quiz: [ 10, 8 ],
      extraCredit: 0,
      totalHomework: 25,
      totalQuiz: 18,
      totalScore: 43
   },
   {
      _id: 2,
      student: "Ryan",
      homework: [ 5, 6, 5 ],
      quiz: [ 8, 8 ],
      extraCredit: 8,
      totalHomework: 16,
      totalQuiz: 16,
      totalScore: 40
   }
]

埋め込みドキュメントへのフィールドの追加

埋め込みドキュメントに新しいフィールドを追加するには、ドット表記を使用します。

次のように、サンプル コレクション vehicles を作成します。

db.vehicles.insertMany( [
   { _id: 1, type: "car", specs: { doors: 4, wheels: 4 } },
   { _id: 2, type: "motorcycle", specs: { doors: 0, wheels: 2 } },
   { _id: 3, type: "jet ski" }
] )

次の集計操作は、埋め込みドキュメント specs に新しいフィールド fuel_type を追加します。

db.vehicles.aggregate( [
   { $set: { "specs.fuel_type": "unleaded" } }
] )

この操作は次の結果を返します。

[
   { _id: 1, type: "car", specs: { doors: 4, wheels: 4, fuel_type: "unleaded" } },
   { _id: 2, type: "motorcycle", specs: { doors: 0, wheels: 2, fuel_type: "unleaded" } },
   { _id: 3, type: "jet ski", specs: { fuel_type: "unleaded" } }
]

既存のフィールドの上書き

$set操作で既存のフィールド名を指定すると、元のフィールドが置き換えられます。

次のように、animals というサンプル コレクションを作成します。

db.animals.insertOne( { _id: 1, dogs: 10, cats: 15 } )

次の$set操作はcatsフィールドを上書きします。

db.animals.aggregate( [
  { $set: { cats: 20 } }
] )

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

[ { _id: 1, dogs: 10, cats: 20 } ]

あるフィールドを別のフィールドで置き換えることができます。次の例では、_id フィールドの代わりに item フィールドを使用します。

次のドキュメントを含む fruits というサンプル コレクションを作成します。

db.fruits.insertMany( [
   { _id: 1, item: "tangerine", type: "citrus" },
   { _id: 2, item: "lemon", type: "citrus" },
   { _id: 3, item: "grapefruit", type: "citrus" }
] )

次の集計操作では、$set を使用して各ドキュメントの _id フィールドを item フィールドの値に置き換え、item フィールドを文字列 "fruit" に置き換えます。

db.fruits.aggregate( [
  { $set: { _id: "$item", item: "fruit" } }
] )

この操作では、以下を返します。

[
   { _id: "tangerine", item: "fruit", type: "citrus" },
   { _id: "lemon", item: "fruit", type: "citrus" },
   { _id: "grapefruit", item: "fruit", type: "citrus" }
]

配列への要素の追加

次のように、サンプル scores コレクションを作成します。

db.scores.insertMany( [
   { _id: 1, student: "Maya", homework: [ 10, 5, 10 ], quiz: [ 10, 8 ], extraCredit: 0 },
   { _id: 2, student: "Ryan", homework: [ 5, 6, 5 ], quiz: [ 8, 8 ], extraCredit: 8 }
] )

$setと$concatArrays式を併用して、既存の配列フィールドに要素を追加できます。 たとえば、次の操作では、 $setを使用して、 homeworkフィールドを、現在のhomework配列が新しいスコア[ 7 ]を含む別の配列に連結されている新しい配列に置き換えます。

db.scores.aggregate( [
   { $match: { _id: 1 } },
   { $set: { homework: { $concatArrays: [ "$homework", [ 7 ] ] } } }
] )

この操作では、以下を返します。

[ { _id: 1, student: "Maya", homework: [ 10, 5, 10, 7 ], quiz: [ 10, 8 ], extraCredit: 0 } ]

既存のフィールドを使用した新しいフィールドの作成

次のように、サンプル scores コレクションを作成します。

db.scores.insertMany( [
   { _id: 1, student: "Maya", homework: [ 10, 5, 10 ], quiz: [ 10, 8 ], extraCredit: 0 },
   { _id: 2, student: "Ryan", homework: [ 5, 6, 5 ], quiz: [ 8, 8 ], extraCredit: 8 }
] )

次の集計操作では、quiz 配列の平均値を含む各ドキュメントに新しいフィールド quizAverage を追加します。

db.scores.aggregate( [
   {
      $set: {
         quizAverage: { $avg: "$quiz" }
      }
   }
] )

この操作により、次のドキュメントが返されます。

[
   {
      _id: 1,
      student: 'Maya',
      homework: [ 10, 5, 10 ],
      quiz: [ 10, 8 ],
      extraCredit: 0,
      quizAverage: 9
   },
   {
      _id: 2,
      student: 'Ryan',
      homework: [ 5, 6, 5 ],
      quiz: [ 8, 8 ],
      extraCredit: 8,
      quizAverage: 8
   }
]

戻る

$searchMeta

次へ

$setWindowFields