DBMS_PIPEパッケージ(永続メッセージング・パイプ)

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

Oracle Autonomous Database on Dedicated Exadata Infrastructureでは、Oracle Database 19cで使用可能なコアDBMS_PIPE機能と拡張機能がサポートされています。

Oracle Databaseで提供されるコアDBMS_PIPE機能の詳細は、『Oracle Database 19c PL/SQLパッケージ・プロシージャおよびタイプ・リファレンス』または『Oracle Database 23ai PL/SQLパッケージおよびタイプ・リファレンス』のDBMS_PIPEを参照してください。

関連項目

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

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

Autonomous Databaseでは、DBMS_PIPEパッケージに、永続メッセージング・パイプをサポートするための拡張機能があります。詳細は、『Oracle Database 19c PL/SQLパッケージ・アンド・タイプ・リファレンス』のDBMS_PIPEまたは『Oracle Database 23ai PL/SQLパッケージ・アンド・タイプ・リファレンス』を参照してください。

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を使用する1つのAutonomous Databaseインスタンスと、WE8MSWIN1252を使用する別のインスタンスがある場合、これら2つのデータベース間でDBMS_PIPEを含むメッセージを送信することはできません。この場合、これらの2つのデータベース間でDBMS_PIPEのメッセージを送信しようとすると、エラーORA-12704が発生します。

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

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

表- 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;

Parameters

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

パラメータ 説明

pipename

作成するパイプの名前。

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

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

maxpipesize

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

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

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

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

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

private

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

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

戻り値

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

戻り 説明

0

成功

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

ORA-23322

命名競合のために失敗。

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

例外

表- 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;

Parameters

表- 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権限が必要です。

location_uri

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

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

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

戻り値

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

戻り 説明

0

成功

1

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

2

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

3

割込みが発生しました

ORA-23322

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

使用上のノート

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

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

  • メッセージの受信後、1つ以上のUNPACK_MESSAGEをコールして、メッセージ内の個別の項目にアクセスする必要があります。UNPACK_MESSAGEプロシージャは、DATE、NUMBER、VARCHAR2タイプの項目をアンパックするためにオーバーロードされ、さらに、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にアクセスする場合は、資格証明オブジェクトで認証トークン認証を使用する必要があります。

例外

表- 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;

Parameters

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

パラメータ 説明
credential_name

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

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

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

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

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$で始まるパイプ名を使用しないでください。これは、オラクル社が提供する製品用に予約されています。パイプ名は128バイト以下で指定し、大/小文字は区別されません。現時点では、名前にグローバリゼーション・サポート文字を含めることはできません。

timeout

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

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

戻り値

表- 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にアクセスする場合は、資格証明オブジェクトで認証トークン認証を使用する必要があります。

例外

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

例外 説明

Null pipe name

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

SET_CREDENTIAL_NAMEプロシージャ

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

構文

DBMS_PIPE.SET_CREDENTIAL_NAME (
   credential_name   IN VARCHAR2 );

Parameters

パラメータ 説明

credential_name

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

使用上のノート

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のフォーマットは、使用しているクラウド・オブジェクト・ストレージ・サービスによって異なります。詳細は、クラウド・オブジェクト・ストレージの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;
/