日本語PDF
  1. PL/SQLパッケージおよびタイプ・リファレンス
  2. DBMS_UMF

187 DBMS_UMF

DBMS_UMFパッケージは、Oracle DatabaseのRemote Management Framework (RMF)をデプロイするためのインタフェースを提供します。RMFは、Oracle Databaseのパフォーマンス統計を収集するために使用されます。

参照:

Oracle DatabaseのRMFの構成の詳細は、『Oracle Databaseパフォーマンス・チューニング・ガイド』を参照してください。

この章では、次の項目について説明します。

187.1 DBMS_UMFサブプログラムの要約

このトピックは、DBMS_UMFサブプログラムをアルファベット順に示し、簡単に説明しています。

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

サブプログラム 説明

CONFIGURE_NODEプロシージャ

RMFトポロジ内のノードを構成します。

CREATE_LINKプロシージャ

RMFトポロジ内の2つのノード間にデータベース・リンクを作成します。

CREATE_TOPOLOGYプロシージャ

RMFトポロジを作成します。

DROP_LINKプロシージャ

RMFトポロジ内の2つのノード間のデータベース・リンクを削除します。

DROP_TOPOLOGYプロシージャ

RMFトポロジを削除します。

ENABLE_SERVICEプロシージャ

RMFトポロジ内のノードでサービスを有効化します。

GET_NODE_ID_LOCALファンクション

RMFトポロジ内のノードのノードIDを戻します。

GET_NODE_NAME_LOCALファンクション

RMFトポロジ内のノードのノード名を戻します。

GET_TARGET_IDファンクション

RMFトポロジ内の宛先IDを戻します。

GET_TOPOLOGY_NAME_LOCALファンクション

ローカル・ノードのRMFトポロジ名を戻します。

QUERY_LINK_INFOプロシージャ

RMFトポロジ内のデータベース・リンクに関する情報を戻します。

QUERY_NODE_INFOプロシージャ

RMFトポロジ内のノードに関する情報を戻します。

REGISTER_NODEファンクションおよびプロシージャ

RMFトポロジ内のノードを登録します。

SWITCH_DESTINATIONプロシージャ

ソース・ノードをRMFトポロジ内の宛先ノードとして指定します。

UNCONFIGURE_NODEプロシージャ

RMFトポロジ内のノードの構成を再設定します。

UNREGISTER_NODEプロシージャ

RMFトポロジ内のノードの登録を削除します。

187.1.1 CONFIGURE_NODEプロシージャ

このプロシージャは、RMFトポロジに登録する必要があるノードを構成します。このプロシージャは、構成する必要があるノードで実行する必要があります。

構文

DBMS_UMF.CONFIGURE_NODE(
   node_name          IN VARCHAR2 DEFAULT NULL,
   dblink_to_target   IN VARCHAR2 DEFAULT NULL);

パラメータ

表187-2 CONFIGURE_NODEプロシージャのパラメータ

パラメータ 説明

node_name

ノードの名前。

RMFトポロジ内の各ノードには一意の名前を割り当てる必要があります。このプロシージャでノードの名前が指定されない場合は、初期化パラメータDB_UNIQUE_NAMEの値がデフォルトでノードの名前として割り当てられます。

dblink_to_target

このノードから宛先ノードへのデータベース・リンク。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.2 CREATE_LINKプロシージャ

このプロシージャは、RMFトポロジ内の2つのノード間にデータベース・リンクを作成します。このプロシージャは、宛先ノードのみで実行する必要があります。

構文

DBMS_UMF.CREATE_LINK(
   topology_name      IN VARCHAR2,
   node_a_name        IN VARCHAR2,
   node_b_name        IN VARCHAR2,
   dblink_a_to_b      IN VARCHAR2,
   dblink_b_to_a      IN VARCHAR2);

パラメータ

表187-3 CREATE_LINKプロシージャのパラメータ

パラメータ 説明

topology_name

RMFトポロジの名前。

node_a_name

最初のノードの名前。

node_b_name

2番目のノードの名前。

dblink_a_to_b

最初のノードから2番目のノードへのデータベース・リンク。

dblink_b_to_b

2番目のノードから最初のノードへのデータベース・リンク。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.3 CREATE_TOPOLOGYプロシージャ

このプロシージャは、RMFトポロジを作成し、このトポロジの宛先ノードとしてそれが実行されるノードを指定します。

構文

DBMS_UMF.CREATE_TOPOLOGY(
   topology_name IN VARCHAR2);

パラメータ

表187-4 CREATE_TOPOLOGYプロシージャのパラメータ

パラメータ 説明

topology_name

RMFトポロジの名前。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.4 DROP_LINKプロシージャ

このプロシージャは、RMFトポロジ内の2つのノード間のデータベース・リンクを削除します。このプロシージャは、宛先ノードのみで実行する必要があります。

