ウィンドウの境界サポートされているウィンドウ演算子例 (MongoDB シェル)コードの例

$setWindowFields

バージョン 8.0.2 の新機能。

Amazon DocumentDB の$setWindowFieldsステージは、パーティション内のドキュメント (ウィンドウ) の指定されたスパンに対してオペレーションを実行し、選択したウィンドウ演算子に基づいて結果を返します。ステージは入力ドキュメントをパーティションにグループ化し、オプションでソートし、ドキュメントごとに周囲のドキュメントのウィンドウで 1 つ以上の出力フィールドを計算します。

[Syntax] (構文)


{
  $setWindowFields: {
    partitionBy: <expression>,
    sortBy: { <sortField1>: <sortOrder>, ... },
    output: {
      <outputField1>: {
        <windowOperator>: <expression>,
        window: {
          documents: [ <lowerBound>, <upperBound> ],
          range: [ <lowerBound>, <upperBound> ],
          unit: <time unit>
        }
      },
      ...
    }
  }
}

パラメータ

partitionBy: オプション。ドキュメントをパーティションにグループ化するために使用される単一の式。これは、フィールドパス ( など"$state") または別の式にすることができます。省略すると、すべての入力ドキュメントは 1 つのパーティションに属します。
sortBy: オプション。各パーティションのドキュメントをソートするフィールドを{ <field>: 1 }昇順または{ <field>: -1 }降順で指定するドキュメント。ドキュメントベースまたは範囲ベースのウィンドウ境界を使用する場合、およびランク付け演算子のいずれかを使用する場合、 sortByが必要です。
output: 必須。各ドキュメントに追加するフィールドを指定するドキュメント。複数の出力フィールドを指定できますが、各出力フィールドには、ウィンドウの境界を定義するウィンドウ演算子、引数、およびオプションのwindowドキュメントが 1 つだけ含まれます{ <field>: { <windowOperator>: <expression>, window: { ... } } }。

ウィンドウの境界

各outputフィールド内では、オプションでwindowドキュメントを使用してウィンドウの境界を定義できます。ウィンドウは、ドキュメントの位置または値の範囲によって定義できます。

documents: ウィンドウを、現在のドキュメントの前後のドキュメントの数として形式で指定します[ <lowerBound>, <upperBound> ]。各境界は整数オフセット (例: -1 または 2)、またはキーワードの 1 つ "unbounded"およびです"current"。は、下限として使用する場合はパーティションの先頭に、上限として使用する場合はパーティションの末尾にウィンドウ"unbounded"を拡張します。は現在のドキュメント"current"を意味します。両方の境界が sortByでない限り、documentsウィンドウにはが必要です"unbounded"。
range: ウィンドウを現在のドキュメントに対するsortByフィールド値の範囲として形式で指定します[ <lowerBound>, <upperBound> ]。各バインドは、現在のドキュメントsortByの値、または"unbounded"キーワードに追加された数値です。range ウィンドウには 1 つの昇順sortByフィールドのみが必要で、"current"キーワードを受け入れません。
unit: オプション。とともに使用rangeして、数値ウィンドウの境界を、sortByフィールドが日付値を保持する期間として解釈します。Amazon DocumentDB は、、"year"、、"quarter""month"、"week"、、"day"、"hour""minute""second"およびの単位をサポートしています"millisecond"。unit を指定する場合、range境界は整数である必要があります。

window ドキュメントを省略すると、デフォルトのウィンドウはでdocuments: ["unbounded", "unbounded"]、パーティション全体に及びます。

注記

日付の値を超えるrangeウィンドウを使用する場合は、カレンダーに依存する長さがあいまいなウィンドウ境界を生成する可能性がある "month"、"quarter"、またはではなく"year"、 "day" (またはそれより小さい) unitなどの固定期間を使用することをお勧めします。

サポートされているウィンドウ演算子

Amazon DocumentDB は、$setWindowFieldsステージの outputフィールドで次の 26 個のウィンドウ演算子をサポートしています。

$sum
$avg
$count
$push
$addToSet
$stdDevPop
$stdDevSamp
$covariancePop
$covarianceSamp
$first
$last
$firstN
$lastN
$top
$bottom
$topN
$bottomN
$min
$minN
$max
$maxN
$median
$percentile
$rank
$denseRank
$documentNumber

