【PHP8.x】MON_GROUPING定数の使い方

Copy
1<?php
2
3// MongoDB PHPドライバのオートロードを読み込みます。
4// `composer require mongodb/mongodb` でドライバをインストールしていることを前提とします。
5require_once __DIR__ . '/vendor/autoload.php';
6
7use MongoDB\Client;
8use MongoDB\Exception\Exception;
9
10/**
11 * MongoDBの集計フレームワークを使用してデータをグループ化する例。
12 *
13 * この関数は、MongoDBコレクション内のデータをカテゴリ別に集計し、
14 * 各カテゴリの合計価格と製品数を計算する方法を示します。
15 *
16 * MON_GROUPING はPHP MongoDBドライバの内部的な定数であり、
17 * 通常のPHPコードで直接使用されることはありません。
18 * しかし、この定数は、ここで示される$groupステージのような
19 * グルーピング操作に内部的に関連しています。
20 */
21function runMongoDbAggregationGroupingExample(): void
22{
23    // MongoDBクライアントの初期化。
24    // 接続URIは環境に合わせて適宜変更してください。
25    $client = null;
26    try {
27        $client = new Client('mongodb://localhost:27017');
28    } catch (Exception $e) {
29        echo "MongoDB接続エラー: " . $e->getMessage() . "\n";
30        echo "MongoDBサーバが稼働しているか、接続URIが正しいか確認してください。\n";
31        return;
32    }
33
34    // 操作対象のデータベースとコレクションを選択します。
35    $collection = $client->selectCollection('testdb', 'products');
36
37    // コレクションが空の場合、サンプルデータを挿入します。
38    if ($collection->countDocuments() === 0) {
39        echo "サンプルデータを挿入します...\n";
40        $collection->insertMany([
41            ['product' => 'Laptop', 'category' => 'Electronics', 'price' => 1200],
42            ['product' => 'Mouse', 'category' => 'Electronics', 'price' => 25],
43            ['product' => 'Keyboard', 'category' => 'Electronics', 'price' => 75],
44            ['product' => 'Shirt', 'category' => 'Apparel', 'price' => 30],
45            ['product' => 'Pants', 'category' => 'Apparel', 'price' => 60],
46            ['product' => 'Monitor', 'category' => 'Electronics', 'price' => 300],
47            ['product' => 'Socks', 'category' => 'Apparel', 'price' => 15],
48        ]);
49        echo "サンプルデータの挿入が完了しました。\n";
50    }
51
52    echo "\n--- 集計パイプラインの実行結果 ---\n";
53
54    // 集計パイプラインの定義。
55    // `$group`ステージを使用して、`category`フィールドでドキュメントをグループ化します。
56    // 各グループに対して、`totalPrice` (合計価格) と `count` (製品数) を計算します。
57    $pipeline = [
58        [
59            '$group' => [
60                '_id' => '$category',          // `category`フィールドの値でドキュメントをグループ化
61                'totalPrice' => ['$sum' => '$price'], // グループ内の`price`フィールドの合計を計算
62                'count' => ['$sum' => 1],      // グループ内のドキュメント数（製品数）をカウント
63            ],
64        ],
65        [
66            '$sort' => [
67                '_id' => 1, // グループ化キー (`_id`、ここではカテゴリ名) で昇順ソート
68            ],
69        ],
70    ];
71
72    try {
73        // コレクションに対して定義した集計パイプラインを実行します。
74        $results = $collection->aggregate($pipeline);
75
76        // 集計結果を繰り返し処理して出力します。
77        foreach ($results as $document) {
78            echo "カテゴリ: " . $document['_id'] . "\n";
79            echo "  合計価格: " . $document['totalPrice'] . "\n";
80            echo "  製品数: " . $document['count'] . "\n";
81            echo "------------------------------\n";
82        }
83    } catch (Exception $e) {
84        echo "集計エラー: " . $e->getMessage() . "\n";
85    }
86
87    echo "--- 集計終了 ---\n";
88}
89
90// 関数を実行して、MongoDB集計の例を表示します。
91runMongoDbAggregationGroupingExample();
92

このPHPサンプルコードは、MongoDBの集計フレームワークを利用してデータをグループ化し、要約する方法を初心者向けに示しています。MON_GROUPINGはPHPのMongoDBドライバが内部的に使用する定数で、引数や戻り値は持ちません。この定数自体が直接コードで使われることはありませんが、データ集計におけるグループ化操作と概念的に関連しています。

コードはまずMongoDBへ接続し、対象コレクションにサンプルデータがない場合は商品データを挿入します。その後、集計パイプラインを定義し実行します。このパイプラインの核となるのは$groupステージで、商品のcategoryフィールドを基準にデータをグループ化します。各カテゴリ内で、$sum演算子を使って全商品の合計価格と商品数を計算しています。最後に、集計された結果をカテゴリ名で昇順にソートし、それぞれのカテゴリの合計価格と商品数をわかりやすく表示しています。

この例を通じて、MongoDBの強力な集計機能の基本であるグルーピング操作がどのように機能し、PHPアプリケーションからそれを実行できるかを理解することができます。

