マテリアライズドビューを使用した Atlas Search クエリの実行方法

項目一覧

purchaseOrdersコレクションの作成

予定されたトリガーを作成する
マテリアライズドビューでの Atlas Search インデックスの作成
マテリアライズドビューでのクエリの実行

このチュートリアルでは、インデックスを作成し、サンプルデータセットの sample_supplies.sales コレクションと新しい sample_supplies.purchaseOrders に対してクエリを実行する方法について説明します。

オンデマンドのマテリアライズドビューは、 $merge集計パイプラインステージを使用して作成および更新するコレクションです。マテリアライズドビューで Atlas Search インデックスを作成し、 $search集計パイプラインステージを使用してマテリアライズドビューでクエリを実行できます。

このチュートリアルでは、次の手順について説明します。

sample_suppliesデータベースにpurchaseOrdersという名前のコレクションを作成します。
予定されたトリガーを 2 つ作成する。
- updateMonthlySales は、サンプル sample_supplies.sales コレクションのデータを使用して monthlyPhoneTransactions のマテリアライズドビューを初期化する updateMonthlySales という関数です。
- updateMonthlyPurchaseOrders は、sample_supplies.purchaseOrders コレクションのデータを使用して monthlyPhoneTransactions のマテリアライズドビューを更新する updateMonthlyPurchaseOrders という関数です。
monthlyPhoneTransactionsのマテリアライズドビューに Atlas Search インデックスを作成します。
monthlyPhoneTransactionsのマテリアライズドビューでクエリを実行します。

開始する前に、Atlas クラスターが前提条件に記載されている要件を満たしていることを確認してください。

Atlas Search インデックスを作成するには、プロジェクトに対するProject Data Access Admin以上のアクセス権が必要です。

トリガーを作成するには、プロジェクトに対して Project Owner 以上のアクセス権が必要です。

`purchaseOrders` コレクションの作成

`sample_supplies` データベースに接続します。

ターミナルウィンドウで mongosh を開き、クラスターに接続します。接続の詳細な手順については、「mongosh で接続」を参照してください。
sample_suppliesデータベースを使用します。
```
use sample_supplies
```

新しいコレクションを追加します。

2018年 1 月からの新しいデバイスの購入注文データを含むpurchaseOrdersコレクションを追加します。次のコマンドを実行します。

db.purchaseOrders.insertMany( [
  {
    saleDate: ISODate("2018-01-23T21:06:49.506Z"),
    items: [
      {
        name: 'printer paper',
        tags: [ 'office', 'stationary' ],
        price: Decimal128("40.01"),
        quantity: 2
      },
      {
        name: 'notepad',
        tags: [ 'office', 'writing', 'school' ],
        price: Decimal128("35.29"),
        quantity: 2
      },
      {
        name: 'pens',
        tags: [ 'writing', 'office', 'school', 'stationary' ],
        price: Decimal128("56.12"),
        quantity: 5
      },
      {
        name: 'backpack',
        tags: [ 'school', 'travel', 'kids' ],
        price: Decimal128("77.71"),
        quantity: 2
      },
      {
        name: 'notepad',
        tags: [ 'office', 'writing', 'school' ],
        price: Decimal128("18.47"),
        quantity: 2
      },
      {
        name: 'envelopes',
        tags: [ 'stationary', 'office', 'general' ],
        price: Decimal128("19.95"),
        quantity: 8
      },
      {
        name: 'envelopes',
        tags: [ 'stationary', 'office', 'general' ],
        price: Decimal128("8.08"),
        quantity: 3
      },
      {
        name: 'binder',
        tags: [ 'school', 'general', 'organization' ],
        price: Decimal128("14.16"),
        quantity: 3
      }
    ],
    storeLocation: 'Denver',
    customer: {
      gender: 'M',
      age: 42,
      email: 'cauho@witwuta.sv',
      satisfaction: 4
    },
    couponUsed: true,
    purchaseMethod: 'Phone'
  }
])

