UserDefinedFunction クラス

定義

名前空間:

Microsoft.Azure.Documents

アセンブリ:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

パッケージ:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

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

public class UserDefinedFunction : Microsoft.Azure.Documents.Resource

type UserDefinedFunction = class
    inherit Resource

Public Class UserDefinedFunction
Inherits Resource

継承

Object

JsonSerializable

Resource

UserDefinedFunction

例

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

await client.CreateUserDefinedFunctionAsync(collectionLink, new UserDefinedFunction { Id = "calculateTax", Body = @"function(amt) { return amt * 0.05; }" });
client.CreateDocumentQuery<Book>(collectionLink, "SELECT VALUE udf.calculateTax(b.price) FROM books b");
client.CreateDocumentQuery<Book>(collectionLink, new SqlQuerySpec("SELECT VALUE udf.calculateTax(b.price) FROM books b"));
client.CreateDocumentQuery<Book>(collectionLink).Select(b => UserDefinedFunctionProvider.Invoke("calculateTax", b.Price));

await client.CreateUserDefinedFunctionAsync(collectionLink, new UserDefinedFunction { Id = "toLowerCase", Body = @"function(s) { return s.ToLowerCase(); }" });
client.CreateDocumentQuery<Book>(collectionLink, "SELECT * FROM books b WHERE b.toLowerCase = 'war and peace'");
client.CreateDocumentQuery<Book>(collectionLink, new SqlQuerySpec(
    "SELECT * FROM books b WHERE b.toLowerCase = @bookNameLowerCase",
    new SqlParameterCollection(new SqlParameter[] {new SqlParameter { Name = "@bookNameLowerCase", Value = "War And Peace".ToLower()
 }})));
 client.CreateDocumentQuery<Book>(collectionLink).Where(b => UserDefinedFunctionProvider.Invoke("toLowerCase", b.Title) == "war and peace");

注釈

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

コンストラクター

UserDefinedFunction()

Azure Cosmos DB サービスの クラスの UserDefinedFunction 新しいインスタンスを初期化します。

プロパティ

AltLink	Azure Cosmos DB サービスから、リソースに関連付けられている alt-link を取得します。 (継承元 Resource)
Body	Azure Cosmos DB サービスのユーザー定義関数の本体を取得または設定します。
ETag	Azure Cosmos DB サービスから、リソースに関連付けられているエンティティ タグを取得します。 (継承元 Resource)
Id	Azure Cosmos DB サービス内のリソースの ID を取得または設定します。 (継承元 Resource)
ResourceId	Azure Cosmos DB サービス内のリソースに関連付けられているリソース ID を取得または設定します。 (継承元 Resource)
SelfLink	Azure Cosmos DB サービスから、リソースに関連付けられているセルフリンクを取得します。 (継承元 Resource)
Timestamp	Azure Cosmos DB サービスから、リソースに関連付けられている最後に変更されたタイムスタンプを取得します。 (継承元 Resource)

メソッド

GetPropertyValue<T>(String)	Azure Cosmos DB サービスから、指定したプロパティ名に関連付けられているプロパティ値を取得します。 (継承元 Resource)
LoadFrom(JsonReader)	Azure Cosmos DB サービスで、指定した JSON リーダーから オブジェクトを読み込みます。 (継承元 JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)	Azure Cosmos DB サービスで、指定した JSON リーダーから オブジェクトを読み込みます。 (継承元 JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)	オブジェクトを Azure Cosmos DB サービスの指定されたストリームに保存します。 (継承元 JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)	オブジェクトを Azure Cosmos DB サービスの指定されたストリームに保存します。 (継承元 JsonSerializable)
SetPropertyValue(String, Object)	Azure Cosmos DB サービスの指定したプロパティ名に関連付けられているプロパティ値を設定します。 (継承元 Resource)
ToByteArray()	Azure Cosmos DB サービスの SaveTo を使用してバイト配列にシリアル化します。 (継承元 Resource)
ToString()	Azure Cosmos DB サービス内の オブジェクトの文字列表現を返します。 (継承元 JsonSerializable)