Journal and Commit APIs

Journaling allows you to specify database files or access paths that you want to protect for recovery purposes. It also provides an audit trail for database file changes. Journaling provides an audit or activity trail for other objects either through system operations or user actions.

Commitment control allows you to define and process changes to resources, such as database files or tables, as a single logical unit of work. Commitment control uses the journaling facility to provide for logical units of work.

The journal APIs allow you to:

• Obtain information about some of the journal's attributes or the journal receiver's attributes

• Obtain journal information based on the journal identifier

• Send an entry to specified journal

• Add, remove, activate, and inactivate remote journals.

The commitment control APIs allow you to:

• Add and remove your own resources to be used during AS/400 system commit or rollback processing

• Retrieve information about the commitment control environment

• Change commitment control options

• Put a commitment definition into rollback-required state

This section presents the APIs in alphabetical order, followed by a description of the commitment control and journal exit programs.

If you plan to use the APIs described in this chapter, you must understand commitment control and journaling as discussed in the Backup and Recovery book .

The commitment control and journal APIs include the following:

• Add Commitment Resource (QTNADDCR) adds an API commitment resource to the current commitment definition.

• Add Remote Journal (QjoAddRemoteJournal) associates a remote journal on the target system, as identified by the relational database directory entry, with the specified journal on the source system.

• Change Commitment Options (QTNCHGCO) changes the commitment control options for the current commitment definition.

• Change Journal State (QjoChangeJournalState) changes the journal state of local and remote journals.

• Delete Pointer Handle (QjoDeletePointerHandle) deletes the specified pointer handle.

• Materialize Journal Port Attributes (QusMaterializeJournalPortAttr) retrieves some of the current attributes of a journal.

• Materialize Journal Space Attributes (QusMaterializeJournalSpaceAttr) retrieves some of the current attributes of a journal receiver.

• Remove Commitment Resource (QTNRMVCR) removes an API commitment resource from the current commitment definition.

• Remove Remote Journal (QjoRemoveRemoteJournal) disassociates a remote journal on the target system, as identified by the relational database directory entry, from the specified journal on the source system.

• Retrieve Commitment Information (QTNRCMTI) gets information about the current commitment definition.

• Retrieve Journal Entries (QjoRetrieveJournalEntries) provides access to journal entries.

• Retrieve Journal Identifier Information (QJORJIDI) gets information about a specific journal identifier (JID) for a specified journal.

• Retrieve Journal Information (QjoRetrieveJournalInformation) provides access to journal-related information to help manage a journal environment, including a remote journal environment.

• Retrieve Journal Receiver Information (QjoRtvJrnReceiverInformation) provides access to journal-receiver-related information to help manage a journal environment, including a remote journal environment.

• Rollback Required (QTNRBRQD) puts the current commitment definition into a rollback-required state.

• Send Journal Entry (QJOSJRNE) writes a single journal entry to a specific journal.