%SYS.Journal.File
persistent class %SYS.Journal.File extends %Library.Persistent
SQL Table Name: %SYS_Journal.File
Journal file related APIProperty Inventory
Method Inventory
- CheckIntegrity()
- ClusterStartTime0Get()
- ClusterStartTimeGet()
- EndGet()
- FirstRecordGet()
- GetGUID()
- GetMaxSize()
- GetMirrorGUID()
- GetNext()
- GetPrev()
- GetReason()
- GetRecordAfter()
- GetRecordAt()
- GetSystemGUID()
- IsValidJournal()
- LastEncrypted()
- LastMarkerGet()
- LastRecordGet()
- Open()
- Purge()
- PurgeAll()
- PurgeOne()
- RequiredForClusterRecovery()
- RequiredForRecovery()
- RequiredForRollback()
- Restore()
- RestorePIDList()
- Summary()
- TranslateReason()
- Use()
Parameters
Properties
Methods
jrnlist can be either a file path or, if passed by reference, a number-indexed array of file paths, e.g.:
jrnlist(1)=path1, jrnlist(2)=path2, etc.
The file paths in the array should be in chronicle order, that is, path1 and path2 are assumed to have been created consecutively in the example above. If it is determined that the files in the given array do not meet that criterion, a single value 0 is returned (for "Invalid Parameter") and the top node of the array is set to the number index of the offending path.
Detail: If 1, scan each given journal file forward to locate the last record and verify it is the last record to be expected.
If SrcDirs is set to 1 and passed by reference, the database directories used in the specified journal file(s) will be stored in SrcDirs array upon return.
InSession: whether to limit the search within a journal session (default=NO)
This is used to help people identify which system created the journal file.
Since this comes from the config file, it's possible that this can change over time but its not supposed to.
Parameters:
- NDaysOld: journal files must be at least this # of days old to be purged
- NBackupsOld: journal files must be older than this # of successive successful backups to be purged
Note: It is the completion date, rather than the creation date, of a file that must meet the date criterion if specified. Thus, a file may not be OK to purge even though the date in its name appears to meet the date criterion.
Warning: Post-backup journal files are not necessarily preserved.
Warning: This method does NOT check for open transactions before deleting the journal file.
FilePath: the full path of the journal file to purge
PurgeTimeH: Time of purging in $H format
LogOnly: if 1, skip purging and log the purged file only. Default = 0
FileName = # of nodes where journal recovery is required
FileName(csn) = the path of the oldest journal file on node <#csn>
If SkipSelf = 1, skip the node where the method is called (local node is covered by RequiredForRecovery()
FileName="" if journaling is disabled, meaning that none is required, as transactions cannot be rolled forward or backward from a pre-disabling file
FileName: the oldest file containing open transactions or current journal file
FileCount: the file counter value assigned to the file
FileCount: the file counter value assigned to the file
Queries
By default, files are listed in reverse order of time, unless TimeOrder = 1
If FileName is specified, files are listed until FileName is reached (depend on TimeOrder)
If CSN is given, only files belong to the node are listed.
Indexes
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %AddToSyncSet()
- %BuildIndices()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDetermineClass()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()