$getField

$getField演算子は、ドキュメントから指定したフィールドの値を取得するために使用されます。 動的なフィールド名を使用する場合や、集計パイプライン内でプログラムによってフィールドにアクセスする必要がある場合に便利です。

構文

{
  $getField: {
    field: <string>,
    input: <document>
  }
}

または、短縮形の構文を次に示します。

{
  $getField: <string>
}

パラメーター

パラメーター	Description
field	取得するフィールドの名前を表す文字列。
input	フィールドの取得元のドキュメント。 指定しない場合は、既定で現在のドキュメント ($$ROOT) が使用されます。

例示

stores コレクションのこのサンプル ドキュメントについて考えてみましょう。

{
    "_id": "0fcc0bf0-ed18-4ab8-b558-9848e18058f4",
    "name": "First Up Consultants | Beverage Shop - Satterfieldmouth",
    "location": {
        "lat": -89.2384,
        "lon": -46.4012
    },
    "staff": {
        "totalStaff": {
            "fullTime": 8,
            "partTime": 20
        }
    },
    "sales": {
        "totalSales": 75670,
        "salesByCategory": [
            {
                "categoryName": "Wine Accessories",
                "totalSales": 34440
            },
            {
                "categoryName": "Bitters",
                "totalSales": 39496
            },
            {
                "categoryName": "Rum",
                "totalSales": 1734
            }
        ]
    },
    "promotionEvents": [
        {
            "eventName": "Unbeatable Bargain Bash",
            "promotionalDates": {
                "startDate": {
                    "Year": 2024,
                    "Month": 6,
                    "Day": 23
                },
                "endDate": {
                    "Year": 2024,
                    "Month": 7,
                    "Day": 2
                }
            },
            "discounts": [
                {
                    "categoryName": "Whiskey",
                    "discountPercentage": 7
                },
                {
                    "categoryName": "Bitters",
                    "discountPercentage": 15
                },
                {
                    "categoryName": "Brandy",
                    "discountPercentage": 8
                },
                {
                    "categoryName": "Sports Drinks",
                    "discountPercentage": 22
                },
                {
                    "categoryName": "Vodka",
                    "discountPercentage": 19
                }
            ]
        },
        {
            "eventName": "Steal of a Deal Days",
            "promotionalDates": {
                "startDate": {
                    "Year": 2024,
                    "Month": 9,
                    "Day": 21
                },
                "endDate": {
                    "Year": 2024,
                    "Month": 9,
                    "Day": 29
                }
            },
            "discounts": [
                {
                    "categoryName": "Organic Wine",
                    "discountPercentage": 19
                },
                {
                    "categoryName": "White Wine",
                    "discountPercentage": 20
                },
                {
                    "categoryName": "Sparkling Wine",
                    "discountPercentage": 19
                },
                {
                    "categoryName": "Whiskey",
                    "discountPercentage": 17
                },
                {
                    "categoryName": "Vodka",
                    "discountPercentage": 23
                }
            ]
        }
    ]
}

例 1: 基本的なフィールドの取得

$getFieldを使用して売上の合計値を取得します。

db.stores.aggregate([
  { $match: {"_id": "2cf3f885-9962-4b67-a172-aa9039e9ae2f"} },
  {
    $project: {
      name: 1,
      totalSalesValue: {
        $getField: {
          field: "totalSales",
          input: "$sales"
        }
      }
    }
  }
])

このクエリは、次の結果を返します。

[
  {
    "_id": "2cf3f885-9962-4b67-a172-aa9039e9ae2f",
    "name": "First Up Consultants | Bed and Bath Center - South Amir",
    "totalSalesValue": 37701
  }
]

例 2: 短縮形構文

ストア名を取得するには、短縮構文を使用します。

db.stores.aggregate([
  { $match: {"_id": "2cf3f885-9962-4b67-a172-aa9039e9ae2f"} },
  {
    $project: {
      storeName: { $getField: "name" },
      storeLocation: { $getField: "location" }
    }
  }
])

このクエリは、次の結果を返します。

[
  {
    "_id": "2cf3f885-9962-4b67-a172-aa9039e9ae2f",
    "storeName": "First Up Consultants | Bed and Bath Center - South Amir",
    "storeLocation": {
      "lat": 60.7954,
      "lon": -142.0012
    }
  }
]