構文

DBMS_UMF.DROP_LINK(
   topology_name  IN VARCHAR2,
   node_a_name    IN VARCHAR2,
   node_b_name    IN VARCHAR2);

パラメータ

表187-5 DROP_LINKプロシージャのパラメータ

パラメータ 説明

topology_name

RMFトポロジの名前。

node_a_name

最初のノードの名前。

node_b_name

2番目のノードの名前。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.5 DROP_TOPOLOGYプロシージャ

このプロシージャは、RMFトポロジを削除します。このプロシージャは、宛先ノードのみで実行する必要があります。

構文

DBMS_UMF.DROP_TOPOLOGY(
   topology_name IN VARCHAR2);

パラメータ

表187-6 DROP_TOPOLOGYプロシージャのパラメータ

パラメータ 説明

topology_name

削除するトポロジの名前。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.6 ENABLE_SERVICEプロシージャ

このプロシージャは、RMFトポロジ内のノードでAWRサービスなどのサービスを有効化します。このプロシージャは、宛先ノードのみで実行する必要があります。

構文

DBMS_UMF.ENABLE_SERVICE(
   topology_name      IN VARCHAR2,
   node_name          IN VARCHAR2,
   service_type       IN NUMBER);

パラメータ

表187-7 ENABLE_SERVICEプロシージャのパラメータ

パラメータ 説明

topology_name

RMFトポロジの名前。

node_name

特定のサービスを有効にする必要があるノードの名前。

service_type

サービスを識別する数値定数。このパラメータに指定できる値はUMF_SERVICE_TYPE_AWRのみで、これは自動ワークロード・リポジトリ(AWR)サービスを示します。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.7 GET_NODE_ID_LOCALファンクション

このファンクションは、RMFトポロジ内の、このファンクションが実行されたノードのノードIDを戻します。

構文

DBMS_UMF.GET_NODE_ID_LOCAL(
   topology_name  IN  VARCHAR2 DEFAULT NULL)
 RETURN NUMBER;

パラメータ

表187-8 GET_NODE_ID_LOCALファンクションのパラメータ

パラメータ 説明

topology_name

ノードが登録されているRMFトポロジの名前。

戻り値

RMFトポロジ内の、このファンクションが実行されたノードのノードIDを戻します。

セキュリティ・モデル

このファンクションを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.8 GET_NODE_NAME_LOCALファンクション

このファンクションは、RMFトポロジ内の、このファンクションが実行されたノードの名前を戻します。

構文

DBMS_UMF.GET_NODE_NAME_LOCAL RETURN VARCHAR2;

戻り値

RMFトポロジ内の、このファンクションが実行されたノードの名前を戻します。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.9 GET_TARGET_IDファンクション

このファンクションは、RMFトポロジ内の宛先ノードのIDを戻します。このファンクションは、RMFトポロジ内の任意のノードで実行できます。

構文

DBMS_UMF.GET_TARGET_ID(
   topology_name  IN  VARCHAR2)
 RETURN NUMBER;

パラメータ

表187-9 GET_TARGET_IDファンクションのパラメータ

パラメータ 説明

topology_name

RMFトポロジの名前。

戻り値

RMFトポロジ内の宛先ノードのIDを戻します。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.10 GET_TOPOLOGY_NAME_LOCALファンクション

このファンクションは、このファンクションが実行されたノードのアクティブなRMFトポロジの名前を戻します。

構文

DBMS_UMF.GET_TOPOLOGY_NAME_LOCAL RETURN VARCHAR2;

戻り値

このファンクションが実行されたノードのアクティブなRMFトポロジの名前を戻します。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.11 QUERY_LINK_INFOプロシージャ

このプロシージャは、RMFトポロジ内の2つのノード間のデータベース・リンクの名前を戻します。このプロシージャは、RMFトポロジ内の任意のノードで実行できます。

構文

DBMS_UMF.QUERY_LINK_INFO(
   topology_name      IN   VARCHAR2,
   from_node_id       IN   NUMBER,
   to_node_id         IN   NUMBER,
   link_name          OUT  VARCHAR2);

パラメータ

表187-10 QUERY_LINK_INFOプロシージャのパラメータ

パラメータ 説明

topology_name

RMFトポロジの名前。

from_node_id

最初のノードのノードID。

to_node_id

2番目のノードのノードID。

link_name

プロシージャにより戻される最初のノードから2番目のノードへのデータベース・リンクの名前。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.12 QUERY_NODE_INFOプロシージャ

このプロシージャは、RMFトポロジ内のノードに関する情報を戻します。このプロシージャは、RMFトポロジ内の任意のノードで実行できます。

構文

DBMS_UMF.QUERY_NODE_INFO(
   topology_name      IN    VARCHAR2  DEFAULT NULL,
   node_name          IN    VARCHAR2,
   node_id            OUT   NUMBER);

