58 DBMS_MGWADM

DBMS_MGWADMの使用方法

• 定数

• ビュー

---

定数

• DBMS_MGWADM定数: クリーンアップ処理

• DBMS_MGWADM定数: 強制値

• DBMS_MGWADM定数: ロギング・レベル

• DBMS_MGWADM定数: 名前付きのプロパティの定数

• DBMS_MGWADM定数: その他の定数

• DBMS_MGWADM定数: 伝播タイプ

• DBMS_MGWADM定数: キュー・ドメイン・タイプ

• DBMS_MGWADM定数: 停止モード

• DBMS_MGWADM定数: WebSphere MQインタフェース・タイプ

---

ビュー

表58-10に示すビューは、メッセージ・ゲートウェイの構成、ステータスおよび統計情報を提供します。特に指示がないかぎり、SELECT権限はMGW_ADMINISTRATOR_ROLEに付与されるため、メッセージ・ゲートウェイの管理者のみがビューにアクセスできます。すべてのビューの所有者はSYSです。

MGW_GATEWAYビュー

このビューは、表58-11に示すように、メッセージ・ゲートウェイの構成およびステータス情報をリストします。

MGW_LINKSビュー

このビューは、現在定義されているメッセージ・システム・リンクの名前とタイプをリストします。表58-12に、MGW_LINKSビューのプロパティを示します。

MGW_MQSERIES_LINKSビュー

このビューは、WebSphere MQメッセージ・システム・リンクの情報をリストします。このビューには、リンク作成時に指定されたメッセージ・システム・プロパティの大部分が表示されます。表58-13に、MGW_MQSERIES_LINKSビューのプロパティを示します。

MGW_TIBRV_LINKSビュー

このビューは、TIB/Rendezvousメッセージ・システム・リンクの情報をリストします。このビューには、リンク作成時に指定されたメッセージ・システム・プロパティの大部分が表示されます。表58-14に、MGW_TIBRV_LINKSビューのプロパティを示します。

MGW_FOREIGN_QUEUESビュー

このビューは、外部キューに関する情報をリストします。このビューには、キューの登録時に指定されたキュー・プロパティの大部分が含まれます。表58-15に、MGW_FOREIGN_QUEUESビューのプロパティを示します。

MGW_SUBSCRIBERSビュー

このビューは、メッセージ・ゲートウェイ・サブスクライバの構成およびステータス情報をリストします。このビューには、サブスクライバの追加時に指定されるサブスクライバ・プロパティの大部分が含まれる他、その他のステータスおよび統計情報が含まれます。表58-16に、MGW_SUBSCRIBERSビューのプロパティを示します。

MGW_SCHEDULESビュー

このビューは、メッセージ・ゲートウェイ・スケジュールの構成およびステータス情報をリストします。このビューには、スケジュールの作成時に指定されるスケジュール・プロパティの大部分が含まれる他、その他のステータス情報が含まれます。表58-17に、MGW_SCHEDULESビューのプロパティを示します。

データ構造

DBMS_MGWADMパッケージは、次のオブジェクト・タイプを定義します。

オブジェクト・タイプ

• SYS.MGW_MQSERIES_PROPERTIESオブジェクト・タイプ

• SYS.MGW_PROPERTIESオブジェクト・タイプ

• SYS.MGW_PROPERTYオブジェクト・タイプ

• SYS.MGW_TIBRV_PROPERTIESオブジェクト・タイプ

---

SYS.MGW_MQSERIES_PROPERTIESオブジェクト・タイプ

このタイプは、WebSphere MQメッセージ・システム・リンクの基本プロパティを指定します。

構文

TYPE SYS.MGW_MQSERIES_PROPERTIES IS OBJECT (
   queue_manager       VARCHAR2(64),
   hostname            VARCHAR2(64),
   port                INTEGER,
   channel             VARCHAR2(64),
   interface_type      INTEGER,
   max_connections     INTEGER,
   username            VARCHAR2(64),
   password            VARCHAR2(64),
   inbound_log_queue   VARCHAR2(64),
   outbound_log_queue  VARCHAR2(64),

-- Methods
STATIC FUNCTION construct
RETURN SYS.MGW_MQSERIES_PROPERTIES,

STATIC FUNCTION alter_construct
RETURN SYS.MGW_MQSERIES_PROPERTIES );

