发行说明


37.1 db2ArchiveLog(新 API)

db2ArchiveLog

关闭并截断可恢复数据库的活动日志文件。如果启用了用户出口,则发出归档请求。

权限

下列其中一项:

必需的连接

此 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 参数

版本
输入。指定作为第二个参数 pDB2ArchiveLogStruct 传送的变量的版本和发行版级别。

pDB2ArchiveLogStruct
输入。指向 db2ArchiveLogStruct 结构的指针。

pSqlca
输出。指向 sqlca 结构的指针。

iAliasLen
输入。一个 4 字节不带符号的整数,表示数据库别名的长度(以字节计)。

iUserNameLen
一个 4 字节不带符号的整数,表示用户名的长度(以字节计)。如果未使用任何用户名,则设置为零。

iPasswordLen
输入。一个 4 字节不带符号的整数,表示密码的长度(以字节计)。如果未使用任何密码,则设置为零。

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
输入。留作将来使用。


[ 页的顶部 | 上一页 | 下一页 | 目录 | 索引 ]