org.mapdb

Class StoreDirect

java.lang.Object

org.mapdb.Store

org.mapdb.StoreDirect

All Implemented Interfaces:

Closeable, AutoCloseable, Engine

Direct Known Subclasses:

StoreCached

public class StoreDirect
extends Store

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	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 static long[]	EMPTY_LONGS
protected ScheduledExecutorService	executor
protected static long	FREE_RECID_STACK
protected AtomicLong	freeSize
protected static long	HEAD_END
protected static int	HEADER 4 byte file header
protected Volume	headVol
protected static long	INDEX_VAL_SIZE
protected long[]	indexPages
protected static long	INITCRC_INDEX_PAGE
protected static long	LAST_PHYS_ALLOCATED_DATA_OFFSET
protected static long	LONG_STACK_MAX_SIZE
protected static long	LONG_STACK_MIN_SIZE
protected static long	LONG_STACK_PREF_SIZE
protected static long	MARCHIVE
protected static int	MAX_REC_SIZE
protected static long	MAX_RECID_OFFSET Maximal allocated recid.
protected static long	MLINKED
protected static long	MOFFSET
protected static long	MPARITY
protected static long	MUNUSED
protected static long	PAGE_MASK
protected static long	PAGE_MASK_INVERSE
protected static long	PAGE_SIZE
protected boolean	recidReuseDisable
protected long	sizeIncrement
protected int	sliceShift
protected static int	SLOTS_COUNT number of free physical slots
protected List<StoreDirect.Snapshot>	snapshots
protected long	startSize
protected static long	STORE_SIZE
protected static int	STORE_VERSION 2 byte store version
protected static long	UNUSED1
protected static long	UNUSED2
protected static long	UNUSED3
protected static long	UNUSED4
protected static long	UNUSED5
protected Volume	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
StoreDirect(String fileName)
StoreDirect(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)

Method Summary

Methods

Modifier and Type	Method and Description
void	backup(OutputStream out, boolean incremental)
void	backupRestore(InputStream[] ins)
boolean	canRollback()
void	clearCache() clears any underlying cache
void	close() Close store/cache.
protected void	closeFilesIgnoreException() will try to close opened files.
void	commit() Makes all changes made since the previous commit/rollback permanent.
void	compact()
protected void	compactIndexPage(StoreDirect target, int indexPageI, long maxRecid)
protected void	compactIndexPages(StoreDirect target, AtomicLong maxRecid)
protected boolean	compactOldFilesExists()
protected static long	composeIndexVal(int size, long offset, boolean linked, boolean unused, boolean archive)
protected <A> void	delete2(long recid, Serializer<A> serializer)
boolean	fileLoad() If underlying storage is memory-mapped-file, this method will try to load and precache all file data into disk cache.
protected void	flush()
protected void	freeDataPut(int segment, long[] linkedOffsets)
protected void	freeDataPut(int segment, long offset, int size)
protected long[]	freeDataTake(int size)
protected long	freeDataTakeSingle(int size, boolean recursive)
protected long	freeRecidTake() returns new recid, recid slot is allocated and ready to use
protected void	freeSizeIncrement(int increment)
protected <A> A	get2(long recid, Serializer<A> serializer)
long	getCurrSize()
long	getFreeSize()
protected <A> A	getFromOffset(Serializer<A> serializer, long[] offsets)
protected int	headChecksum(Volume vol2)
protected void	indexLongPut(long offset, long val)
protected long	indexValGet(long recid)
protected long	indexValGetRaw(long recid)
protected void	indexValPut(long recid, int size, long offset, boolean linked, boolean unused)
void	init()
protected void	initCreate()
protected void	initFailedCloseFiles()
protected void	initHeadVol()
protected void	initOpen()
protected long	lastAllocatedDataGet()
protected void	lastAllocatedDataSet(long offset)
protected long	longStackCount(long masterLinkOffset)
protected long	longStackMasterLinkOffset(long masterSize)
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)
protected long	maxRecidGet()
protected void	maxRecidSet(long maxRecid)
protected long[]	offsetsGet(int segment, long indexVal) return positions of (possibly) linked record
protected int	offsetsTotalSize(long[] offsets)
protected void	offsetsVerify(long[] ret)
protected long	pageAllocate()
protected void	pageIndexEnsurePageForRecidAllocated(long recid)
protected void	pageIndexExtend()
long	preallocate() Preallocates recid for not yet created record.
<A> long	put(A value, Serializer<A> serializer) Insert new record.
protected void	putData(long recid, long[] offsets, byte[] src, int srcLen)
protected void	putDataSingleWithLink(int segment, long offset, long link, byte[] buf, int bufPos, int size)
protected void	putDataSingleWithoutLink(int segment, long offset, byte[] buf, int bufPos, int size)
protected long	recidToOffset(long recid)
protected boolean	recidTooLarge(long recid) check if recid offset fits into current allocated structure
void	rollback() Undoes all changes made in the current transaction.
protected static int	round16Up(int pos)
Engine	snapshot() Returns read-only snapshot of data in Engine.
protected void	snapshotCloseAllOnCompact()
protected long	storeSizeGet()
protected void	storeSizeSet(long storeSize)
protected void	update2(long recid, DataIO.DataOutputByteArray out)

