MongoDBでストアドプロシージャを作成する方法をわかりやすく解説

MongoDBのストアドプロシージャとは

MongoDBでは、JavaScriptの関数を特別なコレクション「db.system.js」に保存することで、ストアドプロシージャのように再利用可能な処理を定義できます。RDBMSにおけるストアドプロシージャと同様に、よく使うロジックをデータベース側に登録しておき、必要なときに呼び出して実行することが可能です。

ストアドプロシージャを作成する基本構文

以下が、MongoDBでストアドプロシージャを作成する際の基本構文です。

db.system.js.save(
    {
        _id: "yourStoredProcedueName",
        value: function(argument1, ....N)
        {
            statement1,
            .
            .
            N
        }
    }
);

ポイントは次の3つです。

• _id: ストアドプロシージャの名前を指定します。この名前を使って後から呼び出します。
• value: 実行したい処理をJavaScriptの関数として定義します。
• 引数: 関数に渡すパラメータは自由に複数指定できます。

実際にストアドプロシージャを作成してみる

それでは、上記の構文に沿って、2つの値を足し算して返す「addTwoValue」というストアドプロシージャを作成してみましょう。作成用のクエリは以下の通りです。

> db.system.js.save(
    {
        _id: "addTwoValue",
        value: function(a, b)
        {
            return a + b;
        }
    }
);

このクエリを実行すると、以下のような出力が得られます。

WriteResult({ "nMatched" : 0, "nUpserted" : 1, "nModified" : 0, "_id" : "addTwoValue" })

この結果は、「addTwoValue」というドキュメントが新しくupsert（挿入）されたことを意味しています。「nUpserted : 1」がその証拠です。これでストアドプロシージャの登録は完了です。

eval()を使ってストアドプロシージャを呼び出す

作成したストアドプロシージャは、db.eval()を使って呼び出すことができます。先ほど登録した「addTwoValue」に100と25を渡して実行してみましょう。

> db.eval("return addTwoValue(100, 25)");
125

実行結果として「125」が返されました。正しく関数が動作していることが確認できます。

注意点：eval()は非推奨

なお、db.eval()はMongoDB 4.2以降で非推奨（deprecated）となっており、最新バージョンでは削除されています。本番環境での利用は避け、代わりにアプリケーション側でJavaScript相当のロジックを実装するか、集計フレームワーク（Aggregation Pipeline）やサーバーサイドJavaScriptが必要な場合は別の設計を検討することをおすすめします。db.system.jsへの保存自体は今でも可能ですが、自動的に読み込まれる仕組みは廃止されている点にも注意してください。