org.mapdb

Class StoreCached

java.lang.Object

org.mapdb.Store

org.mapdb.StoreDirect

org.mapdb.StoreCached

All Implemented Interfaces:

Closeable, AutoCloseable, Engine

Direct Known Subclasses:

StoreWAL

public class StoreCached
extends StoreDirect

Extends StoreDirect with Write Cache

Nested Class Summary

Nested classes/interfaces inherited from class org.mapdb.StoreDirect

StoreDirect.Snapshot

Nested classes/interfaces inherited from class org.mapdb.Store

Store.Cache, Store.LongList, Store.LongLongMap, Store.LongObjectMap<V>, Store.LongObjectObjectMap<V1,V2>, Store.LongQueue, Store.MemoryBarrierLessLock, Store.ReadWriteSingleLock

Nested classes/interfaces inherited from interface org.mapdb.Engine

Engine.CloseOnJVMShutdown, Engine.ReadOnly, Engine.ReadOnlyWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	flushInThread
protected static byte[]	LONG_STACK_PAGE_TOMBSTONE
protected static Object	TOMBSTONE2
protected Store.LongObjectMap<byte[]>	uncommittedStackPages stores modified stack pages.
protected Store.LongObjectObjectMap[]	writeCache
protected int	writeQueueSize
protected int	writeQueueSizePerSegment

Fields inherited from class org.mapdb.StoreDirect

EMPTY_LONGS, executor, FREE_RECID_STACK, freeSize, HEAD_END, HEADER, headVol, INDEX_VAL_SIZE, indexPages, INITCRC_INDEX_PAGE, LAST_PHYS_ALLOCATED_DATA_OFFSET, LONG_STACK_MAX_SIZE, LONG_STACK_MIN_SIZE, LONG_STACK_PREF_SIZE, MARCHIVE, MAX_REC_SIZE, MAX_RECID_OFFSET, MLINKED, MOFFSET, MPARITY, MUNUSED, PAGE_MASK, PAGE_MASK_INVERSE, PAGE_SIZE, recidReuseDisable, sizeIncrement, sliceShift, SLOTS_COUNT, snapshots, startSize, STORE_SIZE, STORE_VERSION, UNUSED1, UNUSED2, UNUSED3, UNUSED4, UNUSED5, vol

Fields inherited from class org.mapdb.Store

caches, checksum, closed, commitLock, compress, deserializeExtra, encrypt, encryptionXTEA, FEAT_COMP_LZF, FEAT_CRC, FEAT_ENC_XTEA, fileLockDisable, fileLockHeartbeat, fileName, HEAD_CHECKSUM, HEAD_FEATURES, LOCKING_STRATEGY_NOLOCK, LOCKING_STRATEGY_READWRITELOCK, LOCKING_STRATEGY_WRITELOCK, lockMask, locks, lockScale, LOG, LZF, metricsDataRead, metricsDataWrite, metricsRecordRead, metricsRecordWrite, NOLOCK, readonly, recycledDataOut, snapshotEnable, structuralLock, volumeFactory

Fields inherited from interface org.mapdb.Engine

CLOSED_ENGINE, RECID_CLASS_CATALOG, RECID_FIRST, RECID_LAST_RESERVED, RECID_NAME_CATALOG, RECID_RECORD_CHECK

Constructor Summary

Constructors

Constructor and Description
StoreCached(String fileName)
StoreCached(String fileName, Volume.VolumeFactory volumeFactory, Store.Cache cache, int lockScale, int lockingStrategy, boolean checksum, boolean compress, byte[] password, boolean readonly, boolean snapshotEnable, boolean fileLockDisable, DataIO.HeartbeatFileLock fileLockHeartbeat, ScheduledExecutorService executor, long startSize, long sizeIncrement, boolean recidReuseDisable, long executorScheduledRate, int writeQueueSize)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertLongStackPage(long offset, byte[] val)
protected void	assertNoOverlaps(Store.LongObjectMap<byte[]> pages)
<A> boolean	compareAndSwap(long recid, A expectedOldValue, A newValue, Serializer<A> serializer) Updates existing record in atomic (Compare And Swap) manner.
protected <A> void	delete2(long recid, Serializer<A> serializer)
protected void	flush()
protected void	flushWriteCache()
protected void	flushWriteCacheSegment(int segment)
protected <A> A	get2(long recid, Serializer<A> serializer)
protected void	initHeadVol()
protected byte[]	loadLongStackPage(long pageOffset, boolean willBeModified)
protected long	longStackCount(long masterLinkOffset)
protected void	longStackNewPage(long masterLinkOffset, long prevPageOffset, long value, boolean recursive)
protected void	longStackPut(long masterLinkOffset, long value, boolean recursive)
protected long	longStackTake(long masterLinkOffset, boolean recursive)
<A> long	put(A value, Serializer<A> serializer) Insert new record.
<A> void	update(long recid, A value, Serializer<A> serializer) Update existing record with new value.

Methods inherited from class org.mapdb.StoreDirect

