INLogEntry (starrocks-bdb-je 18.3.17 API)

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

All Implemented Interfaces:: INContainingEntry, LogEntry, Cloneable

Direct Known Subclasses:: BINDeltaLogEntry

public class INLogEntry<T extends IN>
extends Object
implements LogEntry, INContainingEntry

- INLogEntry is used to read/write full-version IN logrecs. - BINDeltaLogEntry subclasses INLogEntry and is used to read/write BIN-delta logrecs for log versions 9 or later. - OldBINDeltaLogEntry is used to read/write BIN-delta logrecs for log versions earlier than 9. OldBINDeltaLogEntry is not a subclass of INLogEntry. On disk, a full IN logrec contains:

 
 (3 <= version < 6)
        IN
        database id
        prevFullLsn  -- in version 2

 (6 <= version < 8)
        database id
        prevFullLsn
        IN

 (8 <= version)
        database id
        prevFullLsn
        prevDeltaLsn
        IN

On disk, a BIN-delta logrec written via the BINDeltaLogEntry contains:

 
 (version == 9)
        database id
        prevFullLsn  -- always NULL
        prevDeltaLsn
        BIN (dirty slots only)
        prevFullLsn

 (version >= 10)
        database id
        prevFullLsn
        prevDeltaLsn
        BIN (dirty slots only and including the new fullBinNEntries and
             fullBinMaxEntries fields)

Constructor Summary

Constructors
Constructor and Description
`INLogEntry(ByteBuffer bytes, long lastFullLsn, long lastDeltaLsn, LogEntryType logEntryType, IN parent)` Used to write a pre-serialized log entry.
`INLogEntry(T in)` Construct an INLogEntry for writing to the log.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LogEntry`	`clone()`
`static <T extends IN> INLogEntry<T>`	`create(Class<T> INClass)` Construct a log entry for reading.
`StringBuilder`	`dumpEntry(StringBuilder sb, boolean verbose)` Print out the contents of an entry.
`void`	`dumpRep(StringBuilder sb)` Never replicated.
`BIN`	`getBINWithExpiration()` Returns the main item BIN if it has any slots with expiration times.
`DatabaseId`	`getDbId()`
`IN`	`getIN(DatabaseImpl dbImpl)` Currently used by recovery only.
`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()`
`T`	`getMainItem()`
`long`	`getNodeId()`
`long`	`getPrevDeltaLsn()`
`long`	`getPrevFullLsn()`
`Object`	`getResolvedItem(DatabaseImpl dbImpl)` By default, this log entry is complete and does not require fetching additional entries.
`int`	`getSize()`
`long`	`getTransactionId()`
`boolean`	`isBINDelta()`
`boolean`	`isDeleted()` Returns whether this is a deleted LN.
`boolean`	`isImmediatelyObsolete(DatabaseImpl dbImpl)` Returns true if this item should be counted as obsolete when logged.
`boolean`	`isPreSerialized()`
`boolean`	`logicalEquals(LogEntry other)` INs from two different environments are never considered equal, because they have lsns that are environment-specific.
`void`	`postFetchInit(DatabaseImpl dbImpl)`
`void`	`postLogWork(LogEntryHeader header, long justLoggedLsn, VLSN vlsn)` Do any processing we need to do after logging, while under the logging 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.

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, isDeleted, isImmediatelyObsolete, postLogWork, setLogType

- Constructor Detail
  - INLogEntry
```
public INLogEntry(T in)
```
    Construct an INLogEntry for writing to the log.
  - INLogEntry
```
public INLogEntry(ByteBuffer bytes,
                  long lastFullLsn,
                  long lastDeltaLsn,
                  LogEntryType logEntryType,
                  IN parent)
