DBMS_PROFILER パッケージは、パフォーマンスプロファイリングセッション中に実行される PL/pgSQL および SPL 文に関するパフォーマンス情報を収集して保存します。 次の表に、プロファイリングツールの制御に使用できる関数とストアドプロシージャを示します。
| 関数/ストアドプロシージャ | 関数またはストアドプロシージャ | 戻り値のタイプ | 説明 |
|---|---|---|---|
| FLUSH DATA | 両方 | ステータスコードまたは例外 | 現在のセッションで収集されたパフォーマンスデータを、セッションを終了せずにフラッシュします (プロファイリングは続行されます)。 |
| GET VERSION(major OUT, minor OUT) | プロシージャ | N/A | このパッケージのバージョン番号を返します。 |
| INTERNAL VERSION CHECK | 関数 | ステータスコード | プロファイラーの現在のバージョンが現在のデータベースで動作することを確認します。 |
| PAUSE PROFILER | 両方 | ステータスコードまたは例外 | データ収集を一時停止します。 |
| PAUSE_PROFILER | 両方 | ステータスコードまたは例外 | データ収集を再開します。 |
| START PROFILER(run_comment, run_comment1 [, run_number OUT ]) | 両方 | ステータスコードまたは例外 | データ収集を開始します。 |
| STOP PROFILER | 両方 | ステータスコードまたは例外 | データ収集を停止し、パフォーマンスデータを PLSQL PROFILER RAWDATA テーブルにフラッシュします。 |
DBMS_PROFILER パッケージ内の関数は、成功または失敗を示すステータスコードを返します。 DBMS_PROFILER パッケージ内のストアドプロシージャは、障害が発生した場合にのみ例外を発生させます。 次の表に、関数によって返されるステータスコードとメッセージ、およびストアドプロシージャによって発生する例外を示します。
| ステータスコード | メッセージ | 例外 | 説明 |
|---|---|---|---|
| -1 | error version | version_mismatch | プロファイラーのバージョンとデータベースに互換性がありません。 |
| 0 | success | N/A | 操作は正常終了しました。 |
| 1 | error_param | profiler_error | 操作が不正なパラメーターを受け取りました。 |
| 2 | error_io | profiler_error | データのフラッシュ操作が失敗しました。 |
FLUSH_DATA
FLUSH_DATA 関数またはストアドプロシージャは、プロファイラーセッションを終了せずに、現在のセッションで収集されたデータをフラッシュします。 データは、 Oracle Performance Features Guide と互換性のある POLARDB で説明されているテーブルにフラッシュされます。 FLUSH_DATA 関数とストアドプロシージャの構文は次のとおりです。
status INTEGER FLUSH_DATA
FLUSH_DATAパラメーター
| パラメーター | 説明 |
|---|---|
| status | 操作によって返されたステータスコード。 |
GET_VERSION
GET_VERSION ストアドプロシージャは、DBMS_PROFILER パッケージのバージョンを返します。 構文：
GET_VERSION(major OUT INTEGER, minor OUT INTEGER)パラメーター
| パラメーター | 説明 |
|---|---|
| major | DBMS_PROFILER パッケージのメジャーバージョン番号。 |
| minor | DBMS_PROFILER パッケージのマイナーバージョン番号。 |
INTERNAL_VERSION_CHECK
INTERNAL_VERSION_CHECK 関数は、DBMS_PROFILER パッケージの現在のバージョンが現在のデータベースで機能することを確認します。 INTERNAL_VERSION_CHECK 関数の構文は次のとおりです。
status INTEGER INTERNAL_VERSION_CHECKパラメーター
| パラメーター | 説明 |
|---|---|
| status | 操作によって返されたステータスコード。 |
PAUSE_PROFILER
PAUSE_PROFILER 関数またはストアドプロシージャは、プロファイリングセッションを一時停止します。 構文：
status INTEGER PAUSE_PROFILER
PAUSE_PROFILERパラメーター
| パラメーター | 説明 |
|---|---|
| status | 操作によって返されたステータスコード。 |
RESUME_PROFILER
RESUME_PROFILER 関数またはストアドプロシージャは、プロファイリングセッションを再開します。 RESUME_PROFILER 関数またはストアドプロシージャの構文は次のとおりです。
status INTEGER RESUME_PROFILER
RESUME_PROFILERパラメーター
| パラメーター | 説明 |
|---|---|
| status | 操作によって返されたステータスコード。 |
START_PROFILER
START_PROFILER 関数またはストアドプロシージャは、データ収集セッションを開始します。 構文：
status INTEGER START_PROFILER(run_comment TEXT := SYSDATE,
run_comment1 TEXT := '' [, run_number OUT INTEGER ])
START_PROFILER(run_comment TEXT := SYSDATE,
run_comment1 TEXT := '' [, run_number OUT INTEGER ])パラメーター
| パラメーター | 説明 |
|---|---|
| run_comment | プロファイラーセッションに対するユーザー定義のコメント。 デフォルト値は SYSDATE です。 |
| run_comment1 | プロファイラーセッションに関する追加のユーザー定義コメント。 デフォルト値は '' です。 |
| run_number | プロファイラーセッションのセッション番号。 |
| status | 操作によって返されたステータスコード。 |
STOP_PROFILER
STOP_PROFILER 関数またはストアドプロシージャは、プロファイリングセッションを停止し、パフォーマンス情報を DBMS_PROFILER テーブルとビューにフラッシュします。 構文：
status INTEGER STOP_PROFILER
STOP_PROFILERパラメーター
| パラメーター | 説明 |
|---|---|
| status | 操作によって返されたステータスコード。 |