トリガーとユーザー定義関数を作成する

3 分

Azure Cosmos DB では、プリトリガーとポストトリガーがサポートされます。プリトリガーはデータベース項目の変更前に実行され、ポストトリガーはデータベース項目の変更後に実行されます。トリガーは自動的に実行されません。それらを実行する各データベース操作に対して指定する必要があります。トリガーを定義したら、Azure Cosmos DB SDK を使用して登録する必要があります。

トリガーを登録して呼び出す方法の例については、「プレトリガー」と「ポストトリガー」を参照してください。

プレトリガー

次の例は、プレトリガーを使用して、作成される Azure Cosmos 項目のプロパティを検証する方法を示しています。含まれていなければ、これにより、新しく追加された項目にタイムスタンププロパティが追加されます。

function validateToDoItemTimestamp() {
    var context = getContext();
    var request = context.getRequest();

    // item to be created in the current operation
    var itemToCreate = request.getBody();

    // validate properties
    if (!("timestamp" in itemToCreate)) {
        var ts = new Date();
        itemToCreate["timestamp"] = ts.getTime();
    }

    // update the item that will be created
    request.setBody(itemToCreate);
}

プリトリガーには入力パラメーターを与えることができません。トリガー内の要求オブジェクトを使用して、操作に関連付けられた要求メッセージを操作します。前の例では、Azure Cosmos 項目を作成するときにプリトリガーが実行され、要求メッセージの本文に、作成する項目が JSON 形式で含まれています。

トリガーが登録されたら、ユーザーは実行できる操作を指定できます。このトリガーは TriggerOperation.Create の TriggerOperation 値で作成する必要があります。つまり、置換操作でこのトリガーを使用することは許可されません。

プリトリガーを登録して呼び出す方法の例については、プリトリガーに関する記事を参照してください。

ポストトリガー

次にポストトリガーの例を示します。このトリガーは、メタデータ項目を照会し、新しく作成された項目に関する詳細情報に基づいてこれを更新します。

function updateMetadata() {
var context = getContext();
var container = context.getCollection();
var response = context.getResponse();

// item that was created
var createdItem = response.getBody();

// query for metadata document
var filterQuery = 'SELECT * FROM root r WHERE r.id = "_metadata"';
var accept = container.queryDocuments(container.getSelfLink(), filterQuery,
    updateMetadataCallback);
if(!accept) throw "Unable to update metadata, abort";

function updateMetadataCallback(err, items, responseOptions) {
    if(err) throw new Error("Error" + err.message);
        if(items.length != 1) throw 'Unable to find metadata document';

        var metadataItem = items[0];

        // update metadata
        metadataItem.createdItems += 1;
        metadataItem.createdNames += " " + createdItem.id;
        var accept = container.replaceDocument(metadataItem._self,
            metadataItem, function(err, itemReplaced) {
                    if(err) throw "Unable to update metadata, abort";
            });
        if(!accept) throw "Unable to update metadata, abort";
        return;
    }
}

ここで重要なのは、Azure Cosmos DB でのトリガーのトランザクション実行です。ポストトリガーは、基になる項目自体と同じトランザクションの一部として実行されます。ポストトリガーの実行中に例外が発生すると、トランザクション全体が失敗します。コミットされたものすべてがロールバックされ、例外が返されます。

ユーザー定義関数

次の例では、さまざまな所得階層についての所得税を計算する UDF を作成します。このユーザー定義関数は、クエリ内で使用できます。この例では、次のようなプロパティを持つ "Incomes" (所得) という名前のコンテナーがあると仮定します。

{
   "name": "User One",
   "country": "USA",
   "income": 70000
}

さまざまな所得階層についての所得税を計算するための関数定義を以下に示します。

function tax(income) {

        if(income == undefined)
            throw 'no input';

        if (income < 1000)
            return income * 0.1;
        else if (income < 10000)
            return income * 0.2;
        else
            return income * 0.4;
    }

続行

プレトリガー

ポストトリガー

ユーザー定義関数

フィードバック