DocumentDB SQL-ユーザー定義関数

DocumentDB SQLは、ユーザー定義関数（UDF）のサポートを提供します。 UDFは、ユーザーが記述できるJavaScript関数の一種に過ぎず、これらは期待どおりに機能します。 UDFを作成して、クエリで参照できるカスタムビジネスロジックでクエリ言語を拡張できます。

DocumentDB SQL構文は、これらのUDFを使用してカスタムアプリケーションロジックをサポートするように拡張されています。 UDFはDocumentDBに登録し、SQLクエリの一部として参照できます。

この例では、次の3つのドキュメントを考えてみましょう。

*AndersenFamily* ドキュメントは次のとおりです。

{
   "id": "AndersenFamily",
   "lastName": "Andersen",

   "parents": [
      { "firstName": "Thomas", "relationship":  "father" },
      { "firstName": "Mary Kay", "relationship":  "mother" }
   ],

   "children": [
      {
         "firstName": "Henriette Thaulow",
         "gender": "female",
         "grade": 5,
         "pets": [ { "givenName": "Fluffy", "type":  "Rabbit" } ]
      }
   ],

   "location": { "state": "WA", "county": "King", "city": "Seattle" },
   "isRegistered": true
}

*SmithFamily* ドキュメントは次のとおりです。

{
   "id": "SmithFamily",

   "parents": [
      { "familyName": "Smith", "givenName": "James" },
      { "familyName": "Curtis", "givenName": "Helen" }
   ],

   "children": [
      {
         "givenName": "Michelle",
         "gender": "female",
         "grade": 1
      },

      {
         "givenName": "John",
         "gender": "male",
         "grade": 7,

         "pets": [
            { "givenName": "Tweetie", "type": "Bird" }
         ]
      }
   ],

   "location": {
      "state": "NY",
      "county": "Queens",
      "city": "Forest Hills"
   },

   "isRegistered": true
}

*WakefieldFamily* ドキュメントは次のとおりです。

{
   "id": "WakefieldFamily",

   "parents": [
      { "familyName": "Wakefield", "givenName": "Robin" },
      { "familyName": "Miller", "givenName": "Ben" }
   ],

   "children": [
      {
         "familyName": "Merriam",
         "givenName": "Jesse",
         "gender": "female",
         "grade": 6,

         "pets": [
            { "givenName": "Charlie Brown", "type": "Dog" },
            { "givenName": "Tiger", "type": "Cat" },
            { "givenName": "Princess", "type": "Cat" }
         ]
      },

      {
         "familyName": "Miller",
         "givenName": "Lisa",
         "gender": "female",
         "grade": 3,

         "pets": [
            { "givenName": "Jake", "type": "Snake" }
         ]
      }
   ],

   "location": { "state": "NY", "county": "Manhattan", "city": "NY" },
   "isRegistered": false
}

簡単なUDFを作成する例を見てみましょう。

以下は、 CreateUserDefinedFunctions の実装です。

private async static Task CreateUserDefinedFunctions(DocumentClient client) {
   Console.WriteLine();
   Console.WriteLine("*** *Create User Defined Functions* ***");
   Console.WriteLine();

   await CreateUserDefinedFunction(client, "udfRegEx");
}

udfRegExがあり、CreateUserDefinedFunctionでローカルファイルからJavaScriptコードを取得します。次のコードに示すように、新しいUDFの定義オブジェクトを作成し、コレクションのSelfLinkおよびudfDefinitionオブジェクトを使用してCreateUserDefinedFunctionAsyncを呼び出します。

private async static Task<UserDefinedFunction>
CreateUserDefinedFunction(DocumentClient client, string udfId) {
   var udfBody = File.ReadAllText(@"..\..\Server\" + udfId + ".js");

   var udfDefinition = new UserDefinedFunction {
      Id = udfId,
      Body = udfBody
   };

   var result = await client
      .CreateUserDefinedFunctionAsync(_collection.SelfLink, udfDefinition);
   var udf = result.Resource;

   Console.WriteLine("Created user defined function {0}; RID: {1}",
      udf.Id, udf.ResourceId);

   return udf;
}

結果のリソースプロパティから新しいUDFを取得し、呼び出し元に返します。既存のUDFを表示するための ViewUserDefinedFunctions の実装は次のとおりです。 CreateUserDefinedFunctionQuery を呼び出し、通常どおりループします。

private static void ViewUserDefinedFunctions(DocumentClient client) {
   Console.WriteLine();
   Console.WriteLine("*** *View UDFs* ***");
   Console.WriteLine();

   var udfs = client
      .CreateUserDefinedFunctionQuery(_collection.UserDefinedFunctionsLink)
      .ToList();

   foreach (var udf in udfs) {
      Console.WriteLine("User defined function {0}; RID: {1}", udf.Id, udf.ResourceId);
   }
}

DocumentDB SQLには、部分文字列または正規表現を検索するための組み込み関数が用意されていないため、次の小さなワンライナーがJavaScript関数であるこのギャップを埋めます。

function udfRegEx(input, regex) {
   return input.match(regex);
}

最初のパラメーターの入力文字列を指定すると、JavaScriptの組み込み正規表現サポートを使用して、2番目のパラメーターのパターンマッチング文字列を。 match に渡します。サブストリングクエリを実行して、 lastName プロパティにAndersenという単語が含まれるすべてのストアを検索できます。

private static void Execute_udfRegEx(DocumentClient client) {
   var sql = "SELECT c.name FROM c WHERE udf.udfRegEx(c.lastName, 'Andersen') != null";

   Console.WriteLine();
   Console.WriteLine("Querying for Andersen");

   var documents = client.CreateDocumentQuery(_collection.SelfLink, sql).ToList();
   Console.WriteLine("Found {0} Andersen:", documents.Count);

   foreach (var document in documents) {
      Console.WriteLine("Id: {0}, Name: {1}", document.id, document.lastName);
   }
}

すべてのUDF参照を接頭辞 udf で修飾する必要があることに注意してください。通常のクエリと同様に、SQLを CreateDocumentQuery に渡しました。最後に、 CreateDocumentClient タスクから上記のクエリを呼び出しましょう

private static async Task CreateDocumentClient() {
  //Create a new instance of the DocumentClient

   using (var client = new DocumentClient(new Uri(EndpointUrl), AuthorizationKey)){
      database = client.CreateDatabaseQuery("SELECT *FROM c WHERE
         c.id = 'myfirstdb'").AsEnumerable().First();
      collection = client.CreateDocumentCollectionQuery(database.CollectionsLink,
         "SELECT* FROM c WHERE c.id = 'Families'").AsEnumerable().First();

      await CreateUserDefinedFunctions(client);

      ViewUserDefinedFunctions(client);

      Execute_udfRegEx(client);
   }
}

上記のコードが実行されると、次の出力が生成されます。

*** *Create User Defined Functions* ***
Created user defined function udfRegEx; RID: kV5oANVXnwAlAAAAAAAAYA==
*** *View UDFs* ***
User defined function udfRegEx; RID: kV5oANVXnwAlAAAAAAAAYA==
Querying for Andersen
Found 1 Andersen:
 Id: AndersenFamily, Name: Andersen

Documentdb-sql-user-defined-functions

DocumentDB SQL-ユーザー定義関数