DBMS_UMF.QUERY_NODE_INFO(
   node_id            IN    NUMBER,
   topology_name      OUT   VARCHAR2,
   node_name          OUT   VARCHAR2);

パラメータ

表187-11 QUERY_NODE_INFOプロシージャのパラメータ

パラメータ 説明

topology_name

ノードが登録されているRMFトポロジの名前。

node_name

ノードの名前。

node_id

ノードの識別子。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.13 REGISTER_NODEファンクションおよびプロシージャ

このファンクションおよびプロシージャは、RMFトポロジにノードを登録します。このプロシージャおよびファンクションは、RMFトポロジ内の宛先ノードのみで実行する必要があります。

構文

DBMS_UMF.REGISTER_NODE(
   topology_name          IN  VARCHAR2,
   node_name              IN  VARCHAR2,
   dblink_to_node         IN  VARCHAR2 DEFAULT NULL,
   dblink_from_node       IN  VARCHAR2 DEFAULT NULL,
   as_source              IN  VARCHAR2 DEFAULT 'TRUE',
   as_candidate_target    IN  VARCHAR2 DEFAULT 'FALSE');

DBMS_UMF.REGISTER_NODE(
   topology_name          IN  VARCHAR2,
   node_name              IN  VARCHAR2,
   dblink_to_node         IN  VARCHAR2 DEFAULT NULL,
   dblink_from_node       IN  VARCHAR2 DEFAULT NULL,
   as_source              IN  VARCHAR2 DEFAULT 'TRUE',
   as_candidate_target    IN  VARCHAR2 DEFAULT 'FALSE');
   node_id                OUT VARCHAR2);

DBMS_UMF.REGISTER_NODE(
   topology_name          IN  VARCHAR2,
   node_name              IN  VARCHAR2,
   dblink_to_node         IN  VARCHAR2 DEFAULT NULL,
   dblink_from_node       IN  VARCHAR2 DEFAULT NULL,
   as_source              IN  VARCHAR2 DEFAULT 'TRUE',
   as_candidate_target    IN  VARCHAR2 DEFAULT 'FALSE')
 RETURN NUMBER;

パラメータ

表187-12 REGISTER_NODEファンクションおよびプロシージャのパラメータ

パラメータ 説明

topology_name

RMFトポロジの名前。

node_name

登録するノードの名前。

dblink_to_node

宛先からノードへのデータベース・リンクの名前。

dblink_from_node

ノードから宛先へのデータベース・リンクの名前。

as_source

ノードがソースである場合はTRUEに設定し、そうでない場合はFALSEに設定します。

as_candidate_target

ノードが宛先候補である場合はTRUEに設定し、そうでない場合はFALSEに設定します。

node_id

プロシージャにより戻されるノードID。

戻り値

登録されたノードのノードIDを戻します。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.14 SWITCH_DESTINATIONプロシージャ

このプロシージャは、宛先候補をRMFトポロジ内の新しい宛先にします。このプロシージャは、宛先候補のノードのみで実行する必要があります。

構文

DBMS_UMF.SWITCH_DESTINATION(
   topology_name      IN VARCHAR2,
   force_switch       IN BOOLEAN DEFAULT TRUE);

パラメータ

表187-13 SWITCH_DESTINATIONプロシージャのパラメータ

パラメータ 説明

topology_name

RMFトポロジの名前。

force_switch

FALSEに設定した場合、次の状況でこのプロシージャの実行が失敗します。

  • 宛先候補が読取り専用データベースであるため、新しい宛先として指定できない場合。

  • 宛先候補に、トポロジ内の1つ以上のソースへのデータベース・リンクがない場合。

  • 宛先候補が古い宛先からの最新のAWRデータを取得できない場合。

TRUEに設定した場合、次の状況でこのプロシージャの実行が失敗します。

  • 宛先候補が読取り専用データベースであるため、新しい宛先として指定できない場合。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.15 UNCONFIGURE_NODEプロシージャ

このプロシージャは、このプロシージャが実行されたノードの構成の詳細を削除します。

構文

DBMS_UMF.UNCONFIGURE_NODE;

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。

187.1.16 UNREGISTER_NODEプロシージャ

このプロシージャは、RMFトポロジのノードを削除します。このプロシージャは、宛先ノードのみで実行する必要があります。

構文

DBMS_UMF.UNREGISTER_NODE(
   topology_name    IN VARCHAR2,
   node_name        IN VARCHAR2);

パラメータ

表187-14 UNREGISTER_NODEプロシージャのパラメータ

パラメータ 説明

topology_name

RMFトポロジの名前。

node_name

トポロジから削除する必要があるノードの名前。

セキュリティ・モデル

このプロシージャを実行できるのは、データベース・ユーザーSYSおよびSYS$UMFのみです。