DBMS_PIPE-Package

Mit dem Package DBMS_PIPE können zwei oder mehr Sessions in derselben Instanz kommunizieren.

Oracle Autonomous Database unterstützt die DBMS_PIPE-Corefunktionalität, wie in Oracle Database 19c verfügbar, sowie Erweiterungen.

Weitere Informationen zur DBMS_PIPE-Corefunktionalität in Oracle Database finden Sie unter DBMS_PIPE.

DBMS_PIPE Überblick über Singleton-Pipes

Pipe-Funktionalität hat mehrere potenzielle Anwendungen: externe Serviceschnittstelle, Debugging, unabhängige Transaktionen und Warnungen.

In Autonomous Database verfügt das DBMS_PIPE-Package über erweiterte Funktionen zur Unterstützung von Singleton-Pipes.

Singleton-Pipe-Funktionen in DBMS_PIPE stellen Folgendes bereit:

  • Möglichkeit, eine benutzerdefinierte Nachricht von bis zu 32.767 Byte im Oracle-Datenbankspeicher zu cachen und abzurufen. Die maximale Nachrichtengröße von 32.767 Byte gilt für alle Pipes, einschließlich Singleton Pipes. Frühere Versionen von DBMS_PIPE hatten eine geringere maximale Nachrichtengröße.

  • Geben Sie die gecachte Nachricht für mehrere Datenbanksessions mit gleichzeitigen Lesezugriffen frei.

  • Cacheinvalidierungsmethoden:

    • Explizite Cacheinvalidierung, die vom Benutzer gesteuert wird.
    • Cacheinvalidierung nach einem vom Benutzer angegebenen Parameterzeitintervall (shelflife) (in Sekunden).
  • Deklarativ und einfach zu verwendende PL/SQL-APIs für das Caching.

  • Unterstützt sowohl schreibgeschützte als auch schreibgeschützte Datenbanken.

Eine Singleton Pipe kann einer der unterstützten DBMS_PIPE-Typen sein:

  • Implizite Pipe: Wird automatisch erstellt, wenn eine Nachricht mit einem unbekannten Pipe-Namen mit der Funktion DBMS_PIPE.SEND_MESSAGE gesendet wird.
  • Explizite Pipe: Wird mit der Funktion DBMS_PIPE.CREATE_PIPE mit einem benutzerdefinierten Pipe-Namen erstellt.
  • Öffentliche Pipe: Zugriff durch jeden Benutzer mit der Berechtigung EXECUTE für das Package DBMS_PIPE
  • Private Pipe: Zugriff durch Sessions mit demselben Benutzer wie der Pipe-Ersteller.

Zusammenfassung der DBMS_PIPE-Unterprogramme für Singleton-Pipes

In dieser Tabelle werden die Unterprogramme DBMS_PIPE aufgeführt und kurz beschrieben.

Tabelle 6-1: Unterprogramme des Packages DBMS_PIPE

Unterprogramm Beschreibung

Funktion CREATE_PIPE

Erstellt eine Pipe (für private Pipes erforderlich)

Funktion NEXT_ITEM_TYPE

Gibt den Datentyp des nächsten Elements im Puffer zurück

PACK_MESSAGE-Prozeduren

Erstellt Meldung im lokalen Puffer

LÖSCHEN

Löscht den Inhalt der benannten Pipe

Funktion RECEIVE_MESSAGE

Kopiert Nachricht aus benannter Pipe in lokalen Puffer

Prozedur RESET_BUFFER

Löscht den Inhalt des lokalen Puffers

Funktion REMOVE_PIPE

Entfernt die benannte Pipe

Funktion SEND_MESSAGE

Sendet Nachricht an benannte Pipe: Dadurch wird implizit eine öffentliche Pipe erstellt, wenn die benannte Pipe nicht vorhanden ist

Funktion UNIQUE_SESSION_NAME

Gibt einen eindeutigen Sessionnamen zurück

UNPACK_MESSAGE-Prozeduren

Greift auf das nächste Element im Puffer zu

Funktion CREATE_PIPE

Diese Funktion erstellt explizit eine öffentliche oder private Pipe. Wenn das Flag private TRUE ist, wird der Pipe-Ersteller als Eigentümer der privaten Pipe zugewiesen.

Explizit erstellte Pipes können nur entfernt werden, indem REMOVE_PIPE aufgerufen oder die Instanz heruntergefahren wird.

Um eine Singleton-Pipe zu erstellen, setzen Sie den Parameter singleton auf TRUE. Die folgenden Argumente gelten für Singleton Pipes:

  • singleton: Gibt an, dass die Pipe als Singleton-Pipe erstellt werden soll (Standardwert: FALSE).

  • shelflife: Geben Sie optional ein Ablaufdatum (in Sekunden) der gecachten Nachricht in der Singleton Pipe an. Sie kann für die implizite Invalidierung von Nachrichten in Singleton Pipe verwendet werden.

    Die Nachricht shelflife in Singleton Pipe kann auch angegeben werden, wenn Sie eine Nachricht senden (siehe Funktion SEND_MESSAGE).

Syntax

DBMS_PIPE.CREATE_PIPE (
   pipename     IN VARCHAR2,
   maxpipesize  IN INTEGER DEFAULT 66536,
   private      IN BOOLEAN DEFAULT TRUE,
   singleton    IN BOOLEAN DEFAULT FALSE,
   shelflife    IN INTEGER DEFAULT 0)
RETURN INTEGER;

Parameter

Tabelle 6-2: Funktionsparameter CREATE_PIPE

Parameter Beschreibung

pipename

Name der Pipe, die Sie erstellen.

Sie müssen diesen Namen verwenden, wenn Sie SEND_MESSAGE und RECEIVE_MESSAGE aufrufen. Dieser Name muss instanzübergreifend eindeutig sein.

Achtung: Verwenden Sie keine Pipe-Namen, die mit ORA$ beginnen. Diese sind für die von Oracle bereitgestellten Verfahren reserviert. Pipename darf nicht länger als 128 Byte sein und die Groß-/Kleinschreibung wird nicht beachtet. Derzeit darf der Name keine Zeichen für die Globalisierungsunterstützung enthalten.

maxpipesize

Die maximal zulässige Größe für die Pipe in Byte.

