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

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

データベース・マネージャーのモニター情報を収集し、 それをユーザーが割り当てたデータ・バッファーに戻します。 戻された情報は、API が呼び出されたときのデータベース・マネージャーの操作状況のスナップショット を表します。

効力範囲

この API はそれが発行されたノードの情報だけを戻します。

許可

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

必須接続

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

リモート・インスタンス (または別のローカル・インスタンス) からスナップショットを取得するには、 まずそのインスタンスに接続する必要があります。

db2ApiDf.h

C API 構文

int db2GetSnapshot(	unsigned char		version;	
			db2GetSnapshotData *data,            
			struct sqlca 		*sqlca; 	
 
The parameters described in data are:
typedef struct db2GetSnapshotData{
  sqlma 		*piSqlmaData;
  sqlm_collected 	*poCollectedData
  void 			*poBuffer;
  db2uint32		iVersion;
  db2int32		iBufferSize;
  db2uint8		iStoreResult;
db2uint16		iNodeNumber;
db2uint32		*poOutputFormat;
 
}db2GetSnapshotData;

API パラメーター

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

data
入出力。 db2GetSnapshotData 構造体へのポインター。

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

piSqlmaData
入力。 ユーザーが割り当てた sqlma (モニター域) 構造を指すポインター。 この構造は、収集されるデータのタイプを指定します。

poCollectedData
出力。 sqlm_collected 構造体を指すポインター。 データベース・モニターは、この構造体の中に、 バッファー域に戻されるサマリー統計とそれぞれのタイプのデータ構造の数を指定します。

注:この構造体はバージョン 6 以前のデータ・ストリームでのみ使われます。 しかし、 スナップショット呼び出しを以前のレベルのリモート・サーバーに対して行う場合は、 この構造体を渡さないと結果を処理できません。 このため、このパラメーターを常に渡すことをお勧めします。

poBuffer
出力。 スナップショット情報が戻されるユーザー定義データ域を指すポインター。 このバッファーに戻されたデータの解釈の詳細については、 システム・モニター 手引きおよび解説書 を参照してください。

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

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

iBufferSize
入力。 データ・バッファーの長さ。 db2GetSnapshotSize - db2GetSnapshot() 出力バッファーの必要サイズの見積もりを使って、 このバッファーのサイズを見積もってください。 バッファーの大きさが十分でないと、 割り当てられたバッファーに収まるだけの情報とともに、警告が戻されます。 バッファーをサイズ変更して、 もう一度 API を呼び出す必要があるかもしれません。

iStoreResult
入力。 TRUE または FALSE に設定される標識。 スナップショットを SQL で表示できるよう、DB2 サーバーに格納するかどうかを決定します。 スナップショットがデータベース接続を介して取られる場合、 および sqlma のスナップショット・タイプに SQLMA_DYNAMIC_SQL が含まれる場合は、 このパラメーターを必ず TRUE に設定する必要があります。

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

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

poOutputFormat
サーバーが戻すストリームの形式。 これは、以下のいずれかになります。

使用上の注意

異なるインスタンスにあるデータベースの別名が指定されると、 エラー・メッセージが戻されます。

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

追加情報

db2ConvMonStream

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

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

db2ResetMonitor - モニターのリセット


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