ユーザー定義関数

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

Azure Cosmos DB は、ドキュメント、グラフ、キー値のデータモデルをサポートするグローバルに分散されたマルチモデルデータベースです。このセクションの内容は、REST を介して SQL API を使用してユーザー定義関数リソース (udfs) を管理するための内容です。

ユーザー定義関数 (UDF) は、JavaScript で記述された副作用のないアプリケーションロジックです。これにより、開発者はクエリ演算子を構築できるため、Cosmos DB クエリ言語のコアを拡張できます。 UDF はストアドプロシージャのようにコレクション内部に存在するため、アプリケーションロジックはそのコレクション内に制限されています。

ストアドプロシージャと同様、UDF リソースは固定スキーマを持ちます。 body プロパティに、アプリケーションロジックが含まれています。次の例は、ユーザー定義関数の JSON コンストラクトを示しています。

{  
"id":"simpleTaxUDF",  
"body": "  
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;  
    }  
",  
"_rid":"hLEEAI1YjgcBAAAAAAAAgA==",  
"_ts":1408058682,  
"_self":"dbs\/hLEEAA==\/colls\/hLEEAI1Yjgc=\/udfs\/hLEEAI1YjgcBAAAAAAAAgA==\/",  
"_etag":"00004100-0000-0000-0000-53ed453a0000"  
}

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

タスク

ユーザー定義関数を使用して、次の操作を行うことができます。

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

次の方法で共有

ユーザー定義関数

タスク

参照

その他のリソース