db.purchaseOrders.insertMany( [
  {
    saleDate: ISODate("2018-01-25T10:01:02.918Z"),
    items: [
      {
        name: 'envelopes',
        tags: [ 'stationary', 'office', 'general' ],
        price: Decimal128("8.05"),
        quantity: 10
      },
      {
        name: 'binder',
        tags: [ 'school', 'general', 'organization' ],
        price: Decimal128("28.31"),
        quantity: 9
      },
      {
        name: 'notepad',
        tags: [ 'office', 'writing', 'school' ],
        price: Decimal128("20.95"),
        quantity: 3
      },
      {
        name: 'laptop',
        tags: [ 'electronics', 'school', 'office' ],
        price: Decimal128("866.5"),
        quantity: 4
      },
      {
        name: 'notepad',
        tags: [ 'office', 'writing', 'school' ],
        price: Decimal128("33.09"),
        quantity: 4
      },
      {
        name: 'printer paper',
        tags: [ 'office', 'stationary' ],
        price: Decimal128("37.55"),
        quantity: 1
      },
      {
        name: 'backpack',
        tags: [ 'school', 'travel', 'kids' ],
        price: Decimal128("83.28"),
        quantity: 2
      },
      {
        name: 'pens',
        tags: [ 'writing', 'office', 'school', 'stationary' ],
        price: Decimal128("42.9"),
        quantity: 4
      },
      {
        name: 'envelopes',
        tags: [ 'stationary', 'office', 'general' ],
        price: Decimal128("16.68"),
        quantity: 2
      }
    ],
    storeLocation: 'Seattle',
    customer: { gender: 'M', age: 50, email: 'keecade@hem.uy', satisfaction: 5 },
    couponUsed: false,
    purchaseMethod: 'Phone'
  }
])

新しいコレクションをクエリします。

新しい購入注文エントリを確認するには、 purchaseOrdersコレクションをクエリします。

db.purchaseOrders.find().sort( {saleDate: -1} )

{
  _id: ObjectId("62434c07d574cd0ce200ba75"),
  saleDate: ISODate("2018-01-25T10:01:02.918Z"),
  items: [
    {
      name: 'envelopes',
      tags: [ 'stationary', 'office', 'general' ],
      price: Decimal128("8.05"),
      quantity: 10
    },
    {
      name: 'binder',
      tags: [ 'school', 'general', 'organization' ],
      price: Decimal128("28.31"),
      quantity: 9
    },
    {
      name: 'notepad',
      tags: [ 'office', 'writing', 'school' ],
      price: Decimal128("20.95"),
      quantity: 3
    },
    {
      name: 'laptop',
      tags: [ 'electronics', 'school', 'office' ],
      price: Decimal128("866.5"),
      quantity: 4
    },
    {
      name: 'notepad',
      tags: [ 'office', 'writing', 'school' ],
      price: Decimal128("33.09"),
      quantity: 4
    },
    {
      name: 'printer paper',
      tags: [ 'office', 'stationary' ],
      price: Decimal128("37.55"),
      quantity: 1
    },
    {
      name: 'backpack',
      tags: [ 'school', 'travel', 'kids' ],
      price: Decimal128("83.28"),
      quantity: 2
    },
    {
      name: 'pens',
      tags: [ 'writing', 'office', 'school', 'stationary' ],
      price: Decimal128("42.9"),
      quantity: 4
    },
    {
      name: 'envelopes',
      tags: [ 'stationary', 'office', 'general' ],
      price: Decimal128("16.68"),
      quantity: 2
    }
  ],
  storeLocation: 'Seattle',
  customer: {
    gender: 'M',
    age: 50,
    email: 'keecade@hem.uy',
    satisfaction: 5
  },
  couponUsed: false,
  purchaseMethod: 'Phone'
},
{
  _id: ObjectId("62434c07d574cd0ce200ba74"),
  saleDate: ISODate("2018-01-23T21:06:49.506Z"),
  items: [
    {
      name: 'printer paper',
      tags: [ 'office', 'stationary' ],
      price: Decimal128("40.01"),
      quantity: 2
    },
    {
      name: 'notepad',
      tags: [ 'office', 'writing', 'school' ],
      price: Decimal128("35.29"),
      quantity: 2
    },
    {
      name: 'pens',
      tags: [ 'writing', 'office', 'school', 'stationary' ],
      price: Decimal128("56.12"),
      quantity: 5
    },
    {
      name: 'backpack',
      tags: [ 'school', 'travel', 'kids' ],
      price: Decimal128("77.71"),
      quantity: 2
    },
    {
      name: 'notepad',
      tags: [ 'office', 'writing', 'school' ],
      price: Decimal128("18.47"),
      quantity: 2
    },
    {
      name: 'envelopes',
      tags: [ 'stationary', 'office', 'general' ],
      price: Decimal128("19.95"),
      quantity: 8
    },
    {
      name: 'envelopes',
      tags: [ 'stationary', 'office', 'general' ],
      price: Decimal128("8.08"),
      quantity: 3
    },
    {
      name: 'binder',
      tags: [ 'school', 'general', 'organization' ],
      price: Decimal128("14.16"),
      quantity: 3
    }
  ],
  storeLocation: 'Denver',
  customer: {
    gender: 'M',
    age: 42,
    email: 'cauho@witwuta.sv',
    satisfaction: 4
  },
  couponUsed: true,
  purchaseMethod: 'Phone'
}

