com.orientechnologies.orient.core.storage.impl.local.paginated.wal

Class ODiskWriteAheadLog

java.lang.Object

com.orientechnologies.orient.core.storage.impl.local.paginated.wal.OAbstractWriteAheadLog

com.orientechnologies.orient.core.storage.impl.local.paginated.wal.ODiskWriteAheadLog

All Implemented Interfaces:

OWriteAheadLog

public class ODiskWriteAheadLog
extends OAbstractWriteAheadLog

Since:

25.04.13

Author:

Andrey Lomakin

Field Summary

Fields

Modifier and Type	Field and Description
static String	MASTER_RECORD_EXTENSION
static String	WAL_SEGMENT_EXTENSION

Fields inherited from class com.orientechnologies.orient.core.storage.impl.local.paginated.wal.OAbstractWriteAheadLog

closed, lastCheckpoint, syncObject

Constructor Summary

Constructors

Constructor and Description
ODiskWriteAheadLog(int maxPagesCacheSize, int commitDelay, long maxSegmentSize, String walPath, boolean filterWALFiles, OLocalPaginatedStorage storage, int fileTTL)
ODiskWriteAheadLog(OLocalPaginatedStorage storage)

Method Summary

Modifier and Type	Method and Description
long	activeSegment()
void	addCutTillLimit(OLogSequenceNumber lsn) Adds LSN after which WAL log should be preserved.
void	addFullCheckpointListener(OFullCheckpointRequestListener listener)
void	addLowDiskSpaceListener(OLowDiskSpaceListener listener)
boolean	appendNewSegment() Adds new segment so all sequent log entries will be added to this new segment.
OLogSequenceNumber	begin()
void	checkFreeSpace()
void	close()
void	close(boolean flush)
boolean	cutTill(OLogSequenceNumber lsn) Cut WAL content till passed in value of LSN at maximum in many cases smaller portion of WAL may be cut.
void	delete()
void	delete(boolean flush)
OLogSequenceNumber	end()
void	flush()
long	getCacheOverflowCount()
OLogSequenceNumber	getFlushedLsn()
OLogSequenceNumber	getOldestTxLsn()
long	getPreferredSegmentCount()
List<String>	getWalFiles()
String	getWMRFile()
OLogSequenceNumber	log(OWALRecord record)
OLogSequenceNumber	logAtomicOperationEndRecord(OOperationUnitId operationUnitId, boolean rollback, OLogSequenceNumber startLsn, Map<String,OAtomicOperationMetadata<?>> atomicOperationMetadata)
OLogSequenceNumber	logAtomicOperationStartRecord(boolean isRollbackSupported, OOperationUnitId unitId)
void	moveLsnAfter(OLogSequenceNumber lsn) Next LSN generated by WAL will be bigger than passed in value.
OLogSequenceNumber	next(OLogSequenceNumber lsn)
File[]	nonActiveSegments(long fromSegment)
OWALRecord	read(OLogSequenceNumber lsn)
void	removeCutTillLimit(OLogSequenceNumber lsn) Removes LSN after which WAL log should be preserved.
void	removeFullCheckpointListener(OFullCheckpointRequestListener listener)
void	removeLowDiskSpaceListener(OLowDiskSpaceListener listener)
long	size()
void	truncate()

Methods inherited from class com.orientechnologies.orient.core.storage.impl.local.paginated.wal.OAbstractWriteAheadLog

checkForClose, getLastCheckpoint, logFullCheckpointEnd, logFullCheckpointStart, logFuzzyCheckPointEnd, logFuzzyCheckPointStart

Methods inherited from class java.lang.Object

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

Field Detail

MASTER_RECORD_EXTENSION

public static final String MASTER_RECORD_EXTENSION

See Also:

Constant Field Values

WAL_SEGMENT_EXTENSION

public static final String WAL_SEGMENT_EXTENSION

See Also:

Constant Field Values

Constructor Detail

ODiskWriteAheadLog

public ODiskWriteAheadLog(OLocalPaginatedStorage storage)
                   throws IOException

Throws:

IOException

ODiskWriteAheadLog

public ODiskWriteAheadLog(int maxPagesCacheSize,
                          int commitDelay,
                          long maxSegmentSize,
                          String walPath,
                          boolean filterWALFiles,
                          OLocalPaginatedStorage storage,
                          int fileTTL)
                   throws IOException

Parameters:

fileTTL - If file of OLogSegmentV2 will not be accessed inside of this interval (in seconds) it will be closed by timer.

Throws:

IOException

Method Detail

addLowDiskSpaceListener

public void addLowDiskSpaceListener(OLowDiskSpaceListener listener)

removeLowDiskSpaceListener

