Package DBMS_PIPE (Pipes de messagerie persistantes)

Le package DBMS_PIPE permet à plusieurs sessions de la même instance de communiquer.

Oracle Autonomous AI Database on Dedicated Exadata Infrastructure prend en charge les fonctionnalités DBMS_PIPE de base telles qu'elles sont disponibles dans Oracle Database 19c, ainsi que les extensions.

Reportez-vous à DBMS_PIPE dans Oracle Database 19c PL/SQL Packages and Types Reference ou Oracle Database 26ai PL/SQL Packages and Types Reference pour plus d'informations sur la fonctionnalité DBMS_PIPE de base fournie dans Oracle Database.

Présentation de DBMS_PIPE pour les canaux de messagerie persistants

La fonctionnalité Pipe a plusieurs applications potentielles : interface de service externe, débogage, transactions indépendantes et alertes.

Sur la base de données Autonomous AI, le package DBMS_PIPE dispose de fonctionnalités étendues pour prendre en charge les canaux de messagerie persistants. Pour plus d'informations, reportez-vous à DBMS_PIPE dans Oracle Database 19c PL/SQL Packages and Types Reference ou Oracle Database 26ai PL/SQL Packages and Types Reference.

Messages persistants dans DBMS_PIPE :

Limitation DBMS_PIPE

Le package DBMS_PIPE ne prend pas en charge l'envoi de messages entre bases de données qui utilisent des jeux de caractères différents. Par exemple, si vous avez une instance de base de données Autonomous AI qui utilise AL32UTF8 et une autre instance qui utilise WE8MSWIN1252, vous ne pouvez pas envoyer de messages avec DBMS_PIPE entre ces deux bases de données. Dans ce cas, le système génère l'erreur ORA-12704 si vous tentez d'envoyer des messages avec DBMS_PIPE entre ces deux bases de données.

Récapitulatif des sous-programmes DBMS_PIPE pour la messagerie persistante

Ce tableau répertorie les sous-programmes DBMS_PIPE et les décrit brièvement.

Sous-programme Description
Fonction CREATE_PIPE Crée un tuyau (nécessaire pour les tuyaux privés).
Fonction GET_CREDENTIAL_NAME Renvoie la valeur globale de la variable credential_name.
Fonction GET_LOCATION_URI Renvoie la valeur de variable location_uri globale utilisée comme URI d'emplacement par défaut lorsqu'un message est stocké dans la banque d'objets cloud.

Fonction NEXT_ITEM_TYPE

Renvoie le type de données de l'élément suivant dans le tampon.

Procédures PACK_MESSAGE

Crée un message dans la mémoire tampon locale.
Fonction RECEIVE_MESSAGE Copie le message du canal nommé dans le tampon local.

Procédure RESET_BUFFER

Purge le contenu du tampon local.

Fonction REMOVE_PIPE

Supprime le pipe nommé.
Fonction SEND_MESSAGE Envoie un message sur un canal nommé : cela crée implicitement un canal public si le canal nommé n'existe pas.
Procédure SET_CREDENTIAL_NAME Définit la variable credential_name utilisée comme informations d'identification par défaut pour les messages stockés dans la banque d'objets cloud.
Procédure SET_LOCATION_URI Définit la variable location_uri globale utilisée comme URI d'emplacement par défaut pour les messages stockés dans la banque d'objets cloud.

Fonction UNIQUE_SESSION_NAME

Renvoie un nom de session unique.

Procédures UNPACK_MESSAGE

Permet d'accéder à l'élément suivant dans le tampon.

Fonction CREATE_PIPE

Cette fonction crée explicitement un canal public ou privé. Si l'indicateur private est TRUE, le créateur de canal est affecté en tant que propriétaire du canal privé.

Les canaux créés explicitement ne peuvent être supprimés qu'en appelant REMOVE_PIPE ou en arrêtant l'instance.

Syntaxe

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

Paramètres

Paramètre Description
pipename

Nom du pipeline que vous créez.

Vous devez utiliser ce nom lorsque vous appelez SEND_MESSAGE et RECEIVE_MESSAGE. Ce nom doit être unique dans l'instance.

**Attention :** N'utilisez pas de noms de pipe commençant par ORA$. Elles sont réservées à l'utilisation par les procédures fournies par Oracle. Le nom de pipeline ne doit pas dépasser 128 octets et ne tient pas compte de la casse. Pour le moment, le nom ne peut pas contenir de caractères de prise en charge de la globalisation.

maxpipesize

Taille maximale autorisée pour le pipeline, en octets.

La taille totale de tous les messages sur le pipeline ne peut pas dépasser ce montant. Le message est bloqué s'il dépasse ce maximum.

La valeur par défaut de maxpipesize est de 66536 octets.

La valeur maxpipesize d'un tuyau devient une partie des caractéristiques du tuyau et persiste pendant toute sa durée de vie. Les appelants de SEND_MESSAGE avec des valeurs plus élevées augmentent la valeur de maxpipesize. Les appelants dont la valeur est inférieure utilisent la valeur supérieure existante.