Methods inherited from class org.mapdb.Store

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

Methods inherited from class java.lang.Object

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

Field Detail

STORE_VERSION

protected static final int STORE_VERSION

2 byte store version

See Also:

Constant Field Values

HEADER

protected static final int HEADER

4 byte file header

See Also:

Constant Field Values

PAGE_SIZE

protected static final long PAGE_SIZE

See Also:

Constant Field Values

PAGE_MASK

protected static final long PAGE_MASK

See Also:

Constant Field Values

PAGE_MASK_INVERSE

protected static final long PAGE_MASK_INVERSE

See Also:

Constant Field Values

MOFFSET

protected static final long MOFFSET

See Also:

Constant Field Values

MLINKED

protected static final long MLINKED

See Also:

Constant Field Values

MUNUSED

protected static final long MUNUSED

See Also:

Constant Field Values

MARCHIVE

protected static final long MARCHIVE

See Also:

Constant Field Values

MPARITY

protected static final long MPARITY

See Also:

Constant Field Values

STORE_SIZE

protected static final long STORE_SIZE

See Also:

Constant Field Values

MAX_RECID_OFFSET

protected static final long MAX_RECID_OFFSET

Maximal allocated recid. Parity4 plus shift.

See Also:

Constant Field Values

LAST_PHYS_ALLOCATED_DATA_OFFSET

protected static final long LAST_PHYS_ALLOCATED_DATA_OFFSET

See Also:

Constant Field Values

FREE_RECID_STACK

protected static final long FREE_RECID_STACK

See Also:

Constant Field Values

UNUSED1

protected static final long UNUSED1

See Also:

Constant Field Values

UNUSED2

protected static final long UNUSED2

See Also:

Constant Field Values

UNUSED3

protected static final long UNUSED3

See Also:

Constant Field Values

UNUSED4

protected static final long UNUSED4

See Also:

Constant Field Values

UNUSED5

protected static final long UNUSED5

See Also:

Constant Field Values

MAX_REC_SIZE

protected static final int MAX_REC_SIZE

See Also:

Constant Field Values

SLOTS_COUNT

protected static final int SLOTS_COUNT

number of free physical slots

See Also:

Constant Field Values

HEAD_END

protected static final long HEAD_END

See Also:

Constant Field Values

INITCRC_INDEX_PAGE

protected static final long INITCRC_INDEX_PAGE

See Also:

Constant Field Values

EMPTY_LONGS

protected static final long[] EMPTY_LONGS

vol

protected volatile Volume vol

headVol

protected volatile Volume headVol

indexPages

protected volatile long[] indexPages

executor

protected final ScheduledExecutorService executor

snapshots

protected final List<StoreDirect.Snapshot> snapshots

INDEX_VAL_SIZE

protected static final long INDEX_VAL_SIZE

See Also:

Constant Field Values

startSize

protected final long startSize

sizeIncrement

protected final long sizeIncrement

recidReuseDisable

protected final boolean recidReuseDisable

sliceShift

protected final int sliceShift

freeSize

protected final AtomicLong freeSize

LONG_STACK_PREF_SIZE

protected static final long LONG_STACK_PREF_SIZE

See Also:

Constant Field Values

LONG_STACK_MIN_SIZE

protected static final long LONG_STACK_MIN_SIZE

See Also:

Constant Field Values

LONG_STACK_MAX_SIZE

protected static final long LONG_STACK_MAX_SIZE

See Also:

Constant Field Values

Constructor Detail

StoreDirect

public StoreDirect(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)

StoreDirect

public StoreDirect(String fileName)

Method Detail

init

public void init()

Overrides:

init in class Store

initFailedCloseFiles

protected void initFailedCloseFiles()

storeSizeSet

protected void storeSizeSet(long storeSize)

storeSizeGet

protected long storeSizeGet()

initOpen

protected void initOpen()

initCreate

protected void initCreate()

initHeadVol

protected void initHeadVol()

headChecksum

protected int headChecksum(Volume vol2)

get2

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

Specified by:

get2 in class Store

getFromOffset

protected <A> A getFromOffset(Serializer<A> serializer,
                  long[] offsets)

offsetsTotalSize

protected int offsetsTotalSize(long[] offsets)

update2

protected void update2(long recid,
           DataIO.DataOutputByteArray out)

Specified by:

update2 in class Store

offsetsVerify

protected void offsetsVerify(long[] ret)

offsetsGet

protected long[] offsetsGet(int segment,
                long indexVal)

return positions of (possibly) linked record

indexValPut

protected void indexValPut(long recid,
               int size,
               long offset,
               boolean linked,
               boolean unused)

delete2

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

Specified by:

delete2 in class Store

getCurrSize

public long getCurrSize()

Specified by:

getCurrSize in class Store

getFreeSize

public long getFreeSize()

Specified by:

getFreeSize in class Store

fileLoad

public boolean fileLoad()

Description copied from class: Store

