DBMS_PIPEパッケージには、シングルトン・パイプをサポートするためのAutonomous Databaseの拡張機能があります。

DBMS_PIPEのシングルトン・パイプ:

• シングルトン・パイプ・メッセージを使用して、カスタム・データのインメモリー・キャッシュを提供します。

• 最大32,767バイトのカスタム・メッセージをキャッシュおよび取得する機能をサポートします。

• 同時読取りによる複数のデータベース・セッション間でのキャッシュされたメッセージの共有をサポートします。これにより、スループットが高くなり、データベース・セッション間のメッセージの同時読取りがサポートされます。

• 読取り専用データベースおよび読取り専用データベースをサポートします。

• 複数のキャッシュ無効化メソッドをサポートします。

  • ユーザーによって制御される明示的なキャッシュ無効化。
  • ユーザー指定の時間間隔(秒)後のキャッシュ無効化。この無効化方法は、メッセージ・リーダーではなく、shelflifeパラメータを使用して、メッセージ・センダーによって制御されます。これにより、リーダーによるキャッシュの使用が正しくないために、一般的な落とし穴を回避できます。

標準パイプとシングルトン・パイプについて

DBMS_PIPEパッケージを使用すると、2つ以上のデータベース・セッションがインメモリー・メッセージを使用して通信できます。パイプ機能には、外部サービス・インタフェース、デバッグ、独立したトランザクション、アラートなどの複数のアプリケーションがあります。

シングルトン・パイプには、サポートされているDBMS_PIPEタイプのいずれかを指定できます。

• 暗黙的パイプ: DBMS_PIPE.SEND_MESSAGE関数を使用して不明なパイプ名でメッセージを送信すると、自動的に作成されます。
• 明示的パイプ:ユーザー指定のパイプ名でDBMS_PIPE.CREATE_PIPE関数を使用して作成されます。
• パブリック・パイプ: DBMS_PIPEパッケージに対するEXECUTE権限を持つすべてのユーザーがアクセスできます。
• プライベート・パイプ:パイプ作成者と同じユーザーを持つセッションからアクセスできます。

シングルトン・パイプは、Autonomous Databaseインスタンスのメモリーに単一のメッセージをキャッシュする機能を提供します。

次に、シングルトンパイプを使用する一般的なワークフローを示します。

DBMS_PIPEパッケージでは、ユーザー定義のキャッシュ関数を使用して、シングルトン・パイプ・メッセージを自動的に移入できます。

デフォルトでは、シングルトン・パイプの明示的または暗黙的な無効化でメッセージが無効化されると、後続のDBMS_PIPE.RECEIVE_MESSAGEではメッセージを受信しません。パイプに新しいメッセージを追加するには、DBMS_PIPE.SEND_MESSAGEをコールしてメッセージを明示的にキャッシュする必要があります。このような場合、シングルトンパイプから読み取るときにメッセージを使用できないようにするには、キャッシュ関数を定義します。キャッシュ関数を定義すると、次のシナリオでメッセージを受信すると、キャッシュ関数が自動的に起動されます。

• シングルトン・パイプが空の場合
• shelflifeの経過時間が原因でシングルトン・パイプ内のメッセージが無効である場合。

キャッシュ・ファンクションを使用するには、キャッシュ・ファンクションを定義し、DBMS_PIPE.RECEIVE_MESSAGEにcache_funcパラメータを含めます。ユーザー定義キャッシュ・ファンクションは、次の機能を提供します。

• キャッシュ関数は、DBMS_PIPE.RECEIVE_MESSAGEを使用してシングルトン・パイプからメッセージを読み取るときに指定できます。
• シングルトン・パイプにメッセージがない場合、DBMS_PIPE.RECEIVE_MESSAGEはキャッシュ関数を呼び出します。
• メッセージshelflifeの時間が経過すると、データベースはシングルトン・パイプに新しいメッセージを自動的に移入します。

キャッシュ・ファンクションを使用すると、シングルトン・パイプの操作が簡略化されます。空のパイプからメッセージを受信する場合、失敗ケースを処理する必要はありません。また、キャッシュ関数は、シングルトンパイプからメッセージを読み取る際にキャッシュミスがないことを保証し、キャッシュされたメッセージを最大限に利用します。

キャッシュ・ファンクションを定義する場合は、ファンクション名が所有者スキーマで完全修飾されている必要があります:

• OWNER.FUNCTION_NAME
• OWNER.PACKAGE.FUNCTION_NAME

次のシグネチャを使用してキャッシュ関数を定義します。

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

キャッシュ・ファンクションの一般的な操作は次のとおりです。

• DBMS_PIPE.CREATE_PIPEを使用して、明示パイプ用のシングルトン・パイプを作成します。
• シングルトンパイプにキャッシュするメッセージを作成します。
• キャッシュ関数で指定されたパイプにメッセージを送信し、オプションで暗黙的メッセージにshelflifeを指定します。

キャッシュ・ファンクションを使用するには、DBMS_PIPE.RECEIVE_MESSAGEを起動する現在のセッション・ユーザーに、キャッシュ・ファンクションの実行に必要な権限が必要です。

キャッシュ・ファンクションの定義の詳細は、RECEIVE_MESSAGEファンクションを参照してください。

指定されたパイプ名(明示的なシングルトンパイプ)を持つシングルトンパイプを作成する手順について説明します。

