Uses of Interface
io.permazen.kv.KVStore

Packages that use KVStore

Package	Description
io.permazen	Abstraction layer allowing access to a Database using normal Java objects.
io.permazen.core	Core classes for the Permazen Java persistence layer.
io.permazen.jsck	Classes associated with Jsck, the Permazen key/value database consistency checker.
io.permazen.kv	byte[] array key/value store API and related utility classes.
io.permazen.kv.array	A simple KVStore implementation based on a sorted array of key/value pairs.
io.permazen.kv.bdb	KVDatabase implementation based on Oracle's Berkeley DB Java Edition.
io.permazen.kv.caching	Caching KVStore and KVDatabase layers.
io.permazen.kv.fdb	KVDatabase implementation based on FoundationDB.
io.permazen.kv.leveldb	KVDatabase implementation based on LevelDB.
io.permazen.kv.lmdb	KVDatabase implementation based on LMDB.
io.permazen.kv.mvcc	Utility classes for MVCC type operations using a KVStore.
io.permazen.kv.mvstore	AtomicKVStore and KVDatabase implementations based on H2 MVStore.
io.permazen.kv.raft	A distributed KVDatabase based on the Raft consensus algorithm.
io.permazen.kv.raft.fallback	A partition-tolerant KVDatabase that automatically migrates between a clustered RaftKVDatabase and a private non-clustered "standalone mode" KVDatabase, based on availability of the Raft cluster.
io.permazen.kv.simple	A simple in-memory implementation of the KVDatabase interface.
io.permazen.kv.spanner	KVDatabase implementation based on Google Cloud Spanner.
io.permazen.kv.sql	KVDatabase implementations based on SQL connections.
io.permazen.kv.test	Permazen key/value unit test support classes.
io.permazen.kv.util	Utility classes relating to the KVDatabase interface.
io.permazen.kv.xodus	KVDatabase implementation based on Xodus.
io.permazen.spring	Spring Framework integration classes.

Uses of KVStore in io.permazen

Methods in io.permazen with parameters of type KVStore

Modifier and Type	Method	Description
DetachedPermazenTransaction	Permazen.createDetachedTransaction(KVStore kvstore, ValidationMode validationMode)	Create a new DetachedPermazenTransaction based on the provided key/value store.

Uses of KVStore in io.permazen.core

Methods in io.permazen.core that return KVStore

Modifier and Type	Method	Description
KVStore	DetachedTransaction.getKVStore()	Get the underlying KVStore that holds this detached transaction's state.

Methods in io.permazen.core with parameters of type KVStore

Modifier and Type	Method	Description
static void	Layout.copyMetaData(KVStore src, KVStore dst)	Copy non-object meta-data from one KVStore to another.
DetachedTransaction	Database.createDetachedTransaction(KVStore kvstore, TransactionConfig txConfig)	Create a detached transaction based on the provided key/value store.
static void	Layout.deleteObjectData(KVStore kv)	Delete all object and index data from the given KVStore.
static CoreIndex1<Integer,ObjId>	Layout.getSchemaIndex(KVStore kv)	Get a CoreIndex1 view of the object schema index in a key/value database.
static SchemaBundle.Encoded	SchemaBundle.Encoded.readFrom(KVStore kv)	Read encoded SchemaBundle data from the given key/value store.
void	SchemaBundle.Encoded.writeTo(KVStore kv)	Rewrite the schema and storage ID tables in the given key/value store with the contents of this instance.

Uses of KVStore in io.permazen.jsck

Methods in io.permazen.jsck with parameters of type KVStore

Modifier and Type	Method	Description
void	Issue.apply(KVStore kvstore)	Apply the fix for this issue to the given KVStore.
long	Jsck.check(KVStore kv, Consumer<? super Issue> consumer)	Perform check.

Uses of KVStore in io.permazen.kv

Subinterfaces of KVStore in io.permazen.kv

Modifier and Type	Interface	Description
interface	CloseableKVStore	Implemented by KVStores that must be CloseableKVStore.close()ed when no longer in use.
interface	KVTransaction	KVDatabase transaction API.