public void removeLowDiskSpaceListener(OLowDiskSpaceListener listener)

addFullCheckpointListener

public void addFullCheckpointListener(OFullCheckpointRequestListener listener)

removeFullCheckpointListener

public void removeFullCheckpointListener(OFullCheckpointRequestListener listener)

getCacheOverflowCount

public long getCacheOverflowCount()

begin

public OLogSequenceNumber begin()
                         throws IOException

Throws:

IOException

end

public OLogSequenceNumber end()

flush

public void flush()

logAtomicOperationStartRecord

public OLogSequenceNumber logAtomicOperationStartRecord(boolean isRollbackSupported,
                                                        OOperationUnitId unitId)
                                                 throws IOException

Throws:

IOException

logAtomicOperationEndRecord

public OLogSequenceNumber logAtomicOperationEndRecord(OOperationUnitId operationUnitId,
                                                      boolean rollback,
                                                      OLogSequenceNumber startLsn,
                                                      Map<String,OAtomicOperationMetadata<?>> atomicOperationMetadata)
                                               throws IOException

Throws:

IOException

log

public OLogSequenceNumber log(OWALRecord record)
                       throws IOException

Throws:

IOException

getOldestTxLsn

public OLogSequenceNumber getOldestTxLsn()

moveLsnAfter

public void moveLsnAfter(OLogSequenceNumber lsn)
                  throws IOException

Description copied from interface: OWriteAheadLog

Next LSN generated by WAL will be bigger than passed in value.

DO NOT REMOVE IT, USED IN ENTERPRISE STORAGE.

Throws:

IOException

activeSegment

public long activeSegment()

nonActiveSegments

public File[] nonActiveSegments(long fromSegment)

size

public long size()

getWalFiles

public List<String> getWalFiles()

getWMRFile

public String getWMRFile()

truncate

public void truncate()
              throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException

close

public void close(boolean flush)
           throws IOException

Throws:

IOException

delete

public void delete()
            throws IOException

Throws:

IOException

delete

public void delete(boolean flush)
            throws IOException

Throws:

IOException

read

public OWALRecord read(OLogSequenceNumber lsn)
                throws IOException

Throws:

IOException

next

public OLogSequenceNumber next(OLogSequenceNumber lsn)
                        throws IOException

Throws:

IOException

getFlushedLsn

public OLogSequenceNumber getFlushedLsn()

cutTill

public boolean cutTill(OLogSequenceNumber lsn)
                throws IOException

Description copied from interface: OWriteAheadLog

Cut WAL content till passed in value of LSN at maximum in many cases smaller portion of WAL may be cut. If value of LSN is bigger than values provided in OWriteAheadLog.addCutTillLimit(OLogSequenceNumber) then "protected" part of WAL will be preserved for sure.

Parameters:

lsn - Maximum value of LSN till WAL will be cut.

Returns:

true if some portion of WAL will be cut and false if WAL left untouched.

Throws:

IOException

addCutTillLimit

public void addCutTillLimit(OLogSequenceNumber lsn)

Description copied from interface: OWriteAheadLog

Adds LSN after which WAL log should be preserved. It is possible to add many such LSNs smallest value among them will be used to limit value of LSN after which WAL may be cut.

Parameters:

lsn - LSN after which cut of the WAL is not allowed.

See Also:

OWriteAheadLog.removeCutTillLimit(OLogSequenceNumber), OWriteAheadLog.cutTill(OLogSequenceNumber)

removeCutTillLimit

public void removeCutTillLimit(OLogSequenceNumber lsn)

Description copied from interface: OWriteAheadLog

Removes LSN after which WAL log should be preserved. It is possible to add many such LSNs smallest value among them will be used to limit value of LSN after which WAL may be cut.

Parameters:

lsn - LSN after which cut of the WAL is not allowed.

See Also:

OWriteAheadLog.removeCutTillLimit(OLogSequenceNumber), OWriteAheadLog.cutTill(OLogSequenceNumber)

getPreferredSegmentCount

public long getPreferredSegmentCount()

Returns:

preferred segment count this WAL instance tries to keep under. In fact, there may be less segments or more segments in this WAL instance than the returned count, but the returned count is preferred by this WAL instance.

checkFreeSpace

public void checkFreeSpace()

appendNewSegment

public boolean appendNewSegment()

Description copied from interface: OWriteAheadLog

Adds new segment so all sequent log entries will be added to this new segment. New segment can not be appended if:

1. WAL is empty
2. There last segment in WAL is empty.

Despite of the fact that WAL segment will not be appended, method call still will reach its main target, all subsequent log records will have segment number higher than previously logged records. But to inform user that segment is not added result of success of failure of this method will be returned.

Returns:

true if new segment is added, and false otherwise.