Package | Description |
---|---|
oracle.kv |
This package contains the public API for using Oracle NoSQL Database.
|
oracle.kv.avro |
Binding classes for serializing and deserializing Values as Avro binary data.
|
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 | Class and Description |
---|---|
class |
AuthenticationFailureException
This exception is thrown if an application passes invalid credentials
to a KVStore authentication operation.
|
class |
AuthenticationRequiredException
This exception is thrown when a secured operation is attempted and the
client is not currently authenticated.
|
class |
ConsistencyException
Thrown when a single or multiple-operation transaction fails because the
specified
Consistency could not be met, within the allowed timeout
period. |
class |
DurabilityException
Thrown when write operations cannot be initiated because a quorum of
Replicas as determined by the
Durability.ReplicaAckPolicy was not
available. |
class |
KVSecurityException
The common base class of KVStore security-related exceptions.
|
class |
MetadataNotFoundException
The exception is thrown when an expected piece of metadata is not found.
|
class |
RequestLimitException
Thrown when a request cannot be processed because it would exceed the
maximum number of active requests for a node as configured via
KVStoreConfig.setRequestLimit(oracle.kv.RequestLimitConfig) . |
class |
RequestTimeoutException
Thrown when a request cannot be processed because the configured timeout
interval is exceeded.
|
class |
UnauthorizedException
This exception is thrown from methods where an authenticated user is
attempting to perform an operation for which they are not authorized.
|
Modifier and Type | Method and Description |
---|---|
boolean |
ExecutionFuture.cancel(boolean mayInterruptIfRunning)
Attempts to cancel execution of this statement.
|
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.
|
List<OperationResult> |
KVStore.execute(List<Operation> operations)
This method provides an efficient and transactional mechanism for
executing a sequence of operations associated with keys that share the
same Major Path.
|
List<OperationResult> |
KVStore.execute(List<Operation> operations,
Durability durability,
long timeout,
TimeUnit timeoutUnit)
This method provides an efficient and transactional mechanism for
executing a sequence of operations associated with keys that share the
same Major Path.
|
ExecutionFuture |
KVStore.execute(String statement)
Asynchronously executes a DDL statement.
|
StatementResult |
KVStore.executeSync(String statement)
Synchronously execute a table statement.
|
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.
|
static KVStore |
KVStoreFactory.getStore(KVStoreConfig config)
Get a handle to an existing KVStore.
|
static KVStore |
KVStoreFactory.getStore(KVStoreConfig config,
LoginCredentials creds,
ReauthenticateHandler reauthHandler)
Get a handle to an existing KVStore, with optional authentication
arguments for accessing a secure KVStore instance.
|
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).
|
StatementResult |
ExecutionFuture.updateStatus()
Returns information about the execution of the statement.
|
Modifier and Type | Class and Description |
---|---|
class |
SchemaNotAllowedException
Thrown when a schema is passed to a binding method that is not allowed for
the binding.
|
class |
UndefinedSchemaException
Thrown when the application attempts to use a schema that has not been
defined using the NoSQL Database administration interface.
|
Modifier and Type | Class and Description |
---|---|
class |
PartialLOBException
Thrown when
KVLargeObject.getLOB(oracle.kv.Key, oracle.kv.Consistency, long, java.util.concurrent.TimeUnit) is invoked on a partial LOB. |
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 |
ExecutionFuture.cancel(boolean mayInterruptIfRunning)
Deprecated.
Attempts to cancel execution of this statement.
|
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.
|
List<TableOperationResult> |
TableAPI.execute(List<TableOperation> operations,
WriteOptions writeOptions)
This method provides an efficient and transactional mechanism for
executing a sequence of operations associated with tables that share the
same shard key portion of their primary keys.
|
ExecutionFuture |
TableAPI.execute(String statement)
Deprecated.
since 3.3 in favor of
KVStore.execute(java.util.List<oracle.kv.Operation>) |
StatementResult |
TableAPI.executeSync(String statement)
Deprecated.
since 3.3 in favor of
KVStore.executeSync(java.lang.String) |
Row |
TableAPI.get(PrimaryKey key,
ReadOptions readOptions)
Gets the
Row associated with the primary key. |
Table |
TableAPI.getTable(String tableName)
Gets an instance of a table.
|
Map<String,Table> |
TableAPI.getTables()
Gets all known tables.
|
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.
|
StatementResult |
ExecutionFuture.updateStatus()
Deprecated.
Returns information about the execution of the statement.
|
Copyright (c) 2011, 2015 Oracle and/or its affiliates. All rights reserved.