DBMS_PIPEパッケージ

DBMS_PIPEパッケージによって、同じインスタンスにある複数のセッションの通信を行います。

Oracle Autonomous Databaseは、Oracle Database 19cで使用可能なコアDBMS_PIPE機能と拡張機能をサポートしています。

Oracle Databaseで提供されるDBMS_PIPEのコア機能の詳細は、DBMS_PIPEを参照してください。

DBMS_PIPEシングルトン・パイプの概要

パイプ機能には、複数の潜在的なアプリケーション(外部サービス・インタフェース、デバッグ、独立したトランザクションおよびアラート)があります。

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

DBMS_PIPEのシングルトン・パイプ機能には、次のものがあります。

  • Oracleデータベース・メモリーで、最大32,767バイトのカスタム・メッセージをキャッシュおよび取得する機能。最大32,767バイトのメッセージサイズは、シングルトンパイプを含むすべてのパイプに適用されます。以前のバージョンのDBMS_PIPEでは、最大メッセージ・サイズが小さくなりました。

  • キャッシュされたメッセージを複数のデータベース・セッション間で同時読取りと共有します。

  • キャッシュの無効化方法:

    • ユーザーによって制御される明示的なキャッシュ無効化。
    • ユーザー指定のパラメータ(shelflife)の時間間隔(秒)後のキャッシュ無効化。
  • キャッシュ用に宣言的で使いやすいPL/SQL API。

  • 読取り専用データベースと読取り専用データベースの両方をサポートします。

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

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

シングルトン・パイプ用のDBMS_PIPEサブプログラムのサマリー

この表は、DBMS_PIPEサブプログラムを示し、簡単に説明しています。

表6-1 DBMS_PIPEパッケージのサブプログラム

サブプログラム 説明

CREATE_PIPEファンクション

パイプを作成します(プライベート・パイプの場合は必須です)。

NEXT_ITEM_TYPEファンクション

バッファにある次の項目のデータ・タイプを戻します。

PACK_MESSAGEプロシージャ

ローカル・バッファにメッセージを作成します。

PURGEプロシージャ

名前付きパイプの内容をパージします。

RECEIVE_MESSAGEファンクション

名前付きパイプからローカルバッファーにメッセージをコピーします。

RESET_BUFFERプロシージャ

ローカル・バッファの内容をパージします。

REMOVE_PIPEファンクション

名前付きパイプを削除します。

SEND_MESSAGEファンクション

メッセージをNamed Pipに送信します。Named Pipが存在しない場合は、パブリック・パイプが暗黙的に作成されます。

UNIQUE_SESSION_NAMEファンクション

一意のセッション名を戻します。

UNPACK_MESSAGEプロシージャ

バッファにある次の項目にアクセスします。

CREATE_PIPEファンクション

このファンクションは、パブリック・パイプまたはプライベート・パイプを明示的に作成します。privateフラグがTRUEの場合、パイプ作成者がそのプライベート・パイプの所有者として割り当てられます。

明示的に作成されたパイプを削除するには、REMOVE_PIPEをコールするか、またはインスタンスをシャットダウンします。

シングルトン・パイプを作成するには、singletonパラメータをTRUEに設定します。シングルトン・パイプには、次の引数が適用されます。

  • singleton: パイプをシングルトン・パイプとして作成する必要があることを示します(デフォルト値: FALSE)。

  • shelflife: オプションで、シングルトン・パイプにキャッシュされたメッセージのシェルフ有効期限(秒単位)を指定します。シングルトン・パイプ内のメッセージの暗黙的な無効化に使用できます。

    シングルトン・パイプのメッセージshelflifeは、メッセージ・メッセージを送信するときにも指定できます(SEND_MESSAGE関数を参照)。

構文

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;

パラメータ

表6-2 CREATE_PIPEファンクションのパラメータ

パラメータ 説明

pipename

作成するパイプの名前。

SEND_MESSAGEおよびRECEIVE_MESSAGEをコールするときは、この名前を使用する必要があります。この名前は、インスタンス間で一意である必要があります。

注意: ORA$で始まるパイプ名を使用しないでください。これらは、Oracleが提供するプロシージャで使用するために予約されています。パイプ名は128バイト以下で指定し、大/小文字区別がありません。現時点では、名前にグローバル化サポート文字を含めることはできません。

maxpipesize

パイプの最大サイズ(バイト単位)。