2 つのクエリ結果は、発注データが2018の 1 月に終了することを反映しています。

予定されたトリガーを作成する

次の手順では、マテリアライズドビューを作成するトリガーを作成し、マテリアライズドビューを毎日更新する関数をスケジュールします。

`updateMonthlySales` トリガーの作成

手順

Atlas Atlasで、プロジェクトの {0 ページにGoします。GoTriggers

まだ表示されていない場合は、プロジェクトを含む組織をナビゲーションバーの Organizations メニューで選択します。
まだ表示されていない場合は、ナビゲーションバーの Projects メニューからプロジェクトを選択します。
サイドバーで、 Services見出しの下のTriggersをクリックします。
Triggersページが表示されます。

Add a Triggerをクリックして、trigger 構成ページを開きます。

trigger の構成値を入力します。

UI フィールド名	構成
Trigger Type	Scheduled を選択します。
Name	`updateMonthlySales` を指定します。
Schedule Type	Basic を選択します。 Repeat once byで [ `Day of the Month`を選択し、値を希望する日付に設定します。あるいは、テスト目的で、 Repeat once byドロップダウンをより頻繁に発生するように設定します（ MinuteやHourなど）。
Select An Event Type	Function を選択します。

関数を作成する

この trigger の関数は、累積月間売上情報を含む monthlyPhoneTransactions マテリアライズドビューを定義します。電話で行われた販売の月次売上情報を更新する関数です。

次のコードを関数に貼り付けます。

exports = function(){
   var pipeline = [
     { $match: {purchaseMethod: "Phone"} },
     { $unwind: {path: "$items"}},
     { $group: {
      _id: { $dateToString:
      { format: "%Y-%m", date: "$saleDate" } },
      sales_quantity: { $sum: "$items.quantity"},
      sales_price: { $sum: "$items.price"}
     }},
     { $set: { sales_price: { $toDouble: "$sales_price"}}},
     { $merge: { into: "monthlyPhoneTransactions", whenMatched: "replace" } }
   ]
   var monthlyPhoneTransactions = context.services.get("mongodb-atlas").db("sample_supplies").collection("sales");
   return monthlyPhoneTransactions.aggregate(pipeline);
};

この関数は、次の集計パイプラインステージを使用してmonthlyPhoneTransactionsを更新します。

$matchステージではデータがフィルタリングされ、 Phone中に完了した販売のみが処理されます。
$group ステージでは、売上情報が年月別にグループ化されます。このステージでは、次の形式のドキュメントを出力します。
```
{ "_id" : "<YYYY-mm>", "sales_quantity" : <num>, "sales_amount" : <NumberDecimal> }
```
$setステージでは、 sales_priceフィールドのデータ型がdoubleに変更されます。 Atlas Search $search演算子はDecimal128データ型をサポートしていません。 sales_priceフィールドのデータ型を変更すると、Atlas Search インデックスを使用してこのフィールドをクエリできるようになります。
$mergeステージは出力をmonthlyPhoneTransactionsコレクションに書き込みます。
このステージでは、_id フィールドに基づいて、集計結果内のドキュメントがコレクション内の既存のドキュメントと一致するかどうかが確認されます。
- Atlas Search が一致を見つけた場合（つまり、同じ年月を持つドキュメントがコレクション内に既に存在する場合）、Atlas Search はステージで指定された集計結果のドキュメントに既存のドキュメントが置き換えられます。
- Atlas Search で一致するものが見つからなかった場合、Atlas Search は集計結果から、ドキュメントをステージで指定されたコレクションに挿入します。

関数をテストする。

Function Editorの右下隅にあるRunボタンをクリックして、 monthlyPhoneTransactionsマテリアライズドビューを作成します。

Function Editor の下部にある Result タブは、関数の実行状態を反映します。[Save Draft] をクリックします。

`updateMonthlyPurchaseOrders` トリガーの作成

手順

AtlasGoTriggersAtlas で、プロジェクトのページにGoします。

まだ表示されていない場合は、プロジェクトを含む組織をナビゲーションバーの Organizations メニューで選択します。
まだ表示されていない場合は、ナビゲーションバーの Projects メニューからプロジェクトを選択します。
サイドバーで、 Services見出しの下のTriggersをクリックします。
Triggersページが表示されます。

Add a Triggerをクリックして、trigger 構成ページを開きます。

trigger の構成値を入力します。

UI フィールド名	構成
Trigger Type	Scheduled を選択します。
Name	`updateMonthlySales` を指定します。
Schedule Type	Basic を選択します。 Repeat once byで [ `Day of the Month`を選択し、値を希望する日付に設定します。あるいは、テスト目的で、 Repeat once byドロップダウンをより頻繁に発生するように設定します（ MinuteやHourなど）

関数を作成する

`updateMonthlyPurchaseOrders` 関数の仕組み

updateMonthlyPurchaseOrders 関数は、monthlyPhoneTransactions のマテリアライズド・ビューに月次の累積購買発注情報を追加します。この関数は、電話で行われた購買発注の月次購買発注情報を更新します。次の例では、関数を定義しています。

exports = function(){
   var pipeline = [
     { $match: {purchaseMethod: "Phone"} },
     { $unwind: {path: "$items"}},
     { $group: {
      _id: { $dateToString:
      { format: "%Y-%m", date: "$saleDate" } },
      sales_quantity: { $sum: "$items.quantity"},
      sales_price: { $sum: "$items.price"}
     }},
     { $set: { sales_price: { $toDouble: "$sales_price"}}},
     { $merge: { into: "monthlyPhoneTransactions", whenMatched: "replace" } }
   ]
   var monthlyPhoneTransactions = context.services.get("mongodb-atlas").db("sample_supplies").collection("purchaseOrders");
   return monthlyPhoneTransactions.aggregate(pipeline);
};

updateMonthlyPurchaseOrders 関数は、updateMonthlySales 関数と同じ集計パイプラインステージを使用して monthlyPhoneTransactions を更新します。

関数をテストする。

Function Editorの右下隅にあるRunボタンをクリックして、 monthlyPhoneTransactionsのマテリアライズドビューを更新します。

Function Editor の下部にある Result タブは、関数の実行状態を反映します。

updateMonthlyPurchaseOrders関数は、 monthlyPhoneTransactionsのマテリアライズドビューを 1 月の2018の発注データで更新します。

[Save] をクリックします。

`Sales-App` アプリケーションドラフトを確認して配置します。

mongosh を使用して monthlyPhoneTransactions コレクションをクエリし、更新を確認する。

db.monthlyPhoneTransactions.find().sort( { _id: -1} )

{
  _id: '2018-01',
  sales_quantity: 66,
  sales_price: Decimal128("1407.10")
}

monthlyPhoneTransactionsのマテリアライズドビューには新しく追加されたデータが表示されます。上位の結果は、最新のトランザクションが 1 月2018に実行されたことを反映しています。

`Sales-App` アプリケーションドラフトを確認して配置します。

マテリアライズドビューでの Atlas Search インデックスの作成

monthlyPhoneTransactionsコレクションに Atlas Search インデックスを作成します。

AtlasGoClustersAtlas で、プロジェクトのページにGoします。

まだ表示されていない場合は、希望するプロジェクトを含む組織を選択しますナビゲーションバーのOrganizationsメニュー
まだ表示されていない場合は、ナビゲーションバーのProjectsメニューから目的のプロジェクトを選択します。
まだ表示されていない場合は、サイドバーの [Clusters] をクリックします。
[ Clusters （クラスター） ] ページが表示されます。

GoAtlas Searchクラスターのページにします。

GoAtlas Searchページには、サイドバー、Data Explorer 、またはクラスターの詳細ページからできます。

サイドバーで、 Services見出しの下のAtlas Searchをクリックします。
[ Select data sourceドロップダウンからクラスターを選択し、[ Go to Atlas Search ] をクリックします。
Atlas Searchページが表示されます。

クラスターの [Browse Collections] ボタンをクリックします。
データベースを展開し、コレクションを選択します。
コレクションのSearch Indexesタブをクリックします。
Atlas Searchページが表示されます。

クラスタの名前をクリックします。
[Atlas Search] タブをクリックします。
Atlas Searchページが表示されます。

クリック Create Search Index

[Visual Editor] を選択し、[Next] をクリックします。

Index Name を入力し、Database and Collection を設定します。

Index NameフィールドにmonthlyPhoneTransactionsと入力します。
Database and Collectionセクションで、 sample_suppliesデータベースを検索し、 monthlyPhoneTransactionsコレクションを選択します。
[Next] をクリックします。

デフォルトの Atlas Search インデックス構成設定を確認します。

[Create Search Index] をクリックします。

[You're All Set!] モーダルウィンドウを閉じます。

インデックスが作成中であることを知らせるモーダルウィンドウが表示されます。Close ボタンをクリックします。

ステータスを確認します。

新規作成したインデックスは Atlas Search タブに表示されます。インデックスを作成する間、Status フィールドには Building と表示されます。インデックスの作成が完了すると、Status フィールドの表示は Active になります。

注意

コレクションが大きいほど、インデックスの作成に時間がかかります。インデックスの作成が完了すると、メール通知が届きます。

マテリアライズドビューでのクエリの実行

新しくアップデートされ、インデックスが作成されたmonthlyPhoneTransactionsコレクションに対してクエリを実行します。

`mongosh` 内のクラスターに接続します。

ターミナルウィンドウでmongoshを開き、クラスターに接続します。接続の詳細な手順については、「 mongosh経由での接続」を参照してください。

`sample_supplies` データベースを使用します。

mongoshプロンプトで次のコマンドを実行します。

use sample_supplies

`sample_supplies.monthlyPhoneTransactions` コレクションに対して簡単な Atlas Search クエリを実行します。

次のクエリは、合計売上額が10000ドル以上の MongoDBTransactions の月数をカウントします。

db.monthlyPhoneTransactions.aggregate([
  {
      $search: {
          "index": "monthlySalesIndex",
          "range": {
              "gt": 10000,
              "path": ["sales_price"]
          }
      }
  },
  {
    $count: 'months_w_over_10000'
  },
])

上記のクエリでは4が返されます。これは、 monthlyPhoneTransactionsマテリアライズドビューのすべての月のうち4か月のみが合計売上額が10000ドル以上であったことを示します。この結果は、sample_supplies.sales sample_supplies.purchaseOrdersコレクションとコレクションの両方のデータを反映しています。

集計パイプラインの完全なドキュメントについては、 MongoDB Server マニュアルを参照してください。

戻る

コレクション全体

$lookup と $search

purchaseOrders コレクションの作成

sample_supplies データベースに接続します。

新しい コレクションを追加します。

新しいコレクションをクエリします。

予定されたトリガーを作成する

updateMonthlySales トリガーの作成

手順

Atlas Atlasで、プロジェクトの {0 ページにGoします。Go.css-h15tq0{font-style:normal;font-weight:700;}Triggers

Add a Triggerをクリックして、trigger 構成ページを開きます。

trigger の構成値を入力します。

関数を作成する

関数をテストする。

updateMonthlyPurchaseOrders トリガーの作成

手順

AtlasGoTriggersAtlas で、プロジェクトの ページにGoします。

Add a Triggerをクリックして、trigger 構成ページを開きます。

trigger の構成値を入力します。

関数を作成する

updateMonthlyPurchaseOrders 関数の仕組み

関数をテストする。

[Save] をクリックします。

Sales-App アプリケーション ドラフトを確認して配置します。

Sales-App アプリケーション ドラフトを確認して配置します。

マテリアライズドビューでの Atlas Search インデックスの作成

AtlasGoClustersAtlas で、プロジェクトの ページにGoします。

GoAtlas Searchクラスターの ページに します。

クリック Create Search Index

[Visual Editor] を選択し、[Next] をクリックします。

Index Name を入力し、Database and Collection を設定します。

デフォルトの Atlas Search インデックス構成設定を確認します。

[Create Search Index] をクリックします。

[You're All Set!] モーダル ウィンドウを閉じます。

ステータスを確認します。

注意

マテリアライズドビューでのクエリの実行

mongosh 内のクラスターに接続します。

sample_supplies データベースを使用します。

sample_supplies.monthlyPhoneTransactions コレクションに対して簡単な Atlas Search クエリを実行します。

`purchaseOrders` コレクションの作成

`sample_supplies` データベースに接続します。

新しいコレクションを追加します。

`updateMonthlySales` トリガーの作成

Atlas Atlasで、プロジェクトの {0 ページにGoします。GoTriggers

`updateMonthlyPurchaseOrders` トリガーの作成

AtlasGoTriggersAtlas で、プロジェクトのページにGoします。

`updateMonthlyPurchaseOrders` 関数の仕組み

`Sales-App` アプリケーションドラフトを確認して配置します。

`Sales-App` アプリケーションドラフトを確認して配置します。

AtlasGoClustersAtlas で、プロジェクトのページにGoします。

GoAtlas Searchクラスターのページにします。

[You're All Set!] モーダルウィンドウを閉じます。

`mongosh` 内のクラスターに接続します。

`sample_supplies` データベースを使用します。

`sample_supplies.monthlyPhoneTransactions` コレクションに対して簡単な Atlas Search クエリを実行します。