属性

メソッド

---

SYS.MGW_PROPERTIESオブジェクト・タイプ

このタイプは、プロパティの配列を指定します。

構文

TYPE SYS.MGW_PROPERTIES AS VARRAY (2000) OF SYS.MGW_PROPERTY;

属性

使用上の注意

特に注記がないかぎり、メッセージ・ゲートウェイは、名前付きのプロパティを次のように使用します。

• MGWPROP$_接頭辞が付いた名前は予約されています。これらは、特別な目的で使用されており、通常のプロパティ名として使用された場合は無効です。

• プロパティ名は、プロパティ・リストに1回のみ記述できます。つまり、リストでは、特定の名前に対して1つの値のみ指定できます。大文字と小文字は区別されません。

• 通常、プロパティ・リストは順序に依存せず、プロパティ名は任意の順序で表示される場合があります。変更プロパティ・リストは例外です。

• 新しいプロパティ・リストを使用して、既存のプロパティ・リストを変更できます。新規プロパティを使用して既存のプロパティ・リストを変更するには、新規プロパティの追加、既存プロパティの置換、既存プロパティの削除または全プロパティの削除という4通りの方法があります。

変更リストは、最初の要素から最後の要素まで順に処理されます。したがって、変更リストの要素の順序は重要です（特に既存のリストからプロパティを削除するために使用する場合）。

その要素が元のリストにどのように作用するかを判別するために、プロパティ名と値が使用されます。次のルールが適用されます。

• プロパティの追加または変更

  MGW_PROPERTY.NAME = property_name
  MGW_PROPERTY.VALUE = property_value
  

  指定した名前のプロパティがすでに存在している場合、現行の値は新しい値で置き換えられます。プロパティが存在していない場合は、新規プロパティがリストの最後に追加されます。

• プロパティの削除

  MGW_PROPERTY.NAME = 'MGWPROP$_REMOVE'
  MGW_PROPERTY.VALUE = name_of_property_to_remove
  

  プロパティ名が元のリストに存在しない場合、処理は何も行われません。

• すべてのプロパティの削除

  MGW_PROPERTY.NAME = 'MGWPROP$_REMOVE_ALL'
  MGW_PROPERTY.VALUE = not used
  

---

SYS.MGW_PROPERTYオブジェクト・タイプ

このタイプは、メッセージ・リンク、外部キューおよびサブスクライバのオプションのプロパティを指定するために使用される名前付きのプロパティを指定します。

構文

TYPE SYS.MGW_PROPERTY IS OBJECT(
   name  VARCHAR2(500),
   value VARCHAR2(4000),

-- Methods
STATIC FUNCTION construct    --- (1)
RETURN SYS.MGW_PROPERTY,

STATIC FUNCTION construct(   --- (2)
   p_name   IN VARCHAR2,
   p_value  IN VARCHAR2)
RETURN SYS.MGW_PROPERTY );

属性

メソッド

---

SYS.MGW_TIBRV_PROPERTIESオブジェクト・タイプ

このタイプは、TIB/Rendezvousメッセージ・システム・リンクの基本プロパティを指定します。メッセージ・ゲートウェイ・エージェントは、個々のメッセージ・ゲートウェイ・リンクに対して、TibrvRvdTransportタイプのTIB/Rendezvousトランスポートを作成します。

構文

TYPE SYS.MGW_TIBRV_PROPERTIES IS OBJECT(
   service   VARCHAR2(128),
   daemon    VARCHAR2(128),
   network   VARCHAR2(256),
   cm_name   VARCHAR2(256),
   cm_ledger VARCHAR2(256),

-- Methods
STATIC FUNCTION construct
RETURN SYS.MGW_TIBRV_PROPERTIES,

STATIC FUNCTION alter_construct
RETURN SYS.MGW_TIBRV_PROPERTIES );

属性

メソッド

DBMS_MGWADMサブプログラムの要約

---

ADD_SUBSCRIBERプロシージャ

このプロシージャは、伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバを追加します。

構文

DBMS_MGWADM.ADD_SUBSCRIBER(
   subscriber_id     IN VARCHAR2,
   propagation_type  IN BINARY_INTEGER,
   queue_name        IN VARCHAR2,
   destination       IN VARCHAR2,
   rule              IN VARCHAR2 DEFAULT NULL,
   transformation    IN VARCHAR2 DEFAULT NULL,
   exception_queue   IN VARCHAR2 DEFAULT NULL
   options           IN SYS.MGW_PROPERTIES DEFAULT NULL);

