UserDefinedFunctionProperties クラス

定義

名前空間:

Azure.Cosmos.Scripts

アセンブリ:

Azure.Cosmos.dll

パッケージ:

Azure.Cosmos v4.0.0-preview3

Azure Cosmos サービスのユーザー定義関数を表します。

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonUserDefinedFunctionPropertiesConverter))]
public class UserDefinedFunctionProperties

[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonUserDefinedFunctionPropertiesConverter))>]
type UserDefinedFunctionProperties = class

Public Class UserDefinedFunctionProperties

継承

Object

UserDefinedFunctionProperties

属性

JsonConverterAttribute

例

次の例は、UDF を登録して使用する方法を示しています。

await this.container.UserDefinedFunctions.CreateUserDefinedFunctionAsync(
    new UserDefinedFunctionProperties 
    { 
        Id = "calculateTax", 
        Body = @"function(amt) { return amt * 0.05; }" 
    });

QueryDefinition sqlQuery = new QueryDefinition(
    "SELECT VALUE udf.calculateTax(t.cost) FROM toDoActivity t where t.cost > @expensive and t.status = @status")
    .WithParameter("@expensive", 9000)
    .WithParameter("@status", "Done");

await foreach(double tax = this.container.Items.GetItemsQueryIterator<double>(
    sqlQueryDefinition: sqlQuery,
    partitionKey: "Done")
{
    Console.WriteLine(tax);
}

注釈

Azure Cosmos では、データベースに格納され、クエリ内で使用できる JavaScript ユーザー定義関数 (UDF) がサポートされています。 クエリ内で https://docs.microsoft.com/azure/cosmos-db/sql-api-sql-query#javascript-integration UDF を使用する方法については、「」を参照してください。 JavaScript での https://docs.microsoft.com/azure/cosmos-db/programming#udf UDF の実装の詳細については、こちらを参照してください。

コンストラクター

UserDefinedFunctionProperties()

Azure Cosmos サービスのユーザー定義関数を表します。

プロパティ

Body	Azure Cosmos DB サービスのユーザー定義関数の本体を取得または設定します。
ETag	Azure Cosmos DB サービスから、リソースに関連付けられているエンティティ タグを取得します。
Id	Azure Cosmos DB サービス内のリソースの ID を取得または設定します。