次の表に、プロファイリングツールの制御に使用できる関数とストアドプロシージャを示します。
表1. DBMS_PROFILER関数とストアドプロシージャの | 関数またはストアドプロシージャ | データ型 | 戻り値タイプ | 説明 |
| FLUSH_DATA | 関数またはストアドプロシージャ | ステータスコードまたは例外 | 現在のセッションで収集されたパフォーマンスデータをフラッシュします。 |
| GET_VERSION (メジャーOUT、マイナーOUT) | ストアドプロシージャ | N/A | DBMS_PROFILERパッケージのバージョンを返します。 |
| INTERNAL_VERSION_ CHECK | 機能 | ステータスコード | DBMS_PROFILERパッケージの現在のバージョンが現在のデータベースと互換性があることを確認します。 |
| PAUSE_PROFILER | 関数またはストアドプロシージャ | ステータスコードまたは例外 | プロファイラーセッションを中断します。 |
| RESUME_PROFILER | 関数またはストアドプロシージャ | ステータスコードまたは例外 | プロファイラーセッションを再開します。 |
| START_PROFILER (コメントを実行、コメントを実行 [、実行番号OUT ]) | 関数またはストアドプロシージャ | ステータスコードまたは例外 | プロファイラーセッションを開始します。 |
| STOP_PROFILER | 関数またはストアドプロシージャ | ステータスコードまたは例外 | プロファイラーセッションを停止し、パフォーマンスデータをDBMS_PROFILERテーブルおよびビューにフラッシュします。 |
DBMS_PROFILERパッケージ内の関数は、成功または失敗を示すステータスコードを返す。 DBMS_PROFILERパッケージ内のストアドプロシージャは、障害が発生した場合にのみ例外をスローします。 次の表に、関数によって返されるステータスコードとメッセージ、およびストアドプロシージャによってスローされる例外を示します。
表2. 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関数またはストアドプロシージャは、プロファイラセッションを終了せずに、現在のセッションで収集されたデータをフラッシュします。 データは、
PolarDBパフォーマンスガイドで説明されているテーブルにフラッシュされます。 構文:
INTEGER FLUSH_DATAステータス
FLUSH_DATA
の
パラメータ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パッケージの現在のバージョンが現在のデータベースと互換性があることを確認します。 構文:
status INTEGER INTERNAL_VERSION_CHECK
パラメーターPAUSE_PROFILER
PAUSE_PROFILER関数またはストアドプロシージャは、プロファイラーセッションを中断します。 構文:
ステータスINTEGER PAUSE_PROFILER
PAUSE_PROFILER
の
パラメータRESUME_PROFILER
RESUME_PROFILER関数またはストアドプロシージャは、プロファイラセッションを再開します。 構文:
INTEGER RESUME_PROFILERステータス
RESUME_PROFILER
の
パラメータSTART_PROFILER
START_PROFILER関数またはストアドプロシージャは、プロファイラセッションを開始します。 構文:
ステータスINTEGER START_PROFILER(run_commentテキスト:= SYSDATE、
run_comment1テキスト:= '' [, run_number OUT INTEGER ])
START_PROFILER(run_commentテキスト:= SYSDATE、
パラメータrun_comment1 TEXT := '' [, run_number OUT INTEGER ])
| パラメーター | 説明 |
| コメントを実行 | プロファイラーセッションのカスタムコメント。 デフォルト値はSYSDATEです。 |
| コメントを実行 | プロファイラーセッションの追加のカスタムコメント。 デフォルト値はTTです。 |
| 実行番号 | プロファイラーセッションの数。 |
| status | 返された状態コード。 |
STOP_PROFILER
STOP_PROFILER関数またはストアドプロシージャは、プロファイラセッションを停止し、パフォーマンス情報を
DBMS_PROFILERテーブルおよびビューにフラッシュします。 構文:
INTEGER STOP_PROFILERステータス
STOP_PROFILER
の
パラメータ