backup, backupRestore, canRollback, clearCache, close, closeFilesIgnoreException, commit, compact, compactIndexPage, compactIndexPages, compactOldFilesExists, composeIndexVal, fileLoad, freeDataPut, freeDataPut, freeDataTake, freeDataTakeSingle, freeRecidTake, freeSizeIncrement, getCurrSize, getFreeSize, getFromOffset, headChecksum, indexLongPut, indexValGet, indexValGetRaw, indexValPut, init, initCreate, initFailedCloseFiles, initOpen, lastAllocatedDataGet, lastAllocatedDataSet, longStackMasterLinkOffset, maxRecidGet, maxRecidSet, offsetsGet, offsetsTotalSize, offsetsVerify, pageAllocate, pageIndexEnsurePageForRecidAllocated, pageIndexExtend, preallocate, putData, putDataSingleWithLink, putDataSingleWithoutLink, recidToOffset, recidTooLarge, rollback, round16Up, snapshot, snapshotCloseAllOnCompact, storeSizeGet, storeSizeSet, update2

Methods inherited from class org.mapdb.Store

assertReadLocked, assertWriteLocked, canSnapshot, checkFeaturesBitmap, delete, deserialize, forDB, forEngine, get, getWrappedEngine, isClosed, isReadOnly, lockPos, longParityGet, longParitySet, makeFeaturesBitmap, metricsCollect, newDataOut2, serialize

Methods inherited from class java.lang.Object

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

Field Detail

LONG_STACK_PAGE_TOMBSTONE

protected static final byte[] LONG_STACK_PAGE_TOMBSTONE

uncommittedStackPages

protected final Store.LongObjectMap<byte[]> uncommittedStackPages

stores modified stack pages.

writeCache

protected final Store.LongObjectObjectMap[] writeCache

TOMBSTONE2

protected static final Object TOMBSTONE2

writeQueueSize

protected final int writeQueueSize

writeQueueSizePerSegment

protected final int writeQueueSizePerSegment

flushInThread

protected final boolean flushInThread

Constructor Detail

StoreCached

public StoreCached(String fileName,
           Volume.VolumeFactory volumeFactory,
           Store.Cache cache,
           int lockScale,
           int lockingStrategy,
           boolean checksum,
           boolean compress,
           byte[] password,
           boolean readonly,
           boolean snapshotEnable,
           boolean fileLockDisable,
           DataIO.HeartbeatFileLock fileLockHeartbeat,
           ScheduledExecutorService executor,
           long startSize,
           long sizeIncrement,
           boolean recidReuseDisable,
           long executorScheduledRate,
           int writeQueueSize)

StoreCached

public StoreCached(String fileName)

Method Detail

initHeadVol

protected void initHeadVol()

Overrides:

initHeadVol in class StoreDirect

longStackPut

protected void longStackPut(long masterLinkOffset,
                long value,
                boolean recursive)

Overrides:

longStackPut in class StoreDirect

longStackTake

protected long longStackTake(long masterLinkOffset,
                 boolean recursive)

Overrides:

longStackTake in class StoreDirect

loadLongStackPage

protected byte[] loadLongStackPage(long pageOffset,
                       boolean willBeModified)

longStackCount

protected long longStackCount(long masterLinkOffset)

Overrides:

longStackCount in class StoreDirect

longStackNewPage

protected void longStackNewPage(long masterLinkOffset,
                    long prevPageOffset,
                    long value,
                    boolean recursive)

Overrides:

longStackNewPage in class StoreDirect

flush

protected void flush()

Overrides:

flush in class StoreDirect

assertLongStackPage

protected void assertLongStackPage(long offset,
                       byte[] val)

assertNoOverlaps

protected void assertNoOverlaps(Store.LongObjectMap<byte[]> pages)

flushWriteCache

protected void flushWriteCache()

flushWriteCacheSegment

protected void flushWriteCacheSegment(int segment)

get2

protected <A> A get2(long recid,
         Serializer<A> serializer)

Overrides:

get2 in class StoreDirect

delete2

protected <A> void delete2(long recid,
               Serializer<A> serializer)

Overrides:

delete2 in class StoreDirect

put

public <A> long put(A value,
           Serializer<A> serializer)

Description copied from interface: Engine

Insert new record.

Specified by:

put in interface Engine

Overrides:

put in class StoreDirect

Parameters:

value - records to be added

serializer - used to convert record into/from binary form

Returns:

recid (record identifier) under which record is stored.

update

public <A> void update(long recid,
              A value,
              Serializer<A> serializer)

Description copied from interface: Engine

Update existing record with new value.

Recid must be a number returned by 'put' method. Behaviour for invalid recid (random number or already deleted record) is not defined, typically it throws 'EndOfFileException', but it may also corrupt store.

Specified by:

update in interface Engine

Overrides:

update in class Store

Parameters:

recid - (record identifier) under which record was persisted.

value - new record value to be stored

serializer - used to serialize record into binary form

compareAndSwap

public <A> boolean compareAndSwap(long recid,
                         A expectedOldValue,
                         A newValue,
                         Serializer<A> serializer)

Description copied from interface: Engine

Updates existing record in atomic (Compare And Swap) manner. Value is modified only if old value matches expected value. There are three ways to match values, MapDB may use any of them:

1. Equality check oldValue==expectedOldValue when old value is found in instance cache
2. Deserializing oldValue using serializer and checking oldValue.equals(expectedOldValue)
3. Serializing expectedOldValue using serializer and comparing binary array with already serialized oldValue

Recid must be a number returned by 'put' method. Behaviour for invalid recid (random number or already deleted record) is not defined, typically it throws 'EndOfFileException', but it may also corrupt store.

Specified by:

compareAndSwap in interface Engine

Overrides:

compareAndSwap in class Store

Parameters:

recid - (record identifier) under which record was persisted.

expectedOldValue - old value to be compared with existing record

newValue - to be written if values are matching

serializer - used to serialize record into binary form

Returns:

true if values matched and newValue was written