LNLogEntry (starrocks-bdb-je 18.3.17 API)

java.lang.Object
- com.sleepycat.je.log.entry.LNLogEntry<T>

All Implemented Interfaces:

LogEntry, ReplicableLogEntry, Cloneable

Direct Known Subclasses:

DeletedDupLNLogEntry, NameLNLogEntry
```
public class LNLogEntry<T extends LN>
extends Object
```
An LNLogEntry is the in-memory image of an LN logrec describing a write op (insertion, update, or deletion) performed by a locker T on a record R. T always locks R in exclusive (WRITE or WRITE_RANGE) mode before performing any write ops on it, and it retains its exclusive lock on R until it terminates (commits or aborts). (Non-transactional lockers can be viewed as "simple" transactions that perform at most one write op, and then immediately commit). On disk, an LN logrec contains : 1 <= version <= 5 LN data databaseid key abortLsn -- if transactional abortKnownDeleted -- if transactional txn id -- if transactional prev LSN of same txn -- if transactional 6 <= versions <= 10 : databaseid abortLsn -- if transactional abortKnownDeleted -- if transactional txn id -- if transactional prev LSN of same txn -- if transactional data key 11 == version : databaseid abortLsn -- if transactional 1-byte flags abortKnownDeleted embeddedLN haveAbortKey haveAbortData haveAbortVLSN txn id -- if transactional prev LSN of same txn -- if transactional abort key -- if haveAbortKey abort data -- if haveAbortData abort vlsn -- if haveAbortVLSN data key In forReplication mode, these flags and fields are omitted: embeddedLN, haveAbortKey, haveAbortData, haveAbortVLSN, abort key, abort data, abort vlsn 12 <= version : 1-byte flags abortKnownDeleted embeddedLN haveAbortKey haveAbortData haveAbortVLSN haveAbortLSN haveAbortExpiration haveExpiration databaseid abortLsn -- if transactional and haveAbortLSN txn id -- if transactional prev LSN of same txn -- if transactional abort key -- if haveAbortKey abort data -- if haveAbortData abort vlsn -- if haveAbortVLSN abort expiration -- if haveAbortExpiration expiration -- if haveExpiration data key In forReplication mode, these flags and fields are omitted: abortKnownDeleted, embeddedLN, haveAbortKey, haveAbortData, haveAbortVLSN, abort key, abort data, abort vlsn, haveAbortLSN, abortLsn, haveAbortExpiration, abort expiration 16 <= version : 1-byte flags abortKnownDeleted embeddedLN haveAbortKey haveAbortData haveAbortVLSN haveAbortLSN haveAbortExpiration haveExpiration 1-byte flags2 havePriorSize havePriorFile databaseid abortLsn -- if transactional and haveAbortLSN txn id -- if transactional prev LSN of same txn -- if transactional abort key -- if haveAbortKey abort data -- if haveAbortData abort vlsn -- if haveAbortVLSN abort expiration -- if haveAbortExpiration expiration -- if haveExpiration priorSize -- if havePriorSize priorFile -- if havePriorFile data key In forReplication mode, these flags and fields are omitted: abortKnownDeleted, embeddedLN, haveAbortKey, haveAbortData, haveAbortVLSN, abort key, abort data, abort vlsn, haveAbortLSN, abortLsn, haveAbortExpiration, abort expiration, havePriorSize, priorSize, havePriorFile, priorFile NOTE: LNLogEntry is sub-classed by NameLNLogEntry, which adds some extra fields after the record key.

Field Summary

Fields
Modifier and Type Field and Description

static int MIN_LOG_SIZE
Used for computing the minimum log space used by an LNLogEntry.

Fields
Modifier and Type	Field and Description
`static int`	`MIN_LOG_SIZE` Used for computing the minimum log space used by an LNLogEntry.

Constructor Summary