パラメータ

使用上の注意

サブスクライバがアクセスするOracle以外のメッセージ・リンクでJMSインタフェースが使用されている場合、メッセージ・ゲートウェイ・エージェントはOracle JMSインタフェースを使用してOracle Streams AQキューにアクセスします。それ以外の場合は、Oracle Streams AQのネイティブ・インタフェースが使用されます。メッセージ・ゲートウェイ・エージェントがOracle JMSインタフェースを使用してJMS接続を行うときは、パラメータが別の方法で解釈されます。

Oracle JMSインタフェースが伝播に使用されない場合、変換は現在サポートされていません。その場合は、変換パラメータをNULLに設定してください。

OUTBOUND_PROPAGATIONサブスクライバ

サブスクライバがアウトバウンド伝播に使用するパラメータは次のように解釈されます。

• queue_name - 伝播ソースであるOracle Streams AQローカル・キューを指定します。このキューは、schema.queueの構文で指定する必要があります。

• destination - メッセージの伝播先の外部キューを指定します。このキューは、registered_queue@message_linkの構文で指定する必要があります。

• rule - Oracle Streams AQのネイティブ・インタフェースが使用されている場合は、Oracle Streams AQのオプションのサブスクライバ・ルールを指定します。また、Oracle JMSインタフェースが使用されている場合は、JMSセレクタを指定します。NULLの場合、ルールまたはセレクタは使用されません。

• transformation - Oracle Streams AQペイロードをメッセージ・ゲートウェイによって定義されるユーザー定義型に変換するために使用される変換機能を指定します。

  メッセージ・ゲートウェイ伝播では、Oracle Streams AQペイロードをメッセージ・ゲートウェイによって定義されるユーザー定義型に変換するための変換機能を使用して、Oracle Streams AQキューからメッセージをデキューします。その後、メッセージは、メッセージ・ゲートウェイのユーザー定義型に基づいて外部メッセージ・システムにエンキューされます。

• exception_queue - 例外が発生した場合にメッセージを移動するOracle Streams AQローカル・キューの名前を指定します。このキューは、schema.queueの構文で指定する必要があります。

Oracle Streams AQのネイティブ・インタフェースが使用されている場合は、メッセージ・ゲートウェイが実行されているかどうかに関係なく、ADD_SUBSCRIBERプロシージャをコールしたときに、サブスクライバがOracle Streams AQキューに追加されます。ローカル・サブスクライバの形式は、sys.aq$_agent('MGW_subscriber_id', NULL, NULL)になります。

Oracle JMSインタフェースが使用されている場合、メッセージ・ゲートウェイ・エージェントは、MGW_subscriber_idという名前のJMS永続サブスクライバを作成します。エージェントが実行されていないときにADD_SUBSCRIBERプロシージャをコールすると、次にエージェントが起動された時点で、永続サブスクライバが作成されます。

例外キューについては、次の点に注意してください。

• 例外キューとして使用されるOracle Streams AQキューは、ユーザーが作成する必要があります。

• ソース・キューと例外キューのペイロード・タイプは一致している必要があります。

• 例外キューは、キュー・タイプDBMS_AQADM.EXCEPTION_QUEUEではなく、DBMS_AQADM.NORMAL_QUEUEで作成する必要があります。エンキューの制限事項によって、メッセージ・ゲートウェイ伝播は、メッセージ・ゲートウェイ例外キューとしてタイプEXCEPTION_QUEUEのOracle Streams AQキューを使用できません。

INBOUND_PROPAGATIONサブスクライバ

サブスクライバがインバウンド伝播に使用するパラメータは次のように解釈されます。

• queue_name - 伝播ソースである外部キューを指定します。このキューは、registered_queue@message_linkの構文で指定する必要があります。

• destination - メッセージの伝播先のOracle Streams AQローカル・キューを指定します。このキューは、schema.queueの構文で指定する必要があります。

• rule − 外部メッセージ・システムに対して有効であるオプションのサブスクライバ・ルールを指定します。ルールが必要ない場合はNULLを設定します。

