リリース情報

38.1 db2ArchiveLog (新規 API)

db2ArchiveLog

回復可能データベースのアクティブ・ログ・ファイルをクローズして切り捨てます。ユーザー出口が使用可能な場合にはアーカイブ要求を実行します。

権限

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

• sysadm
• sysctrl
• sysmaint
• dbadm

必要な接続

この API は、指定されたデータベースへの接続を自動的に確立します。指定されたデータベースへの接続がすでに確立されている場合、 API はエラーを返します。

API 組み込みファイル

db2ApiDf.h

C API 構文

/* File: db2ApiDf.h */
/* API:  Archive Active Log */
SQL_API_RC SQL_API_FN
   db2ArchiveLog (
      db2Uint32 version,
      void *pDB2ArchiveLogStruct,
      struct sqlca * pSqlca);
 
typedef struct
{
   char                *piDatabaseAlias;
   char                *piUserName;
   char                *piPassword;
   db2Uint16           iAllNodeFlag;
   db2Uint16           iNumNodes;
   SQL_PDB_NODE_TYPE   *piNodeList;
   db2Uint32           iOptions;
} db2ArchiveLogStruct

汎用 API 構文

/* File: db2ApiDf.h */
/* API:  Archive Active Log */
SQL_API_RC SQL_API_FN
   db2gArchiveLog (
      db2Uint32 version,
      void *pDB2ArchiveLogStruct,
      struct sqlca * pSqlca);
 
typedef struct
{
   db2Uint32           iAliasLen;
   db2Uint32           iUserNameLen;
   db2Uint32           iPasswordLen;
   char                *piDatabaseAlias;
   char                *piUserName;
   char                *piPassword;
   db2Uint16           iAllNodeFlag;
   db2Uint16           iNumNodes;
   SQL_PDB_NODE_TYPE   *piNodeList;
   db2Uint32           iOptions;
} db2ArchiveLogStruct

API パラメーター

version

入力。2 番目のパラメーターとして渡される変数 pDB2ArchiveLogStruct のバージョンおよびリリース・レベルを指定します。

pDB2ArchiveLogStruct

入力。db2ArchiveLogStruct 構造へのポインター。

pSqlca

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

iAliasLen

入力。4 バイトの符号なし整数で、データベース別名の長さをバイト数で表します。

iUserNameLen

ユーザー名の長さ (バイト単位) を表す 4 バイトの符号なし整数。ユーザー名を使用しない場合は、0 に設定してください。

iPasswordLen

入力。パスワードの長さ (バイト単位) を表す 4 バイトの符号なし整数。パスワードを使用しない場合、0 に設定します。

piDatabaseAlias

入力。アクティブ・ログのアーカイブが作成されるデータベースのデータベース別名 (システム・データベース・ディレクトリーにカタログされているもの) を含むストリング。

piUserName

入力。接続時に使用されるユーザー名を含むストリング。

piPassword

入力。接続を試みるときに使用されるパスワードを含むストリング。

iAllNodeFlag

MPP のみ。入力。操作を db2nodes.cfg ファイルにリストされているすべてのノードに適用するかどうかを示すフラグ。有効な値は以下の通りです。

DB2ARCHIVELOG_NODE_LIST

piNodeList に渡されるノード・リストのノードに適用されます。

DB2ARCHIVELOG_ALL_NODES

すべてのノードに適用されます。 piNodeList は NULL です。これがデフォルト値です。

DB2ARCHIVELOG_ALL_EXCEPT

piNodeList に渡されるノード・リストのノードを除くすべてのノードに適用されます。

iNumNodes

MPP のみ。入力。piNodeList 配列のノード数を指定します。

piNodeList

MPP のみ。入力。アーカイブ・ログ操作を適用するノード番号の配列を指すポインター。

iOptions

入力。将来の使用のために予約されています。