org.mapdb

Class StoreAppend

java.lang.Object

org.mapdb.Store

org.mapdb.StoreAppend

All Implemented Interfaces:

Engine

Deprecated.

@Deprecated
class StoreAppend
extends Store

Append only store. Uses different file format than Direct and WAL store TODO StoreAppend is buggy and will not be part of 1.0 release.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed Deprecated. true after file was closed
protected long	currFileNum Deprecated. last file number, currently writing into
protected long	currPos Deprecated. last used position, currently writing into
protected Volume	currVolume Deprecated. last uses file, currently writing into
protected boolean	deleteFilesAfterClose Deprecated.
protected static long	END Deprecated. at place of recid indicates uncommited transaction, an end of append log
protected java.io.File	file Deprecated. storage file (without number
protected static long	FILE_MASK Deprecated. mask used to get file offset from index val
protected static int	FILE_SHIFT Deprecated. index value has two parts, first is file number, second is offset in file, this is how many bites file offset occupies
protected static long	HEADER Deprecated. header at beginning of each file
protected Volume	index Deprecated. index table which maps recid into position in index log
protected LongMap<java.lang.Long>	indexInTx Deprecated. same as `index`, but stores uncommited modifications made in this transaction
protected static int	MAX_FILE_SIZE_SHIFT Deprecated.
protected long	maxRecid Deprecated. maximal recid
protected boolean	modified Deprecated. true after file was modified
protected boolean	readOnly Deprecated.
protected static long	RECIDP Deprecated. add to recid before writing it to file
protected long	rollbackCurrFileNum Deprecated. file number on last commit, used for rollback
protected long	rollbackCurrPos Deprecated. file position on last commit, used for rollback
protected long	rollbackMaxRecid Deprecated. maximial recid on last commit, used for rollback
protected static long	SIZEP Deprecated. add to size before writing it to file
protected static long	SKIP Deprecated. at place of recid indicates commited transaction, just ignore this value and continue
protected boolean	syncOnCommit Deprecated.
protected boolean	tx Deprecated. transactions enabled
protected boolean	useRandomAccessFile Deprecated.
protected LongConcurrentHashMap<Volume>	volumes Deprecated. contains opened files, key is file number

Fields inherited from class org.mapdb.Store

checksum, CHECKSUM_FLAG_MASK, CHUNK_SIZE, CHUNK_SIZE_MOD_MASK, closeListeners, compress, COMPRESS_FLAG_MASK, encrypt, ENCRYPT_FLAG_MASK, encryptionXTEA, locks, LOG, LZF, newRecidLock, password, recycledDataOuts, serializerPojo, serializerPojoInitLock, structuralLock

Fields inherited from interface org.mapdb.Engine

CATALOG_RECID, CHECK_RECORD, CLASS_INFO_RECID, LAST_RESERVED_RECID

Constructor Summary

Constructors

Constructor and Description
StoreAppend(java.io.File file) Deprecated.
StoreAppend(java.io.File file, boolean useRandomAccessFile, boolean readOnly, boolean transactionDisabled, boolean deleteFilesAfterClose, boolean syncOnCommitDisabled, boolean checksum, boolean compress, byte[] password, boolean disableLocks) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	calculateStatistics() Deprecated. get some statistics about store.
boolean	canRollback() Deprecated.
void	clearCache() Deprecated. clears any underlying cache
void	close() Deprecated. Close store/cache.
void	commit() Deprecated. Makes all changes made since the previous commit/rollback permanent.
void	compact() Deprecated.
<A> boolean	compareAndSwap(long recid, A expectedOldValue, A newValue, Serializer<A> serializer) Deprecated. Updates existing record in atomic (Compare And Swap) manner.
<A> void	delete(long recid, Serializer<A> serializer) Deprecated. Remove existing record from store/cache Recid must be a number returned by 'put' method.
<A> A	get(long recid, Serializer<A> serializer) Deprecated. Get existing record.
long	getCurrSize() Deprecated. returns current size occupied by physical store (does not include index).
protected java.io.File	getFileFromNum(long fileNumber) Deprecated.
java.util.Iterator<java.lang.Long>	getFreeRecids() Deprecated.
long	getFreeSize() Deprecated. returns free size in physical store (does not include index).
long	getMaxRecid() Deprecated.
protected <A> A	getNoLock(long recid, Serializer<A> serializer) Deprecated.
java.nio.ByteBuffer	getRaw(long recid) Deprecated.
long	getSizeLimit() Deprecated. returns maximal store size or `0` if there is no limit
protected long	indexVal(long recid) Deprecated.
boolean	isClosed() Deprecated. Checks whether Engine was closed.
boolean	isReadOnly() Deprecated. Check if you can write into this Engine.
protected static int	packedLongSize(long value) Deprecated. get number of bytes occupied by packed long
long	preallocate() Deprecated. Preallocates recid for not yet created record.
void	preallocate(long[] recids) Deprecated. Preallocates recids for not yet created record.
<A> long	put(A value, Serializer<A> serializer) Deprecated. Insert new record.
void	rollback() Deprecated. Undoes all changes made in the current transaction.
protected void	rollover() Deprecated.
protected void	setIndexVal(long recid, long indexVal) Deprecated.
<A> void	update(long recid, A value, Serializer<A> serializer) Deprecated. Update existing record with new value.
protected void	updateNoLock(long recid, DataOutput2 out) Deprecated.
void	updateRaw(long recid, java.nio.ByteBuffer data) Deprecated.

Methods inherited from class org.mapdb.Store

canSnapshot, closeListenerRegister, closeListenerUnregister, deserialize, expectedMasks, forDB, forEngine, getSerializerPojo, lockAllWrite, lockPos, newDataOut2, printStatistics, serialize, snapshot, unlockAllWrite

Methods inherited from class java.lang.Object

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

Field Detail

HEADER

protected static final long HEADER

Deprecated.

header at beginning of each file

See Also:

Constant Field Values

FILE_SHIFT

protected static final int FILE_SHIFT

Deprecated.

index value has two parts, first is file number, second is offset in file, this is how many bites file offset occupies

See Also:

Constant Field Values

FILE_MASK

protected static final long FILE_MASK

Deprecated.

mask used to get file offset from index val

See Also:

Constant Field Values

MAX_FILE_SIZE_SHIFT

protected static final int MAX_FILE_SIZE_SHIFT

Deprecated.

See Also:

Constant Field Values

SIZEP

protected static final long SIZEP

Deprecated.

add to size before writing it to file

See Also:

Constant Field Values

RECIDP

protected static final long RECIDP

Deprecated.

add to recid before writing it to file

See Also:

Constant Field Values

END

protected static final long END

Deprecated.

at place of recid indicates uncommited transaction, an end of append log

See Also:

Constant Field Values

SKIP

protected static final long SKIP

Deprecated.

at place of recid indicates commited transaction, just ignore this value and continue

See Also:

Constant Field Values

file

protected final java.io.File file

Deprecated.

storage file (without number

useRandomAccessFile

protected final boolean useRandomAccessFile

Deprecated.

readOnly

protected final boolean readOnly

Deprecated.

syncOnCommit

protected final boolean syncOnCommit

Deprecated.

deleteFilesAfterClose

protected final boolean deleteFilesAfterClose

Deprecated.

tx

protected final boolean tx

Deprecated.

transactions enabled

closed

protected volatile boolean closed

Deprecated.

true after file was closed

modified

protected volatile boolean modified

Deprecated.

true after file was modified

volumes

protected final LongConcurrentHashMap<Volume> volumes

Deprecated.

contains opened files, key is file number

currVolume

protected Volume currVolume

Deprecated.

last uses file, currently writing into

currPos

protected long currPos

Deprecated.

last used position, currently writing into

currFileNum

protected long currFileNum

Deprecated.

last file number, currently writing into

maxRecid

protected long maxRecid

Deprecated.

maximal recid

rollbackCurrPos

protected long rollbackCurrPos

Deprecated.

file position on last commit, used for rollback

rollbackCurrFileNum

protected long rollbackCurrFileNum

Deprecated.

file number on last commit, used for rollback

rollbackMaxRecid

protected long rollbackMaxRecid

Deprecated.

maximial recid on last commit, used for rollback

index

protected Volume index

Deprecated.

index table which maps recid into position in index log

indexInTx

protected final LongMap<java.lang.Long> indexInTx

Deprecated.

same as `index`, but stores uncommited modifications made in this transaction

Constructor Detail

StoreAppend

public StoreAppend(java.io.File file,
                   boolean useRandomAccessFile,
                   boolean readOnly,
                   boolean transactionDisabled,
                   boolean deleteFilesAfterClose,
                   boolean syncOnCommitDisabled,
                   boolean checksum,
                   boolean compress,
                   byte[] password,
                   boolean disableLocks)

Deprecated.

StoreAppend

public StoreAppend(java.io.File file)

Deprecated.

Method Detail

getFileFromNum

protected java.io.File getFileFromNum(long fileNumber)

Deprecated.

rollover

protected void rollover()

Deprecated.

indexVal

protected long indexVal(long recid)

Deprecated.

setIndexVal

protected void setIndexVal(long recid,
                           long indexVal)

Deprecated.

preallocate

public long preallocate()

Deprecated.

Description copied from interface: Engine

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

Returns:

new recid

preallocate

public void preallocate(long[] recids)

Deprecated.

Description copied from interface: Engine

Preallocates recids for not yet created record. It does not insert any data into it. This is done in batch of given size (determied by size of array in argument)

Parameters:

recids - array to put result into

put

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

Deprecated.

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.

get

public <A> A get(long recid,
                 Serializer<A> serializer)

Deprecated.

Description copied from interface: Engine

Get existing record.

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

Parameters:

recid - (record identifier) under which record was persisted

serializer - used to deserialize record from binary form

Returns:

record matching given recid, or null if record is not found under given recid.

getNoLock

protected <A> A getNoLock(long recid,
                          Serializer<A> serializer)
                   throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

update

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

Deprecated.

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.

Parameters:

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

value - new record value to be stored

serializer - used to serialize record into binary form

updateNoLock

protected void updateNoLock(long recid,
                            DataOutput2 out)

Deprecated.

compareAndSwap

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

Deprecated.

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.

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

delete

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

Deprecated.

Description copied from interface: Engine

Remove existing record from store/cache

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.

Parameters:

recid - (record identifier) under which was record persisted

serializer - which may be used in some circumstances to deserialize and store old object

close

public void close()

Deprecated.

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.closeOnJvmShutdown() which uses shutdown hook to automatically close Engine when JVM shutdowns.

isClosed

public boolean isClosed()

Deprecated.

Description copied from interface: Engine

Checks whether Engine was closed.

Returns:

true if engine was closed

commit

public void commit()

Deprecated.

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)

rollback

public void rollback()
              throws java.lang.UnsupportedOperationException

Deprecated.

Description copied from interface: Engine

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

Throws:

java.lang.UnsupportedOperationException - if transactions are disabled

canRollback

public boolean canRollback()

Deprecated.

Returns:

true if engine supports rollback

isReadOnly

public boolean isReadOnly()

Deprecated.

Description copied from interface: Engine

Check if you can write into this Engine. It may be readonly in some cases (snapshot, read-only files).

Returns:

true if engine is read-only

clearCache

public void clearCache()

Deprecated.

Description copied from interface: Engine

clears any underlying cache

compact

public void compact()

Deprecated.

getMaxRecid

public long getMaxRecid()

Deprecated.

Specified by:

getMaxRecid in class Store

getRaw

public java.nio.ByteBuffer getRaw(long recid)

Deprecated.

Specified by:

getRaw in class Store

getFreeRecids

public java.util.Iterator<java.lang.Long> getFreeRecids()

Deprecated.

Specified by:

getFreeRecids in class Store

updateRaw

public void updateRaw(long recid,
                      java.nio.ByteBuffer data)

Deprecated.

Specified by:

updateRaw in class Store

getSizeLimit

public long getSizeLimit()

Deprecated.

Description copied from class: Store

returns maximal store size or `0` if there is no limit

Specified by:

getSizeLimit in class Store

getCurrSize

public long getCurrSize()

Deprecated.

Description copied from class: Store

returns current size occupied by physical store (does not include index). It means file allocated by physical file

Specified by:

getCurrSize in class Store

getFreeSize

public long getFreeSize()

Deprecated.

Description copied from class: Store

returns free size in physical store (does not include index).

Specified by:

getFreeSize in class Store

calculateStatistics

public java.lang.String calculateStatistics()

Deprecated.

Description copied from class: Store

get some statistics about store. This may require traversing entire store, so it can take some time.

Specified by:

calculateStatistics in class Store

packedLongSize

protected static int packedLongSize(long value)

Deprecated.

get number of bytes occupied by packed long