• transformation − メッセージ・ゲートウェイによって定義されるユーザー定義型をOracle Streams AQペイロード・タイプに変換するために使用する変換機能を指定します。

  メッセージ・ゲートウェイ伝播は、外部メッセージ・システムのキューからメッセージをデキューし、メッセージ本体をメッセージ・ゲートウェイによって定義される既知のユーザー定義型に変換します。変換機能は、メッセージがOracle Streams AQキューにエンキューされるときに、メッセージ・ゲートウェイ・ユーザー定義型をOracle Streams AQペイロード・タイプに変換するために使用されます。

• exception_queue − 例外が発生した場合にメッセージを移動する外部キューの名前を指定します。このキューは、registered_queue@message_linkの構文で指定する必要があります。

サブスクライバが必要かどうかは、Oracle以外のメッセージ・システムの要件によって決まります。永続サブスクライバが必要である場合は、メッセージ・ゲートウェイ・エージェントによって永続サブスクライバが作成されます。ADD_SUBSCRIBERプロシージャをコールした時点でエージェントが実行されていない場合は、次にエージェントが起動されたときに、Oracle以外のメッセージ・システム上で永続サブスクライバが作成されます。

例外キューについては、次の点に注意してください。

• 例外キューは、登録済のOracle以外のキューであることが必要です。

• ソース・キューと例外キューは、同じメッセージ・システム・リンクを使用する必要があります。

---

ALTER_AGENTプロシージャ

このプロシージャは、メッセージ・ゲートウェイ・エージェントのパラメータを構成します。

構文

DBMS_MGWADM.ALTER_AGENT (
   max_connections  IN BINARY_INTEGER DEFAULT NULL,
   max_memory       IN BINARY_INTEGER DEFAULT NULL,
   max_threads      IN BINARY_INTEGER DEFAULT NULL);

パラメータ

使用上の注意

これらの構成パラメータのデフォルト値は、メッセージ・ゲートウェイ・エージェントのインストール時に設定されます。

max_memoryパラメータとmax_threadsパラメータに対する変更は、次回メッセージ・ゲートウェイ・エージェントがアクティブになったときに有効になります。メッセージ・ゲートウェイ・エージェントが現在アクティブの場合、変更を有効にするには、エージェントを停止し、再起動する必要があります。

---

TIB/Rendezvous用のALTER_MSGSYSTEM_LINKプロシージャ

このプロシージャは、TIB/Rendezvousメッセージ・システム・リンクのプロパティを変更します。

構文

DBMS_MGWADM.ALTER_MSGSYSTEM_LINK (
   linkname      IN  VARCHAR2,
   properties    IN  SYS.MGW_TIBRV_PROPERTIES,
   options       IN  SYS.MGW_PROPERTIES DEFAULT NULL,
   comment       IN  VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE );

パラメータ

使用上の注意

VARCHAR2データ型のメッセージ・リンク・プロパティの既存値を保持するには、その特定のプロパティにDBMS_MGWADM.NO_CHANGEを指定します。別のデータ型のプロパティの既存値を保持するには、そのプロパティにNULLを指定します。

optionsパラメータは、現行のオプションのプロパティを変更するために使用されるプロパティのセットを指定します。各プロパティによって、新規プロパティの追加、既存プロパティの置換、既存プロパティの削除または全プロパティの削除のいずれかの方法で現行のプロパティ・リストが変更されます。

一部のプロパティは変更できません。このようなプロシージャを変更しようとすると、エラーが発生します。変更可能なプロパティとオプションの中には、動的に変更できるものが少数あります。メッセージ・ゲートウェイでは、動的に変更された新しい値がすぐに使用されます。その他のプロパティやオプションに対する変更を有効にするには、メッセージ・ゲートウェイ・エージェントを停止し、再起動する必要があります。

---

WebSphere MQ用のALTER_MSGSYSTEM_LINKプロシージャ

このプロシージャは、WebSphere MQメッセージ・システム・リンクのプロパティを変更します。

構文

DBMS_MGWADM.ALTER_MSGSYSTEM_LINK (
   linkname   IN  VARCHAR2,
   properties IN  SYS.MGW_MQSERIES_PROPERTIES,
   options    IN  SYS.MGW_PROPERTIES DEFAULT NULL,
   comment    IN  VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE);

パラメータ

使用上の注意