Copy
1<?php
2
3// MongoDB PHP Driver を利用するために、Composer のオートロードが必要になる場合があります。
4// require_once __DIR__ . '/vendor/autoload.php';
5
6// MongoDBに接続するためのManagerインスタンスを作成します。
7// ローカルでMongoDBが動作していることを前提とします（例: Dockerで `docker run --rm -p 27017:27017 mongo` を実行）。
8// 本番環境では、認証情報やレプリカセットの設定が推奨されます。
9try {
10    $manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
11} catch (MongoDB\Driver\Exception\Exception $e) {
12    echo "MongoDB への接続に失敗しました: " . $e->getMessage() . PHP_EOL;
13    exit(1); // エラーコードで終了
14}
15
16/**
17 * サンプルデータをMongoDBコレクションに挿入します。
18 * 冪等性を考慮し、既存データがあってもエラーになりにくいようにします。
19 *
20 * @param MongoDB\Driver\Manager $manager MongoDBマネージャーインスタンス
21 * @param string $dbName データベース名
22 * @param string $collectionName コレクション名
23 */
24function seedData(MongoDB\Driver\Manager $manager, string $dbName, string $collectionName): void
25{
26    $bulk = new MongoDB\Driver\BulkWrite;
27    $documents = [
28        ['item' => 'apple', 'qty' => 5, 'price' => 100],
29        ['item' => 'banana', 'qty' => 10, 'price' => 50],
30        ['item' => 'apple', 'qty' => 3, 'price' => 100],
31        ['item' => 'orange', 'qty' => 7, 'price' => 80],
32        ['item' => 'banana', 'qty' => 2, 'price' => 50],
33        ['item' => 'grape', 'qty' => 8, 'price' => 120],
34    ];
35
36    foreach ($documents as $doc) {
37        $bulk->insert($doc);
38    }
39
40    try {
41        $manager->executeBulkWrite("{$dbName}.{$collectionName}", $bulk);
42        echo "サンプルデータを挿入しました。\n";
43    } catch (MongoDB\Driver\Exception\BulkWriteException $e) {
44        // 重複挿入などのエラーをハンドル。ここでは簡易的にエラーメッセージを表示。
45        // 実際のアプリケーションでは、より詳細なログ記録やエラーリカバリが必要です。
46        echo "データ挿入時にエラーが発生しました (既存データがある場合は無視されることがあります): " . $e->getMessage() . PHP_EOL;
47    }
48}
49
50/**
51 * MongoDBの集計パイプラインを使用してデータのグループ化 (Grouping) を実行します。
52 *
53 * MON_GROUPING という定数は標準のMongoDB PHP拡張には存在しませんが、
54 * ここでは「グループ化」という概念をMongoDBの集計機能で実現するサンプルを示します。
55 * アイテムごとに合計数量を計算する一般的なユースケースです。
56 *
57 * @param MongoDB\Driver\Manager $manager MongoDBマネージャーインスタンス
58 */
59function performMongoAggregationGrouping(MongoDB\Driver\Manager $manager): void
60{
61    $dbName = 'testdb';
62    $collectionName = 'products';
63
64    // 集計を行う前に、コレクションにデータがあることを確認します。
65    seedData($manager, $dbName, $collectionName);
66
67    echo "\n--- MongoDB集計パイプラインによるグループ化 (Aggregation Grouping) ---\n";
68    echo "--- 各アイテムの合計数量を算出します ---\n";
69
70    // 集計パイプラインを定義します。
71    // '$group'ステージで'item'フィールドを基準にグループ化し、
72    // 各グループの'qty'フィールドの合計を'totalQty'として算出します。
73    $pipeline = [
74        ['$group' => [
75            '_id' => '$item',        // 'item'フィールドの値でドキュメントをグループ化
76            'totalQty' => ['$sum' => '$qty'] // グループ内の'qty'フィールドの値を合計
77        ]],
78        ['$sort' => [
79            'totalQty' => -1 // 合計数量が多い順にソート（降順）
80        ]]
81    ];
82
83    // AggregationCommand を作成し、実行します。
84    $command = new MongoDB\Driver\Command([
85        'aggregate' => $collectionName, // 集計対象のコレクション名
86        'pipeline' => $pipeline,       // 定義した集計パイプライン
87        'cursor' => new stdClass,      // 結果をカーソルとして取得するための設定
88    ]);
89
90    try {
91        $cursor = $manager->executeCommand($dbName, $command);
92
93        // カーソルから結果を1つずつ取り出して表示します。
94        foreach ($cursor as $document) {
95            echo "アイテム: " . $document->_id . ", 合計数量: " . $document->totalQty . PHP_EOL;
96        }
97    } catch (MongoDB\Driver\Exception\Exception $e) {
98        echo "集計クエリの実行に失敗しました: " . $e->getMessage() . PHP_EOL;
99    }
100}
101
102// メイン処理の実行
103performMongoAggregationGrouping($manager);
104
105?>

このPHPコードは、MongoDBデータベースの強力な集計機能を利用して、データを効率的にグループ化する方法を初心者向けに解説しています。リファレンスにあるMON_GROUPINGという定数自体は、現在のPHPのMongoDB拡張には直接存在しませんが、このコードは、その「グループ化」という概念をMongoDBのアグリゲーションパイプラインで実現する具体的な例を示しています。

コードはまず、MongoDB\Driver\Managerクラスを用いてMongoDBへの接続を確立します。接続に失敗した場合はエラーメッセージを表示して終了します。次に、seedData関数を使って、集計対象となるサンプルデータをコレクションに挿入します。これにより、データがない状態からでもすぐに動作を確認できます。

メイン処理であるperformMongoAggregationGrouping関数では、$groupステージを含む集計パイプラインを定義しています。このパイプラインは、_idとして指定されたitemフィールドの値に基づいてドキュメントをグループ化し、各グループのqty（数量）フィールドの合計をtotalQtyとして算出します。その後、totalQtyで降順にソートする処理も含まれています。この定義されたパイプラインはMongoDB\Driver\Commandとして実行され、executeCommandメソッドを通じて結果がカーソルとして返されます。最終的に、そのカーソルから取得したドキュメントをループで処理し、アイテムごとの合計数量を表示しています。各ステップでは、エラー発生時に対応するための例外処理も適切に記述されています。