Die Gesamtgröße aller Nachrichten in der Pipe darf diesen Betrag nicht überschreiten. Die Nachricht wird blockiert, wenn sie dieses Maximum überschreitet.

Der Standardwert für maxpipesize ist 66536 Byte.

Die maxpipesize für ein Rohr wird Teil der Eigenschaften des Rohres und bleibt für die Lebensdauer des Rohres bestehen. Aufrufer von SEND_MESSAGE mit größeren Werten führen dazu, dass maxpipesize erhöht wird. Anrufer mit einem kleineren Wert verwenden den vorhandenen, größeren Wert.

Der Standardwert maxpipesize von 65536 gilt für alle Pipes.

private

Verwendet den Standardwert TRUE, um eine private Pipe zu erstellen.

Öffentliche Pipes können implizit erstellt werden, wenn Sie SEND_MESSAGE aufrufen.

singleton

Verwenden Sie TRUE, um eine Singleton Pipe zu erstellen.

Standardwert: FALSE

shelflife

Ablaufzeit in Sekunden einer in Singleton Pipe gecachten Nachricht. Nachdem die angegebene shelflife-Zeit überschritten wurde, ist die Nachricht nicht mehr über die Pipe zugänglich. Der Parameter shelflife gilt nur für eine Singleton Pipe.

Der Standardwert ist 0. Dies bedeutet, dass die Nachricht nie abläuft.

Rückgabewerte

Tabelle 6-3: Rückgabewerte der Funktion CREATE_PIPE

Zurückgehen Beschreibung

0

Erfolgreich.

Wenn die Pipe bereits vorhanden ist und der Benutzer, der sie zu erstellen versucht, zur Verwendung autorisiert ist, gibt Oracle 0 zurück, was den Erfolg anzeigt, und alle Daten, die sich bereits in der Pipe befinden, bleiben erhalten.

6

Vorhandene Pipe konnte nicht in Singleton-Pipe konvertiert werden.

  • Implizite Pipe mit mehreren vorhandenen Nachrichten kann nicht in eine Singleton Pipe konvertiert werden.
  • Bei einer expliziten Pipe, die nicht Singleton ist, kann DBMS_PIPE.SEND_MESSAGE keine Nachricht senden, deren Singleton-Argument auf TRUE gesetzt ist.

7

Für den Parameter shelflife wird ein Wert ungleich Null angegeben, und die Pipe ist keine Singleton-Pipe.

ORA-23322

Fehler aufgrund eines Namenskonflikts.

Wenn eine Pipe mit demselben Namen vorhanden ist und von einem anderen Benutzer erstellt wurde, gibt Oracle den Fehler ORA-23322 an, der auf den Namenskonflikt hinweist.

Ausnahmen

Tabelle 6-4: Funktionsausnahme CREATE_PIPE

Ausnahme Beschreibung

Null pipe name

Berechtigungsfehler: Pipe mit demselben Namen ist bereits vorhanden, und Sie dürfen ihn nicht verwenden.

Beispiel

Erstellen Sie eine Singleton Pipe mit einer Haltbarkeit von 1 Stunde.

DECLARE
  l_status INTEGER;
BEGIN
  l_status := DBMS_PIPE.create_pipe(pipename  => 'MY_PIPE1',
                                    private   => TRUE,
                                    singleton => TRUE,
                                    shelflife => 3600);
END;
/

Funktion RECEIVE_MESSAGE

Diese Funktion kopiert die Nachricht in den lokalen Nachrichtenpuffer.

Syntax

DBMS_PIPE.RECEIVE_MESSAGE (
   pipename      IN VARCHAR2,
   timeout       IN INTEGER      DEFAULT maxwait,
   cache_func    IN VARCHAR2     DEFAULT NULL)
RETURN INTEGER;

Parameter

Tabelle 6-5: Funktionsparameter RECEIVE_MESSAGE

Parameter Beschreibung

pipename

Name der Pipe, auf der eine Nachricht empfangen werden soll.

Namen, die mit ORA$ beginnen, sind für die Verwendung durch Oracle reserviert.

timeout

Wartezeit für eine Nachricht in Sekunden. Mit einem Timeout von 0 können Sie lesen, ohne zu blockieren.

Der Timeout enthält nicht die Zeit, die in der Ausführungscachefunktion verbracht wurde, die im Parameter cache_func angegeben ist.

Standardwert: Die Konstante MAXWAIT, die als 86400000 (1000 Tage) definiert ist.

cache_func

Cachen Sie den Funktionsnamen, um eine Nachricht automatisch in einer Singleton Pipe zu cachen.

Der Name der Funktion muss mit dem Eigentümerschema vollqualifiziert sein:

  • OWNER.FUNCTION_NAME
  • OWNER.PACKAGE.FUNCTION_NAME

Standardwert: NULL

Rückgabewerte

Tabelle 6-6: Rückgabewerte der Funktion RECEIVE_MESSAGE

Zurückgehen Beschreibung

0

Erfolgreich

1

Zeitüberschreitung Wenn die Pipe implizit erstellt wurde und leer ist, wird sie entfernt.

2

Datensatz in der Pipe ist zu groß für den Puffer.

3

Eine Unterbrechung ist aufgetreten.

8

Cachefunktion kann nur bei Verwendung einer Singleton Pipe angegeben werden.

ORA-23322

Der Benutzer hat keine ausreichenden Berechtigungen zum Lesen aus der Pipe.

Hinweise zur Verwendung

Um eine Nachricht von einer Pipe zu empfangen, rufen Sie zuerst RECEIVE_MESSAGE auf. Wenn Sie eine Nachricht erhalten, wird sie aus der Pipe entfernt. Daher kann eine Nachricht nur einmal empfangen werden. Bei implizit erstellten Rohren wird das Rohr entfernt, nachdem der letzte Datensatz aus dem Rohr entfernt wurde.

Wenn die Pipe, die Sie beim Aufruf von RECEIVE_MESSAGE angeben, noch nicht vorhanden ist, erstellt Oracle implizit die Pipe und wartet auf den Empfang der Nachricht. Wenn die Nachricht nicht innerhalb eines festgelegten Timeoutintervalls ankommt, wird der Aufruf zurückgegeben und die Pipe entfernt.