Constructors
Constructor and Description
`LNLogEntry(LogEntryType entryType, DatabaseId dbId, Txn txn, long abortLsn, boolean abortKD, byte[] abortKey, byte[] abortData, long abortVLSN, int abortExpiration, boolean abortExpirationInHours, byte[] key, T ln, boolean embeddedLN, int expiration, boolean expirationInHours, int priorSize, long priorLsn)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LogEntry`	`clone()`
`boolean`	`countPriorVersionObsolete()` Returns true if recovery should count the prior version obsolete using `getPriorVersionSize()` and `getPriorVersionLsn()` ()}.
`static <T extends LN> LNLogEntry<T>`	`create(Class<T> cls)` Creates an instance to read an entry.
`StringBuilder`	`dumpEntry(StringBuilder sb, boolean verbose)` Print out the contents of an entry.
`void`	`dumpRep(StringBuilder sb)` Dump the contents of the log entry that are interesting for replication.
`byte[]`	`getAbortData()`
`int`	`getAbortExpiration()`
`byte[]`	`getAbortKey()`
`boolean`	`getAbortKnownDeleted()`
`long`	`getAbortLsn()`
`long`	`getAbortVLSN()`
`byte[]`	`getData()`
`DatabaseId`	`getDbId()`
`byte[]`	`getEmbeddedData()`
`Collection<VersionedWriteLoggable>`	`getEmbeddedLoggables()` Returns all possible `VersionedWriteLoggable` objects that may be embedded in the binary data of this log entry.
`int`	`getExpiration()`
`byte[]`	`getKey()`
`int`	`getLastFormatChange()` Returns the log version of the most recent format change for this log entry.
`LN`	`getLN()`
`Class<T>`	`getLogClass()` Returns the class of the contained loggable item or items, or null if the instance was created to write an entry.
`LogEntryType`	`getLogType()`
`LN`	`getMainItem()`
`long`	`getPriorVersionLsn()` Returns the LSN of the prior version of this LN, for purposes of obsolete counting -- the LSN offset may be incorrect, but the LSN file is correct.
`int`	`getPriorVersionSize()` Returns the log size of the prior version of this LN.
`Object`	`getResolvedItem(DatabaseImpl dbImpl)` By default, this log entry is complete and does not require fetching additional entries.
`int`	`getSize()`
`int`	`getSize(int logVersion, boolean forReplication)` Returns the number of bytes needed to store this entry in the format for the specified log version.
`long`	`getTransactionId()`
`Long`	`getTxnId()`
`int`	`getUnconvertedDataLength()` This method is only used when the converted length is not needed, for example by StatsFileReader.
`int`	`getUnconvertedKeyLength()` This method is only used when the converted length is not needed, for example by StatsFileReader.
`void`	`getUserKeyData(DatabaseEntry keyParam, DatabaseEntry dataParam)` Translates two-part keys in duplicate DBs back to the original user operation params.
`Txn`	`getUserTxn()`
`boolean`	`hasReplicationFormat()` Returns whether this format has a variant that is optimized for replication.
`boolean`	`isAbortExpirationInHours()`
`boolean`	`isDeleted()` Returns whether this is a deleted LN.
`boolean`	`isEmbeddedLN()`
`boolean`	`isExpirationInHours()`
`boolean`	`isImmediatelyObsolete(DatabaseImpl dbImpl)` Returns true if this item should be counted as obsolete when logged.
`boolean`	`isReplicationFormatWorthwhile(ByteBuffer logBuffer, int srcVersion, int destVersion)` Returns whether it is worthwhile to materialize and then re-serialize a log entry in a format optimized for replication.
`boolean`	`logicalEquals(LogEntry other)`
`void`	`postFetchInit(boolean isDupDb)` Converts the key/data for old format LNs in a duplicates DB.
`void`	`postFetchInit(DatabaseImpl dbImpl)`
`void`	`postLogWork(LogEntryHeader header, long justLoggedLsn, VLSN vlsn)` For LN entries, we need to record the latest LSN for that node with the owning transaction, within the protection of the log latch.
`void`	`readEntry(EnvironmentImpl envImpl, LogEntryHeader header, ByteBuffer entryBuffer)` Read in a log entry.
`void`	`setLogType(LogEntryType entryType)` Inform a BaseEntry instance of its corresponding LogEntryType.
`String`	`toString()`
`void`	`writeEntry(ByteBuffer destBuffer)` Serialize this object into the buffer.
`void`	`writeEntry(ByteBuffer destBuffer, int logVersion, boolean forReplication)` Serializes this object into the specified buffer in the format for the the specified log version.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sleepycat.je.log.entry.LogEntry
clone, getLogType, getResolvedItem, setLogType

