DocumentDB SQL — пользовательские функции

DocumentDB SQL обеспечивает поддержку пользовательских функций (UDF). UDF — это просто еще один вид функций JavaScript, которые вы можете написать, и они работают почти так, как вы ожидаете. Вы можете создавать пользовательские функции для расширения языка запросов с помощью пользовательской бизнес-логики, на которую вы можете ссылаться в своих запросах.

SQL-синтаксис DocumentDB расширен для поддержки пользовательской логики приложения с использованием этих пользовательских функций. UDF могут быть зарегистрированы в DocumentDB, а затем на них можно ссылаться как часть запроса SQL.

Давайте рассмотрим следующие три документа для этого примера.

Документ 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 и вызываем CreateUserDefinedFunctionAsync с SelfLink коллекции и объектом udfDefinition, как показано в следующем коде.

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, передавая строку сопоставления с шаблоном во втором параметре в. совпадать Мы можем запустить запрос подстроки, чтобы найти все магазины со словом Andersen в их свойстве lastName .

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); 
   } 
}

Когда приведенный выше код выполняется, он производит следующий вывод.