Nachdem Sie die Nachricht erhalten haben, müssen Sie mindestens einen Aufruf an UNPACK_MESSAGE vornehmen, um auf die einzelnen Elemente in der Nachricht zuzugreifen. Die Prozedur UNPACK_MESSAGE wird überladen, um Elemente des Typs DATE, NUMBER, VARCHAR2 zu entpacken. Außerdem gibt es zwei zusätzliche Prozeduren zum Entpacken von RAW- und ROWID-Elementen. Wenn Sie den Typ der Daten, die Sie entpacken möchten, nicht kennen, rufen Sie NEXT_ITEM_TYPE auf, um den Typ des nächsten Elements im Puffer zu bestimmen.

Cachefunktionsparameter

Singleton Pipes unterstützt die Cache-Funktion, um eine Nachricht automatisch in der Pipe zu cachen, falls die folgenden beiden Szenarios auftreten:

  • Singleton Pipe ist leer.
  • Nachricht in Singleton-Pipe ist aufgrund der verstrichenen shelflife-Zeit ungültig.

Der Name der Funktion muss mit dem Eigentümerschema vollqualifiziert sein:

  • OWNER.FUNCTION_NAME
  • OWNER.PACKAGE.FUNCTION_NAME

Um eine Cachefunktion verwenden zu können, muss der aktuelle Sessionbenutzer, der DBMS_PIPE.RECEIVE_MESSAGE aufruft, über die erforderlichen Berechtigungen zum Ausführen der Cachefunktion verfügen.

Cachefunktionssyntax

CREATE OR REPLACE FUNCTION cache_function_name (
       pipename  IN VARCHAR2
) RETURN INTEGER;
Parameter Datentyp Beschreibung

pipename

VARCHAR2

Name der Singleton Pipe.

Zurückgehen Beschreibung
0 Erfolgreich
Nicht null Fehlerwert von DBMS_PIPE.RECEIVE_MESSAGE zurückgegeben

Definieren Sie eine Cache-Funktion, um eine Kapselung und Abstraktion der Komplexität aus den Lesersessions von Singleton Pipe bereitzustellen. Typische Vorgänge innerhalb einer Cache-Funktion sind:

  • Erstellen Sie eine Singleton-Pipe für eine explizite Pipe mit DBMS_PIPE.CREATE_PIPE.
  • Erstellen Sie die Nachricht, die in der Singleton Pipe gecacht werden soll.
  • Nachricht an Singleton Pipe senden, optional mit shelflife für die implizite Nachricht.

Ausnahmen

Tabelle 6-7: Funktionsausnahmen RECEIVE_MESSAGE

Ausnahme Beschreibung

Null pipe name

Berechtigungsfehler. Unzureichende Berechtigung zum Entfernen des Datensatzes aus der Pipe. Die Pipe gehört einer anderen Person.

Beispiel

DECLARE
  l_status INTEGER;
BEGIN
  l_status := DBMS_PIPE.receive_message(pipename   => 'MY_PIPE1',
                                        timeout    => 1,
                                        cache_func => 'MY_USER.MY_CACHE_FUNC');
END;
/

Funktion SEND_MESSAGE

Diese Funktion sendet eine Nachricht an die benannte Pipe.

Die Nachricht ist im lokalen Nachrichtenpuffer enthalten, der mit Aufrufen an PACK_MESSAGE gefüllt wurde. Sie können eine Pipe explizit mit CREATE_PIPE erstellen. Andernfalls wird sie implizit erstellt.

Um eine implizite Singleton-Pipe zu erstellen, setzen Sie den Parameter singleton auf TRUE. Die folgenden Argumente gelten für Singleton Pipes:

  • singleton: Gibt an, dass die Pipe als Singleton-Pipe erstellt werden soll (Standardwert: FALSE).
  • shelflife: Geben Sie optional einen Ablauf der gecachten Nachricht in der Singleton Pipe an. Sie kann für die implizite Invalidierung von Nachrichten in Singleton Pipe verwendet werden.

    Dieses Argument gilt sowohl für implizite als auch explizite Singleton-Pipes. Ein shelflife-Wert, der in der SEND_MESSAGE-Funktion angegeben ist, überschreibt die shelflife, die für die explizite Singleton-Pipe in der CREATE_PIPE-Funktion angegeben wurde, und ist der Standard für alle neuen Nachrichten, die in der Singleton-Pipe gecacht werden.

Syntax

DBMS_PIPE.SEND_MESSAGE (
    pipename     IN VARCHAR2,
    timeout      IN INTEGER DEFAULT MAXWAIT,
    maxpipesize  IN INTEGER DEFAULT 65536,
    singleton    IN BOOLEAN DEFAULT FALSE,
    shelflife    IN INTEGER DEFAULT 0)
RETURN INTEGER;

Parameter

Tabelle 6-8: Funktionsparameter SEND_MESSAGE

Parameter Beschreibung

pipename

Name der Pipe, auf der die Nachricht abgelegt werden soll.

Wenn Sie eine explizite Pipe verwenden, ist dies der Name, den Sie beim Aufruf von CREATE_PIPE angegeben haben.

Achtung: Verwenden Sie keine Pipe-Namen, die mit "ORA$" beginnen. Diese Namen sind für die Verwendung durch von Oracle bereitgestellte Prozeduren reserviert. Pipename darf nicht länger als 128 Byte sein und die Groß-/Kleinschreibung wird nicht beachtet. Derzeit darf der Name keine Zeichen für die Globalisierungsunterstützung enthalten.

timeout

Wartezeit beim Versuch, eine Nachricht in einer Pipe zu platzieren, in Sekunden.

Der Standardwert ist die Konstante MAXWAIT, die als 86400000 (1000 Tage) definiert ist.

maxpipesize

Maximal zulässige Größe für die Pipe in Byte.

Die Gesamtgröße aller Nachrichten in der Pipe darf diesen Betrag nicht überschreiten. Die Nachricht wird blockiert, wenn sie dieses Maximum überschreitet. Der Standardwert beträgt 65536 Byte.