Classes in io.permazen.kv that implement KVStore

Modifier and Type	Class	Description
class	AbstractKVStore	Support superclass for KVStore implementations.

Methods in io.permazen.kv that return KVStore

Modifier and Type	Method	Description
KVStore	KVPairIterator.getKVStore()	Get the KVStore associated with this instance.

Constructors in io.permazen.kv with parameters of type KVStore

Modifier	Constructor	Description
	KVPairIterator(KVStore kv, byte[] prefix)	Convenience constructor for forward iteration over all keys having a given prefix.
	KVPairIterator(KVStore kv, byte[] prefix, boolean reverse)	Convenience constructor for iteration over all keys having a given prefix.
	KVPairIterator(KVStore kv, KeyRange keyRange)	Convenience constructor for forward iteration over a specified range.
	KVPairIterator(KVStore kv, KeyRange keyRange, KeyFilter keyFilter, boolean reverse)	Primary constructor.

Uses of KVStore in io.permazen.kv.array

Classes in io.permazen.kv.array that implement KVStore

Modifier and Type	Class	Description
class	ArrayKVStore	A simple read-only KVStore based on a sorted array of key/value pairs.
class	ArrayKVTransaction	ArrayKVDatabase transaction.
class	AtomicArrayKVStore	AtomicKVStore based on ArrayKVStore plus a write-ahead log and background compaction.

Methods in io.permazen.kv.array with parameters of type KVStore

Modifier and Type	Method	Description
void	ArrayKVWriter.writeMerged(KVStore kvstore, Iterator<KVPair> kvIterator, Mutations mutations)	Merge the given key/value pair iteration with the specified mutations and write out the merged combination.

Uses of KVStore in io.permazen.kv.bdb

Classes in io.permazen.kv.bdb that implement KVStore

Modifier and Type	Class	Description
class	BerkeleyKVTransaction	Oracle Berkeley DB Java Edition KVTransaction implementation.

Uses of KVStore in io.permazen.kv.caching

Classes in io.permazen.kv.caching that implement KVStore

Modifier and Type	Class	Description
class	CachingKVStore	A caching layer for read-only KVStore's that have high latency for individual reads but low latency for consecutive key/value pairs in a KVStore.getRange() range read.
class	CachingKVTransaction	A transaction associated with a CachingKVDatabase.

Constructors in io.permazen.kv.caching with parameters of type KVStore

Modifier	Constructor	Description
	CachingKVStore(KVStore kvstore, ExecutorService executor, long rttEstimate)	Constructor.

Uses of KVStore in io.permazen.kv.fdb

Classes in io.permazen.kv.fdb that implement KVStore

Modifier and Type	Class	Description
class	FoundationKVStore	A KVStore view of a FoundationDB Transaction.
class	FoundationKVTransaction	FoundationDB transaction.

Uses of KVStore in io.permazen.kv.leveldb

Classes in io.permazen.kv.leveldb that implement KVStore

Modifier and Type	Class	Description
class	LevelDBAtomicKVStore	An AtomicKVStore view of a LevelDB database.
class	LevelDBKVStore	Straightforward KVStore view of a LevelDB database.
class	LevelDBKVTransaction	LevelDBKVDatabase transaction.
class	SnapshotLevelDBKVStore	Read-only KVStore view of a LevelDB Snapshot.

Uses of KVStore in io.permazen.kv.lmdb

Classes in io.permazen.kv.lmdb that implement KVStore

Modifier and Type	Class	Description
class	ByteArrayLMDBKVStore	KVStore view of a LMDB transaction using byte[] array buffers.
class	ByteArrayLMDBKVTransaction	LMDBKVTransaction using byte[] arrays buffers.
class	LMDBKVStore<T>	Straightforward KVStore view of a LMDB transaction.
class	LMDBKVTransaction<T>	LMDB transaction viewed as a KVTransaction.

Methods in io.permazen.kv.lmdb that return KVStore

Modifier and Type	Method	Description
protected KVStore	LMDBKVTransaction.delegate()

