Gespeicherte Prozeduren, Trigger und benutzerdefinierte Funktionen

  • Artikel

GILT FÜR: NoSQL

Azure Cosmos DB ermöglicht die in die JavaScript-Sprache integrierte, transaktionale Ausführung von JavaScript. Wenn Sie die API für NoSQL in Azure Cosmos DB verwenden, können Sie gespeicherte Prozeduren, Trigger und benutzerdefinierte Funktionen (User-Defined Functions, UDFs) in der JavaScript-Sprache schreiben. Sie können Ihre Logik in JavaScript-Code schreiben, der in der Datenbank-Engine ausgeführt wird. Sie können Trigger, gespeicherte Prozeduren und benutzerdefinierte Funktionen im Azure-Portal, mithilfe der JavaScript-Language Integrated Query-API in Azure Cosmos DB oder mit den Azure Cosmos DB for NoSQL-Client-SDKs erstellen und ausführen.

Nutzen der serverseitigen Programmierung

Das Schreiben von gespeicherten Prozeduren, Triggern und benutzerdefinierten Funktionen in JavaScript ermöglicht Ihnen das Erstellen umfassender Anwendungen, die folgende Vorteile bieten:

  • Prozedurale Logik: JavaScript ist eine übergeordnete Programmiersprache, die eine umfangreiche und vertraute Schnittstelle zum Ausdrücken von Geschäftslogik bietet. Sie können eine Sequenz komplexer Vorgänge für die Daten ausführen.

  • Unteilbare Transaktionen: Azure Cosmos DB-Datenbankvorgänge, die in einer einzelnen gespeicherten Prozedur oder einem Trigger ausgeführt werden, sind unteilbar. Durch diese Unteilbarkeit kann eine Anwendung zusammengehörige Vorgänge in einem einzelnen Batch kombinieren, sodass entweder alle Vorgänge erfolgreich ausgeführt werden oder keiner von ihnen.

  • Leistung: Die JSON-Daten sind dem Typensystem der JavaScript-Sprache zugeordnet. Diese Zuordnung ermöglicht eine Reihe von Optimierungen, beispielsweise die verzögerte Materialisierung von JSON-Dokumenten im Pufferpool und deren bedarfsgesteuerte Bereitstellung für den ausführenden Code. Die Verlagerung der Geschäftslogik in die Datenbank bietet noch weitere Leistungsvorteile:

    • Batchverarbeitung: Sie können Vorgänge wie Einfügungen gruppieren und dann gleichzeitig übermitteln. Die durch die Wartezeit des Netzwerkdatenverkehrs verursachten Kosten und der erhöhte Speicheraufwand für die Erstellung separater Transaktionen werden erheblich verringert.

    • Vorkompilierung: Gespeicherte Prozeduren, Trigger und benutzerdefinierte Funktionen werden implizit im Bytecodeformat vorkompiliert, um die aufwendige Kompilierung bei jedem Skriptaufruf zu vermeiden. Durch die Vorkompilierung werden gespeicherte Prozeduren schnell und mit geringem Speicherbedarf aufgerufen.

    • Sequenzierung: Manchmal erfordern Vorgänge einen Auslösemechanismus, der eine oder zusätzliche Aktualisierungen an den Daten vornehmen kann. Neben der Unteilbarkeit ergeben sich durch die Ausführung auf dem Server auch Leistungsvorteile.

  • Kapselung: Mithilfe gespeicherter Prozeduren kann die Logik an einem Ort zusammengefasst werden. Durch die Kapselung wird eine Abstraktionsebene über den Daten hinzugefügt, die es Ihnen erlaubt, Ihre Anwendungen unabhängig von den Daten zu entwickeln. Diese Abstraktionsebene ist hilfreich, wenn die Daten kein Schema aufweisen und Sie keine zusätzliche Logik direkt in der Anwendung hinzufügen müssen. Durch diese Abstraktion können Sie den Zugriff über die Scripts optimieren und Ihre Daten schützen.

Tipp