Die maxpipesize für ein Rohr wird Teil der Eigenschaften des Rohres und bleibt für die Lebensdauer des Rohres bestehen. Aufrufer von SEND_MESSAGE mit größeren Werten führen dazu, dass maxpipesize erhöht wird. Anrufer mit einem kleineren Wert verwenden einfach den vorhandenen, größeren Wert.

Wenn Sie maxpipesize als Teil der Prozedur SEND_MESSAGE angeben, ist kein separater Aufruf zum Öffnen der Pipe erforderlich. Wenn Sie die Pipe explizit erstellt haben, können Sie den optionalen Parameter maxpipesize verwenden, um die Spezifikationen für die Erstellungs-Pipe-Größe außer Kraft zu setzen.

Der Standardwert maxpipesize von 65536 gilt für alle Pipes.

singleton

Verwenden Sie TRUE, um eine Singleton Pipe zu erstellen.

Standardwert: FALSE

shelflife

Ablaufzeit in Sekunden einer in Singleton Pipe gecachten Nachricht.

Nachdem die angegebene shelflife-Zeit überschritten wurde, ist die Nachricht nicht mehr über die Pipe zugänglich. Der Parameter shelflife gilt nur für eine Singleton Pipe.

Der Standardwert ist 0. Dies bedeutet, dass die Nachricht nie abläuft.

Rückgabewerte

Tabelle 6-9: Rückgabewerte der Funktion SEND_MESSAGE

Zurückgehen Beschreibung

0

Erfolg.

Wenn die Pipe bereits vorhanden ist und der Benutzer, der sie zu erstellen versucht, zur Verwendung autorisiert ist, gibt Oracle 0 zurück, was den Erfolg anzeigt, und alle Daten, die sich bereits in der Pipe befinden, bleiben erhalten.

Wenn ein als SYSDBS/SYSOPER verbundener Benutzer eine Pipe neu erstellt, gibt Oracle den Status 0 zurück, der Eigentümer der Pipe bleibt jedoch unverändert.

1

Zeitüberschreitung

Bei diesem Verfahren kann ein Timeout auftreten, weil es keine Sperre für das Rohr erhalten kann oder weil das Rohr zu voll ist, um verwendet zu werden. Wenn die Pipe implizit erstellt wurde und leer ist, wird sie entfernt.

3

Eine Unterbrechung ist aufgetreten.

Wenn die Pipe implizit erstellt wurde und leer ist, wird sie entfernt.

6

Vorhandene Pipe konnte nicht in Singleton-Pipe konvertiert werden.

  • Implizite Pipe mit mehreren vorhandenen Nachrichten kann nicht in eine Singleton Pipe konvertiert werden.
  • Bei einer expliziten Pipe, die nicht Singleton ist, kann DBMS_PIPE.SEND_MESSAGE keine Nachricht senden, deren Singleton-Argument auf TRUE gesetzt ist.

7

Für den Parameter shelflife wird ein Wert ungleich Null angegeben, und die Pipe ist keine Singleton-Pipe.

ORA-23322

Unzureichende Berechtigungen.

Wenn eine Pipe mit demselben Namen vorhanden ist und von einem anderen Benutzer erstellt wurde, gibt Oracle den Fehler ORA-23322 an, der auf den Namenskonflikt hinweist.

Ausnahmen

Tabelle 6-10: Funktionsausnahme SEND_MESSAGE

Ausnahme Beschreibung

Null pipe name

Berechtigungsfehler. Unzureichende Berechtigung zum Schreiben in die Pipe. Die Pfeife ist privat und gehört jemand anderem.

DBMS_PIPE Überblick über persistente Messaging-Pipes

Pipe-Funktionalität hat mehrere potenzielle Anwendungen: externe Serviceschnittstelle, Debugging, unabhängige Transaktionen und Warnungen.

In Autonomous Database verfügt das DBMS_PIPE-Package über erweiterte Funktionen zur Unterstützung persistenter Messaging-Pipes.

Persistente Nachrichten in DBMS_PIPE:

  • Unterstützen Sie die Möglichkeit, sehr große Nachrichten zu senden und abzurufen.

  • Unterstützt eine große Anzahl von Pipe-Nachrichten.

  • Unterstützen Sie die gemeinsame Nutzung von Nachrichten innerhalb einer einzigen Datenbank, über mehrere Datenbanken und über Datenbanken in verschiedenen Regionen hinweg.

  • Unterstützt mehrere Pipes mit derselben Cloud-Objektspeicherort-URI.

    Durch die persistente Messaging-Funktionalität können zwei oder mehr Datenbanksessions mit Nachrichten kommunizieren, die im Cloud-Objektspeicher gespeichert sind. Mit dieser Funktionalität können Nachrichten in einer Pipe nur für die aktuelle Datenbank verfügbar gemacht werden oder sie können für mehrere Datenbanken in derselben Region oder über verschiedene Regionen hinweg verfügbar gemacht werden.

    Eine persistente Messaging-Pipe kann einer der unterstützten DBMS_PIPE-Typen sein:

    • Implizite Pipe: Wird automatisch erstellt, wenn eine Nachricht mit einem unbekannten Pipe-Namen mit der Funktion DBMS_PIPE.SEND_MESSAGE gesendet wird.
    • Explizite Pipe: Wird mit der Funktion DBMS_PIPE.CREATE_PIPE mit einem benutzerdefinierten Pipe-Namen erstellt.
    • Öffentliche Pipe: Zugriff durch jeden Benutzer mit der Berechtigung EXECUTE für das Package DBMS_PIPE.
    • Private Pipe: Zugriff durch Sessions mit demselben Benutzer wie der Pipe-Ersteller.
Hinweis

Wenn Sie Nachrichten über verschiedene Datenbanken mit persistenten Nachrichten senden und empfangen, empfiehlt Oracle, dass Sie DBMS_PIPE.CREATE_PIPE anrufen, bevor Sie Nachrichten senden oder empfangen. Durch das Erstellen einer expliziten Pipe mit DBMS_PIPE.CREATE_PIPE wird sichergestellt, dass eine Pipe mit den gewünschten Zugriffsberechtigungen (öffentlich oder privat) erstellt wird (indem der Parameter PRIVATE auf FALSE gesetzt oder der Standardwert TRUE verwendet wird).

DBMS_PIPE Einschränkung