La valeur par défaut maxpipesize (65536) est applicable à tous les tubes.

private

Utilise la valeur par défaut, TRUE, pour créer un canal privé.

Les canaux publics peuvent être implicitement créés lorsque vous appelez SEND_MESSAGE.

Valeurs retournées

Retour Description
0

Succès.

Si le canal existe déjà et que l'utilisateur qui tente de le créer est autorisé à l'utiliser, Oracle renvoie 0, ce qui indique qu'il a réussi et toutes les données déjà présentes dans le canal restent.

ORA-23322

Echec en raison d'un conflit de noms.

Si un canal portant le même nom existe et a été créé par un autre utilisateur, Oracle signale l'erreur ORA-23322, indiquant le conflit de dénomination.

Exceptions

Exception Description
Null pipe name Erreur d'autorisation : un canal portant le même nom existe déjà et vous n'êtes pas autorisé à l'utiliser.

Exemple

Créer une valeur privée explicite nommée MY_PIPE1

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

Fonction GET_CREDENTIAL_NAME

Cette fonction renvoie la valeur de variable credential_name globale à utiliser lorsque les messages sont stockés dans la banque d'objets cloud.

Syntaxe

DBMS_PIPE.GET_CREDENTIAL_NAME
         RETURN VARCHAR2;

Valeurs retournées

Valeur renvoyée Description
credential_name Nom des informations d'identification permettant d'accéder au stockage d'objet cloud.

Exemple

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

Fonction GET_LOCATION_URI

Cette fonction renvoie la valeur de variable location_uri globale qui peut être utilisée comme URI d'emplacement par défaut lorsque les messages de canal sont stockés dans la banque d'objets cloud.

Syntaxe

DBMS_PIPE.GET_LOCATION_URI
        RETURN VARCHAR2;

Valeur renvoyée

Valeur renvoyée Description
location_uri URI d'objet.

Exemple

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

Fonction RECEIVE_MESSAGE

Cette fonction copie le message dans le tampon de messages local.

Syntaxe

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

Paramètres

Table - Paramètres de la fonction RECEIVE_MESSAGE

Paramètre Description
pipename

Nom du canal sur lequel vous souhaitez recevoir un message.

Les noms commençant par ORA$ sont réservés à Oracle.

timeout

Temps d'attente d'un message, en secondes. Un délai d'attente de 0 vous permet de lire sans bloquer.

Le délai d'expiration n'inclut pas le temps passé à exécuter la fonction de cache indiquée avec le paramètre cache_func.

Valeur par défaut : constante MAXWAIT, définie comme 86400000 (1000 jours).

credential_name

Nom des informations d'identification de la banque cloud utilisée pour stocker les messages.

credential_name est un argument de package initialisé par défaut en tant que NULL.

Vous pouvez définir cette valeur avant d'appeler DBMS_PIPE.RECEIVE_MESSAGE. La valeur de paramètre transmise est prioritaire sur la valeur de la variable globale.

L'objet d'informations d'identification doit disposer des privilèges EXECUTE et READ/WRITE de l'utilisateur exécutant DBMS_PIPE.RECEIVE_MESSAGE.

location_uri

URI d'emplacement de la banque cloud utilisée pour stocker les messages.

location_uri est une variable globale qui par défaut est initialisée en tant que NULL.

Vous pouvez définir cette valeur avant d'appeler DBMS_PIPE.RECEIVE_MESSAGE. La valeur de paramètre transmise est prioritaire sur la valeur de la variable globale.

Valeurs retournées

Table - Valeurs renvoyées par la fonction RECEIVE_MESSAGE

Retour Description
0 Succès
1 Délai expiré. Si le tuyau a été implicitement créé et est vide, il est enlevé.
2 L'enregistrement dans le tuyau est trop volumineux pour le tampon.
3 Une interruption s'est produite.
ORA-23322 L'utilisateur ne dispose pas de privilèges suffisants pour lire à partir du canal.

Remarques sur l'utilisation

Exceptions

Table - Exceptions de fonction RECEIVE_MESSAGE

Exception Description
Null pipe name Erreur d'autorisation. Privilège insuffisant pour supprimer l'enregistrement du canal. Le tuyau appartient à quelqu'un d'autre.

Fonction SEND_MESSAGE

Cette fonction envoie un message sur le pipeline nommé.

Le message est contenu dans le tampon de message local, qui a été rempli d'appels à PACK_MESSAGE. Vous pouvez créer un canal explicitement à l'aide de CREATE_PIPE. Sinon, il est créé implicitement.

Syntaxe

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

Paramètres

Table - Paramètres de la fonction SEND_MESSAGE

Paramètre Description
credential_name

Nom des informations d'identification de la banque cloud utilisée pour stocker les messages.

credential_name est un argument de package initialisé par défaut en tant que NULL.

Vous pouvez définir cette valeur avant d'appeler DBMS_PIPE.SEND_MESSAGE. La valeur de paramètre transmise est prioritaire sur la valeur de la variable globale.

L'objet d'informations d'identification doit disposer des privilèges EXECUTE et READ/WRITE de l'utilisateur exécutant DBMS_PIPE.SEND_MESSAGE.