注記

$rand 演算子は、$setWindowFieldsステージのウィンドウ演算子内ではサポートされていません。

空のウィンドウ

ウィンドウにドキュメントが含まれていない場合 (範囲の値がないrangeウィンドウなど）、結果は演算子によって異なります。 $count およびは 0、$push、、$addToSet、$firstN、$lastN$minN、 $maxN$sumを返し$topN、空の配列$bottomNを返します。 $percentile はnull値の配列を返します (リクエストされたパーセンタイルごとに 1 つ）。他のすべての演算子はを返しますnull。

例 (MongoDB シェル)

次の例ではregion、ドキュメントをでパーティション化し、各パーティションをでソートしday、パーティションの開始revenueから現在のドキュメントまでのの累計を計算します。

サンプルドキュメントを作成する


db.sales.insertMany([
  { _id: 1, region: "east", day: 1, revenue: 100 },
  { _id: 2, region: "east", day: 2, revenue: 150 },
  { _id: 3, region: "east", day: 3, revenue: 120 },
  { _id: 4, region: "west", day: 1, revenue: 200 },
  { _id: 5, region: "west", day: 2, revenue: 180 }
]);

クエリの例


db.sales.aggregate([
  {
    $setWindowFields: {
      partitionBy: "$region",
      sortBy: { day: 1 },
      output: {
        runningRevenue: {
          $sum: "$revenue",
          window: { documents: ["unbounded", "current"] }
        }
      }
    }
  }
]);

出力


[
  { "_id": 1, "region": "east", "day": 1, "revenue": 100, "runningRevenue": 100 },
  { "_id": 2, "region": "east", "day": 2, "revenue": 150, "runningRevenue": 250 },
  { "_id": 3, "region": "east", "day": 3, "revenue": 120, "runningRevenue": 370 },
  { "_id": 4, "region": "west", "day": 1, "revenue": 200, "runningRevenue": 200 },
  { "_id": 5, "region": "west", "day": 2, "revenue": 180, "runningRevenue": 380 }
]

各ドキュメントはrunningRevenue、現在のドキュメントまでのパーティションrevenue内のの累積合計であるで拡張されます。

コードの例

$setWindowFields ステージを使用するためのコード例を表示するには、使用する言語のタブを選択します。

Node.js


const { MongoClient } = require('mongodb');

async function example() {
  const client = new MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false');

  try {
    await client.connect();
    const db = client.db('test');
    const sales = db.collection('sales');

    await sales.insertMany([
      { _id: 1, region: "east", day: 1, revenue: 100 },
      { _id: 2, region: "east", day: 2, revenue: 150 },
      { _id: 3, region: "east", day: 3, revenue: 120 },
      { _id: 4, region: "west", day: 1, revenue: 200 },
      { _id: 5, region: "west", day: 2, revenue: 180 }
    ]);

    const result = await sales.aggregate([
      {
        $setWindowFields: {
          partitionBy: "$region",
          sortBy: { day: 1 },
          output: {
            runningRevenue: {
              $sum: "$revenue",
              window: { documents: ["unbounded", "current"] }
            }
          }
        }
      }
    ]).toArray();

    console.log(result);
  } finally {
    await client.close();
  }
}

example();

Python


from pymongo import MongoClient

def example():
    client = MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false')

    try:
        db = client['test']
        sales = db['sales']

        sales.insert_many([
            { '_id': 1, 'region': 'east', 'day': 1, 'revenue': 100 },
            { '_id': 2, 'region': 'east', 'day': 2, 'revenue': 150 },
            { '_id': 3, 'region': 'east', 'day': 3, 'revenue': 120 },
            { '_id': 4, 'region': 'west', 'day': 1, 'revenue': 200 },
            { '_id': 5, 'region': 'west', 'day': 2, 'revenue': 180 }
        ])

        result = list(sales.aggregate([
            {
                '$setWindowFields': {
                    'partitionBy': '$region',
                    'sortBy': { 'day': 1 },
                    'output': {
                        'runningRevenue': {
                            '$sum': '$revenue',
                            'window': { 'documents': ['unbounded', 'current'] }
                        }
                    }
                }
            }
        ]))

        print(result)
    finally:
        client.close()

example()

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

$setUnion

$sigmoid