Das DBMS_PIPE-Package unterstützt das Senden von Nachrichten zwischen Datenbanken, die unterschiedliche Zeichensätze verwenden. Beispiel: Wenn Sie eine Autonomous Database-Instanz verwenden, die AL32UTF8 verwendet, und eine andere Instanz, die WE8MSWIN1252 verwendet, können Sie keine Nachrichten mit DBMS_PIPE zwischen diesen beiden Datenbanken senden. In diesem Fall löst das System den Fehler ORA-12704 aus, wenn Sie versuchen, Nachrichten mit DBMS_PIPE zwischen diesen beiden Datenbanken zu senden.

Weitere Informationen finden Sie unter Zeichensatz für Autonomous Database auswählen.

Zusammenfassung der DBMS_PIPE-Unterprogramme für persistentes Messaging

In dieser Tabelle werden die Unterprogramme DBMS_PIPE aufgeführt und kurz beschrieben.

Tabelle 6-11: Unterprogramme des Packages DBMS_PIPE

Unterprogramm Beschreibung

Funktion CREATE_PIPE

Erstellt eine Pipe (für private Pipes erforderlich).

Funktion GET_CREDENTIAL_NAME

Gibt den globalen Variablenwert credential_name zurück.

Funktion GET_LOCATION_URI

Gibt den globalen Variablenwert location_uri zurück, der als Standard-Speicherort-URI verwendet wird, wenn eine Nachricht im Cloud-Objektspeicher gespeichert wird.

Funktion NEXT_ITEM_TYPE

Gibt den Datentyp des nächsten Elements im Puffer zurück.

PACK_MESSAGE-Prozeduren

Erstellt Meldung im lokalen Puffer.

Funktion RECEIVE_MESSAGE

Kopiert die Nachricht aus der benannten Pipe in den lokalen Puffer.

Prozedur RESET_BUFFER

Löscht den Inhalt des lokalen Puffers.

Funktion REMOVE_PIPE

Entfernt die benannte Pipe.

Funktion SEND_MESSAGE

Sendet eine Nachricht an eine benannte Pipe: Dadurch wird implizit eine öffentliche Pipe erstellt, wenn die benannte Pipe nicht existiert.

Prozedur SET_CREDENTIAL_NAME

Legt die Variable credential_name fest, die als Standardzugangsdaten für Nachrichten verwendet wird, die im Cloud-Objektspeicher gespeichert sind.

Prozedur SET_LOCATION_URI

Legt die globale location_uri-Variable fest, die als Standardverzeichnis-URI für Nachrichten verwendet wird, die im Cloud-Objektspeicher gespeichert sind.

Funktion UNIQUE_SESSION_NAME

Gibt einen eindeutigen Sessionnamen zurück.

UNPACK_MESSAGE-Prozeduren

Greift auf das nächste Element im Puffer zu.

Funktion CREATE_PIPE

Diese Funktion erstellt explizit eine öffentliche oder private Pipe. Wenn das Flag private TRUE ist, wird der Pipe-Ersteller als Eigentümer der privaten Pipe zugewiesen.

Explizit erstellte Pipes können nur entfernt werden, indem REMOVE_PIPE aufgerufen oder die Instanz heruntergefahren wird.

Syntax

DBMS_PIPE.CREATE_PIPE (
   pipename     IN VARCHAR2,
   maxpipesize  IN INTEGER DEFAULT 66536,
   private      IN BOOLEAN DEFAULT TRUE)
RETURN INTEGER;

Parameter

Tabelle 6-12: Funktionsparameter CREATE_PIPE

Parameter Beschreibung

pipename

Name der Pipe, die Sie erstellen.

Sie müssen diesen Namen verwenden, wenn Sie SEND_MESSAGE und RECEIVE_MESSAGE aufrufen. Dieser Name muss instanzübergreifend eindeutig sein.

Achtung: Verwenden Sie keine Pipe-Namen, die mit ORA$ beginnen. Diese sind für die von Oracle bereitgestellten Verfahren reserviert. Pipename darf nicht länger als 128 Byte sein und die Groß-/Kleinschreibung wird nicht beachtet. Derzeit darf der Name keine Zeichen für die Globalisierungsunterstützung enthalten.

maxpipesize

Die maximal zulässige Größe für die Pipe in Byte.

Die Gesamtgröße aller Nachrichten in der Pipe darf diesen Betrag nicht überschreiten. Die Nachricht wird blockiert, wenn sie dieses Maximum überschreitet.

Der Standardwert für maxpipesize ist 66536 Byte.

Die maxpipesize für ein Rohr wird Teil der Eigenschaften des Rohres und bleibt für die Lebensdauer des Rohres bestehen. Aufrufer von SEND_MESSAGE mit größeren Werten führen dazu, dass maxpipesize erhöht wird. Anrufer mit einem kleineren Wert verwenden den vorhandenen, größeren Wert.

Der Standardwert maxpipesize von 65536 gilt für alle Pipes.

private

Verwendet den Standardwert TRUE, um eine private Pipe zu erstellen.

Öffentliche Pipes können implizit erstellt werden, wenn Sie SEND_MESSAGE aufrufen.

Rückgabewerte

Tabelle 6-13: Rückgabewerte der Funktion CREATE_PIPE

Zurückgehen Beschreibung

0

Erfolgreich.

Wenn die Pipe bereits vorhanden ist und der Benutzer, der sie zu erstellen versucht, zur Verwendung autorisiert ist, gibt Oracle 0 zurück, was den Erfolg anzeigt, und alle Daten, die sich bereits in der Pipe befinden, bleiben erhalten.

ORA-23322

Fehler aufgrund eines Namenskonflikts.

Wenn eine Pipe mit demselben Namen vorhanden ist und von einem anderen Benutzer erstellt wurde, gibt Oracle den Fehler ORA-23322 an, der auf den Namenskonflikt hinweist.

Ausnahmen

Tabelle 6-14: Funktionsausnahme CREATE_PIPE

Ausnahme Beschreibung

Null pipe name

Berechtigungsfehler: Pipe mit demselben Namen ist bereits vorhanden, und Sie dürfen ihn nicht verwenden.

Beispiel

Erstellen Sie einen expliziten privaten Namen namens MY_PIPE1.

DECLARE
  l_status INTEGER;
