Package | Description |
---|---|
oracle.kv |
This package contains the public API for using Oracle NoSQL Database.
|
oracle.kv.lob |
The KVLargeObject interface defines the operations used to read and write
Large Objects (LOBs) such as audio and video files.
|
oracle.kv.table |
Table support for Oracle NoSQL Database.
|
Modifier and Type | Method and Description |
---|---|
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,
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,
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,
TimeUnit timeoutUnit)
Get the value associated with the key.
|
void |
KVStore.login(LoginCredentials creds)
Updates the login credentials for this store handle.
|
void |
KVStore.logout()
Logout the store handle.
|
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,
TimeUnit timeoutUnit)
Deletes the descendant Key/Value pairs associated with the
parentKey . |
SortedMap<Key,ValueVersion> |
KVStore.multiGet(Key parentKey,
KeyRange subRange,
Depth depth)
Returns the descendant key/value pairs associated with the
parentKey . |
SortedMap<Key,ValueVersion> |
KVStore.multiGet(Key parentKey,
KeyRange subRange,
Depth depth,
Consistency consistency,
long timeout,
TimeUnit timeoutUnit)
Returns the descendant key/value pairs associated with the
parentKey . |
Iterator<KeyValueVersion> |
KVStore.multiGetIterator(Direction direction,
int batchSize,
Key parentKey,
KeyRange subRange,
Depth depth)
The iterator form of
KVStore.multiGet(Key, KeyRange, Depth) . |
Iterator<KeyValueVersion> |
KVStore.multiGetIterator(Direction direction,
int batchSize,
Key parentKey,
KeyRange subRange,
Depth depth,
Consistency consistency,
long timeout,
TimeUnit timeoutUnit)
The iterator form of
KVStore.multiGet(Key, KeyRange, Depth, Consistency,
long, TimeUnit) . |
SortedSet<Key> |
KVStore.multiGetKeys(Key parentKey,
KeyRange subRange,
Depth depth)
Returns the descendant keys associated with the
parentKey . |
SortedSet<Key> |
KVStore.multiGetKeys(Key parentKey,
KeyRange subRange,
Depth depth,
Consistency consistency,
long timeout,
TimeUnit timeoutUnit)
Returns the descendant keys associated with the
parentKey . |
Iterator<Key> |
KVStore.multiGetKeysIterator(Direction direction,
int batchSize,
Key parentKey,
KeyRange subRange,
Depth depth)
The iterator form of
KVStore.multiGetKeys(Key, KeyRange, Depth) . |
Iterator<Key> |
KVStore.multiGetKeysIterator(Direction direction,
int batchSize,
Key parentKey,
KeyRange subRange,
Depth depth,
Consistency consistency,
long timeout,
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,
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,
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,
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,
TimeUnit timeoutUnit)
Put a key/value pair, but only if the version of the existing value
matches the matchVersion argument.
|
Iterator<KeyValueVersion> |
KVStore.storeIterator(Direction direction,
int batchSize)
Return an Iterator which iterates over all key/value pairs in unsorted
order.
|
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.
|
Iterator<KeyValueVersion> |
KVStore.storeIterator(Direction direction,
int batchSize,
Key parentKey,
KeyRange subRange,
Depth depth,
Consistency consistency,
long timeout,
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,
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).
|
ParallelScanIterator<KeyValueVersion> |
KVStore.storeIterator(Iterator<Key> parentKeyIterator,
int batchSize,
KeyRange subRange,
Depth depth,
Consistency consistency,
long timeout,
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(List<Iterator<Key>> parentKeyIterators,
int batchSize,
KeyRange subRange,
Depth depth,
Consistency consistency,
long timeout,
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).
|
Iterator<Key> |
KVStore.storeKeysIterator(Direction direction,
int batchSize)
Return an Iterator which iterates over all keys in unsorted order.
|
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.
|
Iterator<Key> |
KVStore.storeKeysIterator(Direction direction,
int batchSize,
Key parentKey,
KeyRange subRange,
Depth depth,
Consistency consistency,
long timeout,
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,
TimeUnit timeoutUnit,
StoreIteratorConfig storeIteratorConfig)
Return an Iterator which iterates over all keys (or the descendants of a
parentKey, or those in a KeyRange).
|
ParallelScanIterator<Key> |
KVStore.storeKeysIterator(Iterator<Key> parentKeyIterator,
int batchSize,
KeyRange subRange,
Depth depth,
Consistency consistency,
long timeout,
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(List<Iterator<Key>> parentKeyIterators,
int batchSize,
KeyRange subRange,
Depth depth,
Consistency consistency,
long timeout,
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).
|
Modifier and Type | Method and Description |
---|---|
Version |
KVLargeObject.appendLOB(Key lobKey,
InputStream lobAppendStream,
Durability durability,
long lobTimeout,
TimeUnit timeoutUnit)
Appends to a value of an existing LOB key/value pair.
|
boolean |
KVLargeObject.deleteLOB(Key lobKey,
Durability durability,
long lobTimeout,
TimeUnit timeoutUnit)
Deletes the LOB associated with the key.
|
InputStreamVersion |
KVLargeObject.getLOB(Key lobKey,
Consistency consistency,
long lobTimeout,
TimeUnit timeoutUnit)
Returns an InputStream representing the underlying LOB value associated
with the key.
|
Version |
KVLargeObject.putLOB(Key lobKey,
InputStream lobStream,
Durability durability,
long lobTimeout,
TimeUnit timeoutUnit)
Put a key/LOB value pair, inserting new value or overwriting an existing
pair as appropriate.
|
Version |
KVLargeObject.putLOBIfAbsent(Key lobKey,
InputStream lobStream,
Durability durability,
long lobTimeout,
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,
InputStream lobStream,
Durability durability,
long lobTimeout,
TimeUnit timeoutUnit)
Put a key/LOB value pair, but only if a complete value for the given key
is present.
|
Modifier and Type | Method and Description |
---|---|
boolean |
TableAPI.delete(PrimaryKey key,
ReturnRow prevRow,
WriteOptions writeOptions)
Deletes a row from a table.
|
boolean |
TableAPI.deleteIfVersion(PrimaryKey key,
Version matchVersion,
ReturnRow prevRow,
WriteOptions writeOptions)
Deletes a row from a table but only if its version matches the one
specified in matchVersion.
|
Row |
TableAPI.get(PrimaryKey key,
ReadOptions readOptions)
Gets the
Row associated with the primary key. |
int |
TableAPI.multiDelete(PrimaryKey key,
MultiRowOptions getOptions,
WriteOptions writeOptions)
Deletes multiple rows from a table in an atomic operation.
|
List<Row> |
TableAPI.multiGet(PrimaryKey key,
MultiRowOptions getOptions,
ReadOptions readOptions)
Returns the rows associated with a partial primary key in an
atomic manner.
|
List<PrimaryKey> |
TableAPI.multiGetKeys(PrimaryKey key,
MultiRowOptions getOptions,
ReadOptions readOptions)
Return the rows associated with a partial primary key in an
atomic manner.
|
Version |
TableAPI.put(Row row,
ReturnRow prevRow,
WriteOptions writeOptions)
Puts a row into a table.
|
Version |
TableAPI.putIfAbsent(Row row,
ReturnRow prevRow,
WriteOptions writeOptions)
Puts a row into a table, but only if the row does not exist.
|
Version |
TableAPI.putIfPresent(Row row,
ReturnRow prevRow,
WriteOptions writeOptions)
Puts a row into a table, but only if the row already exists.
|
Version |
TableAPI.putIfVersion(Row row,
Version matchVersion,
ReturnRow prevRow,
WriteOptions writeOptions)
Puts a row, but only if the version of the existing row matches the
matchVersion argument.
|
TableIterator<Row> |
TableAPI.tableIterator(IndexKey key,
MultiRowOptions getOptions,
TableIteratorOptions iterateOptions)
Returns an iterator over the rows associated with an index key.
|
TableIterator<Row> |
TableAPI.tableIterator(Iterator<PrimaryKey> primaryKeyIterator,
MultiRowOptions getOptions,
TableIteratorOptions iterateOptions)
Returns an iterator over the rows matching the primary keys supplied by
iterator (or the rows in ancestor or descendant tables, or those in a
range specified by the MultiRowOptions argument).
|
TableIterator<Row> |
TableAPI.tableIterator(List<Iterator<PrimaryKey>> primaryKeyIterators,
MultiRowOptions getOptions,
TableIteratorOptions iterateOptions)
Returns an iterator over the rows matching the primary keys supplied by
iterator (or the rows in ancestor or descendant tables, or those in a
range specified by the MultiRowOptions argument).
|
TableIterator<Row> |
TableAPI.tableIterator(PrimaryKey key,
MultiRowOptions getOptions,
TableIteratorOptions iterateOptions)
Returns an iterator over the rows associated with a partial primary key.
|
TableIterator<KeyPair> |
TableAPI.tableKeysIterator(IndexKey key,
MultiRowOptions getOptions,
TableIteratorOptions iterateOptions)
Return the keys for matching rows associated with an index key.
|
TableIterator<PrimaryKey> |
TableAPI.tableKeysIterator(Iterator<PrimaryKey> primaryKeyIterator,
MultiRowOptions getOptions,
TableIteratorOptions iterateOptions)
Returns an iterator over the keys matching the primary keys supplied by
iterator (or the rows in ancestor or descendant tables, or those in a
range specified by the MultiRowOptions argument).
|
TableIterator<PrimaryKey> |
TableAPI.tableKeysIterator(List<Iterator<PrimaryKey>> primaryKeyIterators,
MultiRowOptions getOptions,
TableIteratorOptions iterateOptions)
Returns an iterator over the keys matching the primary keys supplied by
iterator (or the rows in ancestor or descendant tables, or those in a
range specified by the MultiRowOptions argument).
|
TableIterator<PrimaryKey> |
TableAPI.tableKeysIterator(PrimaryKey key,
MultiRowOptions getOptions,
TableIteratorOptions iterateOptions)
Returns an iterator over the keys associated with a partial primary key.
|
Copyright (c) 2011, 2015 Oracle and/or its affiliates. All rights reserved.