Journal and Commit APIs

Journaling allows you to specify objects that you want to protect for recovery purposes. It also provides an audit trail for object changes. Journaling provides an audit or activity trail for other objects either through system operations or user actions. 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.
• Start and stop journaling.

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 commitment control APIs allow you to:

• Add and remove your own resources to be used during system commit or rollback processing
• Retrieve information about the commitment control environment
• Change commitment control options
• Put a commitment definition into rollback-required state

For additional information, see:

• Journaling for Journal and Commit APIs
  
  
• Commitment Control for Journal and Commit APIs

If you plan to use the APIs described in this chapter, you must understand the Commitment Control and Journal Management topics in the Information Center. These topics include information on remote journaling, remote journaling support, and a complete description of the information contained in journal entries that the system sends and all the possible journal codes and entry types.

The journal and commit APIs are:

• 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 Recovery Count (QJOCHRVC) controls how often changes to journaled objects are forced to auxiliary storage.
• Change Journal State (QjoChangeJournalState) changes the journal state of local and remote journals.
• Clear LU6.2 Partners (QTNCLRLU) clears LU6.2 syncpoint LOG partners known to the system.
• Delete Pointer Handle (QjoDeletePointerHandle) deletes the specified pointer handle.
• End Journal (QjoEndJournal) ends journaling for the specified object.
• 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.
• Replay Database Operation (QDBRPLAY) Replay a database operation from a single journal entry.
• 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.
• Return LU6.2 Partners (QTNRTNLU) returnss LU6.2 syncpoint LOG partners known to the system.
• 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.
• Start Journal (QjoStartJournal) starts journaling for the specified object.

The journal and commit exit programs are:

• Commitment Control is called during commitment control operations after an API commitment resource is added to a commitment definition. The commitment control operations pass specific information to the exit program.
• Delete Journal Receiver is called when a journal receiver is to be deleted by any method. For example, the exit program will be called when the user runs the Delete Journal Receiver (DLTJRNRCV) command, or when the system attempts to delete a journal receiver because the journal has the DLTRCV(*YES) attribute specified.