org.mapdb

Class StoreArchive

java.lang.Object

org.mapdb.Store

org.mapdb.StoreArchive

All Implemented Interfaces:

Closeable, AutoCloseable, Engine

public final class StoreArchive
extends Store

Store without index table. Recid is actual physical offset in file. Very space efficient, but read-only, must be created with Data Pump

Nested Class Summary

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	DATA_START_OFFSET
protected static long	FILE_SIZE_OFFSET
protected static long	FIRST_RESERVED_RECID_OFFSET
protected Volume	vol
protected long	volSize

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
StoreArchive(String fileName, Volume.VolumeFactory volumeFactory, boolean readonly)
StoreArchive(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)

Method Summary

Methods

Modifier and Type	Method and Description
protected long	add2(DataIO.DataOutputByteArray out)
void	backup(OutputStream out, boolean incremental)
void	backupRestore(InputStream[] in)
boolean	canRollback()
void	close() Close store/cache.
void	commit() Makes all changes made since the previous commit/rollback permanent.
void	compact()
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 <A> A	get2(long recid, Serializer<A> serializer)
long	getCurrSize()
long	getFreeSize()
void	init()
long	preallocate() Preallocates recid for not yet created record.
<A> long	put(A value, Serializer<A> serializer) Insert new record.
protected void	rewriteNamedCatalog(NavigableMap<String,Object> catalog)
void	rollback() Undoes all changes made in the current transaction.
Engine	snapshot() Returns read-only snapshot of data in Engine.
protected void	update2(long recid, DataIO.DataOutputByteArray out)

Methods inherited from class org.mapdb.Store

assertReadLocked, assertWriteLocked, canSnapshot, checkFeaturesBitmap, clearCache, 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

FILE_SIZE_OFFSET

protected static final long FILE_SIZE_OFFSET

See Also:

Constant Field Values

FIRST_RESERVED_RECID_OFFSET

protected static final long FIRST_RESERVED_RECID_OFFSET

See Also:

Constant Field Values

DATA_START_OFFSET

protected static final long DATA_START_OFFSET

See Also:

Constant Field Values

vol

protected Volume vol

volSize

protected long volSize

Constructor Detail

StoreArchive

public StoreArchive(String fileName,
            Volume.VolumeFactory volumeFactory,
            boolean readonly)

StoreArchive

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

Method Detail

init

public void init()

Overrides:

init in class Store

get2

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

Specified by:

get2 in class Store

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.

add2

protected long add2(DataIO.DataOutputByteArray out)

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)

rewriteNamedCatalog

protected void rewriteNamedCatalog(NavigableMap<String,Object> catalog)

getCurrSize

public long getCurrSize()

Specified by:

getCurrSize in class Store

update2

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

Specified by:

update2 in class Store

delete2

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

Specified by:

delete2 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

backup

public void backup(OutputStream out,
          boolean incremental)

Specified by:

backup in class Store

backupRestore

public void backupRestore(InputStream[] in)

Specified by:

backupRestore in class Store

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

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

compact

public void compact()