VARCHAR2データ型のメッセージ・リンク・プロパティの既存値を保持するには、その特定のプロパティにDBMS_MGWADM.NO_CHANGEを指定します。別のデータ型のプロパティの既存値を保持するには、そのプロパティにNULLを指定します。

optionsパラメータは、現行のオプションのプロパティを変更するために使用されるプロパティのセットを指定します。各プロパティによって、新規プロパティの追加、既存プロパティの置換、既存プロパティの削除または全プロパティの削除のいずれかの方法で現行のプロパティ・リストが変更されます。

一部のプロパティは変更できません。このようなプロシージャを変更しようとすると、エラーが発生します。変更可能なプロパティとオプションの中には、動的に変更できるものが少数あります。メッセージ・ゲートウェイでは、動的に変更された新しい値がすぐに使用されます。その他のプロパティやオプションに対する変更を有効にするには、メッセージ・ゲートウェイ・エージェントを停止し、再起動する必要があります。

---

ALTER_PROPAGATION_SCHEDULEプロシージャ

このプロシージャは、伝播スケジュールを変更します。

構文

DBMS_MGWADM.ALTER_PROPAGATION_SCHEDULE (
   schedule_id  IN VARCHAR2,
   duration     IN NUMBER DEFAULT NULL,
   next_time    IN VARCHAR2 DEFAULT NULL,
   latency      IN NUMBER DEFAULT NULL);

パラメータ

使用上の注意

このプロシージャは、各パラメータの既存値を常に上書きします。特定のパラメータが指定されない場合、既存値はデフォルト値で上書きされます。

---

ALTER_SUBSCRIBERプロシージャ

このプロシージャは、伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバのパラメータを変更します。

構文

DBMS_MGWADM.ALTER_SUBSCRIBER (
   subscriber_id    IN VARCHAR2,
   rule             IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE,
   transformation   IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE,
   exception_queue  IN VARCHAR2 DEFAULT DBMS_MGWADM.NO_CHANGE,
   options          IN SYS.MGW_PROPERTIES DEFAULT NULL );

パラメータ

使用上の注意

サブスクライバがアクセスするOracle以外のメッセージ・リンクでJMSインタフェースが使用されている場合、メッセージ・ゲートウェイ・エージェントはOracle JMSインタフェースを使用してOracle Streams AQキューにアクセスします。それ以外の場合は、Oracle Streams AQのネイティブ・インタフェースが使用されます。メッセージ・ゲートウェイ・エージェントがOracle JMSインタフェースを使用してJMS接続を行うときは、パラメータが別の方法で解釈されます。

JMSソースから伝播を行う場合、サブスクライバ・ルールは変更できません。そのため、既存のサブスクライバを削除して、新しいルールとともにサブスクライバを追加する必要があります。JMSにおいて永続サブスクリプション上のメッセージ・セレクタを変更することは、サブスクリプションを削除してから再作成することと同じです。

Oracle JMSインタフェースが伝播に使用されない場合、変換は現在サポートされていません。したがって、変換パラメータをDBMS_MGWADM.NO_CHANGE（デフォルト値）に設定する必要があります。

optionsパラメータは、現行のオプションのプロパティを変更するために使用されるプロパティのセットを指定します。各プロパティによって、新規プロパティの追加、既存プロパティの置換、既存プロパティの削除または全プロパティの削除のいずれかの方法で現行のプロパティ・リストが変更されます。

---

CLEANUP_GATEWAYプロシージャ

このプロシージャは、メッセージ・ゲートウェイをクリーンアップします。メッセージ・ゲートウェイになんらかの異常がある状態または予期しない状態のままのときに、必要なクリーンアップまたはリカバリ処理を実行します。MGW_GATEWAYビューには、クリーンアップ処理に関係するメッセージ・ゲートウェイ・ステータスおよび構成情報が表示されます。

構文

DBMS_MGWADM.CLEANUP_GATEWAY(
   action  IN BINARY_INTEGER,
   sarg    IN VARCHAR2 DEFAULT NULL);

パラメータ

使用上の注意

CLEAN_STARTUP_STATE

sargパラメータは使用されないため、NULLに設定してください。