Gespeicherte Prozeduren eignen sich am besten für Vorgänge mit vielen Schreibvorgängen und erfordern eine Transaktion über einen Partitionsschlüsselwert. Bei der Überlegung, ob Sie gespeicherte Prozeduren verwenden, sollten Sie die Kapselung der maximal möglichen Anzahl von Schreibvorgängen optimieren. Gespeicherte Prozeduren sind im Allgemeinen nicht die effizienteste Methode für die Ausführung zahlreicher Lese- oder Abfragevorgänge. Eine große Anzahl von an den Client zurückzugebenden Lesevorgängen mithilfe von gespeicherten Prozeduren in einem Batch zusammenzufassen, bietet daher nicht den gewünschten Nutzen. Um eine optimale Leistung zu erzielen, sollten Vorgänge mit zahlreichen Lesevorgängen auf der Clientseite unter Verwendung des Azure Cosmos DB SDK ausgeführt werden.

Hinweis

Serverseitige JavaScript-Features, einschließlich gespeicherter Prozeduren, Trigger und benutzerdefinierter Funktionen, unterstützen das Importieren von Modulen nicht.

Transaktionen

Eine Transaktion in einer typischen Datenbank kann als Folge von Vorgängen definiert werden, die als einzelne logische Arbeitseinheit ausgeführt wird. Jede Transaktion bietet ACID-Eigenschaftsgarantien. ACID ist ein bekanntes Akronym und steht für Atomicity, Consistency, Isolation und Durability (Atomarität, Konsistenz, Isolation, Dauerhaftigkeit).

  • Die Atomarität bzw. Unteilbarkeit gewährleistet, dass alle innerhalb einer Transaktion ausgeführten Vorgänge als eine einzige Einheit betrachtet werden und entweder alle Vorgänge committet werden oder keiner von ihnen.

  • Die Konsistenz stellt sicher, dass die Daten zwischen den Transaktionen immer einen gültigen Zustand aufweisen.

  • Die Isolation sorgt dafür, dass es niemals zu Konflikten zwischen zwei Transaktionen kommt. Viele kommerzielle Systeme bieten mehrere Isolationsstufen, die je nach Anforderungen der Anwendung genutzt werden können.

  • Die Dauerhaftigkeit stellt sicher, dass jede Änderung, die in einer Datenbank committet wird, immer vorhanden ist.

In Azure Cosmos DB wird die JavaScript-Runtime in der Datenbank-Engine gehostet. Daher werden Anforderungen in den gespeicherten Prozeduren und Triggern im gleichen Bereich ausgeführt wie die Datenbanksitzung. Durch dieses Feature kann Azure Cosmos DB die vier ACID-Eigenschaften für alle Vorgänge garantieren, die Teil einer gespeicherten Prozedur oder eines Triggers sind. Beispiele finden Sie im Artikel zum Implementieren von Transaktionen.

Tipp

Zur Transaktionsunterstützung in Azure Cosmos DB for NoSQL können Sie auch einen Transaktionsbatch mit Ihrem bevorzugten Client-SDK implementieren. Weitere Informationen finden Sie unter Transaktionsbatchvorgänge in Azure Cosmos DB for NoSQL.

Bereich einer Transaktion

Gespeicherte Prozeduren sind einem Azure Cosmos DB-Container zugeordnet. Die Ausführung gespeicherter Prozeduren ist auf einen logischen Partitionsschlüssel beschränkt. Gespeicherte Prozeduren müssen während der Ausführung einen logischen Partitionsschlüsselwert enthalten, der die logische Partition für den Transaktionsumfang definiert. Weitere Informationen finden Sie unter Partitionierung in Azure Cosmos DB.

Commit und Rollback

Transaktionen sind nativ in das JavaScript-Programmiermodell von Azure Cosmos DB integriert. Innerhalb einer JavaScript-Funktion werden alle Vorgänge automatisch von einer einzelnen Transaktion umschlossen. Wenn die JavaScript-Logik in einer gespeicherten Prozedur ohne Ausnahmen abgeschlossen wird, werden alle Vorgänge in der Transaktion in die Datenbank committet. Anweisungen wie BEGIN TRANSACTION und COMMIT TRANSACTION (bei relationalen Datenbanken bekannt) sind in Azure Cosmos DB implizit. Wenn das Skript Ausnahmen ausgibt, führt die JavaScript-Runtime von Azure Cosmos DB ein Rollback für die gesamte Transaktion aus. Das Auslösen einer Ausnahme entspricht daher praktisch einer ROLLBACK TRANSACTION in Azure Cosmos DB.