BEGIN
  l_status := DBMS_PIPE.create_pipe(
      pipename  => 'MY_PIPE1',
      private   => TRUE);
END;
/

Funktion GET_CREDENTIAL_NAME

Diese Funktion gibt den globalen Variablenwert credential_name zurück, der verwendet wird, wenn Nachrichten im Cloud-Objektspeicher gespeichert werden.

Syntax

DBMS_PIPE.GET_CREDENTIAL_NAME
         RETURN VARCHAR2;

Rückgabewerte

Rückgabewert Beschreibung

credential_name

Der Name der Zugangsdaten für den Zugriff auf den Cloud-Objektspeicher.

Beispiel

DECLARE
  credential_name     VARCHAR2(400)
BEGIN
  credential_name := DBMS_PIPE.GET_CREDENTIAL_NAME;
END;
/

Funktion GET_LOCATION_URI

Diese Funktion gibt den globalen Variablenwert location_uri zurück, der als Standardstandort-URI verwendet werden kann, wenn Pipe-Nachrichten im Cloud-Objektspeicher gespeichert werden.

Syntax

DBMS_PIPE.GET_LOCATION_URI
        RETURN VARCHAR2;

Rückgabewert

Rückgabewert Beschreibung
location_uri

Die Objekt-URI.

Beispiel

DECLARE
  location_uri     VARCHAR2(400)
BEGIN
  location_uri := DBMS_PIPE.GET_LOCATION_URI;
END;
/

Funktion RECEIVE_MESSAGE

Diese Funktion kopiert die Nachricht in den lokalen Nachrichtenpuffer.

Syntax

DBMS_PIPE.RECEIVE_MESSAGE (
   pipename          IN VARCHAR2,
   timeout           IN INTEGER  DEFAULT maxwait,
   credential_name   IN VARCHAR2 DEFAULT null,
   location_uri      IN VARCHAR2)
RETURN INTEGER;

Parameter

Tabelle 6-15: Funktionsparameter RECEIVE_MESSAGE

Parameter Beschreibung

pipename

Name der Pipe, auf der eine Nachricht empfangen werden soll.

Namen, die mit ORA$ beginnen, sind für die Verwendung durch Oracle reserviert.

timeout

Wartezeit für eine Nachricht in Sekunden. Mit einem Timeout von 0 können Sie lesen, ohne zu blockieren.

Der Timeout enthält nicht die Zeit, die für die Ausführung der mit dem Parameter cache_func angegebenen Cachefunktion aufgewendet wurde.

Standardwert: Die Konstante MAXWAIT, die als 86400000 (1000 Tage) definiert ist.

credential_name

Der Zugangsdatenname für den Cloud-Speicher, der zum Speichern von Nachrichten verwendet wird.

credential_name ist ein Packageargument, das standardmäßig als NULL initialisiert wird.

Sie können diesen Wert festlegen, bevor Sie DBMS_PIPE.RECEIVE_MESSAGE aufrufen. Der übergebene Parameterwert hat Vorrang vor dem Wert der globalen Variable.

Das Zugangsdatenobjekt muss über die Berechtigungen EXECUTE und READ/WRITE des Benutzers verfügen, der DBMS_PIPE.RECEIVE_MESSAGE ausführt.

Der Wert credential_name kann ein OCI-Resource Principal, ein Azure-Service Principal, ein Amazon-Ressourcenname (ARN) oder ein Google-Serviceaccount sein. Weitere Informationen zur Authentifizierung auf Basis von Resource Principals finden Sie unter Policys und Rollen für den Zugriff auf Ressourcen konfigurieren.

location_uri

Die Standort-URI für den Cloud-Speicher, der zum Speichern von Nachrichten verwendet wird.

Die location_uri ist eine globale Variable, die standardmäßig als NULL initialisiert wird.

Sie können diesen Wert festlegen, bevor Sie DBMS_PIPE.RECEIVE_MESSAGE aufrufen. Der übergebene Parameterwert hat Vorrang vor dem Wert der globalen Variable.

Rückgabewerte

Tabelle 6-16: Rückgabewerte der Funktion RECEIVE_MESSAGE

Zurückgehen Beschreibung

0

Erfolgreich

1

Zeitüberschreitung Wenn die Pipe implizit erstellt wurde und leer ist, wird sie entfernt.

2

Datensatz in der Pipe ist zu groß für den Puffer.

3

Eine Unterbrechung ist aufgetreten.

ORA-23322

Der Benutzer hat keine ausreichenden Berechtigungen zum Lesen aus der Pipe.

Hinweise zur Verwendung

  • Um eine Nachricht von einer Pipe zu empfangen, rufen Sie zuerst RECEIVE_MESSAGE auf. Wenn Sie eine Nachricht erhalten, wird sie aus der Pipe entfernt. Daher kann eine Nachricht nur einmal empfangen werden. Bei implizit erstellten Rohren wird das Rohr entfernt, nachdem der letzte Datensatz aus dem Rohr entfernt wurde.

  • Wenn die Pipe, die Sie beim Aufruf von RECEIVE_MESSAGE angeben, noch nicht vorhanden ist, erstellt Oracle implizit die Pipe und wartet auf den Empfang der Nachricht. Wenn die Nachricht nicht innerhalb eines festgelegten Timeoutintervalls ankommt, wird der Aufruf zurückgegeben und die Pipe entfernt.

  • Nachdem Sie die Nachricht erhalten haben, müssen Sie mindestens einen Aufruf an UNPACK_MESSAGE vornehmen, um auf die einzelnen Elemente in der Nachricht zuzugreifen. Die Prozedur UNPACK_MESSAGE wird überladen, um Elemente des Typs DATE, NUMBER, VARCHAR2 zu entpacken. Außerdem gibt es zwei zusätzliche Prozeduren zum Entpacken von RAW- und ROWID-Elementen. Wenn Sie den Typ der Daten, die Sie entpacken möchten, nicht kennen, rufen Sie NEXT_ITEM_TYPE auf, um den Typ des nächsten Elements im Puffer zu bestimmen.

  • Persistente Nachrichten werden garantiert entweder von genau einem Prozess geschrieben oder gelesen. Dadurch wird eine Inkonsistenz des Nachrichteninhalts aufgrund gleichzeitiger Schreib- und Lesevorgänge verhindert. Mit einer persistenten Messaging-Pipe lässt DBMS_PIPE zu, dass nur ein Vorgang, das Senden einer Nachricht oder einer Empfangsnachricht, zu einem bestimmten Zeitpunkt aktiv ist. Wenn ein Vorgang jedoch aufgrund eines laufenden Vorgangs nicht möglich ist, wiederholt der Prozess regelmäßig, bis der Wert timeout erreicht ist.

  • Wenn Sie Nachrichten in Oracle Cloud Infrastructure Object Storage speichern, können Sie native Oracle Cloud Infrastructure-URIs oder Swift-URIs verwenden. Der Speicherort-URI und die Zugangsdaten müssen jedoch wie folgt mit dem Typ übereinstimmen:

    • Wenn Sie für den Zugriff auf Oracle Cloud Infrastructure Object Storage ein natives URI-Format verwenden, müssen Sie die Authentifizierung mit nativen Oracle Cloud Infrastructure-Signaturschlüsseln im Zugangsdatenobjekt verwenden.

    • Wenn Sie das Swift-URI-Format für den Zugriff auf Oracle Cloud Infrastructure Object Storage verwenden, müssen Sie eine Authentifizierungstokenauthentifizierung im Zugangsdatenobjekt verwenden.

