Uses of Class
oracle.kv.Key

Packages that use Key

Package	Description
oracle.kv	This package contains the public API for using Oracle NoSQL Database.
oracle.kv.coherence	This package contains the public API for integration of Oracle NoSQL Database with Oracle Coherence.
oracle.kv.hadoop	Support for loading Oracle NoSQL Database into Hadoop.
oracle.kv.lob	The KVLargeObject interface defines the operations used to read and write Large Objects (LOBs) such as audio and video files.

Uses of Key in oracle.kv

Methods in oracle.kv that return Key

Modifier and Type	Method	Description
static Key	Key.createKey(java.lang.String majorComponent)	Creates a Key from a single component Major Path; the Minor Path will be empty.
static Key	Key.createKey(java.lang.String majorComponent, java.lang.String minorComponent)	Creates a Key from a single component Major Path and a single component Minor Path.
static Key	Key.createKey(java.lang.String majorComponent, java.util.List<java.lang.String> minorPath)	Creates a Key from a single component Major Path and a Minor Path list.
static Key	Key.createKey(java.util.List<java.lang.String> majorPath)	Creates a Key from a Major Path list; the Minor Path will be empty.
static Key	Key.createKey(java.util.List<java.lang.String> majorPath, java.lang.String minorComponent)	Creates a Key from a Major Path list and a single component Minor Path.
static Key	Key.createKey(java.util.List<java.lang.String> majorPath, java.util.List<java.lang.String> minorPath)	Creates a Key from a Major Path list and a Minor Path list.
static Key	Key.fromByteArray(byte[] keyBytes)	Deserializes the given bytes that were returned earlier by toByteArray() and returns the resulting Key.
static Key	Key.fromString(java.lang.String pathString)	Decodes a key path string and returns the resulting Key object.
Key	KeyValue.getKey()	Returns the Key part of the KV pair.
Key	KeyValueVersion.getKey()	Returns the Key part of the KV pair.
Key	Operation.getKey()	Returns the Key associated with the operation.
Key	StoreIteratorException.getKey()	Returns the key which was used to retrieve the current batch of records in the iteration.

Methods in oracle.kv that return types with arguments of type Key

Modifier and Type	Method	Description
java.util.SortedMap<Key,ValueVersion>	KVStore.multiGet(Key parentKey, KeyRange subRange, Depth depth)	Returns the descendant key/value pairs associated with the parentKey.
java.util.SortedMap<Key,ValueVersion>	KVStore.multiGet(Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Returns the descendant key/value pairs associated with the parentKey.
java.util.SortedSet<Key>	KVStore.multiGetKeys(Key parentKey, KeyRange subRange, Depth depth)	Returns the descendant keys associated with the parentKey.
java.util.SortedSet<Key>	KVStore.multiGetKeys(Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Returns the descendant keys associated with the parentKey.
java.util.Iterator<Key>	KVStore.multiGetKeysIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth)	The iterator form of KVStore.multiGetKeys(Key, KeyRange, Depth).
java.util.Iterator<Key>	KVStore.multiGetKeysIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	The iterator form of KVStore.multiGetKeys(Key, KeyRange, Depth, Consistency, long, TimeUnit).
ParallelScanIterator<Key>	KVStore.storeKeysIterator(java.util.Iterator<Key> parentKeyIterator, int batchSize, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit, StoreIteratorConfig storeIteratorConfig)	Return an Iterator which iterates over all keys matching the keys supplied by iterator (or the descendants of a parentKey, or those in a KeyRange).
ParallelScanIterator<Key>	KVStore.storeKeysIterator(java.util.List<java.util.Iterator<Key>> parentKeyIterators, int batchSize, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit, StoreIteratorConfig storeIteratorConfig)	Return an Iterator which iterates over all keys matching the keys supplied by iterators (or the descendants of a parentKey, or those in a KeyRange).
java.util.Iterator<Key>	KVStore.storeKeysIterator(Direction direction, int batchSize)	Return an Iterator which iterates over all keys in unsorted order.
java.util.Iterator<Key>	KVStore.storeKeysIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth)	Return an Iterator which iterates over all keys (or the descendants of a parentKey, or those in a KeyRange) in unsorted order.
java.util.Iterator<Key>	KVStore.storeKeysIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Return an Iterator which iterates over all keys (or the descendants of a parentKey, or those in a KeyRange) in unsorted order.
ParallelScanIterator<Key>	KVStore.storeKeysIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit, StoreIteratorConfig storeIteratorConfig)	Return an Iterator which iterates over all keys (or the descendants of a parentKey, or those in a KeyRange).