Datenkonsistenz

Gespeicherte Prozeduren und Trigger werden immer auf dem primären Replikat eines Azure Cosmos DB-Containers ausgeführt. Dadurch wird sichergestellt, dass Lesevorgänge in gespeicherten Prozeduren eine hohe Konsistenz aufweisen. Abfragen mit benutzerdefinierten Funktionen können auf dem primären oder einem sekundären Replikat ausgeführt werden. Gespeicherte Prozeduren und Trigger dienen zur Unterstützung von Transaktionsschreibvorgängen. Schreibgeschützte Logik lässt sich dagegen am besten als anwendungsseitige Logik und Abfragen unter Verwendung der Azure Cosmos DB for NoSQL SDKs implementieren. Dies trägt dazu bei, den Datenbankdurchsatz vollständig zu nutzen.

Tipp

Bei innerhalb einer gespeicherten Prozedur oder eines Triggers ausgeführten Abfragen werden möglicherweise keine Änderungen angezeigt, die von derselben Skripttransaktion an Elementen vorgenommen wurden. Dies gilt sowohl für SQL-Abfragen wie z. B. getContent().getCollection().queryDocuments() als auch für integrierte Sprachabfragen wie z. B. getContext().getCollection().filter().

Gebundene Ausführung

Alle Azure Cosmos DB-Vorgänge müssen innerhalb der angegebenen Timeoutdauer abgeschlossen werden. Für gespeicherte Prozeduren gilt ein Zeitlimit von 5 Sekunden. Diese Einschränkung gilt auch für JavaScript-Funktionen (gespeicherte Prozeduren, Trigger und benutzerdefinierte Funktionen). Wird ein Vorgang nicht innerhalb dieses Zeitlimits abgeschlossen, wird für die Transaktion ein Rollback ausgeführt.

Sie können entweder sicherstellen, dass Ihre JavaScript-Funktionen innerhalb des Zeitlimits abgeschlossen werden oder ein auf der Fortführung basierendes Modell implementieren, um die Ausführung in einem Batch zusammenzufassen/fortzusetzen. Um die Entwicklung gespeicherter Prozeduren und Trigger zur Behandlung von Zeitlimits zu vereinfachen, geben alle Funktionen unter dem Azure Cosmos DB-Container (z. B. Erstellen, Lesen, Ersetzen und Löschen von Elementen) einen booleschen Wert zurück, der angibt, ob der jeweilige Vorgang abgeschlossen wird. Lautet dieser Wert „false“, weist dies darauf hin, dass die Prozedur die Ausführung beenden muss, weil das Skript mehr Zeit oder bereitgestellten Durchsatz beansprucht als der konfigurierte Wert zulässt. Vorgänge, die vor dem ersten nicht akzeptierten Speichervorgang in die Warteschlange gestellt wurden, werden garantiert fertiggestellt, wenn die gespeicherte Prozedur rechtzeitig abgeschlossen wird und keine weiteren Anforderungen in die Warteschlange stellt. Daher sollten Vorgänge mithilfe der Rückrufkonvention von JavaScript nacheinander in die Warteschlange eingereiht werden, um die Ablaufsteuerung des Skripts zu verwalten. Da Skripts in einer serverseitigen Umgebung ausgeführt werden, unterliegen sie einen strikten Kontrolle und Steuerung. Skripts, die wiederholt Ausführungsgrenzen verletzt haben, werden möglicherweise als inaktiv markiert und können nicht ausgeführt werden. Sie sollten unter Berücksichtigung der Ausführungsgrenzen neu erstellt werden.

Für JavaScript-Funktionen gilt auch die bereitgestellte Durchsatzkapazität. Letztendlich können JavaScript-Funktionen unter Umständen eine große Anzahl von Anforderungseinheiten innerhalb eines kurzen Zeitraums verwenden. Wenn die bereitgestellte Durchsatzkapazität erreicht ist, werden sie möglicherweise begrenzt. Wichtig ist, dass Skripts neben dem Durchsatz für die Ausführung von Datenbankvorgängen zusätzlichen Durchsatz beanspruchen. Diese Datenbankvorgänge sind jedoch etwas weniger aufwendig als die Ausführung der gleichen Vorgänge über den Client.