Uses of KVStore in io.permazen.kv.mvcc

Subinterfaces of KVStore in io.permazen.kv.mvcc

Modifier and Type	Interface	Description
interface	AtomicKVStore	Extension of the KVStore interface for implementations that support atomic, batched reads and writes.
interface	DeltaKVStore	Presents a mutable view of an underlying read-only KVStore and records the mutations in memory.

Classes in io.permazen.kv.mvcc that implement KVStore

Modifier and Type	Class	Description
class	AtomicKVDatabase	Wrapper class that presents an AtomicKVStore view of a KVDatabase, using individual transactions for each operation.
class	BranchedKVTransaction	A KVTransaction that is based on a snapshot from an original KVTransaction and that can, at some arbitrary later time, be merged back into a new KVTransaction from the same database, assuming no conflicting changes have occurred in the meantime.
class	MemoryAtomicKVStore	Provides a KVStore view of an underlying ConcurrentNavigableMap<byte[], byte[]> whose keys are sorted lexicographically as unsigned bytes.
class	MutableView	Straightforward implementation of the DeltaKVStore interface.
class	SnapshotKVTransaction	SnapshotKVDatabase transaction.

Methods in io.permazen.kv.mvcc that return KVStore

Modifier and Type	Method	Description
protected KVStore	SnapshotKVTransaction.delegate()	Get the underlying KVStore.
KVStore	DeltaKVStore.getBaseKVStore()	Get the KVStore that underlies this instance.
KVStore	MutableView.getBaseKVStore()

Methods in io.permazen.kv.mvcc with parameters of type KVStore

Modifier and Type	Method	Description
static void	Writes.apply(Mutations mutations, KVStore target)	Deprecated. use apply(io.permazen.kv.mvcc.Mutations) instead
void	Writes.applyTo(KVStore target)	Apply all mutations contained in this instance to the given KVStore.
void	MutableView.setKVStore(KVStore kv)	Swap out the underlying KVStore associated with this instance.

Constructors in io.permazen.kv.mvcc with parameters of type KVStore

Modifier	Constructor	Description
	MutableView(KVStore kv)	Constructor.
	MutableView(KVStore kv, boolean trackReads)	Constructor with optional read tracking.
	MutableView(KVStore kv, Reads reads, Writes writes)	Constructor using caller-provided Reads (optional) and Writes.
	MutableView(KVStore kv, Writes writes)	Constructor with no read tracking and caller-provided Writes.

Uses of KVStore in io.permazen.kv.mvstore

Classes in io.permazen.kv.mvstore that implement KVStore

Modifier and Type	Class	Description
class	MVMapKVStore	Straightforward KVStore view of an MVMap.
class	MVMapSnapshot	A read-only snapshot an MVMap.
class	MVStoreAtomicKVStore	An AtomicKVStore implementation based on an MVMap in an MVStore.
class	MVStoreKVTransaction	MVStoreKVDatabase transaction.

Uses of KVStore in io.permazen.kv.raft

Classes in io.permazen.kv.raft that implement KVStore

Modifier and Type	Class	Description
class	RaftKVTransaction	RaftKVDatabase transaction.

Uses of KVStore in io.permazen.kv.raft.fallback

Classes in io.permazen.kv.raft.fallback that implement KVStore

Modifier and Type	Class	Description
class	FallbackKVTransaction	A KVTransaction associated with a FallbackKVDatabase.

Methods in io.permazen.kv.raft.fallback that return KVStore

Modifier and Type	Method	Description
protected KVStore	FallbackKVTransaction.delegate()

Uses of KVStore in io.permazen.kv.simple

Classes in io.permazen.kv.simple that implement KVStore

Modifier and Type	Class	Description
class	SimpleKVTransaction	KVTransaction implementation for SimpleKVDatabase.
class	XMLKVTransaction	Transaction associated with a XMLKVDatabase.

Uses of KVStore in io.permazen.kv.spanner

Classes in io.permazen.kv.spanner that implement KVStore