- Field Detail
  - MIN_LOG_SIZE
```
public static final int MIN_LOG_SIZE
```
    Used for computing the minimum log space used by an LNLogEntry.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LNLogEntry
```
public LNLogEntry(LogEntryType entryType,
                  DatabaseId dbId,
                  Txn txn,
                  long abortLsn,
                  boolean abortKD,
                  byte[] abortKey,
                  byte[] abortData,
                  long abortVLSN,
                  int abortExpiration,
                  boolean abortExpirationInHours,
                  byte[] key,
                  T ln,
                  boolean embeddedLN,
                  int expiration,
                  boolean expirationInHours,
                  int priorSize,
                  long priorLsn)
```
- Method Detail
  - create
```
public static <T extends LN> LNLogEntry<T> create(Class<T> cls)
```
    Creates an instance to read an entry.
    
    Type Parameters:
    
    T - the type of the contained LN
    
    Parameters:
    
    cls - the class of the contained LN
    
    Returns:
    
    the log entry
  - readEntry
```
public void readEntry(EnvironmentImpl envImpl,
                      LogEntryHeader header,
                      ByteBuffer entryBuffer)
```
    Description copied from interface: LogEntry
    
    Read in a log entry.
  - hasReplicationFormat
```
public boolean hasReplicationFormat()
```
    Description copied from interface: ReplicableLogEntry
    
    Returns whether this format has a variant that is optimized for replication.
    
    Specified by:
    
    hasReplicationFormat in interface ReplicableLogEntry
  - isReplicationFormatWorthwhile
```
public boolean isReplicationFormatWorthwhile(ByteBuffer logBuffer,
                                             int srcVersion,
                                             int destVersion)
```
    Description copied from interface: ReplicableLogEntry
    
    Returns whether it is worthwhile to materialize and then re-serialize a log entry in a format optimized for replication. Implementations should attempt to check efficiently, without instantiating the log entry object. Some implementations will simply return false.
    WARNING: The logBuffer position must not be changed by this method.
    WARNING: The shared LogEntry object is used for calling this method, and this method must not change any of the fields in the object.
    
    Specified by:
    
    isReplicationFormatWorthwhile in interface ReplicableLogEntry
    
    Parameters:
    
    logBuffer - contains the entry that would be re-serialized.
    
    srcVersion - the log version of entry in logBuffer.
    
    destVersion - the version that would be used for re-serialization.
  - dumpEntry
```
public StringBuilder dumpEntry(StringBuilder sb,
                               boolean verbose)
```
    Description copied from interface: LogEntry
    
    Print out the contents of an entry.
  - dumpRep
```
public void dumpRep(StringBuilder sb)
```
    Description copied from interface: LogEntry
    
    Dump the contents of the log entry that are interesting for replication.
  - getMainItem
```
public LN getMainItem()
```
    Returns:
    
    the first item of the log entry
  - getTransactionId
```
public long getTransactionId()
```
    Returns:
    
    return the transaction id if this log entry is transactional, 0 otherwise.
  - getLastFormatChange
```
public int getLastFormatChange()
```
    Description copied from interface: ReplicableLogEntry
    
    Returns the log version of the most recent format change for this log entry.
    
    Returns:
    
    the log version of the most recent format change
  - getEmbeddedLoggables
```
public Collection<VersionedWriteLoggable> getEmbeddedLoggables()
```
    Description copied from interface: ReplicableLogEntry
    
    Returns all possible VersionedWriteLoggable objects that may be embedded in the binary data of this log entry.
    This is used by tests to ensure that for each X:Y pair, where X is a ReplicableLogEntry and Y is a VersionedWriteLoggable, and X embeds Y either directly or indirectly, X.getLastFormatChange is greater than or equal to Y.getLastFormatChange.
    Each ReplicableLogEntry and VersionedWriteLoggable class typically has a LAST_FORMAT_CHANGE constant that is returned by its getLastFormatChange method. When bumping this constant for an object X embedded by an log entry Y, Y.LAST_FORMAT_CHANGE should also be set to the minimum of its current value and X.LAST_FORMAT_CHANGE.
    Enforcing this rule in a general way is made possible by the getEmbeddedLoggables method of each ReplicableLogEntry and VersionedWriteLoggable. Note that this method is not intended to be called outside of tests.
  - getSize
