API Reference

RFWD-OUTPUT

This structure is used to pass information from sqluroll - Rollforward Database).

Table 7. Fields in the RFWD-OUTPUT Structure

Field Name Data Type Description
PAPPLICATIONID Pointer The address of a buffer of length SQLU_APPLID_LEN+1 (defined in sqlutil) to hold an application identifier returned from the API. This identifier can be used with the database system monitor APIs to monitor some aspects of the application. If this information is not of interest, supply the NULL pointer. In a multi-node environment, returns only the application identifier for the catalog node.
PNUMREPLIES Pointer Number of node replies received. Each node that replies fills in an sqlurf_info structure in pNodeInfo. In a single-node environment, the value of this parameter is 1.
PNODEINFO Structure Node reply information. A user defined array of NumNodeInfo sqlurf_info structures.
NODENUM SQL_PDB_NODE_TYPE Node number.
STATE LONG State information.
NEXTARCLOG UNSIGNED CHAR(13) A 12-byte buffer to hold the returned name of the next archived log file required. If a caller action other than SQLUM_QUERY is supplied, the value returned in this field indicates that an error occurred when accessing the file. Possible causes are:

The file was not found in the database log directory, nor on the path specified by the overflow log path parameter
The user exit program failed to return the archived file.

FIRSTARCDEL UNSIGNED CHAR(13) A 12-byte buffer to hold the returned name of the first archived log file no longer needed for recovery. This file, and all files up to and including lastarcdel, can be moved to make room on the disk.
For example, if the values returned in firstarcdel and lastarcdel are S0000001.LOG and S0000005.LOG, the following log files can be moved:

S0000001.LOG
S0000002.LOG
S0000003.LOG
S0000004.LOG
S0000005.LOG

LASTARCDEL UNSIGNED CHAR(13) A 12-byte buffer to hold the returned name of the last archived log file that can be removed from the database log directory.
LASTCOMMIT UNSIGNED CHAR(27) A 26-character string containing a time stamp in ISO format. This value represents the time stamp of the last committed transaction after the rollforward operation terminates.

Field Name	Data Type	Description
PAPPLICATIONID	Pointer	The address of a buffer of length `SQLU_APPLID_LEN+1` (defined in `sqlutil`) to hold an application identifier returned from the API. This identifier can be used with the database system monitor APIs to monitor some aspects of the application. If this information is not of interest, supply the NULL pointer. In a multi-node environment, returns only the application identifier for the catalog node.
PNUMREPLIES	Pointer	Number of node replies received. Each node that replies fills in an sqlurf_info structure in pNodeInfo. In a single-node environment, the value of this parameter is 1.
PNODEINFO	Structure	Node reply information. A user defined array of NumNodeInfo sqlurf_info structures.
NODENUM	SQL_PDB_NODE_TYPE	Node number.
STATE	LONG	State information.
NEXTARCLOG	UNSIGNED CHAR(13)	A 12-byte buffer to hold the returned name of the next archived log file required. If a caller action other than `SQLUM_QUERY` is supplied, the value returned in this field indicates that an error occurred when accessing the file. Possible causes are: The file was not found in the database log directory, nor on the path specified by the overflow log path parameter The user exit program failed to return the archived file.
FIRSTARCDEL	UNSIGNED CHAR(13)	A 12-byte buffer to hold the returned name of the first archived log file no longer needed for recovery. This file, and all files up to and including lastarcdel, can be moved to make room on the disk. For example, if the values returned in firstarcdel and lastarcdel are `S0000001.LOG` and `S0000005.LOG`, the following log files can be moved: `S0000001.LOG` `S0000002.LOG` `S0000003.LOG` `S0000004.LOG` `S0000005.LOG`
LASTARCDEL	UNSIGNED CHAR(13)	A 12-byte buffer to hold the returned name of the last archived log file that can be removed from the database log directory.
LASTCOMMIT	UNSIGNED CHAR(27)	A 26-character string containing a time stamp in ISO format. This value represents the time stamp of the last committed transaction after the rollforward operation terminates.

Possible values for STATE (defined in sqlutil) are:

SQLURFQ_NOT_AVAILABLE: Could not connect to the node.
SQLURFQ_NOT_RFW_PENDING: Database is not rollforward pending.
SQLURFQ_DB_RFW_PENDING: Database is rollforward pending.
SQLURFQ_TBL_RFW_PENDING: Table space is rollforward pending.
SQLURFQ_DB_RFW_IN_PROGRESS: Database rollforward in progress.
SQLURFQ_TBL_RFW_IN_PROGRESS: Table space rollforward in progress.
SQLURFQ_DB_RFW_STOPPING: Database rollforward was interrupted while processing a STOP request.
SQLURFQ_TBL_RFW_STOPPING: Table space rollforward was interrupted while processing a STOP request.

Language Syntax

C Structure

/* File: sqlutil.h */ /* Structure: RFWD-OUTPUT */ /* ... */ SQL_STRUCTURE rfwd_output { char *pApplicationId; long *pNumReplies; struct sqlurf_info *pNodeInfo; }; /* ... */

/* File: sqlutil.h */ /* Structure: SQLURF-INFO */ /* ... */ SQL_STRUCTURE sqlurf_info { SQL_PDB_NODE_TYPE nodenum; long state; unsigned char nextarclog[SQLUM_ARCHIVE_FILE_LEN+1]; unsigned char firstarcdel[SQLUM_ARCHIVE_FILE_LEN+1]; unsigned char lastarcdel[SQLUM_ARCHIVE_FILE_LEN+1]; unsigned char lastcommit[SQLUM_TIMESTAMP_LEN+1]; }; /* ... */

COBOL Structure

* File: sqlutil.cbl 01 SQL-RFWD-OUTPUT. 05 SQL-APPLID USAGE IS POINTER. 05 SQL-NUMREPLIES USAGE IS POINTER. 05 SQL-P-NODE-INFO USAGE IS POINTER. *

* File: sqlutil.cbl 01 SQLURF-INFO. 05 SQL-NODENUM PIC S9(4) COMP-5. 05 FILLER PIC X(2). 05 SQL-STATE PIC S9(9) COMP-5. 05 SQL-NEXTARCLOG PIC X(12). 05 FILLER PIC X. 05 SQL-FIRSTARCDEL PIC X(12). 05 FILLER PIC X. 05 SQL-LASTARCDEL PIC X(12). 05 FILLER PIC X. 05 SQL-LASTCOMMIT PIC X(26). 05 FILLER PIC X. 05 FILLER PIC X(2). *

[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]

[ DB2 List of Books | Search the DB2 Books ]