xflminterface IF_RestoreStatus : public XF_RefCount
This class represents the restore status interface. It extends XF_RefCount. XFLAIM does not provide an implementation of this interface. It must be implemented by an application. It allows an application to be given status reports on the progress of a database restore operation. It is called from the IF_DbSystem::dbRestore method.
|
Method Summary |
|
RCODE |
reportProgress - Method to report the progress of the current restore operation. |
RCODE |
reportError - Method to report an error. |
RCODE |
reportOpenRflFile - Method to report when a roll-forward log file is opened. |
RCODE |
reportRflRead - Method to reading from a roll-forward log file. |
RCODE |
reportBeginTrans - Method to report a transaction begin. |
RCODE |
reportCommitTrans - Method to report a transaction commit. |
RCODE |
reportAbortTrans - Method to report a transaction abort. |
RCODE |
reportBlockChainFree - Method to report to the application the freeing of a chain of blocks in a b-tree. |
RCODE |
reportIndexSuspend - Method to report the suspending of an index. |
RCODE |
reportIndexResume - Method to report the resuming of an index. |
RCODE |
reportReduce - Method to report a database reduce operation. |
RCODE |
reportUpgrade - Method to report a database upgrade operation. |
RCODE |
reportEnableEncryption - Method to report the enabling of encryption on a database. |
RCODE |
reportWrapKey - Method to report the wrapping of the database key in a password or in the local NICI storage key. |
RCODE |
reportRollOverDbKey - Method to report the generation of a new database key. |
RCODE |
reportDocumentDone - Method to report a document done operation. |
RCODE |
reportNodeDelete - Method to report a node delete operation. |
RCODE |
reportAttributeDelete - Method to report an attribute delete operation. |
RCODE |
reportNodeChildrenDelete - Method to report the deletion of a child nodes. |
RCODE |
reportNodeCreate - Method to report the creation of a node. |
RCODE |
reportInsertBefore - Method to report the inserting of a node as a prior sibling of another node. |
RCODE |
reportNodeUpdate - Method to report the updating of a node. |
RCODE |
reportNodeSetValue - Method to report the setting of a value for a node. |
RCODE |
reportAttributeSetValue - Method to report the setting of a value on an attribute. |
RCODE |
reportNodeFlagsUpdate - Method to report the setting or unsetting of flags on a node. |
RCODE |
reportNodeSetPrefixId - Method to report the setting of a prefix id on a node or an attribute. |
RCODE |
reportNodeSetMetaValue - Method to report the setting of a meta value on a node. |
RCODE |
reportSetNextNodeId - Method to report the setting of the next node id for a collection. |
|
Method Detail |
RCODE reportProgress(
eRestoreAction * peAction,
FLMUINT64 ui64BytesToDo,
FLMUINT64 ui64BytesDone);
Method to report the progress of the current restore operation to the client.
Parameters In:
FLMUINT64 ui64BytesToDo Total bytes to restore. FLMUINT64 ui64BytesDone Total bytes restored so far.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportError(
eRestoreAction * peAction,
RCODE rcErr);
Method to report an error to the application.
Parameters In:
RCODE rcErr The error code.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportOpenRflFile(
eRestoreAction * peAction,
FLMUINT uiRflFileNum);
Method to report the opening of a roll-forward log file to the application.
Parameters In:
FLMUINT uiRflFileNum Roll-forward log file that is being opened.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportRflRead(
eRestoreAction * peAction,
FLMUINT uiRflFileNum,
FLMUINT uiBytesRead);
Method to report reading from an RFL file to the application.
Parameters In:
FLMUINT uiRflFileNum Roll-forward log file being read from. FLMUINT uiBytesRead Number of bytes that were read.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportBeginTrans(
eRestoreAction * peAction,
FLMUINT64 ui64TransId);
Method to report a transaction begin operation.
Parameters In:
FLMUINT64 ui64TransId The transaction Id
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportCommitTrans(
eRestoreAction * peAction,
FLMUINT64 ui64TransId);
Method to report a transaction commit operation.
Parameters In:
FLMUINT64 ui64TransId The transaction Id
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportAbortTrans(
eRestoreAction * peAction,
FLMUINT64 ui64TransId);
Method to report a transaction abort operation.
Parameters In:
FLMUINT64 ui64TransId The transaction Id
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportBlockChainFree(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT64 ui64MaintDocNum,
FLMUINT uiStartBlkAddr,
FLMUINT uiEndBlkAddr,
FLMUINT uiCount);
Method to report the freeing of a chain of blocks in a b-tree.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT64 ui64MaintDocNum Document Id of the document in the tracker collection that is being used to track this background delete. FLMUINT uiStartBlkAddr Starting block address of first block to be deleted. FLMUINT uiEndBlkAddr Ending block address of last block to be deleted. FLMUINT uiCount Total number of blocks to be deleted.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportIndexSuspend(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiIndexNum);
Method to report the suspending of an index.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiIndexNum Number of index to be suspended.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportIndexResume(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiIndexNum);
Method to report the resuming of an index.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiIndexNum Number of index to be resumed.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportReduce(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCount);
Method to report a reduce operation.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCount Number of blocks to be reduced.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportUpgrade(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiOldDbVersion,
FLMUINT uiNewDbVersion);
Method to report the upgrading of the database.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiOldDbVersion Database version being upgraded from. FLMUINT uiNewDbVersion Database version being upgraded to.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportEnableEncryption(
eRestoreAction * peAction,
FLMUINT64 ui64TransId);
Method to report the enabling of encryption on the database.
Parameters In:
FLMUINT64 ui64TransId Transaction Id
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportWrapKey(
eRestoreAction * peAction,
FLMUINT64 ui64TransId);
Method to report the wrapping of the database key - either in a password or in the local NICI storage key.
Parameters In:
FLMUINT64 ui64TransId Transaction Id
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportRollOverDbKey(
eRestoreAction * peAction,
FLMUINT64 ui64TransId);
Method to report the generation of a new database key.
Parameters In:
FLMUINT64 ui64TransId Transaction Id
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportDocumentDone(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64DocumentId);
Method to report a document done operation.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number of the collection holding the document. FLMUINT64 ui64DocumentId Document Id.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportNodeDelete(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64NodeId);
Method to report a node delete operation.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number. FLMUINT64 ui64NodeId Node Id of node to be deleted.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportAttributeDelete(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64ElementNodeId,
FLMUINT uiAttrNameId);
Method to report an attribute delete operation.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number. FLMUINT64 ui64NodeId Node Id of the element that has the attribute to be deleted FLMUINT uiAttrNameId Name Id of the attribute to be deleted.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportNodeChildrenDelete(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64ParentNodeId,
FLMUINT uiNameId);
Method to report the deletion of nodes that are children to another node.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number. FLMUINT64 ui64ParentNodeId Node Id of the parent node whose child nodes are to be deleted. FLMUINT uiNameId Name Id of the child nodes that are to be deleted.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportNodeCreate(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64RefNodeId,
eDomNodeType eNodeType,
FLMUINT uiNameId,
eNodeInsertLoc eLocation);
Method to report the creation of a node.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number. FLMUINT64 ui64RefNodeId Node Id of the reference node - the node that the new node is to be created relative to. eDomNodeType eNodeType Type of node that to be created. FLMUINT uiNameId Name Id of the new node to be created. eNodeInsertLoc eLocation Relative location with respect to the reference node where the new node will be created.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportInsertBefore(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64ParentNodeId,
FLMUINT64 ui64NewChildNodeId,
FLMUINT64 ui64RefChildNodeId);
Method to report the inserting of a node relative to another node.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number. FLMUINT64 ui64ParentNodeId Node Id of the parent node - the new node will be created as a child of this node. FLMUINT64 ui64NewChildNodeId Node Id of the new child node that is to be inserted. FLMUINT64 ui64RefChildNodeId Node of the reference child node that the new child node is to be inserted as a prior sibling to.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportNodeUpdate(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64NodeId);
Method to report a node update operation.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number. FLMUINT64 ui64NodeId Node Id of node that is to be updated.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportNodeSetValue(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64NodeId);
Method to report a node set value operation.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number. FLMUINT64 ui64NodeId Node Id of node whose value will be set.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportAttributeSetValue(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64ElementNodeId,
FLMUINT uiAttrNameId);
Method to report an attribute set value operation.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number. FLMUINT64 ui64ElementNodeId Node Id of element node containing the attribute whose value is to be set. FLMUINT uiAttrNameId Name Id of the attribute whose value will be set.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportNodeFlagsUpdate(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64NodeId,
FLMUINT uiFlags,
FLMBOOL bAdd);
Method to report the updating of the flags on a node.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number. FLMUINT64 ui64NodeId Node Id of node whose flags are to be updated. FLMUINT uiFlags Flags that are to be added to or removed from the node. FLMBOOL bAdd If TRUE, this indicates that the flags are to be added to the existing flags. If FALSE, the flags are to be removed from the existing flags.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportNodeSetPrefixId(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64NodeId,
FLMUINT uiAttrNameId,
FLMUINT uiPrefixId);
Method to report the setting of a node's prefix ID.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number. FLMUINT64 ui64NodeId Node Id of node whose prefix id is to be updated. FLMUINT uiAttrNameId Name Id of attribute whose prefix id is to be updated. If this is non-zero, then ui64NodeId is the element node Id of the element that contains this attribute. The prefix will be set on the attribute in that case, and not the element node. FLMUINT uiPrefixId Prefix Id that is to be set on the node or attribute.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportNodeSetMetaValue(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64NodeId,
FLMUINT64 ui64MetaValue);
Method to report the setting of a node's meta value.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number. FLMUINT64 ui64NodeId Node Id of node whose meta value is to be set. FLMUINT64 ui64MetaValue Meta value that is to be set on the node.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.
RCODE reportSetNextNodeId(
eRestoreAction * peAction,
FLMUINT64 ui64TransId,
FLMUINT uiCollectionNum,
FLMUINT64 ui64NextNodeId);
Method to report the setting of the next node id for a collection.
Parameters In:
FLMUINT64 ui64TransId Transaction Id FLMUINT uiCollectionNum Collection number. FLMUINT64 ui64NextNodeId Next node id value that will be set for the collection.
Parameters Out:
eRestoreAction * peAction The action to take after reporting.