Auslöser

Azure Cosmos DB unterstützt zwei Arten von Triggern:

Vorangestellte Trigger

Azure Cosmos DB stellt Trigger bereit, die durch Ausführen eines Vorgangs für ein Azure Cosmos DB-Element aufgerufen werden können. Sie können beispielsweise beim Erstellen eines Elements einen vorangestellter Trigger angeben. In diesem Fall wird der vorangestellte Trigger ausgeführt, bevor das Element erstellt wird. Vorangestellte Trigger können keine Eingabeparameter übernehmen. Bei Bedarf kann das Anforderungsobjekt verwendet werden, um den Dokumenttext der ursprünglichen Anforderung zu aktualisieren. Wenn Trigger registriert werden, können die Benutzer die Vorgänge angeben, mit denen sie ausgeführt werden können. Wenn ein Trigger mit TriggerOperation.Create erstellt wurde, bedeutet dies, dass die Verwendung des Triggers in einem Ersetzungsvorgang nicht zulässig ist. Beispiele finden Sie unter Schreiben von Triggern.

Nachgestellte Trigger

Ähnlich wie vorangestellte Trigger sind nachgestellte Trigger ebenfalls einem Vorgang für ein Azure Cosmos DB-Element zugeordnet, und sie erfordern keine Eingabeparameter. Sie werden ausgeführt, nachdem der Vorgang abgeschlossen wurde, und haben Zugriff auf die Antwortnachricht, die an den Client gesendet wird. Beispiele finden Sie unter Schreiben von Triggern.

Hinweis

Registrierte Trigger werden bei Auftreten der entsprechenden Vorgänge (Erstellen/Löschen/Ersetzen/Aktualisieren) nicht automatisch ausgeführt. Sie müssen beim Ausführen dieser Vorgänge explizit aufgerufen werden. Weitere Informationen finden Sie im Artikel Ausführen von Triggern.

Benutzerdefinierte Funktionen

Mithilfe von benutzerdefinierten Funktionen (User-Defined Functions, UDFs) kann die Syntax der „API für NoSQL“-Abfragesprache erweitert und mühelos eine benutzerdefinierte Geschäftslogik implementiert werden. Benutzerdefinierte Funktionen können nur innerhalb von Abfragen aufgerufen werden. UDFs haben keinen Zugriff auf das Kontextobjekt und sind als JavaScript-Komponente vorgesehen, die ausschließlich der Berechnung dient. Daher können benutzerdefinierte Funktionen auf sekundären Replikaten ausgeführt werden.

JavaScript-Language Integrated Query (LINQ)-API

Zusätzlich zu Abfragen mit der „API für NoSQL“-Abfragesyntax ermöglicht das serverseitige SDK die Durchführung von Abfragen mithilfe einer JavaScript-Schnittstelle, die keinerlei SQL-Kenntnisse voraussetzt. Mit der JavaScript-Abfrage-API können Sie programmgesteuert Abfragen erstellen, indem Sie Prädikatfunktionen an eine Funktionsaufrufsequenz übergeben. Abfragen werden von der JavaScript-Runtime analysiert und in Azure Cosmos DB effizient ausgeführt. Weitere Informationen zur Unterstützung der JavaScript-Abfrage-API finden Sie im Artikel Working with JavaScript language integrated query API (Arbeiten mit der JavaScript-Language Integrated Query-API). Beispiele finden Sie im Artikel Schreiben von gespeicherten Prozeduren und Triggern mit der JavaScript-Abfrage-API.

Nächste Schritte

Lesen Sie die folgenden Artikel, um sich mit dem Schreiben und Verwenden von gespeicherten Prozeduren, Triggern und benutzerdefinierten Funktionen in Azure Cosmos DB vertraut zu machen:

Versuchen Sie, die Kapazitätsplanung für eine Migration zu Azure Cosmos DB durchzuführen? Sie können Informationen zu Ihrem vorhandenen Datenbankcluster für die Kapazitätsplanung verwenden.