Package oracle.kv

This package contains the public API for using Oracle NoSQL Database.

Interface Summary

Interface	Description
EntryStream<E>	The stream interface that supplies the data (Row or Key/Value pair) to be batched and loaded into the store.
ExecutionFuture	An ExecutionFuture is a Future that provides a handle to an administrative statement that has been issued and is being processed by the kvstore.
ExecutionSubscription	A subinterface of Subscription implemented by subscriptions supplied when a Subscriber subscribes to a Publisher associated with the asynchronous execution of a query.
IterationSubscription	A subinterface of Subscription implemented by subscriptions supplied when a Subscriber subscribes to a Publisher associated with an asynchronous table iteration.
KVSecurityConstants	The KVSecurityConstants interface defines constants used for security configuration.
KVStore	KVStore is the handle to a store that is running remotely.
LoginCredentials	The common interface of KVStore credential class implementations.
Operation	Denotes an Operation in a sequence of operations passed to the KVStore.execute method.
OperationFactory	A factory to create operations that can be batched for execution by KVStore.execute.
OperationResult	The Result associated with the execution of an Operation.
ParallelScanIterator<K>	Interface to the specialized Iterator type returned by the Parallel Scan version of storeIterator().
ReauthenticateHandler	A callback interface used when KVStore authentication has expired and requires renewal.
StatementResult	A StatementResult provides information about the execution and outcome of a table statement.
ValueBinding<T>	Deprecated. as of 4.0, use the table API instead.

Class Summary

Class	Description
BulkWriteOptions	BulkWriteOptions is used to configure bulk write operations.
Consistency	Used to provide consistency guarantees for read operations.
Consistency.Time	A consistency policy which describes the amount of time the Replica is allowed to lag the Master.
Consistency.Version	A consistency policy which ensures that the environment on a Replica node is at least as current as denoted by the specified Key-Value pair Consistency.Version.
Durability	Defines the durability characteristics associated with a standalone write (put or update) operation, or in the case of KVStore.execute with a set of operations performed in a single transaction.
KerberosCredentials	Login credentials for Kerberos authentication.
Key	The Key in a Key/Value store.
KeyRange	Defines a range of Key components for use in multiple-key operations and iterations.
KeyValue	Represents a key/value pair.
KeyValueVersion	Represents a key/value pair along with its version.
KVLocal	KVLocal is a handle for managing embedded Oracle NoSQL Database.
KVLocalConfig	Represents the configuration parameters used to create a KVLocal object.
KVLocalConfig.Builder	Base builder class used to set configuration parameters common to both TCP sockets and Unix domain sockets.
KVLocalConfig.InetBuilder	InetBuilder to help construct a KVLocalConfig instance using TCP sockets.
KVLocalConfig.UnixDomainBuilder	Builder class to help construct a KVLocalConfig instance using Unix domain sockets.
KVStoreConfig	Represents the configuration parameters used to create a handle to an existing KV store.
KVStoreFactory	Factory class used to produce handles to an existing KVStore.
KVVersion	Oracle NoSQL DB version information.
PasswordCredentials	Username/password credentials.
RequestLimitConfig	Describes how requests may be limited so that one or more nodes with long service times don't end up consuming all available threads in the KVS client.
ReturnValueVersion	Used with put and delete operations to return the previous value and version.
StoreIteratorConfig	The configuration object for KVStore.storeIterator(Direction, int, Key, KeyRange, Depth, Consistency, long, TimeUnit, StoreIteratorConfig).
Value	The Value in a Key/Value store.
ValueVersion	Holds a Value and Version that are associated with a given Key.
Version	A Version refers to a specific version of a key-value pair.

Enum Summary

Enum	Description
Depth	Used with multiple-key and iterator operations to specify whether to select (return or operate on) the key-value pair for the parent key, and the key-value pairs for only immediate children or all descendants.
Direction	Used with iterator operations to specify the order that keys are returned.
Durability.ReplicaAckPolicy	A replicated environment makes it possible to increase an application's transaction commit guarantees by committing changes to its replicas on the network.
Durability.SyncPolicy	Defines the synchronization policy to be used when committing a transaction.
Operation.Type	The type of operation, as determined by the method used to create it.
ReturnValueVersion.Choice	Specifies whether to return the value, version, both or neither.
StatementResult.Kind	Shows the kind of StatementResult.
Value.Format	Identifies the format of a value.

Exception Summary

Exception	Description
AuthenticationFailureException	This exception is thrown if an application passes invalid credentials to a KVStore authentication operation.
AuthenticationRequiredException	This exception is thrown when a secured operation is attempted and the client is not currently authenticated.
ChildTableLimitException	Thrown when an attempt is made to exceeded a table's child limit.
ConsistencyException	Thrown when a single or multiple-operation transaction fails because the specified Consistency could not be met, within the allowed timeout period.
ContingencyException	Used to indicate a status condition or result that is not expressed through the return value, and that should normally be handled by the caller of the method.
DurabilityException	Thrown when write operations cannot be initiated because a quorum of Replicas as determined by the Durability.ReplicaAckPolicy was not available.
FastExternalizableException	A common exception base class to support internal serialization facilities.
FaultException	Used to indicate an error condition that cannot normally be handled by the caller of the method, except by retrying the operation.
IndexLimitException	Thrown when an attempt is made to exceeded a table's index limit.
KVLocalException	Generic exception class for generating runtime exceptions for KVLocal.
KVSecurityException	The common abstract base class of KVStore security-related exceptions.
MetadataNotFoundException	The exception is thrown when an expected piece of metadata is not found.
NoSQLRuntimeException	Generic exception class for generating runtime exceptions whose messages are derived from a locale specific message file.
OperationExecutionException	Used to indicate a failure to execute a sequence of operations.
ReadThroughputException	Thrown when a read operation cannot be completed because the read throughput rate limit has been exceeded.
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).
RequestTimeoutException	Thrown when a request cannot be processed because the configured timeout interval is exceeded.
ResourceLimitException	A common exception base class for exceptions related to resource usage.
ServerResourceLimitException	Thrown when the server is unable to handle a request because of resource constraints.
StaleStoreHandleException	Thrown when a KVStore instance is no longer valid.
StoreIteratorException	Thrown by KVStore.storeIterator(Direction, int, Key, KeyRange, Depth, Consistency, long, TimeUnit, StoreIteratorConfig) when an exception occurs.
TableAccessException	Thrown when an operation to a table cannot be completed due to limits on write and possibly read access.
TablePartitionSizeLimitException	Thrown when write operations cannot be completed because a partition size limit has been exceeded.
TableSizeLimitException	Thrown when write operations cannot be completed because a table size limit has been exceeded.
ThroughputLimitException	Thrown when read or write operations cannot be completed because a throughput rate limit has been exceeded.
UnauthorizedException	This exception is thrown from methods where an authenticated user is attempting to perform an operation for which they are not authorized.
WriteThroughputException	Thrown when a write operation cannot be completed because the write throughput rate limit has been exceeded.