```
public int getSize(int logVersion,
                   boolean forReplication)
```
    Description copied from interface: ReplicableLogEntry
    
    Returns the number of bytes needed to store this entry in the format for the specified log version. Earlier log versions only need to be supported for log entries with format changes made in LogEntryType.LOG_VERSION_REPLICATE_OLDER or greater.
    
    Parameters:
    
    logVersion - the log version
    
    forReplication - whether the entry will be sent over the wire, and not written to the log.
    
    Returns:
    
    the number of bytes to store this entry for the log version
  - writeEntry
```
public void writeEntry(ByteBuffer destBuffer,
                       int logVersion,
                       boolean forReplication)
```
    Description copied from interface: ReplicableLogEntry
    
    Serializes this object into the specified buffer in the format for the the specified log version. Earlier log versions only need to be supported for log entries with format changes made in LogEntryType.LOG_VERSION_REPLICATE_OLDER or greater.
    
    Parameters:
    
    destBuffer - the destination buffer
    
    logVersion - the log version
    
    forReplication - whether the entry will be sent over the wire, and not written to the log.
  - isImmediatelyObsolete
```
public boolean isImmediatelyObsolete(DatabaseImpl dbImpl)
```
    Description copied from interface: LogEntry
    
    Returns true if this item should be counted as obsolete when logged.
    
    Specified by:
    
    isImmediatelyObsolete in interface LogEntry
  - isDeleted
```
public boolean isDeleted()
```
    Description copied from interface: LogEntry
    
    Returns whether this is a deleted LN.
    
    Specified by:
    
    isDeleted in interface LogEntry
  - postLogWork
```
public void postLogWork(LogEntryHeader header,
                        long justLoggedLsn,
                        VLSN vlsn)
```
    For LN entries, we need to record the latest LSN for that node with the owning transaction, within the protection of the log latch. This is a callback for the log manager to do that recording.
    
    Specified by:
    
    postLogWork in interface LogEntry
  - postFetchInit
```
public void postFetchInit(DatabaseImpl dbImpl)
```
  - postFetchInit
```
public void postFetchInit(boolean isDupDb)
```
    Converts the key/data for old format LNs in a duplicates DB. This method MUST be called before calling any of the following methods: getLN getKey getUserKeyData TODO: This method is not called by the HA feeder when materializing entries. This is OK because entries with log version 7 and below are never materialized. But we may want to rename this method to make it clear that it only is, and only must be, called for the log versions < 8.
  - getUserKeyData
```
public void getUserKeyData(DatabaseEntry keyParam,
                           DatabaseEntry dataParam)
```
    Translates two-part keys in duplicate DBs back to the original user operation params. postFetchInit must be called before calling this method.
  - isEmbeddedLN
```
public boolean isEmbeddedLN()
```
  - getLN
```
public LN getLN()
```
  - getKey
```
public byte[] getKey()
```
  - getData
```
public byte[] getData()
```
  - getEmbeddedData
```
public byte[] getEmbeddedData()
```
  - getExpiration
```
public int getExpiration()
```
  - isExpirationInHours
```
public boolean isExpirationInHours()
```
  - getUnconvertedDataLength
```
public int getUnconvertedDataLength()
```
    This method is only used when the converted length is not needed, for example by StatsFileReader.
  - getUnconvertedKeyLength
```
public int getUnconvertedKeyLength()
```
    This method is only used when the converted length is not needed, for example by StatsFileReader.
  - getDbId
```
public DatabaseId getDbId()
```
    Returns:
    
    the ID of the database containing this entry, or null if this entry type is not part of a database.
  - getAbortLsn