Ausnahmen

Tabelle 6-17: Funktionsausnahmen RECEIVE_MESSAGE

Ausnahme Beschreibung

Null pipe name

Berechtigungsfehler. Unzureichende Berechtigung zum Entfernen des Datensatzes aus der Pipe. Die Pipe gehört einer anderen Person.

Funktion SEND_MESSAGE

Diese Funktion sendet eine Nachricht an die benannte Pipe.

Die Nachricht ist im lokalen Nachrichtenpuffer enthalten, der mit Aufrufen an PACK_MESSAGE gefüllt wurde. Sie können eine Pipe explizit mit CREATE_PIPE erstellen. Andernfalls wird sie implizit erstellt.

Syntax

DBMS_PIPE.SEND_MESSAGE (
    pipename          IN VARCHAR2,
    timeout           IN INTEGER DEFAULT MAXWAIT,
    credential_name   IN VARCHAR2 DEFAULT null,
    location_uri      IN VARCHAR2 )
RETURN INTEGER;

Parameter

Tabelle 6-18: Funktionsparameter SEND_MESSAGE

Parameter Beschreibung
credential_name

Der Zugangsdatenname für den Cloud-Speicher, der zum Speichern von Nachrichten verwendet wird.

credential_name ist ein Packageargument, das standardmäßig als NULL initialisiert wird.

Sie können diesen Wert festlegen, bevor Sie DBMS_PIPE.SEND_MESSAGE aufrufen. Der übergebene Parameterwert hat Vorrang vor dem Wert der globalen Variable.

Das Zugangsdatenobjekt muss über die Berechtigungen EXECUTE und READ/WRITE des Benutzers verfügen, der DBMS_PIPE.SEND_MESSAGE ausführt.

Der Wert credential_name kann ein OCI-Resource Principal, ein Azure-Service Principal, ein Amazon-Ressourcenname (ARN) oder ein Google-Serviceaccount sein. Weitere Informationen zur Authentifizierung auf Basis von Resource Principals finden Sie unter Policys und Rollen für den Zugriff auf Ressourcen konfigurieren.

location_uri

Die Standort-URI für den Cloud-Speicher, der zum Speichern von Nachrichten verwendet wird.

Die location_uri ist eine globale Variable, die standardmäßig als NULL initialisiert wird.

Sie können diesen Wert festlegen, bevor Sie DBMS_PIPE.SEND_MESSAGE aufrufen. Der übergebene Parameterwert hat Vorrang vor dem Wert der globalen Variable.

maxpipesize

Maximal zulässige Größe für die Pipe in Byte.

Die Gesamtgröße aller Nachrichten in der Pipe darf diesen Betrag nicht überschreiten. Die Nachricht wird blockiert, wenn sie dieses Maximum überschreitet. Der Standardwert beträgt 65536 Byte.

Die maxpipesize für ein Rohr wird Teil der Eigenschaften des Rohres und bleibt für die Lebensdauer des Rohres bestehen. Aufrufer von SEND_MESSAGE mit größeren Werten führen dazu, dass maxpipesize erhöht wird. Anrufer mit einem kleineren Wert verwenden einfach den vorhandenen, größeren Wert.

Wenn Sie maxpipesize als Teil der Prozedur SEND_MESSAGE angeben, ist kein separater Aufruf zum Öffnen der Pipe erforderlich. Wenn Sie die Pipe explizit erstellt haben, können Sie den optionalen Parameter maxpipesize verwenden, um die Spezifikationen für die Erstellungs-Pipe-Größe außer Kraft zu setzen.

Der Standardwert maxpipesize von 65536 gilt für alle Pipes.

pipename

Name der Pipe, auf der die Nachricht abgelegt werden soll.

Wenn Sie eine explizite Pipe verwenden, ist dies der Name, den Sie beim Aufruf von CREATE_PIPE angegeben haben.

Achtung: Verwenden Sie keine Pipe-Namen, die mit "ORA$" beginnen. Diese Namen sind für die Verwendung durch von Oracle bereitgestellte Prozeduren reserviert. Pipename darf nicht länger als 128 Byte sein und die Groß-/Kleinschreibung wird nicht beachtet. Derzeit darf der Name keine Zeichen für die Globalisierungsunterstützung enthalten.

timeout

Wartezeit beim Versuch, eine Nachricht in einer Pipe zu platzieren, in Sekunden.

Der Standardwert ist die Konstante MAXWAIT, die als 86400000 (1000 Tage) definiert ist.

Rückgabewerte

Tabelle 6-19: Rückgabewerte der Funktion SEND_MESSAGE

Zurückgehen Beschreibung

0

Erfolg.

Wenn die Pipe bereits vorhanden ist und der Benutzer, der sie zu erstellen versucht, zur Verwendung autorisiert ist, gibt Oracle 0 zurück, was den Erfolg anzeigt, und alle Daten, die sich bereits in der Pipe befinden, bleiben erhalten.

