UserDefinedFunction Classe

Définition

Espace de noms:

Microsoft.Azure.Documents

Assemblys:

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

Paquets:

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

Représente une fonction définie par l’utilisateur dans le service Azure Cosmos DB.

public class UserDefinedFunction : Microsoft.Azure.Documents.Resource

type UserDefinedFunction = class
    inherit Resource

Public Class UserDefinedFunction
Inherits Resource

Héritage

Object

JsonSerializable

Resource

UserDefinedFunction

Exemples

Les exemples suivants montrent comment inscrire et utiliser des fonctions définies par l’utilisateur.

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

Remarques

Azure Cosmos DB prend en charge les fonctions définies par l’utilisateur (UDF) JavaScript qui sont stockées dans la base de données et peuvent être utilisées dans des requêtes. Reportez-vous à http://azure.microsoft.com/documentation/articles/documentdb-sql-query/#javascript-integration pour savoir comment utiliser les fonctions définies par l’utilisateur dans les requêtes. Reportez-vous à pour plus d’informations http://azure.microsoft.com/documentation/articles/documentdb-programming/#udf sur l’implémentation des fonctions définies par l’utilisateur dans JavaScript.

Constructeurs

UserDefinedFunction()

Initialise une nouvelle instance de la UserDefinedFunction classe pour le service Azure Cosmos DB.

Propriétés

AltLink	Obtient le lien de remplacement associé à la ressource à partir du service Azure Cosmos DB. (Hérité de Resource)
Body	Obtient ou définit le corps de la fonction définie par l’utilisateur pour le service Azure Cosmos DB.
ETag	Obtient la balise d’entité associée à la ressource à partir du service Azure Cosmos DB. (Hérité de Resource)
Id	Obtient ou définit l’ID de la ressource dans le service Azure Cosmos DB. (Hérité de Resource)
ResourceId	Obtient ou définit l’ID de ressource associé à la ressource dans le service Azure Cosmos DB. (Hérité de Resource)
SelfLink	Obtient l’auto-liaison associée à la ressource à partir du service Azure Cosmos DB. (Hérité de Resource)
Timestamp	Obtient le dernier horodatage modifié associé à la ressource à partir du service Azure Cosmos DB. (Hérité de Resource)

Méthodes

GetPropertyValue<T>(String)	Obtient la valeur de propriété associée au nom de propriété spécifié à partir du service Azure Cosmos DB. (Hérité de Resource)
LoadFrom(JsonReader)	Charge l’objet à partir du lecteur JSON spécifié dans le service Azure Cosmos DB. (Hérité de JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)	Charge l’objet à partir du lecteur JSON spécifié dans le service Azure Cosmos DB. (Hérité de JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)	Enregistre l’objet dans le flux spécifié dans le service Azure Cosmos DB. (Hérité de JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)	Enregistre l’objet dans le flux spécifié dans le service Azure Cosmos DB. (Hérité de JsonSerializable)
SetPropertyValue(String, Object)	Définit la valeur de propriété associée au nom de propriété spécifié dans le service Azure Cosmos DB. (Hérité de Resource)
ToByteArray()	Sérialiser dans un tableau d’octets via SaveTo pour le service Azure Cosmos DB. (Hérité de Resource)
ToString()	Retourne la représentation sous forme de chaîne de l’objet dans le service Azure Cosmos DB. (Hérité de JsonSerializable)