UserDefinedFunction Klasse

Definition

Namespace:

Microsoft.Azure.Documents

Assemblys:

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

Pakete:

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

Stellt eine benutzerdefinierte Funktion im Azure Cosmos DB-Dienst dar.

public class UserDefinedFunction : Microsoft.Azure.Documents.Resource

type UserDefinedFunction = class
    inherit Resource

Public Class UserDefinedFunction
Inherits Resource

Vererbung

Object

JsonSerializable

Resource

UserDefinedFunction

Beispiele

Die folgenden Beispiele zeigen, wie Sie UDFs registrieren und verwenden.

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

Hinweise

Azure Cosmos DB unterstützt benutzerdefinierte JavaScript-Funktionen (UdFs), die in der Datenbank gespeichert sind und in Abfragen verwendet werden können. Informationen zur http://azure.microsoft.com/documentation/articles/documentdb-sql-query/#javascript-integration Verwendung von UDFs in Abfragen finden Sie unter. Weitere Informationen zur http://azure.microsoft.com/documentation/articles/documentdb-programming/#udf Implementierung von UDFs in JavaScript finden Sie unter.

Konstruktoren

UserDefinedFunction()

Initialisiert eine neue instance der UserDefinedFunction -Klasse für den Azure Cosmos DB-Dienst.

Eigenschaften

AltLink	Ruft den alt-Link ab, der der Ressource aus dem Azure Cosmos DB-Dienst zugeordnet ist. (Geerbt von Resource)
Body	Ruft den Textkörper der benutzerdefinierten Funktion für den Azure Cosmos DB-Dienst ab oder legt diese fest.
ETag	Ruft das Entitätstag ab, das der Ressource aus dem Azure Cosmos DB-Dienst zugeordnet ist. (Geerbt von Resource)
Id	Ruft die ID der Ressource im Azure Cosmos DB-Dienst ab oder legt sie fest. (Geerbt von Resource)
ResourceId	Ruft die Ressourcen-ID ab, die der Ressource im Azure Cosmos DB-Dienst zugeordnet ist, oder legt sie fest. (Geerbt von Resource)
SelfLink	Ruft die der Ressource zugeordnete Selbstverknüpfung aus dem Azure Cosmos DB-Dienst ab. (Geerbt von Resource)
Timestamp	Ruft den zuletzt geänderten Zeitstempel ab, der der Ressource aus dem Azure Cosmos DB-Dienst zugeordnet ist. (Geerbt von Resource)

Methoden

GetPropertyValue<T>(String)	Ruft den Eigenschaftenwert ab, der dem angegebenen Eigenschaftsnamen aus dem Azure Cosmos DB-Dienst zugeordnet ist. (Geerbt von Resource)
LoadFrom(JsonReader)	Lädt das Objekt aus dem angegebenen JSON-Reader im Azure Cosmos DB-Dienst. (Geerbt von JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)	Lädt das Objekt aus dem angegebenen JSON-Reader im Azure Cosmos DB-Dienst. (Geerbt von JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)	Speichert das Objekt im angegebenen Stream im Azure Cosmos DB-Dienst. (Geerbt von JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)	Speichert das Objekt im angegebenen Stream im Azure Cosmos DB-Dienst. (Geerbt von JsonSerializable)
SetPropertyValue(String, Object)	Legt den Eigenschaftenwert fest, der dem angegebenen Eigenschaftsnamen im Azure Cosmos DB-Dienst zugeordnet ist. (Geerbt von Resource)
ToByteArray()	Serialisieren Sie über SaveTo für den Azure Cosmos DB-Dienst in ein Bytearray. (Geerbt von Resource)
ToString()	Gibt die Zeichenfolgendarstellung des Objekts im Azure Cosmos DB-Dienst zurück. (Geerbt von JsonSerializable)