Wenn ein als SYSDBS/SYSOPER verbundener Benutzer eine Pipe neu erstellt, gibt Oracle den Status 0 zurück, der Eigentümer der Pipe bleibt jedoch unverändert.

1

Zeitüberschreitung

Bei diesem Verfahren kann ein Timeout auftreten, weil es keine Sperre für das Rohr erhalten kann oder weil das Rohr zu voll ist, um verwendet zu werden. Wenn die Pipe implizit erstellt wurde und leer ist, wird sie entfernt.

3

Eine Unterbrechung ist aufgetreten.

Wenn die Pipe implizit erstellt wurde und leer ist, wird sie entfernt.

ORA-23322

Unzureichende Berechtigungen.

Wenn eine Pipe mit demselben Namen vorhanden ist und von einem anderen Benutzer erstellt wurde, gibt Oracle den Fehler ORA-23322 an, der auf den Namenskonflikt hinweist.

Hinweise zur Verwendung

  • Persistente Nachrichten werden garantiert entweder von genau einem Prozess geschrieben oder gelesen. Dadurch wird eine Inkonsistenz des Nachrichteninhalts aufgrund gleichzeitiger Schreib- und Lesevorgänge verhindert. Mit einer persistenten Messaging-Pipe lässt DBMS_PIPE zu, dass nur ein Vorgang, das Senden einer Nachricht oder einer Empfangsnachricht, zu einem bestimmten Zeitpunkt aktiv ist. Wenn ein Vorgang jedoch aufgrund eines laufenden Vorgangs nicht möglich ist, wiederholt der Prozess regelmäßig, bis der Wert timeout erreicht ist.

  • Wenn Sie Nachrichten in Oracle Cloud Infrastructure Object Storage speichern, können Sie native Oracle Cloud Infrastructure-URIs oder Swift-URIs verwenden. Der Speicherort-URI und die Zugangsdaten müssen jedoch wie folgt mit dem Typ übereinstimmen:

    • Wenn Sie für den Zugriff auf Oracle Cloud Infrastructure Object Storage ein natives URI-Format verwenden, müssen Sie die Authentifizierung mit nativen Oracle Cloud Infrastructure-Signaturschlüsseln im Zugangsdatenobjekt verwenden.

    • Wenn Sie das Swift-URI-Format für den Zugriff auf Oracle Cloud Infrastructure Object Storage verwenden, müssen Sie eine Authentifizierungstokenauthentifizierung im Zugangsdatenobjekt verwenden.

Ausnahmen

Tabelle 6-20: Funktionsausnahme SEND_MESSAGE

Ausnahme Beschreibung

Null pipe name

Berechtigungsfehler. Unzureichende Berechtigung zum Schreiben in die Pipe. Die Pfeife ist privat und gehört jemand anderem.

Prozedur SET_CREDENTIAL_NAME

Diese Prozedur legt die Variable credential_name fest, die als Standardzugangsdaten verwendet wird, wenn Pipe-Nachrichten im Cloud-Objektspeicher gespeichert werden.

Syntax

DBMS_PIPE.SET_CREDENTIAL_NAME (
   credential_name   IN VARCHAR2 );

Parameter

Parameter Beschreibung

credential_name

Der Name der Zugangsdaten für den Zugriff auf den Cloud-Objektspeicher.

Der Wert credential_name kann ein OCI-Resource Principal, ein Azure-Service Principal, ein Amazon-Ressourcenname (ARN) oder ein Google-Serviceaccount sein. Weitere Informationen zur Authentifizierung auf Basis von Resource Principals finden Sie unter Policys und Rollen für den Zugriff auf Ressourcen konfigurieren.

Hinweis zur Verwendung

Wenn Sie Nachrichten in Oracle Cloud Infrastructure Object Storage speichern, können Sie native Oracle Cloud Infrastructure-URIs oder Swift-URIs verwenden. Der Speicherort-URI und die Zugangsdaten müssen jedoch wie folgt mit dem Typ übereinstimmen:

  • Wenn Sie für den Zugriff auf Oracle Cloud Infrastructure Object Storage ein natives URI-Format verwenden, müssen Sie die Authentifizierung mit nativen Oracle Cloud Infrastructure-Signaturschlüsseln im Zugangsdatenobjekt verwenden.

  • Wenn Sie das Swift-URI-Format für den Zugriff auf Oracle Cloud Infrastructure Object Storage verwenden, müssen Sie eine Authentifizierungstokenauthentifizierung im Zugangsdatenobjekt verwenden.

Beispiel

BEGIN
     DBMS_PIPE.SET_CREDENTIAL_NAME(
       credential_name =>  'my_cred1');
END;
/

Prozedur SET_LOCATION_URI

Diese Prozedur legt die globale Variable location_uri fest.

Syntax

DBMS_PIPE.SET_LOCATION_URI (
   location_uri   IN VARCHAR2 );

Parameter

Parameter Beschreibung
location_uri

Objekt- oder Datei-URI. Das Format der URI ist vom eingesetzten Cloud-Objektspeichersystem abhängig. Weitere Einzelheiten finden Sie unter URI-Formate für DBMS_CLOUD.

Hinweis zur Verwendung

Wenn Sie Nachrichten in Oracle Cloud Infrastructure Object Storage speichern, können Sie native Oracle Cloud Infrastructure-URIs oder Swift-URIs verwenden. Der Speicherort-URI und die Zugangsdaten müssen jedoch wie folgt mit dem Typ übereinstimmen:

  • Wenn Sie für den Zugriff auf Oracle Cloud Infrastructure Object Storage ein natives URI-Format verwenden, müssen Sie die Authentifizierung mit nativen Oracle Cloud Infrastructure-Signaturschlüsseln im Zugangsdatenobjekt verwenden.

  • Wenn Sie das Swift-URI-Format für den Zugriff auf Oracle Cloud Infrastructure Object Storage verwenden, müssen Sie eine Authentifizierungstokenauthentifizierung im Zugangsdatenobjekt verwenden.

Beispiel

BEGIN
  DBMS_PIPE.GET_LOCATION_URI(
      location_uri  => 'https://objectstorage.us-phoenix-1.oraclecloud.com/n/namespace-string/b/bucketname1/');
END;
/