ストアドプロシージャ

[アーティクル]
08/05/2023

Azure Cosmos DB は、ドキュメント、グラフ、キー値のデータモデルをサポートするグローバル分散マルチモデルデータベースです。このセクションの内容は、REST 経由で SQL API を使用してドキュメントリソースを作成、クエリ、および管理するための内容です。

ストアドプロシージャは JavaScript で記述されたアプリケーションのロジックです。1 つの処理としてコレクションに対して登録され、実行されます。 Azure Cosmos DB では、JavaScript はデータベースと同じメモリ空間でホストされます。そのため、ストアドプロシージャ内で行われた要求はデータベースセッションの同じ範囲で実行されます。このプロセスにより、Azure Cosmos DB は、1 つのストアドプロシージャに含まれるすべての操作に対して ACID を保証できます。

ストアドプロシージャリソースは、 Azure Cosmos DB リソースモデルの sprocs によって表されます。

ストアドプロシージャリソースのスキーマは固定です。 body プロパティに、アプリケーションロジックが含まれています。次の例は、ストアドプロシージャの JSON 構造を示しています。

{    
   "id":"SimpleStoredProc",  
   "body":"function (docToCreate, addedPropertyName, addedPropertyValue {getContext().getResponse().setBody('Hello World');}",  
   "_rid":"hLEEAI1YjgcBAAAAAAAAgA==",  
   "_ts":1408058682,  
   "_self":"dbs\/hLEEAA==\/colls\/hLEEAI1Yjgc=\/sprocs\/hLEEAI1YjgcBAAAAAAAAgA==\/",  
   "_etag":"00004100-0000-0000-0000-53ed453a0000"  
}

特定のストアドプロシージャに対して All アクセスモード を設定するだけでは、ユーザーがストアドプロシージャを実行することはできません。代わりに、ユーザーはストアドプロシージャを実行するために、コレクションレベルで All アクセスモード を使用する必要があります。

プロパティ	説明
id	必須。これはユーザー設定可能なプロパティです。ストアドプロシージャの識別に使用される一意の名前です。 ID は 255 文字以内にする必要があります。
body	必須。これはユーザー設定可能なプロパティです。これはストアドプロシージャの本体です。
_解消	システムによって生成されるプロパティです。リソース ID (_rid) は、リソースモデル上のリソーススタックごとに階層化された一意識別子です。ストアドプロシージャリソースの配置およびナビゲーションのために内部的に使用されます。
_Ts	システムによって生成されるプロパティです。リソースの最終更新タイムスタンプを示します。値は、タイムスタンプです。
_自己	システムによって生成されるプロパティです。リソースの一意のアドレス指定が可能な URI です。
_Etag	これは、オプティミスティックコンカレンシー制御に必要なリソース etag を指定するシステム生成のプロパティです。

ストアドプロシージャでは、Cosmos DB JavaScript サーバー側 SDK を使用して、ドキュメントの作成、読み取り、更新、削除、クエリ、および要求本文からの読み取りとストアドプロシージャの応答本文への書き込みなどのデータベース操作を行うことができます。詳細については、 Cosmos DB サーバー側プログラミングチュートリアルを参照してください。

たとえば、ここに「Hello World」のストアドプロシージャがあります。

var helloWorldStoredProc = {  
    id: "helloWorld",  
    body: function () {  
        var context = getContext();  
        var response = context.getResponse();  
  
        response.setBody("Hello, World");  
    }  
}

次の例では、ストアドプロシージャ内にドキュメントを作成します。

{  
    id: "createMyDocument",  
    body: function createMyDocument(documentToCreate) {  
        var context = getContext();  
        var collection = context.getCollection();  
  
        var accepted = collection.createDocument(collection.getSelfLink(),  
              documentToCreate,  
            function (err, documentCreated) {  
                if (err) throw new Error('Error' + err.message);  
                context.getResponse().setBody(documentCreated.id)  
            });  
        if (!accepted) return;  
    }  
}

次の例では、ストアドプロシージャ内で 2 つの項目が入れ替えられます。

// JavaScript source code  
var exchangeItemsSproc = {  
    name: "exchangeItems",  
    body: function (playerId1, playerId2) {  
        var context = getContext();  
        var collection = context.getCollection();  
        var response = context.getResponse();  
  
        var player1Document, player2Document;  
  
        // query for players  
        var filterQuery = 'SELECT * FROM Players p where p.id  = "' + playerId1 + '"';  
        var accept = collection.queryDocuments(collection.getSelfLink(), filterQuery, {},  
            function (err, documents, responseOptions) {  
                if (err) throw new Error("Error" + err.message);  
  
                if (documents.length != 1) throw "Unable to find both names";  
                player1Document = documents[0];  
  
                var filterQuery2 = 'SELECT * FROM Players p where p.id = "' + playerId2 + '"';  
                var accept2 = collection.queryDocuments(collection.getSelfLink(), filterQuery2, {},  
                    function (err2, documents2, responseOptions2) {  
                        if (err2) throw new Error("Error" + err2.message);  
                        if (documents2.length != 1) throw "Unable to find both names";  
                        player2Document = documents2[0];  
                        swapItems(player1Document, player2Document);  
                        return;  
                    });  
                if (!accept2) throw "Unable to read player details, abort ";  
            });  
  
        if (!accept) throw "Unable to read player details, abort ";  
  
        // swap the two players’ items  
        function swapItems(player1, player2) {  
            var player1ItemSave = player1.item;  
            player1.item = player2.item;  
            player2.item = player1ItemSave;  
  
            var accept = collection.replaceDocument(player1._self, player1,  
                function (err, docReplaced) {  
                    if (err) throw "Unable to update player 1, abort ";  
  
                    var accept2 = collection.replaceDocument(player2._self, player2,  
                        function (err2, docReplaced2) {  
                            if (err) throw "Unable to update player 2, abort"  
                        });  
  
                    if (!accept2) throw "Unable to update player 2, abort";  
                });  
  
            if (!accept) throw "Unable to update player 1, abort";  
        }  
    }  
}

タスク

ストアドプロシージャでは、次の操作を実行できます。

ストアドプロシージャの実行など、ストアドプロシージャの動作の詳細については、「 Azure Cosmos DB プログラミング: ストアドプロシージャ、トリガー、UDF」を参照してください。

ストアド プロシージャ

タスク

参照

その他のリソース

ストアドプロシージャ