Checkpoint (lkt_checkpoint)

Use the following functions to checkpoint all, or a selected set of, in-memory objects:

dvkerr_t lkt_checkpoint(lpar_t host, lpar_t names, lpar_t *dblist);
dvkerr_t lkt_checkpointT(lpar_t host, lpar_t names, lpar_t tran, 
                         lpar_t options, lpar_t *dblist);

If a checkpoint of multiple objects is requested, all objects that can be checkpointed are checkpointed. A list of all objects that could not be checkpointed is returned as the error item of the DVK_ERR_PARTIALCHPT error.

If a checkpoint of a database table is requested, all tables in the same joined set of tables are automatically included in the tables checkpointed. The joined set of tables for a child table is its parent table and all child tables of its parent table. The joined set of tables for a parent table is all of its child tables. If one or more tables in the joined set of tables cannot be checkpointed, the entire joined set of tables is not checkpointed. In other words, a joined set of tables is always checkpointed as a unit. If the durable-data feature is enabled, lkt_checkpoint has no effect and returns successfully.

Input

host (optional)

This is used to identify the server. For more information, see Communicating with TIBCO Patterns Servers

names (required)

This entry must be one of the following:

•

LPAR_NULL use this to specify all database tables.

•

LPAR_STR_DBDESCRIPTOR use this to specify a single database table.

•

A generic list (LPAR_LST_GENERIC) of LPAR_STR_DBDESCRIPTORs. Use this to specify a set of specific tables. The list might consist of a single entry, in which case the entry is treated as if a single LPAR_STR_DBDESCRIPTOR was passed.

•

A multi descriptor list (LPAR_LST_MULTIDESC) of lists of objects. Use this to checkpoint any combination of object types. The LPAR_LST_MULTIDESC must contain exactly four generic lists. The first list must be a list of LPAR_STR_DBDESCRIPTOR values, specifying the database tables to be processed. The second list must be a list of LPAR_STR_CHARMAP values, specifying the custom character maps to be processed. The third list must be a list of LPAR_STR_THESAURUSNAME values, specifying the thesauri to be processed. The fourth list must be a list of LPAR_STR_RLMODELNAME values, specifying the Learn Models to be processed.

The following holds for all four lists in a multi descriptor list:

•

If the list value is LPAR_NULL instead of LPAR_LST_GENERIC, all objects of the type (as determined by the position of the list in the multi descriptor list) are processed.

•

If the list is an empty generic list (LPAR_LST_GENERIC), no objects of the type (as determined by the position of the list in the multi descriptor list) are processed.

•

If the list is a generic list (LPAR_LST_GENERIC) with more than one entry, the object specified by each entry is processed.

tran (optional)

identifies the user transaction (LPAR_LONG_TRAN_ID) under which the checkpoint operation is to be performed.

options (optional)

for future use. Value should be LPAR_NULL

Output

dblist (optional)

If non-null a list of the objects successfully checkpointed is returned. The list is a generic list (LPAR_LST_GENERIC) of object names. The names can be a mix of LPAR_STR_DBDESCRIPTOR, LPAR_STR_CHARMAP, LPAR_STR_THESAURUSNAME, and LPAR_STR_RLMODELNAME. The entries are not returned in any particular order.

Error codes and items returned by lkt_checkpoint

CHPTFAIL	list of databases that failed to checkpoint
DBNOTFOUND	list of objects not found
DBPARAM	invalid lpar from object name
DUPDBDESCS	duplicate object name
EXPECTDBDESC	item that should have been a n object name
LPAR_NULL	if checkpointing not enabled
INTERNAL	description of error, or LPAR_NULL
NODBDESC	Object name with empty value or LPAR_LST_GENERIC with no entries
NOSYSINIT	(none)
PARAMVAL	The invalid object name
PARMTYPE	The object name that is invalid
PARTIALCHPT	list of databases that failed to checkpoint
TRAN_UNKNOWN	lpar that contains the unknown transaction id
TRAN_IN_USE	lpar that contains the transaction id
TRANCONFLICT	list that contains LPAR_LONGINT_TRAN_ID and LPAR_STR_ERRORDETAILS