location_uri

URI d'emplacement de la banque cloud utilisée pour stocker les messages.

location_uri est une variable globale qui par défaut est initialisée en tant que NULL.

Vous pouvez définir cette valeur avant d'appeler DBMS_PIPE.SEND_MESSAGE. La valeur de paramètre transmise est prioritaire sur la valeur de la variable globale.

maxpipesize

Taille maximale autorisée pour le pipeline, en octets.

La taille totale de tous les messages sur le pipeline ne peut pas dépasser ce montant. Le message est bloqué s'il dépasse ce maximum. La longueur par défaut est de 65536 octets.

La valeur maxpipesize d'un tuyau devient une partie des caractéristiques du tuyau et persiste pendant toute sa durée de vie. Les appelants de SEND_MESSAGE avec des valeurs plus élevées augmentent la valeur de maxpipesize. Les appelants dont la valeur est inférieure utilisent simplement la valeur supérieure existante.

Si vous indiquez maxpipesize dans le cadre de la procédure SEND_MESSAGE, vous n'avez plus besoin d'un appel distinct pour ouvrir le canal. Si vous avez créé le canal de manière explicite, vous pouvez utiliser le paramètre facultatif maxpipesize pour remplacer les spécifications de taille de canal de création.

La valeur par défaut maxpipesize (65536) est applicable à tous les tubes.

pipename

Nom du canal sur lequel vous voulez placer le message.

Si vous utilisez un canal explicite, il s'agit du nom que vous avez indiqué lorsque vous avez appelé CREATE_PIPE.

**Attention :** N'utilisez pas de noms de pipe commençant par 'ORA$'. Ces noms sont réservés à l'usage des procédures fournies par Oracle. Le nom de pipeline ne doit pas dépasser 128 octets et ne respecte pas la casse. Pour le moment, le nom ne peut pas contenir de caractères de prise en charge de la globalisation.

timeout

Temps d'attente lors de la tentative de placement d'un message sur un canal, en secondes.

La valeur par défaut est la constante MAXWAIT, qui est définie comme 86400000 (1000 jours).

Valeurs retournées

Table - Valeurs renvoyées par la fonction SEND_MESSAGE

Retour Description
0

Succès.

Si le canal existe déjà et que l'utilisateur qui tente de le créer est autorisé à l'utiliser, Oracle renvoie 0, ce qui indique qu'il a réussi et toutes les données déjà présentes dans le canal restent.

Si un utilisateur connecté en tant que SYSDBS/SYSOPER recrée un canal, Oracle renvoie le statut 0, mais la propriété du canal reste inchangée.

1

Délai expiré.

Cette procédure peut expirer soit parce qu'elle ne peut pas obtenir un verrou sur le tuyau, soit parce que le tuyau reste trop plein pour être utilisé. Si le tuyau a été implicitement créé et est vide, il est enlevé.

3

Une interruption s'est produite.

Si le tuyau a été implicitement créé et est vide, il est enlevé.

ORA-23322

Les privilèges sont insuffisants.

Si un canal portant le même nom existe et a été créé par un autre utilisateur, Oracle signale l'erreur ORA-23322, indiquant le conflit de dénomination.

Remarques sur l'utilisation

Exceptions

Table - Exception de fonction SEND_MESSAGE

Exception Description
Null pipe name Erreur d'autorisation. Privilège insuffisant pour écrire dans le pipe. Le tuyau est privé et appartient à quelqu'un d'autre.

Procédure SET_CREDENTIAL_NAME

Cette procédure définit la variable credential_name qui est utilisée comme informations d'identification par défaut lorsque les messages de canal sont stockés dans la banque d'objets cloud.

Syntaxe

DBMS_PIPE.SET_CREDENTIAL_NAME (
   credential_name   IN VARCHAR2 );

Paramètres

Paramètre Description
credential_name Nom des informations d'identification permettant d'accéder au stockage d'objet cloud.

Remarque sur l'utilisation

Si vous utilisez Oracle Cloud Infrastructure Object Storage pour stocker des messages, vous pouvez utiliser des URI natifs Oracle Cloud Infrastructure ou des URI Swift. Cependant, l'URI d'emplacement et les informations d'identification doivent correspondre au type suivant :

Exemple

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

Procédure SET_LOCATION_URI

Cette procédure définit la variable location_uri globale.

Syntaxe

DBMS_PIPE.SET_LOCATION_URI (
   location_uri   IN VARCHAR2 );

Paramètre

Paramètre Description
location_uri URI de l'objet ou du fichier. Le format de l'URI dépend du service Cloud Object Storage que vous utilisez. Pour plus de détails, reportez-vous à Formats d'URI de stockage d'objet cloud.

Remarque sur l'utilisation

Si vous utilisez Oracle Cloud Infrastructure Object Storage pour stocker des messages, vous pouvez utiliser des URI natifs Oracle Cloud Infrastructure ou des URI Swift. Cependant, l'URI d'emplacement et les informations d'identification doivent correspondre au type suivant :

Exemple

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

Contenu connexe