# Package oracle.kv

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

- Related Packages
  Package
  Description
  oracle.kv.coherence
  This package contains the public API for integration of Oracle NoSQL Database with Oracle Coherence.
  oracle.kv.exttab
  This package contains the public API and Utilities for accessing Oracle NoSQL Database data through Oracle Database External Tables.
  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.
  oracle.kv.pubsub
  Provides the classes used to define a Subscription to all logical changes (table row puts and deletes) made to a NoSQL store.
  oracle.kv.query
  This package contains the majority of the public API for using Oracle NoSQL Database query language.
  oracle.kv.stats
  Statistics for Oracle NoSQL Database.
  oracle.kv.table
  Table support for Oracle NoSQL Database.
  oracle.kv.txn
- Class
  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.
  BulkWriteOptions
  BulkWriteOptions is used to configure bulk write operations.
  ChildTableLimitException
  Thrown when an attempt is made to exceeded a table's child limit.
  Consistency
  Used to provide consistency guarantees for read operations.
  Consistency.NoneRequired
  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`.
  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.
  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
  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.
  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.
  DurabilityException
  Thrown when write operations cannot be initiated because a quorum of Replicas as determined by the `Durability.ReplicaAckPolicy` was not available.
  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.
  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.
  IterationSubscription
  A subinterface of `Subscription` implemented by subscriptions supplied when a `Subscriber` subscribes to a `Publisher` associated with an asynchronous table iteration.
  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.
  KVLocalException
  Generic exception class for generating runtime exceptions for KVLocal.
  KVSecurityConstants
  The KVSecurityConstants interface defines constants used for security configuration.
  KVSecurityException
  The common abstract base class of KVStore security-related exceptions.
  KVStore
  KVStore is the handle to a store that is running remotely.
  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.
  LoginCredentials
  The common interface of KVStore credential class implementations.
  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.
  Operation
  Denotes an Operation in a sequence of operations passed to the `KVStore.execute` method.
  Operation.Type
  The type of operation, as determined by the method used to create it.
  OperationExecutionException
  Used to indicate a failure to execute a sequence of operations.
  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().
  PasswordCredentials
  Username/password credentials.
  PrepareQueryException
  An exception thrown when a prepared query is executed and the query must be re-prepared by the application before it can be executed.
  ReadThroughputException
  Thrown when a read operation cannot be completed because the read throughput rate limit has been exceeded.
  ReauthenticateHandler
  A callback interface used when KVStore authentication has expired and requires renewal.
  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.
  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.
  ReturnValueVersion
  Used with put and delete operations to return the previous value and version.
  ReturnValueVersion.Choice
  Specifies whether to return the value, version, both or neither.
  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.
  StatementResult
  A StatementResult provides information about the execution and outcome of a table statement.
  StatementResult.Kind
  Shows the kind of StatementResult.
  StoreIteratorConfig
  The configuration object for `KVStore.storeIterator(Direction, int, Key, KeyRange, Depth, Consistency, long, TimeUnit, StoreIteratorConfig)`.
  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.
  Value
  The Value in a Key/Value store.
  Value.Format
  Identifies the format of a value.
  ValueBinding<T>
  Deprecated.
  as of 4.0, use the table API instead.
  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.
  WriteThroughputException
  Thrown when a write operation cannot be completed because the write throughput rate limit has been exceeded.