```
    Used to write a pre-serialized log entry.
- Method Detail
  - create
```
public static <T extends IN> INLogEntry<T> create(Class<T> INClass)
```
    Construct a log entry for reading.
  - isBINDelta
```
public boolean isBINDelta()
```
    Specified by:
    
    isBINDelta in interface INContainingEntry
  - getDbId
```
public DatabaseId getDbId()
```
    Specified by:
    
    getDbId in interface INContainingEntry
    
    Specified by:
    
    getDbId in interface LogEntry
    
    Returns:
    
    the ID of the database containing this entry, or null if this entry type is not part of a database.
  - getPrevFullLsn
```
public long getPrevFullLsn()
```
    Specified by:
    
    getPrevFullLsn in interface INContainingEntry
    
    Returns:
    
    the LSN of the prior full version of this node, or NULL_LSN if no prior full version. Used for counting the prior version as obsolete. If the offset of the LSN is zero, only the file number is known because we read a version 1 log entry.
  - getPrevDeltaLsn
```
public long getPrevDeltaLsn()
```
    Specified by:
    
    getPrevDeltaLsn in interface INContainingEntry
    
    Returns:
    
    the LSN of the prior delta version of this node, or NULL_LSN if the prior version is a full version. Used for counting the prior version as obsolete. If the offset of the LSN is zero, only the file number is known because we read a version 1 log entry.
  - getMainItem
```
public T getMainItem()
```
    Specified by:
    
    getMainItem in interface LogEntry
    
    Returns:
    
    the first item of the log entry
  - getIN
```
public IN getIN(DatabaseImpl dbImpl)
```
    Description copied from interface: INContainingEntry
    
    Currently used by recovery only. For an OldBINDeltaEntry it merges the delta with the last full BIN and returns the new full BIN. For a new BINDeltaLogEntry, it just returns the delta. And for an INLogEntry it just returns the (full) IN.
    
    Specified by:
    
    getIN in interface INContainingEntry
  - getNodeId
```
public long getNodeId()
```
  - isPreSerialized
```
public boolean isPreSerialized()
```
  - getBINWithExpiration
```
public BIN getBINWithExpiration()
```
    Returns the main item BIN if it has any slots with expiration times. Must only be called if this entry's type is BIN or BIN_DELTA. This method is called for expiration tracking because getMainItem and getIN cannot be called on an INLogEntry logging parameter, since it may be in pre-serialized form when it appears in the off-heap cache.
  - readEntry
```
public void readEntry(EnvironmentImpl envImpl,
                      LogEntryHeader header,
                      ByteBuffer entryBuffer)
```
    Description copied from interface: LogEntry
    
    Read in a log entry.
    
    Specified by:
    
    readEntry in interface LogEntry
  - getSize
```
public int getSize()
```
    Specified by:
    
    getSize in interface LogEntry
    
    Returns:
    
    size of byte buffer needed to store this entry.
  - 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
  - getTransactionId
```
public long getTransactionId()
```
    Specified by:
    
    getTransactionId in interface LogEntry
    
    Returns:
    
    return the transaction id if this log entry is transactional, 0 otherwise.
  - logicalEquals
```
public boolean logicalEquals(LogEntry other)
```
    INs from two different environments are never considered equal, because they have lsns that are environment-specific.
    
    Specified by:
    
    logicalEquals in interface LogEntry
    
    Returns:
    
    true if these two log entries are logically the same. Used for replication.
  - dumpEntry
```
public StringBuilder dumpEntry(StringBuilder sb,
                               boolean verbose)
```
    Description copied from interface: LogEntry
    
    Print out the contents of an entry.
    
    Specified by:
    
    dumpEntry in interface LogEntry
  - dumpRep
```
public void dumpRep(StringBuilder sb)
```
    Never replicated.
    
    Specified by:
    
    dumpRep in interface LogEntry
  - 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
  - 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)
```
    Do any processing we need to do after logging, while under the logging latch.
    
    Specified by:
    
    postLogWork in interface LogEntry
    
    Throws:
    
    DatabaseException - from subclasses.
  - postFetchInit
```
public void postFetchInit(DatabaseImpl dbImpl)
```
  - 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 INLogEntry<T extends IN>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

INLogEntry

INLogEntry

Method Detail

create

isBINDelta

getDbId

getPrevFullLsn

getPrevDeltaLsn

getMainItem

getIN

getNodeId

isPreSerialized

getBINWithExpiration

readEntry

getSize

writeEntry

getTransactionId

logicalEquals

dumpEntry

dumpRep

getLogClass

setLogType

getLogType

getResolvedItem

isImmediatelyObsolete

isDeleted

postLogWork

postFetchInit

clone

toString