public class OrderedKeyValueStoreAdapter extends BaseKeyColumnValueAdapter
OrderedKeyValueStore
and exposes it as a KeyColumnValueStore
.
An optional key length parameter can be specified if it is known and guaranteed that all keys
passed into and read through the KeyColumnValueStore
have that length. If this length is
static, specifying that length will make the representation of a KeyColumnValueStore
in a OrderedKeyValueStore
more concise and more efficient.
Modifier and Type | Field and Description |
---|---|
static int |
maxVariableKeyLength |
static int |
variableKeyLength |
static int |
variableKeyLengthSize |
NO_ADDITIONS, NO_DELETIONS
Constructor and Description |
---|
OrderedKeyValueStoreAdapter(OrderedKeyValueStore store) |
OrderedKeyValueStoreAdapter(OrderedKeyValueStore store,
int keyLength) |
Modifier and Type | Method and Description |
---|---|
void |
acquireLock(StaticBuffer key,
StaticBuffer column,
StaticBuffer expectedValue,
StoreTransaction txh)
Attempts to claim a lock on the value at the specified
key and
column pair. |
KeyIterator |
getKeys(KeyRangeQuery keyQuery,
StoreTransaction txh)
Returns a
KeyIterator over all keys that fall within the key-range specified by the given query and have one or more columns matching the column-range. |
KeySlicesIterator |
getKeys(MultiSlicesQuery queries,
StoreTransaction txh)
Returns a
KeySlicesIterator over all keys in the store that have one or more columns matching the column-range. |
KeyIterator |
getKeys(SliceQuery columnQuery,
StoreTransaction txh)
Returns a
KeyIterator over all keys in the store that have one or more columns matching the column-range. |
EntryList |
getSlice(KeySliceQuery query,
StoreTransaction txh)
Retrieves the list of entries (i.e.
|
Map<StaticBuffer,EntryList> |
getSlice(List<StaticBuffer> keys,
SliceQuery query,
StoreTransaction txh)
Retrieves the list of entries (i.e.
|
void |
mutate(StaticBuffer key,
List<Entry> additions,
List<StaticBuffer> deletions,
StoreTransaction txh)
Verifies acquisition of locks
txh from previous calls to
KeyColumnValueStore.acquireLock(StaticBuffer, StaticBuffer, StaticBuffer, StoreTransaction)
, then writes supplied additions and/or deletions to
key in the underlying data store. |
close, getName, isClosed
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getMultiSlices
public static final int variableKeyLength
public static final int maxVariableKeyLength
public static final int variableKeyLengthSize
public OrderedKeyValueStoreAdapter(OrderedKeyValueStore store)
public OrderedKeyValueStoreAdapter(OrderedKeyValueStore store, int keyLength)
public EntryList getSlice(KeySliceQuery query, StoreTransaction txh) throws BackendException
KeyColumnValueStore
query
- Query to get results fortxh
- TransactionBackendException
- when columnEnd < columnStartKeySliceQuery
public Map<StaticBuffer,EntryList> getSlice(List<StaticBuffer> keys, SliceQuery query, StoreTransaction txh) throws BackendException
KeyColumnValueStore
SliceQuery
for all
of the given keys together.keys
- List of keysquery
- Slicequery specifying matching entriestxh
- TransactionBackendException
public void mutate(StaticBuffer key, List<Entry> additions, List<StaticBuffer> deletions, StoreTransaction txh) throws BackendException
KeyColumnValueStore
txh
from previous calls to
KeyColumnValueStore.acquireLock(StaticBuffer, StaticBuffer, StaticBuffer, StoreTransaction)
, then writes supplied additions
and/or deletions
to
key
in the underlying data store. Deletions are applied strictly
before additions. In other words, if both an addition and deletion are
supplied for the same column, then the column will first be deleted and
then the supplied Entry for the column will be added.
Implementations which don't support locking should skip the initial lock verification step but otherwise behave as described above.
key
- the key under which the columns in additions
and
deletions
will be writtenadditions
- the list of Entry instances representing column-value pairs to
create under key
, or null to add no column-value pairsdeletions
- the list of columns to delete from key
, or null to
delete no columnstxh
- the transaction to usePermanentLockingException
- if locking is supported by the implementation and at least
one lock acquisition attempted by
KeyColumnValueStore.acquireLock(StaticBuffer, StaticBuffer, StaticBuffer, StoreTransaction)
has failedBackendException
public KeyIterator getKeys(KeyRangeQuery keyQuery, StoreTransaction txh) throws BackendException
KeyColumnValueStore
KeyIterator
over all keys that fall within the key-range specified by the given query and have one or more columns matching the column-range.
Calling KeyIterator.getEntries()
returns the list of all entries that match the column-range specified by the given query.
This method is only supported by stores which keep keys in byte-order.
BackendException
public KeyIterator getKeys(SliceQuery columnQuery, StoreTransaction txh) throws BackendException
KeyColumnValueStore
KeyIterator
over all keys in the store that have one or more columns matching the column-range. Calling KeyIterator.getEntries()
returns the list of all entries that match the column-range specified by the given query.
This method is only supported by stores which do not keep keys in byte-order.
BackendException
public KeySlicesIterator getKeys(MultiSlicesQuery queries, StoreTransaction txh) throws BackendException
KeyColumnValueStore
KeySlicesIterator
over all keys in the store that have one or more columns matching the column-range. Calling KeySlicesIterator.getEntries()
returns the map of all entries that match the column-range specified by the given queries.
This method is mandatory for stores which do not guaranty key orders while running parallel scans.
BackendException
public void acquireLock(StaticBuffer key, StaticBuffer column, StaticBuffer expectedValue, StoreTransaction txh) throws BackendException
KeyColumnValueStore
key
and
column
pair. These locks are discretionary.
If locking fails, implementations of this method may, but are not
required to, throw PermanentLockingException
.
This method is not required
to determine whether locking actually succeeded and may return without
throwing an exception even when the lock can't be acquired. Lock
acquisition is only only guaranteed to be verified by the first call to
KeyColumnValueStore.mutate(StaticBuffer, List, List, StoreTransaction)
on any given
txh
.
The expectedValue
must match the actual value present at the
key
and column
pair. If the true value does not match the
expectedValue
, the lock attempt fails and
LockingException
is thrown. This method may check
expectedValue
. The mutate()
mutate is required to check
it.
When this method is called multiple times on the same key
,
column
, and txh
, calls after the first have no effect.
Locks acquired by this method must be automatically released on
transaction commit()
or rollback()
.
Implementations which don't support locking should throw
UnsupportedOperationException
.
key
- the key on which to lockcolumn
- the column on which to lockexpectedValue
- the expected value for the specified key-column pair on which
to lock (null means the pair must have no value)txh
- the transaction to usePermanentLockingException
- the lock could not be acquired due to contention with other
transactions or a locking-specific storage problemBackendException
Copyright © 2012–2023. All rights reserved.