If underlying storage is memory-mapped-file, this method will try to load and precache all file data into disk cache. Most likely it will call MappedByteBuffer.load(), but could also read content of entire file etc This method will not pin data into memory, they might be removed at any time.

Specified by:

fileLoad in class Store

Returns:

true if this method did something, false if underlying storage does not support loading, or is already in-memory

freeSizeIncrement

protected void freeSizeIncrement(int increment)

preallocate

public long preallocate()

Description copied from interface: Engine

Preallocates recid for not yet created record. It does not insert any data into it.

Returns:

new recid

put

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

Description copied from interface: Engine

Insert new record.

Parameters:

value - records to be added

serializer - used to convert record into/from binary form

Returns:

recid (record identifier) under which record is stored.

putData

protected void putData(long recid,
           long[] offsets,
           byte[] src,
           int srcLen)

putDataSingleWithoutLink

protected void putDataSingleWithoutLink(int segment,
                            long offset,
                            byte[] buf,
                            int bufPos,
                            int size)

putDataSingleWithLink

protected void putDataSingleWithLink(int segment,
                         long offset,
                         long link,
                         byte[] buf,
                         int bufPos,
                         int size)

freeDataPut

protected void freeDataPut(int segment,
               long[] linkedOffsets)

freeDataPut

protected void freeDataPut(int segment,
               long offset,
               int size)

freeDataTake

protected long[] freeDataTake(int size)

freeDataTakeSingle

protected long freeDataTakeSingle(int size,
                      boolean recursive)

longStackPut

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

longStackNewPage

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

longStackTake

protected long longStackTake(long masterLinkOffset,
                 boolean recursive)

longStackCount

protected long longStackCount(long masterLinkOffset)

close

public void close()

Description copied from interface: Engine

Close store/cache. This method must be called before JVM exits to flush all caches and prevent store corruption. Also it releases resources used by MapDB (disk, memory..).

Engine can no longer be used after this method was called. If Engine is used after closing, it may throw any exception including NullPointerException

There is an configuration option DBMaker.Maker.closeOnJvmShutdown() which uses shutdown hook to automatically close Engine when JVM shutdowns.

commit

public void commit()

Description copied from interface: Engine

Makes all changes made since the previous commit/rollback permanent. In transactional mode (on by default) it means creating journal file and replaying it to storage. In other modes it may flush disk caches or do nothing at all (check your config options)

flush

protected void flush()

rollback

public void rollback()
              throws UnsupportedOperationException

Description copied from interface: Engine

Undoes all changes made in the current transaction. If transactions are disabled it throws UnsupportedOperationException.

Throws:

UnsupportedOperationException - if transactions are disabled

canRollback

public boolean canRollback()

Returns:

true if engine supports rollback

snapshot

public Engine snapshot()
                throws UnsupportedOperationException

Description copied from interface: Engine

Returns read-only snapshot of data in Engine.

Throws:

UnsupportedOperationException - if snapshots are not supported/enabled

clearCache

public void clearCache()

Description copied from interface: Engine

clears any underlying cache

Specified by:

clearCache in interface Engine

Overrides:

clearCache in class Store

backup

public void backup(OutputStream out,
          boolean incremental)

Specified by:

backup in class Store

backupRestore

public void backupRestore(InputStream[] ins)

Specified by:

backupRestore in class Store

compact

public void compact()

compactOldFilesExists

protected boolean compactOldFilesExists()

snapshotCloseAllOnCompact

protected void snapshotCloseAllOnCompact()

compactIndexPages

protected void compactIndexPages(StoreDirect target,
                     AtomicLong maxRecid)

compactIndexPage

protected void compactIndexPage(StoreDirect target,
                    int indexPageI,
                    long maxRecid)

indexValGet

protected long indexValGet(long recid)

indexValGetRaw

protected long indexValGetRaw(long recid)

recidToOffset

protected final long recidToOffset(long recid)

recidTooLarge

protected boolean recidTooLarge(long recid)

check if recid offset fits into current allocated structure

composeIndexVal

protected static long composeIndexVal(int size,
                   long offset,
                   boolean linked,
                   boolean unused,
                   boolean archive)

freeRecidTake

protected long freeRecidTake()

returns new recid, recid slot is allocated and ready to use

indexLongPut

protected void indexLongPut(long offset,
                long val)

pageIndexEnsurePageForRecidAllocated

protected void pageIndexEnsurePageForRecidAllocated(long recid)

pageIndexExtend

protected void pageIndexExtend()

pageAllocate

protected long pageAllocate()

round16Up

protected static int round16Up(int pos)

longStackMasterLinkOffset

protected long longStackMasterLinkOffset(long masterSize)

closeFilesIgnoreException

protected void closeFilesIgnoreException()

will try to close opened files. If an exception is thrown, it is logged and ignored

maxRecidSet

protected void maxRecidSet(long maxRecid)

maxRecidGet

protected long maxRecidGet()

lastAllocatedDataSet

protected void lastAllocatedDataSet(long offset)

lastAllocatedDataGet

protected long lastAllocatedDataGet()