パイプ上のすべてのメッセージの合計サイズは、この数を超えることはできません。この上限を超えると、そのメッセージはブロックされます。

デフォルトのmaxpipesizeは66536バイトです。

パイプのmaxpipesizeはパイプ特性の一部となり、パイプが存続するかぎり有効です。これより大きい値でSEND_MESSAGEをコールすると、maxpipesizeの値が大きくなります。これを小さくすると、より大きい既存の値が使用されます。

デフォルトのmaxpipesize 65536は、すべてのパイプに適用できます。

private

デフォルトのTRUEを使用して、プライベート・パイプを作成します。

パブリック・パイプは、SEND_MESSAGEをコールして、暗黙的に作成できます。

singleton

シングルトン・パイプを作成するには、TRUEを使用します。

デフォルト値: FALSE

shelflife

シングルトン・パイプにキャッシュされるメッセージの失効時間(秒)。指定したshelflife時間が経過すると、メッセージはパイプからアクセスできなくなります。パラメータshelflifeは、シングルトン・パイプにのみ適用されます。

デフォルトは0で、メッセージの有効期限がないことを意味します。

戻り値

表6-3 CREATE_PIPEファンクションの戻り値

戻り 説明

0

成功

パイプがすでに存在し、パイプを作成しようとするユーザーにそのパイプの使用が認可されている場合、Oracleは0(ゼロ)を戻して成功であることを示し、パイプ内のデータはそのまま残ります。

6

既存のパイプをシングルトン・パイプに変換できませんでした。

  • 複数の既存のメッセージがある暗黙的パイプは、シングルトン・パイプに変換できません。
  • シングルトンではない明示的なパイプの場合、DBMS_PIPE.SEND_MESSAGEではsingleton引数をTRUEに設定したメッセージを送信できません。

7

shelflifeパラメータに0以外の値が与えられ、パイプはシングルトン・パイプではありません。

ORA-23322

命名競合のために失敗。

同じ名前のパイプが存在し、別のユーザーがそのパイプを作成した場合、OracleではエラーORA-23322を通知してネーミング競合であることを示しています。

例外

表6-4 CREATE_PIPEファンクションの例外

例外 説明

Null pipe name

アクセス権エラー: 同名のパイプが存在するため使用できません。

シェルフが1時間であるシングルトンパイプを作成します。

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

RECEIVE_MESSAGEファンクション

このファンクションは、メッセージをローカル・メッセージ・バッファにコピーします。

構文

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

パラメータ

表6-5 RECEIVE_MESSAGEファンクションのパラメータ

パラメータ 説明

pipename

メッセージを受信するパイプ名。

ORA$で始まる名前は、Oracleで使用するために予約されています。

timeout

メッセージ待ち時間(秒単位)。タイムアウトを0に設定すると、ブロックされずに読み込むことができます。

タイムアウトには、cache_funcパラメータで指定された実行キャッシュ関数に費やされた時間は含まれません。

デフォルト値: 定数MAXWAITで、8640000000(1000日)に定義されています。

cache_func

シングルトンパイプにメッセージを自動的にキャッシュするためのキャッシュ関数名。

ファンクションの名前は、所有者スキーマで完全修飾されている必要があります:

  • OWNER.FUNCTION_NAME
  • OWNER.PACKAGE.FUNCTION_NAME

デフォルト値: NULL

戻り値

表6-6 RECEIVE_MESSAGEファンクションの戻り値

戻り 説明

0

完了

1

タイムアウトしました暗黙的に作成されたパイプが空の場合、そのパイプは削除されます。

2

パイプにあるレコードが、バッファに対して大きすぎます。

3

割込みが発生しました

8

キャッシュ関数は、シングルトンパイプを使用している場合にのみ指定できます。

ORA-23322

パイプから読み込むための十分な権限がユーザーにありません。

使用上のノート

メッセージをパイプから受信するには、最初にRECEIVE_MESSAGEをコールします。メッセージを受信すると、メッセージはパイプから削除されるため、メッセージは1回しか受信できません。暗黙的に作成されたパイプは、最後のレコードがそのパイプから削除された後で削除されます。

RECEIVE_MESSAGEのコール時に指定したパイプがすでに存在しない場合、Oracleはパイプを暗黙的に作成してメッセージの受信を待ちます。メッセージが指定したタイムアウト間隔内に着信しなかった場合、そのコールは戻され、パイプは削除されます。