CREATE OR REPLACE FUNCTION msg_types AS
       TYPE t_rcv_row IS RECORD (c1 VARCHAR2(32767), c2 NUMBER);
       TYPE t_rcv_tab IS TABLE OF t_rcv_row;
END;


CREATE OR REPLACE FUNCTION receive_message(
      pipename    IN VARCHAR2,
      rcv_count   IN NUMBER DEFAULT 1,
      cache_func  IN VARCHAR2 DEFAULT NULL)
   RETURN msg_types.t_rcv_tab pipelined
    AS
       l_msg    VARCHAR2(32767);
       l_status NUMBER;
 BEGIN
      FOR i IN 1..rcv_count LOOP
           l_status := DBMS_PIPE.RECEIVE_MESSAGE(
            pipename   => pipename,
            cache_func => cache_func,
            timeout    => 1);
         IF l_status != 0 THEN
              raise_application_error(-20000,
             'Message not received for attempt: ' || to_char(i) || ' status: ' ||
            l_status);
         END IF;

         DBMS_PIPE.UNPACK_MESSAGE(l_msg);
             pipe row(msg_types.t_rcv_row(l_msg));
     END LOOP;
 RETURN;
 END;

1. shelflifeパラメータを3600 (秒)に設定して、PIPE_TESTという名前の明示的なシングルトン・パイプを作成します。

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

   詳細は、CREATE_PIPEファンクションを参照してください。

2. シングルトンパイプが作成されていることを確認します。

   SELECT name, singleton, type
        FROM v$db_pipes WHERE name= '&pipename' ORDER BY 1;
   
   NAME                 SINGLETON  TYPE
   -------------------- ---------- -------
   PIPE_TEST            YES        PRIVATE

3. シングルトンパイプにメッセージをパックして送信します。

   
   EXEC DBMS_PIPE.PACK_MESSAGE('This is a real message that you can get multiple times');
   
   SELECT DBMS_PIPE.SEND_MESSAGE(pipename => '&pipename') status FROM DUAL;
   
   STATUS
   ----------
   0

   詳細は、PACK_MESSAGEプロシージャおよびSEND_MESSAGEファンクションを参照してください。

4. シングルトンパイプからメッセージを受信します。

   SELECT * FROM receive_message(
       pipename => '&pipename',
       rcv_count => 2);
   
   MESSAGE
   --------------------------------------------------------------------------------
   This is a real message that you can get multiple times
   This is a real message that you can get multiple times

   receive_message関数は、DBMS_PIPE.RECEIVE_MESSAGEをコールするヘルパー関数です。

5. メッセージを削除し、パイプを削除します。

   EXEC DBMS_PIPE.PURGE('&pipename');
   SELECT DBMS_PIPE.REMOVE_PIPE('&pipename') status FROM DUAL;

指定されたパイプ名、明示的なシングルトンパイプを使用してシングルトンパイプを作成する手順と、キャッシュ機能を提供する手順について説明します。キャッシュ関数を使用すると、メッセージをシングルトンパイプに自動的に移入できます。

1. シングルトン・パイプ用のキャッシュ・ファンクションtest_cache_messageを作成します。

   CREATE OR REPLACE FUNCTION test_cache_message(
        pipename IN VARCHAR2) return NUMBER 
   AS 
      l_status NUMBER;
      l_data VARCHAR2(4000);
   BEGIN
      l_status := DBMS_PIPE.CREATE_PIPE(
             pipename => pipename,
             private => TRUE,
             singleton => true,
             shelflife => 600);
      IF l_status != 0 THEN RETURN l_status;
      END IF;
    
      DBMS_PIPE.PACK_MESSAGE('This is a placeholder cache message for an empty pipe');
      l_status := DBMS_PIPE.SEND_MESSAGE(pipename => pipename);
      RETURN l_status;
    END;
   /

   ノート
   
   DBMS_PIPE.RECEIVE_MESSAGEを起動する現在のセッション・ユーザーには、キャッシュ関数を実行するために必要な権限が必要です。
2. キャッシュ関数で受信し、パイプに移入されたメッセージを確認します。パイプは、キャッシュ関数に作成されたプライベートパイプとして存在する必要があります。

   SELECT * FROM receive_message(
        pipename => '&pipename',
        rcv_count => 1,
        cache_func => 'TEST_CACHE_MESSAGE');
   
   MESSAGE
   ---------------
   This is a placeholder cache message for an empty pipe
   

   receive_message関数は、DBMS_PIPE.RECEIVE_MESSAGEをコールするヘルパー関数です。receive_message定義については、「明示的なシングルトン・パイプの作成」を参照してください。

   詳細は、CREATE_PIPEファンクションを参照してください。

3. キャッシュ関数なしで受信し、メッセージがパイプに保持されていることを確認します。

   SELECT * FROM receive_message(
        pipename => '&pipename',
        rcv_count => 2);
   
   MESSAGE
   ---------------
   This is a placeholder cache message for an empty pipe
   This is a placeholder cache message for an empty pipe

   receive_message関数は、DBMS_PIPE.RECEIVE_MESSAGEをコールするヘルパー関数です。receive_message定義については、「明示的なシングルトン・パイプの作成」を参照してください。

   詳細は、CREATE_PIPEファンクションを参照してください。