Modifier and Type	Class	Description
class	ReadOnlySpannerView	Provides a (read-only) KVStore view of a ReadContext.
class	ReadWriteSpannerView	Provides a mutable KVStore view of a ReadContext.
class	SpannerKVTransaction	SpannerKVDatabase transaction.

Methods in io.permazen.kv.spanner that return KVStore

Modifier and Type	Method	Description
protected KVStore	SpannerKVTransaction.delegate()

Uses of KVStore in io.permazen.kv.sql

Classes in io.permazen.kv.sql that implement KVStore

Modifier and Type	Class	Description
class	SQLKVTransaction	SQLKVDatabase transaction.

Methods in io.permazen.kv.sql that return KVStore

Modifier and Type	Method	Description
protected KVStore	SQLKVTransaction.delegate()

Uses of KVStore in io.permazen.kv.test

Methods in io.permazen.kv.test with parameters of type KVStore

Modifier and Type	Method	Description
void	KVDatabaseTest.RandomTask.performRandomAccess(KVStore tx)
void	KVDatabaseTest.RandomTask.runRandomAccess(KVStore tx)
protected RuntimeException	KVTestSupport.showKV(KVStore kv, String label)	Dump KV contents to the log.
protected RuntimeException	KVTestSupport.showKV(KVStore kv, String label, byte[] minKey, byte[] maxKey)	Dump KV portion to the log.
protected String	KVTestSupport.toXmlString(KVStore kv)
protected String	KVTestSupport.toXmlString(KVStore kv, byte[] minKey, byte[] maxKey)

Uses of KVStore in io.permazen.kv.util

Classes in io.permazen.kv.util that implement KVStore

Modifier and Type	Class	Description
class	CloseableForwardingKVStore	A ForwardingKVStore also implementing CloseableKVStore, with some associated underlying Closeable resource to close when CloseableForwardingKVStore.close()'d.
class	ForwardingKVStore	Forwards all KVStore operations to another underlying KVStore.
class	MemoryKVStore	Provides a KVStore view of an underlying ConcurrentNavigableMap<byte[], byte[]> whose keys are sorted lexicographically as unsigned bytes.
class	PrefixKVStore	A KVStore view of all keys having a common byte[] prefix in an outer, containing KVStore.
class	PrefixKVTransaction	KVTransaction view of all keys having a common byte[] prefix in a containing KVTransaction.
class	UnmodifiableKVStore	Provides a read-only view of an underlying KVStore.

Fields in io.permazen.kv.util declared as KVStore

Modifier and Type	Field	Description
protected final KVStore	AbstractKVIterator.kv	The underlying KVStore.
protected final KVStore	AbstractKVNavigableMap.kv	The underlying KVStore.
protected final KVStore	AbstractKVNavigableSet.kv	The underlying KVStore.

Methods in io.permazen.kv.util that return KVStore

Modifier and Type	Method	Description
protected KVStore	CloseableForwardingKVStore.delegate()
protected abstract KVStore	ForwardingKVStore.delegate()	Get the underlying KVStore.
protected KVStore	UnmodifiableKVStore.delegate()

Methods in io.permazen.kv.util with parameters of type KVStore

Modifier and Type	Method	Description
static PrefixKVStore	PrefixKVStore.create(KVStore kvstore, byte[] keyPrefix)	Create a PrefixKVStore instance using the specified prefix and underlying KVStore.

Constructors in io.permazen.kv.util with parameters of type KVStore