メッセージの受信後、1つ以上のUNPACK_MESSAGEをコールして、メッセージ内の個別の項目にアクセスする必要があります。UNPACK_MESSAGEプロシージャは、DATENUMBERVARCHAR2タイプの項目をアンパックするためにオーバーロードされ、さらに、RAWおよびROWID項目をアンパックするための2つのプロシージャがあります。アンパックするデータのタイプが不明の場合は、NEXT_ITEM_TYPEをコールして、バッファ内にある次の項目のタイプを判別します。

キャッシュ・ファンクション・パラメータ

シングルトン・パイプは、次の2つのシナリオの場合に、パイプにメッセージを自動的にキャッシュするキャッシュ機能をサポートしています。

  • シングルトン・パイプが空
  • shelflife時間が経過したため、シングルトン・パイプのメッセージが無効です。

ファンクションの名前は、所有者スキーマで完全修飾されている必要があります:

  • OWNER.FUNCTION_NAME
  • OWNER.PACKAGE.FUNCTION_NAME

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

キャッシュ関数の構文

CREATE OR REPLACE FUNCTION cache_function_name (
       pipename  IN VARCHAR2
) RETURN INTEGER;
パラメータ Datatype 説明

pipename

VARCHAR2

シングルトンパイプの名前。

戻り 説明
0 完了
0以外 DBMS_PIPE.RECEIVE_MESSAGEから返される失敗値

シングルトンパイプのリーダセッションからの複雑なカプセル化と抽象化を提供するキャッシュ関数を定義します。キャッシュ・ファンクションの一般的な操作は次のとおりです。

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

例外

表6-7 RECEIVE_MESSAGEファンクションの例外

例外 説明

Null pipe name

権限エラーパイプからレコードを削除するための権限がありません。パイプは別のユーザーが所有しています。

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

SEND_MESSAGEファンクション

このファンクションは、名前を付けたパイプにメッセージを送信します。

PACK_MESSAGEへのコールで入力されたメッセージは、ローカル・メッセージ・バッファに格納されます。CREATE_PIPEを使用するとパイプを明示的に作成でき、それ以外の場合は暗黙的に作成されます。

暗黙的なシングルトン・パイプを作成するには、singletonパラメータをTRUEに設定します。シングルトン・パイプには、次の引数が適用されます。

  • singleton: パイプをシングルトン・パイプとして作成する必要があることを示します(デフォルト値: FALSE)。
  • shelflife: オプションで、シングルトン・パイプでキャッシュされたメッセージのシェルフ有効期限を指定します。シングルトン・パイプ内のメッセージの暗黙的な無効化に使用できます。

    この引数は、暗黙的および明示的なシングルトン・パイプに適用されます。SEND_MESSAGEファンクションで指定されたshelflife値は、CREATE_PIPEファンクションの明示的シングルトン・パイプに指定されたshelflifeを上書きし、シングルトン・パイプにキャッシュされる新しいメッセージのデフォルトになります。

構文

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;

パラメータ

表6-8 SEND_MESSAGEファンクションのパラメータ

パラメータ 説明

pipename

メッセージを設定するパイプの名前。

明示的なパイプを使用している場合、この名前は、CREATE_PIPEをコールしたときに指定した名前です。

注意: ORA$で始まるパイプ名を使用しないでください。これらの名前は、Oracleが提供するプロシージャで使用するために予約されています。パイプ名は128バイト以下で指定し、大/小文字区別がありません。現時点では、名前にグローバル化サポート文字を含めることはできません。

timeout