CLEAN_STARTUP_STATE処理では、メッセージ・ゲートウェイ・エージェントがクラッシュしたか、他のなんらかの異常な状態が発生して、メッセージ・ゲートウェイが再起動不可能になった場合に、メッセージ・ゲートウェイを既知の状態に復元します。このクリーンアップ処理は、メッセージ・ゲートウェイ・エージェントが起動された後で、クラッシュしたと思われるか、長時間応答がない場合にのみ実行してください。

MGW_GATEWAYビューに表示されるAGENT_STATUSの値がNOT_STARTEDまたはSTART_SCHEDULED以外であり、AGENT_PINGの値が長時間UNREACHABLEである場合には、CLEAN_STARTUP_STATE処理が必要になります。

AGENT_STATUSの値がBROKENである場合、問題が解決されてCLEAN_STARTUP_STATE処理を通じてエージェントの状態がリセットされるまでは、エージェントを起動できません。BROKENステータスは、メッセージ・ゲートウェイ・エージェントがすでに実行されている状況がメッセージ・ゲートウェイの起動ジョブによって検出されたことを示します。正常な使用環境では、このような状況は決して発生しません。

この処理では次のタスクが実行されます。

• 外部メッセージ・ゲートウェイ・エージェント・プロセスの起動に使用されるキューイングされたジョブを削除します。

• 特定の構成情報を既知の状態に設定します。たとえば、エージェント・ステータスをNOT_STARTEDに設定します。

次のような場合はコマンドの処理に失敗します。

• エージェントのステータスがNOT_STARTEDまたはSTART_SCHEDULEDである場合。

• エージェントのステータスがSTARTINGの場合を除いて、このプロシージャのコール前に停止が試みられなかった場合。

• メッセージ・ゲートウェイ・エージェントに正常に接続できた場合。

  エージェントがすでにアクティブである場合、このプロシージャは失敗したと考えられます。数回試行してもエージェントが応答しない場合は、クリーンアップ処理が実行されます。クリーンアップ処理には、少なくとも数秒（最長で1分程度）の時間がかかります。これは、この特定のクリーンアップ処理が適切で必要な状態での予想される動作です。

CLEAN_LOG_QUEUES

sargパラメータは使用されないため、NULLに設定してください。

構成されたすべてのメッセージ・システム・リンクのログ・キューをメッセージ・ゲートウェイ・エージェントによってクリアします。このエージェントは、すべての伝播アクティビティを一時的に停止した後、各リンクのログ・キューから不要または不正なログ・レコードをすべて削除します。メッセージ・ゲートウェイ・エージェントが実行されていない場合は、処理に失敗します。

このクリーンアップ処理は、メッセージ・ゲートウェイ・エージェントを起動するたびに自動的に実行されます。

RESET_SUB_MISSING_LOG_REC

sargパラメータには、リセットするメッセージ・ゲートウェイ・サブスクライバIDを指定します。NULL以外の値を指定してください。

ログ・レコードが存在しないためにエラーになったメッセージ・ゲートウェイ・サブスクライバをメッセージ・ゲートウェイ・エージェントによって復元します。ソースと宛先のログ・レコードが、エージェントによってリセットされます。メッセージ・ゲートウェイ・エージェントが実行されていない場合は、処理に失敗します。

RESET_SUB_MISSING_MESSAGE

sargパラメータには、リセットするメッセージ・ゲートウェイ・サブスクライバIDを指定します。NULL以外の値を指定してください。

永続ソース・メッセージが存在しないためにエラーになったメッセージ・ゲートウェイ・サブスクライバをメッセージ・ゲートウェイ・エージェントによって復元します。エージェントはメッセージを非永続メッセージとして取り扱い、サブスクライバの処理を続けます。メッセージ・ゲートウェイ・エージェントが実行されていない場合は、処理に失敗します。

---

TIB/Rendezvous用のCREATE_MSGSYSTEM_LINKプロシージャ

このプロシージャは、TIB/Rendezvousメッセージ・システムへのリンクを作成します。

構文

DBMS_MGWADM.CREATE_MSGSYSTEM_LINK (
   linkname     IN  VARCHAR2,
   properties   IN  SYS.MGW_TIBRV_PROPERTIES,
   options      IN  SYS.MGW_PROPERTIES DEFAULT NULL,
   comment      IN  VARCHAR2 DEFAULT NULL );

パラメータ

使用上の注意

---

WebSphere MQ用のCREATE_MSGSYSTEM_LINKプロシージャ

