システム・モニター 手引きおよび解説書

db2GetSnapshotSize - db2GetSnapshot() 出力バッファーの必要サイズの見積もり

db2GetSnapshot - スナップショットの取得によって必要とされるバッファー・サイズを見積もります。

効力範囲

この API は、 呼び出しアプリケーションが接続されているインスタンスにだけ影響を与えます。

許可

以下のいずれかになります。

必須接続

インスタンス。 インスタンスの接続がない場合は、 省略時のインスタンス接続が作成されます。

リモート・インスタンス (または別のローカル・インスタンス) から情報を取得するには、 そのインスタンスに最初に接続する必要があります。 接続が存在しない場合は、 DB2INSTANCE 環境変数によって指定されたノードにインスタンスが暗黙接続されます。

db2ApiDf.h

C API 構文

int db2GetSnapshotSize(db2Uint32	version,    	
			    void* 	pParamStruct,
			    struct sqlca* sqlca);
 
typedef struct
{
        struct sqlma                    *piSqlmaData;
        sqluint32                       *poBufferSize;
        db2Uint32                       iVersion;
        db2int32                        iNodeNumber;			
}db2GetSnapshotSizeData;
/* ...*/

API パラメーター

version
入力。 2 番目のパラメーター pParamStruct として渡される構造体のバージョンとリリース・レベルを指定します。

pParamStruct
入力。 db2GetSnapshotSizeStruct 構造体へのポインター

sqlca
出力。 sqlca 構造体へのポインター。

piSqlmaData
入力。 ユーザーが割り当てた sqlma (モニター域) 構造を指すポインター。 この構造は収集されるスナップショット・データのタイプを指定し、 db2GetSnapshot - スナップショットの取得への入力としても再使用できます。

poBufferSize
出力。GET SNAPSHOT API に必要な、 戻された見積もり済みのバッファー・サイズを指すポインター。

iVersion
入力。 収集するデータベース・モニター・データのバージョン ID。 データベース・モニターは、要求されたバージョンで使用可能なデータだけを戻します。 このパラメーターは以下の記号定数のいずれかに設定してください。

注:バージョンが SQLM_DBMON_VERSION1 と指定された場合は、 API はリモートで実行できません。

iNodeNumber
入力。 要求が送信されるノード。 この値に基づき、現在のノード、すべてのノード、 またはユーザーが指定したノードで要求が処理されます。有効値は以下のとおりです。

注:スタンドアロン・インスタンスの場合、 SQLM_CURRENT_NODE を使用する必要があります。

使用上の注意

この関数には、相当のオーバーヘッドが伴います。 また、それぞれの db2GetSnapshot 呼び出しに動的にメモリーを割り当てて解放すると、 コストがかかります。 (たとえば一定期間ごとにデータを抽出する時のように) db2GetSnapshot を繰り返し呼び出す場合は、 db2GetSnapshotSize を呼び出すよりも、 固定サイズのバッファーを割り当てる方が効率的かもしれません。

データベース・システム・モニターが活動状態のデータベースやアプリケーションを見つけられない場合、 ゼロのバッファー・サイズが戻されることがあります (たとえば、 活動状態でないデータベースに関するロック情報が要求される場合)。 db2GetSnapshot - スナップショットの取得を呼び出す前に、 この API によって戻された見積もりバッファー・サイズがゼロでないことを確かめてください。 バッファー・スペースが足りなくて出力を保管できないために db2GetSnapshot がエラーを戻した場合、 この API をもう一度呼び出して、新しいサイズ必要量を判別してください。

データベース・モニター API の使用方法の詳細について、 およびデータベース・モニターのすべてのデータ要素とモニター・グループの要約については、 システム・モニター 手引きおよび解説書 を参照してください。

追加情報

db2MonitorSwitches - モニターのスイッチの取得 / 更新

db2GetSnapshot - スナップショットの取得

db2ResetMonitor - モニターのリセット


[ ページのトップ | 前ページ | 次ページ | 目次 | 索引 ]