パイプにメッセージを設定する間の待機時間(秒単位。

デフォルト値は定数MAXWAITで、8640000000(1000日)に定義されています。

maxpipesize

パイプの最大サイズ(バイト単位)。

パイプ上のすべてのメッセージの合計サイズは、この数を超えることはできません。この上限を超えると、そのメッセージはブロックされます。デフォルトは65536バイトです。

パイプのmaxpipesizeはパイプ特性の一部となり、パイプが存続するかぎり有効です。これより大きい値でSEND_MESSAGEをコールすると、maxpipesizeの値が大きくなります。これより小さいサイズでコールした場合は、より大きい既存の値を使用します。

SEND_MESSAGEプロシージャの一部としてmaxpipesizeを指定すると、別のコールでパイプをオープンする必要がありません。明示的にパイプを作成した場合は、オプションのmaxpipesizeパラメータを使用して、作成したパイプのサイズを上書きできます。

デフォルトのmaxpipesize 65536は、すべてのパイプに適用できます。

singleton

シングルトン・パイプを作成するには、TRUEを使用します。

デフォルト値: FALSE

shelflife

シングルトン・パイプにキャッシュされるメッセージの失効時間(秒)。

指定したshelflife時間が経過すると、メッセージはパイプからアクセスできなくなります。パラメータshelflifeは、シングルトン・パイプにのみ適用されます。

デフォルトは0で、メッセージの有効期限がないことを意味します。

戻り値

表6-9 SEND_MESSAGEファンクションの戻り値

戻り 説明

0

成功

パイプがすでに存在し、パイプを作成しようとするユーザーにそのパイプの使用が認可されている場合、Oracleは0(ゼロ)を戻して成功であることを示し、パイプ内のデータはそのまま残ります。

SYSDBS/SYSOPERとして接続したユーザーがパイプを再作成した場合、Oracleはステータス0(ゼロ)を戻しますが、そのパイプの所有者は変更されないままです。

1

タイムアウトしました

このプロシージャは、パイプでロックが取得できないか、またはパイプがいっぱいで使用できないためにタイムアウトできます。暗黙的に作成されたパイプが空の場合、そのパイプは削除されます。

3

割込みが発生しました

暗黙的に作成されたパイプが空の場合、そのパイプは削除されます。

6

既存のパイプをシングルトン・パイプに変換できませんでした。

  • 複数の既存のメッセージがある暗黙的パイプは、シングルトン・パイプに変換できません。
  • シングルトンではない明示的なパイプの場合、DBMS_PIPE.SEND_MESSAGEではsingleton引数をTRUEに設定したメッセージを送信できません。

7

shelflifeパラメータに0以外の値が与えられ、パイプはシングルトン・パイプではありません。

ORA-23322

十分な権限がありません

同じ名前のパイプが存在し、別のユーザーがそのパイプを作成した場合、OracleではエラーORA-23322を通知してネーミング競合であることを示しています。

例外

表6-10 SEND_MESSAGEファンクションの例外

例外 説明

Null pipe name

権限エラーパイプに書込みを行うための権限がありません。パイプはプライベートで、別のユーザーが所有しています。

DBMS_PIPE永続メッセージング・パイプの概要

パイプ機能には、複数の潜在的なアプリケーション(外部サービス・インタフェース、デバッグ、独立したトランザクションおよびアラート)があります。

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

DBMS_PIPEの永続メッセージ:

  • 非常に大きなメッセージを送信および取得する機能をサポートします。

  • 多数のパイプメッセージをサポートします。

  • 1つのデータベース内、複数のデータベース間、および異なるリージョンのデータベース間でのメッセージの共有をサポートします。

  • 同じクラウド・オブジェクト・ストアの場所URIを使用して複数のパイプをサポートします。

    永続メッセージング機能を使用すると、2つ以上のデータベース・セッションが、クラウド・オブジェクト・ストアに格納されているメッセージと通信できます。パイプでこの機能メッセージを使用すると、現在のデータベースのみが使用できるようにすることも、同じリージョンまたは異なるリージョンの複数のデータベースで使用できるようにすることもできます。

    永続メッセージング・パイプには、サポートされているDBMS_PIPEタイプのいずれかを指定できます。

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

永続メッセージを使用して異なるデータベース間でメッセージを送受信する場合、Oracleでは、メッセージの送信または受信の前にDBMS_PIPE.CREATE_PIPEをコールすることをお薦めします。DBMS_PIPE.CREATE_PIPEを使用して明示的なパイプを作成すると、(PRIVATEパラメータをFALSEに設定するか、デフォルト値TRUEを使用して)パブリックまたはプライベートのいずれかのアクセス権限でパイプが作成されます。

DBMS_PIPEの制限

DBMS_PIPEパッケージでは、異なる文字セットを使用するデータベース間でのメッセージの送信はサポートされていません。たとえば、AL32UTF8を使用するAutonomous Databaseインスタンスと、WE8MSWIN1252を使用する別のインスタンスがある場合、これら2つのデータベース間でDBMS_PIPEを含むメッセージを送信することはできません。この場合、これらの2つのデータベース間でDBMS_PIPEのメッセージを送信しようとすると、エラーORA-12704が発生します。

詳細については、Choose a Character Set for Autonomous Databaseを参照してください。

永続メッセージング用のDBMS_PIPEサブプログラムのサマリー

この表は、DBMS_PIPEサブプログラムを示し、簡単に説明しています。

表6-11 DBMS_PIPEパッケージのサブプログラム

サブプログラム 説明

CREATE_PIPEファンクション

パイプを作成します(プライベート・パイプの場合は必須です)。

GET_CREDENTIAL_NAME関数

グローバルcredential_name変数値を返します。

GET_LOCATION_URIファンクション

メッセージがクラウド・オブジェクト・ストアに格納されるときに使用するデフォルトのロケーションURIとして使用されるグローバルなlocation_uri 変数値を返します。

NEXT_ITEM_TYPEファンクション

バッファにある次の項目のデータ・タイプを戻します。

PACK_MESSAGEプロシージャ

ローカル・バッファにメッセージを作成します。

RECEIVE_MESSAGEファンクション

名前付きパイプからローカルバッファーにメッセージをコピーします。

RESET_BUFFERプロシージャ

ローカル・バッファの内容をパージします。

REMOVE_PIPEファンクション

名前付きパイプを削除します。

SEND_MESSAGEファンクション

メッセージを名前付きパイプに送信します。名前付きパイプが存在しない場合は、パブリック・パイプが暗黙的に作成されます。

SET_CREDENTIAL_NAMEプロシージャ

クラウド・オブジェクト・ストアに格納されているメッセージのデフォルトの資格証明として使用されるcredential_name変数を設定します。

SET_LOCATION_URIプロシージャ

クラウド・オブジェクト・ストアに格納されているメッセージのデフォルトの場所URIとして使用されるグローバルlocation_uri変数を設定します。

UNIQUE_SESSION_NAMEファンクション

一意のセッション名を戻します。

UNPACK_MESSAGEプロシージャ

バッファにある次の項目にアクセスします。

CREATE_PIPEファンクション

このファンクションは、パブリック・パイプまたはプライベート・パイプを明示的に作成します。privateフラグがTRUEの場合、パイプ作成者がそのプライベート・パイプの所有者として割り当てられます。

明示的に作成されたパイプを削除するには、REMOVE_PIPEをコールするか、またはインスタンスをシャットダウンします。

構文

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

パラメータ

表6-12 CREATE_PIPEファンクションのパラメータ

パラメータ 説明

pipename

作成するパイプの名前。

SEND_MESSAGEおよびRECEIVE_MESSAGEをコールするときは、この名前を使用する必要があります。この名前は、インスタンス間で一意である必要があります。

注意: ORA$で始まるパイプ名を使用しないでください。これらは、Oracleが提供するプロシージャで使用するために予約されています。パイプ名は128バイト以下で指定し、大/小文字区別がありません。現時点では、名前にグローバル化サポート文字を含めることはできません。

maxpipesize

パイプの最大サイズ(バイト単位)。

パイプ上のすべてのメッセージの合計サイズは、この数を超えることはできません。この上限を超えると、そのメッセージはブロックされます。

デフォルトのmaxpipesizeは66536バイトです。

パイプのmaxpipesizeはパイプ特性の一部となり、パイプが存続するかぎり有効です。これより大きい値でSEND_MESSAGEをコールすると、maxpipesizeの値が大きくなります。これを小さくすると、より大きい既存の値が使用されます。

デフォルトのmaxpipesize 65536は、すべてのパイプに適用できます。

private

デフォルトのTRUEを使用して、プライベート・パイプを作成します。

パブリック・パイプは、SEND_MESSAGEをコールして、暗黙的に作成できます。

戻り値

表6-13 CREATE_PIPEファンクションの戻り値

戻り 説明

0

成功

パイプがすでに存在し、パイプを作成しようとするユーザーにそのパイプの使用が認可されている場合、Oracleは0(ゼロ)を戻して成功であることを示し、パイプ内のデータはそのまま残ります。

ORA-23322

命名競合のために失敗。

同じ名前のパイプが存在し、別のユーザーがそのパイプを作成した場合、OracleではエラーORA-23322を通知してネーミング競合であることを示しています。

例外

表6-14 CREATE_PIPEファンクションの例外

例外 説明

Null pipe name

アクセス権エラー: 同名のパイプが存在するため使用できません。

MY_PIPE1という名前の明示的なプライベートを作成します。

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

GET_CREDENTIAL_NAME関数

このファンクションは、メッセージがクラウド・オブジェクト・ストアに格納されるときに使用するグローバルcredential_name変数値を返します。

構文

DBMS_PIPE.GET_CREDENTIAL_NAME
         RETURN VARCHAR2;

戻り値

戻り値 説明

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

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

GET_LOCATION_URIファンクション

このファンクションは、パイプ・メッセージがクラウド・オブジェクト・ストアに格納されるときにデフォルトの場所URIとして使用できるグローバルなlocation_uri変数値を返します。

構文

DBMS_PIPE.GET_LOCATION_URI
        RETURN VARCHAR2;

戻り値

戻り値 説明
location_uri

オブジェクトURI。

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

RECEIVE_MESSAGEファンクション

このファンクションは、メッセージをローカル・メッセージ・バッファにコピーします。

構文

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

パラメータ

表6-15 RECEIVE_MESSAGEファンクションのパラメータ

パラメータ 説明

pipename

メッセージを受信するパイプ名。

ORA$で始まる名前は、Oracleで使用するために予約されています。

timeout

メッセージ待ち時間(秒単位)。タイムアウトを0に設定すると、ブロックされずに読み込むことができます。

タイムアウトには、cache_funcパラメータで指定されたキャッシュ・ファンクションの実行にかかった時間は含まれません。

デフォルト値: 定数MAXWAITで、8640000000(1000日)に定義されています。

credential_name

メッセージの格納に使用するクラウド・ストアの資格証明名。

credential_nameは、デフォルトでNULLとして初期化されるパッケージ引数です。

この値は、DBMS_PIPE.RECEIVE_MESSAGEをコールする前に設定できます。渡したパラメータ値は、グローバル変数の値よりも優先されます。

資格証明オブジェクトには、DBMS_PIPE.RECEIVE_MESSAGEを実行しているユーザーによるEXECUTEおよびREAD/WRITE権限が必要です。

credential_name値は、OCIリソース・プリンシパル、Azureサービス・プリンシパル、Amazonリソース名(ARN)またはGoogleサービス・アカウントです。リソース・プリンシパル・ベースの認証の詳細は、リソースにアクセスするためのポリシーおよびロールの構成を参照してください。

location_uri

メッセージの格納に使用されるクラウド・ストアの場所URI。

location_uriはグローバル変数で、デフォルトではNULLとして初期化されます。

この値は、DBMS_PIPE.RECEIVE_MESSAGEをコールする前に設定できます。渡したパラメータ値は、グローバル変数の値よりも優先されます。

戻り値

表6-16 RECEIVE_MESSAGEファンクションの戻り値

戻り 説明

0

完了

1

タイムアウトしました暗黙的に作成されたパイプが空の場合、そのパイプは削除されます。

2

パイプにあるレコードが、バッファに対して大きすぎます。

3

割込みが発生しました

ORA-23322

パイプから読み込むための十分な権限がユーザーにありません。

使用上のノート

  • メッセージをパイプから受信するには、最初にRECEIVE_MESSAGEをコールします。メッセージを受信すると、メッセージはパイプから削除されるため、メッセージは1回しか受信できません。暗黙的に作成されたパイプは、最後のレコードがそのパイプから削除された後で削除されます。

  • RECEIVE_MESSAGEのコール時に指定したパイプがすでに存在しない場合、Oracleはパイプを暗黙的に作成してメッセージの受信を待ちます。メッセージが指定したタイムアウト間隔内に着信しなかった場合、そのコールは戻され、パイプは削除されます。

  • メッセージの受信後、1つ以上のUNPACK_MESSAGEをコールして、メッセージ内の個別の項目にアクセスする必要があります。UNPACK_MESSAGEプロシージャは、DATENUMBERVARCHAR2タイプの項目をアンパックするためにオーバーロードされ、さらに、RAWおよびROWID項目をアンパックするための2つのプロシージャがあります。アンパックするデータのタイプが不明の場合は、NEXT_ITEM_TYPEをコールして、バッファ内にある次の項目のタイプを判別します。

  • 永続メッセージは、1つのプロセスによる書込みまたは読取りが保証されます。これにより、同時書込みおよび同時読取りによるメッセージ・コンテンツの不整合が回避されます。永続メッセージング・パイプを使用すると、DBMS_PIPEは1つの操作のみを許可し、メッセージまたは受信メッセージを一度にアクティブに送信します。ただし、進行中の操作のために操作が不可能な場合、timeout値に達するまで、プロセスは定期的に再試行します。

  • Oracle Cloud Infrastructure Object Storageを使用してメッセージを格納する場合は、Oracle Cloud InfrastructureネイティブURIまたはSwift URIを使用できます。ただし、ロケーションURIと資格証明は、次のようにタイプで一致する必要があります。

    • ネイティブURI形式を使用してOracle Cloud Infrastructure Object Storageにアクセスする場合は、資格証明オブジェクトでネイティブのOracle Cloud Infrastructure署名キー認証を使用する必要があります。

    • Swift URI形式を使用してOracle Cloud Infrastructure Object Storageにアクセスする場合は、資格証明オブジェクトで認証トークン認証を使用する必要があります。

例外

表6-17 RECEIVE_MESSAGEファンクションの例外

例外 説明

Null pipe name

権限エラーパイプからレコードを削除するための権限がありません。パイプは別のユーザーが所有しています。

SEND_MESSAGEファンクション

このファンクションは、名前を付けたパイプにメッセージを送信します。

PACK_MESSAGEへのコールで入力されたメッセージは、ローカル・メッセージ・バッファに格納されます。CREATE_PIPEを使用するとパイプを明示的に作成でき、それ以外の場合は暗黙的に作成されます。

構文

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

パラメータ

表6-18 SEND_MESSAGEファンクションのパラメータ

パラメータ 説明
credential_name

メッセージの格納に使用するクラウド・ストアの資格証明名。

credential_nameは、デフォルトでNULLとして初期化されるパッケージ引数です。

この値は、DBMS_PIPE.SEND_MESSAGEをコールする前に設定できます。渡したパラメータ値は、グローバル変数の値よりも優先されます。

資格証明オブジェクトには、DBMS_PIPE.SEND_MESSAGEを実行しているユーザーによるEXECUTEおよびREAD/WRITE権限が必要です。

credential_name値は、OCIリソース・プリンシパル、Azureサービス・プリンシパル、Amazonリソース名(ARN)またはGoogleサービス・アカウントです。リソース・プリンシパル・ベースの認証の詳細は、リソースにアクセスするためのポリシーおよびロールの構成を参照してください。

location_uri

メッセージの格納に使用されるクラウド・ストアの場所URI。

location_uriはグローバル変数で、デフォルトではNULLとして初期化されます。

この値は、DBMS_PIPE.SEND_MESSAGEをコールする前に設定できます。渡したパラメータ値は、グローバル変数の値よりも優先されます。

maxpipesize

パイプの最大サイズ(バイト単位)。

パイプ上のすべてのメッセージの合計サイズは、この数を超えることはできません。この上限を超えると、そのメッセージはブロックされます。デフォルトは65536バイトです。

パイプのmaxpipesizeはパイプ特性の一部となり、パイプが存続するかぎり有効です。これより大きい値でSEND_MESSAGEをコールすると、maxpipesizeの値が大きくなります。これより小さいサイズでコールした場合は、より大きい既存の値を使用します。

SEND_MESSAGEプロシージャの一部としてmaxpipesizeを指定すると、別のコールでパイプをオープンする必要がありません。明示的にパイプを作成した場合は、オプションのmaxpipesizeパラメータを使用して、作成したパイプのサイズを上書きできます。

デフォルトのmaxpipesize 65536は、すべてのパイプに適用できます。

pipename

メッセージを設定するパイプの名前。

明示的なパイプを使用している場合、この名前は、CREATE_PIPEをコールしたときに指定した名前です。

注意: ORA$で始まるパイプ名を使用しないでください。これらの名前は、Oracleが提供するプロシージャで使用するために予約されています。パイプ名は128バイト以下で指定し、大/小文字区別がありません。現時点では、名前にグローバル化サポート文字を含めることはできません。

timeout

パイプにメッセージを設定する間の待機時間(秒単位。

デフォルト値は定数MAXWAITで、8640000000(1000日)に定義されています。

戻り値

表6-19 SEND_MESSAGEファンクションの戻り値

戻り 説明

0

成功

パイプがすでに存在し、パイプを作成しようとするユーザーにそのパイプの使用が認可されている場合、Oracleは0(ゼロ)を戻して成功であることを示し、パイプ内のデータはそのまま残ります。

SYSDBS/SYSOPERとして接続したユーザーがパイプを再作成した場合、Oracleはステータス0(ゼロ)を戻しますが、そのパイプの所有者は変更されないままです。

1

タイムアウトしました

このプロシージャは、パイプでロックが取得できないか、またはパイプがいっぱいで使用できないためにタイムアウトできます。暗黙的に作成されたパイプが空の場合、そのパイプは削除されます。

3

割込みが発生しました

暗黙的に作成されたパイプが空の場合、そのパイプは削除されます。

ORA-23322

十分な権限がありません

同じ名前のパイプが存在し、別のユーザーがそのパイプを作成した場合、OracleではエラーORA-23322を通知してネーミング競合であることを示しています。

使用上のノート

  • 永続メッセージは、1つのプロセスによる書込みまたは読取りが保証されます。これにより、同時書込みおよび同時読取りによるメッセージ・コンテンツの不整合が回避されます。永続メッセージング・パイプを使用すると、DBMS_PIPEは1つの操作のみを許可し、メッセージまたは受信メッセージを一度にアクティブに送信します。ただし、進行中の操作のために操作が不可能な場合、timeout値に達するまで、プロセスは定期的に再試行します。

  • Oracle Cloud Infrastructure Object Storageを使用してメッセージを格納する場合は、Oracle Cloud InfrastructureネイティブURIまたはSwift URIを使用できます。ただし、ロケーションURIと資格証明は、次のようにタイプで一致する必要があります。

    • ネイティブURI形式を使用してOracle Cloud Infrastructure Object Storageにアクセスする場合は、資格証明オブジェクトでネイティブのOracle Cloud Infrastructure署名キー認証を使用する必要があります。

    • Swift URI形式を使用してOracle Cloud Infrastructure Object Storageにアクセスする場合は、資格証明オブジェクトで認証トークン認証を使用する必要があります。

例外

表6-20 SEND_MESSAGEファンクションの例外

例外 説明

Null pipe name

権限エラーパイプに書込みを行うための権限がありません。パイプはプライベートで、別のユーザーが所有しています。

SET_CREDENTIAL_NAMEプロシージャ

このプロシージャは、パイプ・メッセージがクラウド・オブジェクト・ストアに格納されるときにデフォルトの資格証明として使用されるcredential_name変数を設定します。

構文

DBMS_PIPE.SET_CREDENTIAL_NAME (
   credential_name   IN VARCHAR2 );

パラメータ

パラメータ 説明

credential_name

クラウド・オブジェクト・ストレージにアクセスするための資格証明の名前。

credential_name値は、OCIリソース・プリンシパル、Azureサービス・プリンシパル、Amazonリソース名(ARN)またはGoogleサービス・アカウントです。リソース・プリンシパル・ベースの認証の詳細は、リソースにアクセスするためのポリシーおよびロールの構成を参照してください。

使用上のノート

Oracle Cloud Infrastructure Object Storageを使用してメッセージを格納する場合は、Oracle Cloud InfrastructureネイティブURIまたはSwift URIを使用できます。ただし、ロケーションURIと資格証明は、次のようにタイプで一致する必要があります。

  • ネイティブURI形式を使用してOracle Cloud Infrastructure Object Storageにアクセスする場合は、資格証明オブジェクトでネイティブのOracle Cloud Infrastructure署名キー認証を使用する必要があります。

  • Swift URI形式を使用してOracle Cloud Infrastructure Object Storageにアクセスする場合は、資格証明オブジェクトで認証トークン認証を使用する必要があります。

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

SET_LOCATION_URIプロシージャ

このプロシージャは、グローバルlocation_uri変数を設定します。

構文

DBMS_PIPE.SET_LOCATION_URI (
   location_uri   IN VARCHAR2 );

パラメータ

パラメータ 説明
location_uri

オブジェクトまたはファイルURI。URIの形式は、使用しているCloud Object Storageサービスによって異なります。詳細は、DBMS_CLOUD URI形式を参照してください。

使用上のノート

Oracle Cloud Infrastructure Object Storageを使用してメッセージを格納する場合は、Oracle Cloud InfrastructureネイティブURIまたはSwift URIを使用できます。ただし、ロケーションURIと資格証明は、次のようにタイプで一致する必要があります。

  • ネイティブURI形式を使用してOracle Cloud Infrastructure Object Storageにアクセスする場合は、資格証明オブジェクトでネイティブのOracle Cloud Infrastructure署名キー認証を使用する必要があります。

  • Swift URI形式を使用してOracle Cloud Infrastructure Object Storageにアクセスする場合は、資格証明オブジェクトで認証トークン認証を使用する必要があります。

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