このプロシージャは、WebSphere MQメッセージ・システムへのメッセージ・システム・リンクを作成します。

構文

DBMS_MGWADM.CREATE_MSGSYSTEM_LINK(
   linkname    IN VARCHAR2,
   properties  IN SYS.MGW_MQSERIES_PROPERTIES,
   options     IN SYS.MGW_PROPERTIES DEFAULT NULL,
   comment     IN VARCHAR2 DEFAULT NULL);

パラメータ

使用上の注意

---

DB_CONNECT_INFOプロシージャ

このプロシージャは、Oracleデータベースに接続するためにメッセージ・ゲートウェイ・エージェントが使用する接続情報を構成します。

構文

DBMS_MGWADM.DB_CONNECT_INFO (
   username      IN VARCHAR2,
   password      IN VARCHAR2,
   database      IN VARCHAR2 DEFAULT NULL);

パラメータ

使用上の注意

メッセージ・ゲートウェイ・エージェントは、このプロシージャで構成されたユーザーとしてOracleデータベースに接続します。Oracleの管理者は、ユーザーを作成し、そのユーザーにロールMGW_AGENT_ROLEを付与した後、このプロシージャをコールしてメッセージ・ゲートウェイを構成する必要があります。ロールMGW_AGENT_ROLEは、データベースに格納されているメッセージ・ゲートウェイ構成情報へのアクセス、Oracle Streams AQキューとのメッセージのデキューとエンキュー、および特定のOracle Streams AQ管理タスクの実行に必要となる特別な権限をこのユーザーに付与するために使用されます。

---

DISABLE_PROPAGATION_SCHEDULEプロシージャ

このプロシージャは、伝播スケジュールを無効にします。

構文

DBMS_MGWADM.DISABLE_PROPAGATION_SCHEDULE (
   schedule_id  IN VARCHAR2 );

パラメータ

---

ENABLE_PROPAGATION_SCHEDULEプロシージャ

このプロシージャは、伝播スケジュールを使用可能にします。

構文

DBMS_MGWADM.ENABLE_PROPAGATION_SCHEDULE (
   schedule_id  IN VARCHAR2 );

パラメータ

---

REGISTER_FOREIGN_QUEUEプロシージャ

このプロシージャは、Oracle以外のキュー・エンティティをメッセージ・ゲートウェイに登録します。

構文

DBMS_MGWADM.REGISTER_FOREIGN_QUEUE(
   name            IN VARCHAR2,
   linkname        IN VARCHAR2,
   provider_queue  IN VARCHAR2 DEFAULT NULL,
   domain          IN INTEGER DEFAULT NULL,
   options         IN SYS.MGW_PROPERTIES DEFAULT NULL,
   comment         IN VARCHAR2 DEFAULT NULL);

パラメータ

使用上の注意

このプロシージャは、Oracle以外のメッセージ・システムに物理的なキューを作成しません。Oracle以外のキューは、そのメッセージ・システムの管理ツールを使用して作成する必要があります。

---

REMOVE_MSGSYSTEM_LINKプロシージャ

このプロシージャは、Oracle以外のメッセージ・システムに対するメッセージ・システム・リンクを削除します。

構文

DBMS_MGWADM.REMOVE_MSGSYSTEM_LINK(
   linkname  IN VARCHAR2);

パラメータ

使用上の注意

メッセージ・システム・リンクを削除するには、このリンクと関連付けられた登録済のすべてのキューを削除する必要があります。削除対象のリンクを参照する登録済の外部キュー（Oracle以外の）がある場合、このプロシージャは失敗します。

---

REMOVE_SUBSCRIBERプロシージャ

このプロシージャは、伝播用のソース・キューから宛先にメッセージをコンシュームするために使用されるサブスクライバを削除します。

構文

DBMS_MGWADM.REMOVE_SUBSCRIBER (
   subscriber_id  IN VARCHAR2,
   force          IN BINARY_INTEGER DEFAULT DBMS_MGWADM.NO_FORCE );

パラメータ

使用上の注意

アウトバウンド伝播の場合、ローカル・サブスクライバがOracle Streams AQキューから削除されます。

---

RESET_SUBSCRIBERプロシージャ

このプロシージャは、サブスクライバの伝播エラー状態をリセットします。

構文

DBMS_MGWADM.RESET_SUBSCRIBER (
   subscriber_id  IN VARCHAR2 );

