com.sleepycat.je.log

Class LogParams

java.lang.Object

com.sleepycat.je.log.LogParams

public class LogParams
extends Object

Parameters passed when an item is logged. This class is used as a simple struct for passing multiple params, and does not need getters and setters.

Field Summary

Fields

Modifier and Type	Field and Description
long	auxOldLsn Another LSN to be counted as obsolete in the LogContext.nodeDb database, or NULL_LSN.
boolean	backgroundIO Whether the write should be counted as background IO when throttling of background IO is configured.
LogEntry	entry Object to be marshaled and logged.
boolean	flushRequired Whether the log buffer(s) must be written to the file system.
boolean	forceNewLogFile Whether a new log file must be created for containing the logged item(s).
boolean	fsyncRequired Whether an fsync must be performed after writing the item(s) to the log.
DatabaseImpl	nodeDb Database of the node(s), or null if entry is not a node.
boolean	obsoleteDupsAllowed Whether it is possible that the previous version of this log entry is already marked obsolete.
Collection<WriteLockInfo>	obsoleteWriteLockInfo Set of obsolete LSNs which are counted when logging a commit entry.
long	oldLsn The previous version of the node to be counted as obsolete, or NULL_LSN if the entry is not a node or has no old LSN.
int	oldSize For LNs, oldSize should be set along with oldLsn before logging.
PackedObsoleteInfo	packedObsoleteInfo Sequence of packed obsolete info which is counted when logging a non-provisional IN.
Provisional	provisional Whether the logged entry should be processed during recovery.
ReplicationContext	repContext Whether the logged entry should be replicated.

Constructor Summary

Constructors

Constructor and Description
LogParams()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nodeDb

public DatabaseImpl nodeDb

Database of the node(s), or null if entry is not a node. Used for per- database utilization tracking.

flushRequired

public boolean flushRequired

Whether the log buffer(s) must be written to the file system.

forceNewLogFile

public boolean forceNewLogFile

Whether a new log file must be created for containing the logged item(s).

fsyncRequired

public boolean fsyncRequired

Whether an fsync must be performed after writing the item(s) to the log.

backgroundIO

public boolean backgroundIO

Whether the write should be counted as background IO when throttling of background IO is configured.

obsoleteWriteLockInfo

public Collection<WriteLockInfo> obsoleteWriteLockInfo

Set of obsolete LSNs which are counted when logging a commit entry. This information includes the DatabaseImpl for each LSN, and the nodeDb field does not apply.

packedObsoleteInfo

public PackedObsoleteInfo packedObsoleteInfo

Sequence of packed obsolete info which is counted when logging a non-provisional IN. This information is for a single database, the nodeDb. The nodeDb is passed as a parameter to countObosoleteNode when adding this information to the global tracker.

obsoleteDupsAllowed

public boolean obsoleteDupsAllowed

Whether it is possible that the previous version of this log entry is already marked obsolete. In general, the latest version of any IN or LN is alive, so that logging a new version requires making the last version obsolete. Utilization tracking generally asserts that this last version is not already obsolete. When partial rollbacks are used, some of the original intermediate versions may have been pruned away, leaving a current previous that was already marked obsolete. For example, a transaction might have done: LNA (version 1) LNA (version 2) -- now version 1 is obsolete -- if we do a partial rollback to version1, verison 2 is removed -- we start retransmitting LNA (version 2) When we log this LNA/version2, this previous LNA (version1) is already obsolete. obsoleteDupsAllowed supports this case.

entry

public LogEntry entry

Object to be marshaled and logged.

oldLsn

public long oldLsn

The previous version of the node to be counted as obsolete, or NULL_LSN if the entry is not a node or has no old LSN.

oldSize

public int oldSize

For LNs, oldSize should be set along with oldLsn before logging. It should normally be obtained by calling BIN.getLastLoggedSize.

auxOldLsn

public long auxOldLsn

Another LSN to be counted as obsolete in the LogContext.nodeDb database, or NULL_LSN. Used for obsolete BIN-deltas.

provisional

public Provisional provisional

Whether the logged entry should be processed during recovery.

repContext

public ReplicationContext repContext

Whether the logged entry should be replicated.

Constructor Detail

LogParams

public LogParams()