Methods in oracle.kv with parameters of type Key

Modifier and Type	Method	Description
int	Key.compareTo(Key otherKey)	Compares this Key with the specified Key for order.
Operation	OperationFactory.createDelete(Key key)	Create a Delete operation suitable for use as an argument to the execute method.
Operation	OperationFactory.createDelete(Key key, ReturnValueVersion.Choice prevReturn, boolean abortIfUnsuccessful)	Create a Delete operation suitable for use as an argument to the execute method.
Operation	OperationFactory.createDeleteIfVersion(Key key, Version version)	Create a Delete operation suitable for use as an argument to the execute method.
Operation	OperationFactory.createDeleteIfVersion(Key key, Version version, ReturnValueVersion.Choice prevReturn, boolean abortIfUnsuccessful)	Create a Delete operation suitable for use as an argument to the execute method.
Operation	OperationFactory.createPut(Key key, Value value)	Create a Put operation suitable for use as an argument to the execute method.
Operation	OperationFactory.createPut(Key key, Value value, ReturnValueVersion.Choice prevReturn, boolean abortIfUnsuccessful)	Create a Put operation suitable for use as an argument to the execute method.
Operation	OperationFactory.createPutIfAbsent(Key key, Value value)	Create a Put operation suitable for use as an argument to the execute method.
Operation	OperationFactory.createPutIfAbsent(Key key, Value value, ReturnValueVersion.Choice prevReturn, boolean abortIfUnsuccessful)	Create a Put operation suitable for use as an argument to the execute method.
Operation	OperationFactory.createPutIfPresent(Key key, Value value)	Create a Put operation suitable for use as an argument to the execute method.
Operation	OperationFactory.createPutIfPresent(Key key, Value value, ReturnValueVersion.Choice prevReturn, boolean abortIfUnsuccessful)	Create a Put operation suitable for use as an argument to the execute method.
Operation	OperationFactory.createPutIfVersion(Key key, Value value, Version version)	Create a Put operation suitable for use as an argument to the execute method.
Operation	OperationFactory.createPutIfVersion(Key key, Value value, Version version, ReturnValueVersion.Choice prevReturn, boolean abortIfUnsuccessful)	Create a Put operation suitable for use as an argument to the execute method.
boolean	KVStore.delete(Key key)	Delete the key/value pair associated with the key.
boolean	KVStore.delete(Key key, ReturnValueVersion prevValue, Durability durability, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Delete the key/value pair associated with the key.
boolean	KVStore.deleteIfVersion(Key key, Version matchVersion)	Delete a key/value pair, but only if the version of the existing value matches the matchVersion argument.
boolean	KVStore.deleteIfVersion(Key key, Version matchVersion, ReturnValueVersion prevValue, Durability durability, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Delete a key/value pair, but only if the version of the existing value matches the matchVersion argument.
ValueVersion	KVStore.get(Key key)	Get the value associated with the key.
ValueVersion	KVStore.get(Key key, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Get the value associated with the key.
boolean	KeyRange.inRange(Key parentKey, Key checkKey)	Returns true if a Key is within the bounds of this range with respect to a parent Key.
boolean	Key.isPrefix(Key otherKey)	Returns true if this key is a prefix of the key supplied as the argument.
int	KVStore.multiDelete(Key parentKey, KeyRange subRange, Depth depth)	Deletes the descendant Key/Value pairs associated with the parentKey.
int	KVStore.multiDelete(Key parentKey, KeyRange subRange, Depth depth, Durability durability, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Deletes the descendant Key/Value pairs associated with the parentKey.
java.util.SortedMap<Key,ValueVersion>	KVStore.multiGet(Key parentKey, KeyRange subRange, Depth depth)	Returns the descendant key/value pairs associated with the parentKey.
java.util.SortedMap<Key,ValueVersion>	KVStore.multiGet(Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Returns the descendant key/value pairs associated with the parentKey.
java.util.Iterator<KeyValueVersion>	KVStore.multiGetIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth)	The iterator form of KVStore.multiGet(Key, KeyRange, Depth).
java.util.Iterator<KeyValueVersion>	KVStore.multiGetIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	The iterator form of KVStore.multiGet(Key, KeyRange, Depth, Consistency, long, TimeUnit).
java.util.SortedSet<Key>	KVStore.multiGetKeys(Key parentKey, KeyRange subRange, Depth depth)	Returns the descendant keys associated with the parentKey.
java.util.SortedSet<Key>	KVStore.multiGetKeys(Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Returns the descendant keys associated with the parentKey.
java.util.Iterator<Key>	KVStore.multiGetKeysIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth)	The iterator form of KVStore.multiGetKeys(Key, KeyRange, Depth).
java.util.Iterator<Key>	KVStore.multiGetKeysIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	The iterator form of KVStore.multiGetKeys(Key, KeyRange, Depth, Consistency, long, TimeUnit).
Version	KVStore.put(Key key, Value value)	Put a key/value pair, inserting or overwriting as appropriate.
Version	KVStore.put(Key key, Value value, ReturnValueVersion prevValue, Durability durability, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Put a key/value pair, inserting or overwriting as appropriate.
Version	KVStore.putIfAbsent(Key key, Value value)	Put a key/value pair, but only if no value for the given key is present.
Version	KVStore.putIfAbsent(Key key, Value value, ReturnValueVersion prevValue, Durability durability, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Put a key/value pair, but only if no value for the given key is present.
Version	KVStore.putIfPresent(Key key, Value value)	Put a key/value pair, but only if a value for the given key is present.
Version	KVStore.putIfPresent(Key key, Value value, ReturnValueVersion prevValue, Durability durability, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Put a key/value pair, but only if a value for the given key is present.
Version	KVStore.putIfVersion(Key key, Value value, Version matchVersion)	Put a key/value pair, but only if the version of the existing value matches the matchVersion argument.
Version	KVStore.putIfVersion(Key key, Value value, Version matchVersion, ReturnValueVersion prevValue, Durability durability, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Put a key/value pair, but only if the version of the existing value matches the matchVersion argument.
java.util.Iterator<KeyValueVersion>	KVStore.storeIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth)	Return an Iterator which iterates over all key/value pairs (or the descendants of a parentKey, or those in a KeyRange) in unsorted order.
java.util.Iterator<KeyValueVersion>	KVStore.storeIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Return an Iterator which iterates over all key/value pairs (or the descendants of a parentKey, or those in a KeyRange) in unsorted order.
ParallelScanIterator<KeyValueVersion>	KVStore.storeIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit, StoreIteratorConfig storeIteratorConfig)	Return an Iterator which iterates over all key/value pairs (or the descendants of a parentKey, or those in a KeyRange).
java.util.Iterator<Key>	KVStore.storeKeysIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth)	Return an Iterator which iterates over all keys (or the descendants of a parentKey, or those in a KeyRange) in unsorted order.
java.util.Iterator<Key>	KVStore.storeKeysIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit)	Return an Iterator which iterates over all keys (or the descendants of a parentKey, or those in a KeyRange) in unsorted order.
ParallelScanIterator<Key>	KVStore.storeKeysIterator(Direction direction, int batchSize, Key parentKey, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit, StoreIteratorConfig storeIteratorConfig)	Return an Iterator which iterates over all keys (or the descendants of a parentKey, or those in a KeyRange).

Method parameters in oracle.kv with type arguments of type Key

Modifier and Type	Method	Description
ParallelScanIterator<KeyValueVersion>	KVStore.storeIterator(java.util.Iterator<Key> parentKeyIterator, int batchSize, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit, StoreIteratorConfig storeIteratorConfig)	Returns an Iterator which iterates over all key/value pairs matching the keys supplied by iterator (or the descendants of a parentKey, or those in a KeyRange).
ParallelScanIterator<KeyValueVersion>	KVStore.storeIterator(java.util.List<java.util.Iterator<Key>> parentKeyIterators, int batchSize, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit, StoreIteratorConfig storeIteratorConfig)	Returns an Iterator which iterates over all key/value pairs matching the keys supplied by iterators (or the descendants of a parentKey, or those in a KeyRange).
ParallelScanIterator<Key>	KVStore.storeKeysIterator(java.util.Iterator<Key> parentKeyIterator, int batchSize, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit, StoreIteratorConfig storeIteratorConfig)	Return an Iterator which iterates over all keys matching the keys supplied by iterator (or the descendants of a parentKey, or those in a KeyRange).
ParallelScanIterator<Key>	KVStore.storeKeysIterator(java.util.List<java.util.Iterator<Key>> parentKeyIterators, int batchSize, KeyRange subRange, Depth depth, Consistency consistency, long timeout, java.util.concurrent.TimeUnit timeoutUnit, StoreIteratorConfig storeIteratorConfig)	Return an Iterator which iterates over all keys matching the keys supplied by iterators (or the descendants of a parentKey, or those in a KeyRange).

Constructors in oracle.kv with parameters of type Key

Constructor	Description
KeyValue(Key key, Value value)	Creates a KeyValue, key and value should be non-null.

Uses of Key in oracle.kv.coherence

Methods in oracle.kv.coherence that return Key

Modifier and Type	Method	Description
Key	CacheKeyMapper.mapCacheKey(java.lang.Object keyObject)	Given an object that represents an Oracle Coherence cache key, return an Oracle NoSQL Database Key.

Uses of Key in oracle.kv.hadoop

Methods in oracle.kv.hadoop with parameters of type Key

Modifier and Type	Method	Description
static void	KVInputFormatBase.setParentKey(Key parentKey)	Specifies the parent key whose "child" KV pairs are to be returned by the InputFormat.

Uses of Key in oracle.kv.lob

Methods in oracle.kv.lob with parameters of type Key

Modifier and Type	Method	Description
Version	KVLargeObject.appendLOB(Key lobKey, java.io.InputStream lobAppendStream, Durability durability, long lobTimeout, java.util.concurrent.TimeUnit timeoutUnit)	Appends to a value of an existing LOB key/value pair.
boolean	KVLargeObject.deleteLOB(Key lobKey, Durability durability, long lobTimeout, java.util.concurrent.TimeUnit timeoutUnit)	Deletes the LOB associated with the key.
InputStreamVersion	KVLargeObject.getLOB(Key lobKey, Consistency consistency, long lobTimeout, java.util.concurrent.TimeUnit timeoutUnit)	Returns an InputStream representing the underlying LOB value associated with the key.
Version	KVLargeObject.putLOB(Key lobKey, java.io.InputStream lobStream, Durability durability, long lobTimeout, java.util.concurrent.TimeUnit timeoutUnit)	Put a key/LOB value pair, inserting new value or overwriting an existing pair as appropriate.
Version	KVLargeObject.putLOBIfAbsent(Key lobKey, java.io.InputStream lobStream, Durability durability, long lobTimeout, java.util.concurrent.TimeUnit timeoutUnit)	Put a key/LOB value pair, but only if the key either has no value or has a partially inserted or deleted LOB value present.
Version	KVLargeObject.putLOBIfPresent(Key lobKey, java.io.InputStream lobStream, Durability durability, long lobTimeout, java.util.concurrent.TimeUnit timeoutUnit)	Put a key/LOB value pair, but only if a complete value for the given key is present.