パラメータ

---

SCHEDULE_PROPAGATIONプロシージャ

このプロシージャは、ソースから宛先へのメッセージ伝播をスケジュールします。スケジュールが使用可能で、メッセージが伝播されるようにメッセージ・ゲートウェイが適切に起動されている必要があります。

構文

DBMS_MGWADM.SCHEDULE_PROPAGATION (
   schedule_id       IN VARCHAR2,
   propagation_type  IN BINARY_INTEGER,
   source            IN VARCHAR2,
   destination       IN VARCHAR2,
   start_time        IN DATE DEFAULT SYSDATE,
   duration          IN NUMBER DEFAULT NULL,
   next_time         IN VARCHAR2 DEFAULT NULL,
   latency           IN NUMBER DEFAULT NULL);

パラメータ

使用上の注意

アウトバウンド伝播の場合、パラメータは次のように解釈されます。

• source - メッセージの伝播元であるOracle Streams AQローカル・キューを指定します。このキューは、schema.queueの構文で指定する必要があります。

• destination - メッセージの伝播先の外部キューを指定します。このキューは、registered_queue@message_linkの構文で指定する必要があります。

インバウンド伝播の場合、パラメータは次のように解釈されます。

• source - メッセージの伝播元である外部キューを指定します。このキューは、registered_queue@message_linkの構文で指定する必要があります。

• destination - メッセージの伝播先のOracle Streams AQローカル・キューを指定します。このキューは、schema.queueの構文で指定する必要があります。

スケジュールは、作成時に使用可能な状態に設定されます。

---

SET_LOG_LEVELプロシージャ

このプロシージャは、メッセージ・ゲートウェイ・エージェントのロギング・レベルを動的に変更します。メッセージ・ゲートウェイ・エージェントが実行されている必要があります。

構文

DBMS_MGWADM.SET_LOG_LEVEL (
   log_level  IN BINARY_INTEGER);

パラメータ

---

SHUTDOWNプロシージャ

このプロシージャは、メッセージ・ゲートウェイ・エージェントを停止します。メッセージ・ゲートウェイが再起動されるまで、伝播アクティビティは実行されません。

構文

DBMS_MGWADM.SHUTDOWN (
   sdmode  IN BINARY_INTEGER DEFAULT DBMS_MGWADM.SHUTDOWN_NORMAL);

パラメータ

---

STARTUPプロシージャ

このプロシージャは、メッセージ・ゲートウェイ・エージェントを起動します。伝播アクティビティを行うには、このプロシージャをコールする必要があります。

構文

DBMS_MGWADM.STARTUP(
   instance  IN  BINARY_INTEGER DEFAULT 0,
   force     IN  BINARY_INTEGER DEFAULT DBMS_MGWADM.NO_FORCE);

パラメータ

使用上の注意

メッセージ・ゲートウェイ・エージェントは、DBMS_MGWADM.DB_CONNECT_INFOを使用してエージェント・ユーザーが構成されるまで起動できません。

このプロシージャは、ジョブ・キューのジョブを発行し、実行時にメッセージ・ゲートウェイ・エージェントを起動します。instanceおよびforceパラメータは、ジョブ・キュー親和性に使用されます。この親和性を利用して、発行されたジョブを実行できるのは、特定のインスタンスか、または任意のインスタンスかを示します。

---

UNREGISTER_FOREIGN_QUEUEプロシージャ

このプロシージャは、Oracle以外のキュー・エンティティをメッセージ・ゲートウェイから削除します。

構文

DBMS_MGWADM.UNREGISTER_FOREIGN_QUEUE(
   name         IN VARCHAR2,
   linkname     IN VARCHAR2);

パラメータ

使用上の注意

このプロシージャは、Oracle以外のメッセージ・システムの物理的なキューを削除しません。

キューの登録を解除するには、このキューを参照しているすべてのサブスクライバおよびスケジュールの登録を解除する必要があります。サブスクライバまたは伝播スケジュールがOracle以外のキューを参照している場合、このプロシージャは失敗します。

---

UNSCHEDULE_PROPAGATIONプロシージャ

このプロシージャは、伝播スケジュールを削除します。

構文

DBMS_MGWADM.UNSCHEDULE_PROPAGATION (
   schedule_id   IN VARCHAR2 );

パラメータ