Modifier	Constructor	Description
protected	AbstractKVIterator(KVStore kv, boolean prefixMode, boolean reversed)	Convenience constructor for when there are no range restrictions.
protected	AbstractKVIterator(KVStore kv, boolean prefixMode, boolean reversed, byte[] prefix)	Convenience constructor for when the range of visible KVStore keys is all keys sharing a given byte[] prefix.
protected	AbstractKVIterator(KVStore kv, boolean prefixMode, boolean reversed, KeyRange keyRange, KeyFilter keyFilter)	Primary constructor.
protected	AbstractKVNavigableMap(KVStore kv, boolean prefixMode)	Convenience constructor for when there are no range restrictions.
protected	AbstractKVNavigableMap(KVStore kv, boolean prefixMode, boolean reversed, KeyRange keyRange, KeyFilter keyFilter, Bounds<K> bounds)	Internal constructor.
protected	AbstractKVNavigableMap(KVStore kv, boolean prefixMode, byte[] prefix)	Convenience constructor for when the range of visible KVStore keys is all keys sharing a given byte[] prefix.
protected	AbstractKVNavigableMap(KVStore kv, boolean prefixMode, KeyRange keyRange)	Primary constructor.
protected	AbstractKVNavigableSet(KVStore kv, boolean prefixMode)	Convenience constructor for when there are no range restrictions.
protected	AbstractKVNavigableSet(KVStore kv, boolean prefixMode, boolean reversed, KeyRange keyRange, KeyFilter keyFilter, Bounds<E> bounds)	Internal constructor.
protected	AbstractKVNavigableSet(KVStore kv, boolean prefixMode, byte[] prefix)	Convenience constructor for when the range of visible KVStore keys is all keys sharing a given byte[] prefix.
protected	AbstractKVNavigableSet(KVStore kv, boolean prefixMode, KeyRange keyRange)	Primary constructor.
	CloseableForwardingKVStore(KVStore kvstore, Runnable closeAction)	Constructor.
	KVNavigableMap(KVStore kv)	Constructor for when there are no range restrictions.
protected	KVNavigableMap(KVStore kv, boolean reversed, KeyRange keyRange, KeyFilter keyFilter)	Primary constructor.
	KVNavigableMap(KVStore kv, byte[] prefix)	Constructor for when the range of visible KVStore keys is all keys sharing a given byte[] prefix.
	KVNavigableSet(KVStore kv)	Constructor for when there are no range restrictions.
protected	KVNavigableSet(KVStore kv, boolean reversed, KeyRange keyRange, KeyFilter keyFilter)	Primary constructor.
	KVNavigableSet(KVStore kv, byte[] prefix)	Constructor for when the range of visible KVStore keys is all keys sharing a given byte[] prefix.
	UnmodifiableKVStore(KVStore kvstore)	Constructor.
	XMLSerializer(KVStore kv)	Constructor.

Uses of KVStore in io.permazen.kv.xodus

Classes in io.permazen.kv.xodus that implement KVStore

Modifier and Type	Class	Description
class	XodusKVStore	Straightforward KVStore view of a Xodus Store viewed within an open Transaction.
class	XodusKVTransaction	XodusKVDatabase transaction.

Methods in io.permazen.kv.xodus that return KVStore

Modifier and Type	Method	Description
protected KVStore	XodusKVTransaction.delegate()

Uses of KVStore in io.permazen.spring

Methods in io.permazen.spring that return KVStore

Modifier and Type	Method	Description
protected KVStore	KVStoreHttpMessageConverter.readInternal(Class<? extends KVStore> clazz, HttpInputMessage input)

Methods in io.permazen.spring with parameters of type KVStore

Modifier and Type	Method	Description
protected Long	KVStoreHttpMessageConverter.getContentLength(KVStore kvstore, MediaType mediaType)
static Long	KVStoreHttpMessageConverter.getKVStoreContentLength(KVStore kvstore)	Determine the content length of the given key/value store when encoded as payload.
static void	KVStoreHttpMessageConverter.readKVStore(KVStore kvstore, HttpInputMessage input)	Decode a key/value store HTTP payload.
protected void	KVStoreHttpMessageConverter.writeInternal(KVStore kvstore, HttpOutputMessage output)
static void	KVStoreHttpMessageConverter.writeKVStore(KVStore kvstore, HttpOutputMessage output)	Encode a key/value store HTTP payload.

Method parameters in io.permazen.spring with type arguments of type KVStore

Modifier and Type	Method	Description
protected KVStore	KVStoreHttpMessageConverter.readInternal(Class<? extends KVStore> clazz, HttpInputMessage input)