# Uses of Package
oracle.kv

- Packages that use oracle.kv
  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.coherence | This package contains the public API for integration of the 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.table | Table support for Oracle NoSQL Database.

- Classes in oracle.kv used by oracle.kv
  Class and Description
  AuthenticationFailureException This exception is thrown if an application passes invalid credentials to a KVStore authentication operation.
  Consistency Used to provide consistency guarantees for read operations.
  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.
  FaultException Used to indicate an error condition that cannot normally be handled by the caller of the method, except by retrying the operation.
  Key The Key in a Key/Value store.
  KeyRange Defines a range of Key components for use in multiple-key operations and iterations.
  KeyValueVersion Represents a key/value pair along with its version.
  KVSecurityConstants The KVSecurityConstants interface defines constants used for security configuration.
  KVSecurityException The common 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.
  KVVersion Oracle NoSQL DB version information.
  LoginCredentials The common interface of KVStore credential class implementations.
  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 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.
  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.
  RequestTimeoutException Thrown when a request cannot be processed because the configured timeout interval is exceeded.
  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.
  StoreIteratorConfig The configuration object for `KVStore.storeIterator(Direction, int, Key, KeyRange, Depth, Consistency, long, TimeUnit, StoreIteratorConfig)`.
  Value The Value in a Key/Value store.
  Value.Format Identifies the format of a value.
  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.

- Classes in oracle.kv used by oracle.kv.avro
  Class and Description
  Consistency Used to provide consistency guarantees for read operations.
  FaultException Used to indicate an error condition that cannot normally be handled by the caller of the method, except by retrying the operation.
  Value The Value in a Key/Value store.
  ValueBinding Generic interface for translating between `Value`s (stored byte arrays) and typed objects representing that value.

- Classes in oracle.kv used by oracle.kv.coherence
  Class and Description
  Key The Key in a Key/Value store.

- Classes in oracle.kv used by oracle.kv.exttab
  Class and Description
  KeyValueVersion Represents a key/value pair along with its version.
  KVStore KVStore is the handle to a store that is running remotely.

- Classes in oracle.kv used by oracle.kv.hadoop
  Class and Description
  Consistency Used to provide consistency guarantees for read operations.
  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.
  Key The Key in a Key/Value store.
  KeyRange Defines a range of Key components for use in multiple-key operations and iterations.
  KeyValueVersion Represents a key/value pair along with its version.
  KVStore KVStore is the handle to a store that is running remotely.

- Classes in oracle.kv used by oracle.kv.lob
  Class and Description
  Consistency Used to provide consistency guarantees for read operations.
  ConsistencyException Thrown when a single or multiple-operation transaction fails because the specified `Consistency` could not be met, within the allowed timeout period.
  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.
  DurabilityException Thrown when write operations cannot be initiated because a quorum of Replicas as determined by the `Durability.ReplicaAckPolicy` was not available.
  FaultException Used to indicate an error condition that cannot normally be handled by the caller of the method, except by retrying the operation.
  Key The Key in a Key/Value store.
  RequestTimeoutException Thrown when a request cannot be processed because the configured timeout interval is exceeded.
  Version A Version refers to a specific version of a key-value pair.

- Classes in oracle.kv used by oracle.kv.table
  Class and Description
  Consistency Used to provide consistency guarantees for read operations.
  ConsistencyException Thrown when a single or multiple-operation transaction fails because the specified `Consistency` could not be met, within the allowed timeout period.
  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.
  DurabilityException Thrown when write operations cannot be initiated because a quorum of Replicas as determined by the `Durability.ReplicaAckPolicy` was not available.
  FaultException Used to indicate an error condition that cannot normally be handled by the caller of the method, except by retrying the operation.
  OperationExecutionException Used to indicate a failure to execute a sequence of operations.
  ParallelScanIterator Interface to the specialized Iterator type returned by the `Parallel Scan version` of storeIterator().
  RequestTimeoutException Thrown when a request cannot be processed because the configured timeout interval is exceeded.
  Version A Version refers to a specific version of a key-value pair.

Copyright (c) 2011, 2014 Oracle and/or its affiliates. All rights reserved.