```
public long getAbortLsn()
```
  - getAbortKnownDeleted
```
public boolean getAbortKnownDeleted()
```
  - getAbortKey
```
public byte[] getAbortKey()
```
  - getAbortData
```
public byte[] getAbortData()
```
  - getAbortVLSN
```
public long getAbortVLSN()
```
  - countPriorVersionObsolete
```
public boolean countPriorVersionObsolete()
```
    Returns true if recovery should count the prior version obsolete using getPriorVersionSize() and getPriorVersionLsn() ()}. True is returned if there is a prior version of this LN that is not immediately obsolete.
  - getPriorVersionSize
```
public int getPriorVersionSize()
```
    Returns the log size of the prior version of this LN. Must not be called if countPriorVersionObsolete() returns false.
  - getPriorVersionLsn
```
public long getPriorVersionLsn()
```
    Returns the LSN of the prior version of this LN, for purposes of obsolete counting -- the LSN offset may be incorrect, but the LSN file is correct. If the prior version LSN is the abortLsn, then the abortLsn (including its true offset) is returned by this method. Must not be called if countPriorVersionObsolete() returns false.
  - getAbortExpiration
```
public int getAbortExpiration()
```
  - isAbortExpirationInHours
```
public boolean isAbortExpirationInHours()
```
  - getTxnId
```
public Long getTxnId()
```
  - getUserTxn
```
public Txn getUserTxn()
```
  - logicalEquals
```
public boolean logicalEquals(LogEntry other)
```
    Returns:
    
    true if these two log entries are logically the same. Used for replication.
  - writeEntry
```
public void writeEntry(ByteBuffer destBuffer)
```
    Description copied from interface: LogEntry
    
    Serialize this object into the buffer.
    
    Specified by:
    
    writeEntry in interface LogEntry
    
    Parameters:
    
    destBuffer - is the destination buffer
  - getSize
```
public int getSize()
```
    Specified by:
    
    getSize in interface LogEntry
    
    Returns:
    
    size of byte buffer needed to store this entry.
  - getLogClass
```
public Class<T> getLogClass()
```
    Returns the class of the contained loggable item or items, or null if the instance was created to write an entry.
    
    Returns:
    
    the loggable class or null
  - setLogType
```
public void setLogType(LogEntryType entryType)
```
    Inform a BaseEntry instance of its corresponding LogEntryType.
    
    Specified by:
    
    setLogType in interface LogEntry
  - getLogType
```
public LogEntryType getLogType()
```
    Specified by:
    
    getLogType in interface LogEntry
    
    Returns:
    
    the type of log entry
  - getResolvedItem
```
public Object getResolvedItem(DatabaseImpl dbImpl)
```
    By default, this log entry is complete and does not require fetching additional entries. This method is overridden by BINDeltaLogEntry.
    
    Specified by:
    
    getResolvedItem in interface LogEntry
  - clone
```
public LogEntry clone()
```
    Specified by:
    
    clone in interface LogEntry
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a shallow clone.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class LNLogEntry<T extends LN>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.sleepycat.je.log.entry.LogEntry

Field Detail

MIN_LOG_SIZE

Constructor Detail

LNLogEntry

Method Detail

create

readEntry

hasReplicationFormat

isReplicationFormatWorthwhile

dumpEntry

dumpRep

getMainItem

getTransactionId

getLastFormatChange

getEmbeddedLoggables

getSize

writeEntry

isImmediatelyObsolete

isDeleted

postLogWork

postFetchInit

postFetchInit

getUserKeyData

isEmbeddedLN

getLN

getKey

getData

getEmbeddedData

getExpiration

isExpirationInHours

getUnconvertedDataLength

getUnconvertedKeyLength

getDbId

getAbortLsn

getAbortKnownDeleted

getAbortKey

getAbortData

getAbortVLSN

countPriorVersionObsolete

getPriorVersionSize

getPriorVersionLsn

getAbortExpiration

isAbortExpirationInHours

getTxnId

getUserTxn

logicalEquals

writeEntry

getSize

getLogClass

setLogType

getLogType

getResolvedItem

clone

toString