# All Classes and Interfaces

Class
Description
AddReplicaRequest
Cloud service only.
ArrayValue
ArrayValue represents an array of `FieldValue` instances.
AuthenticationException
On-premises only.
AuthorizationProvider
A callback interface used by the driver to obtain an authorization string for a request.
BatchOperationNumberLimitException
Cloud service only.
BinaryValue
A `FieldValue` instance representing a binary value.
BooleanValue
A `FieldValue` instance representing a boolean value.
Consistency
Consistency is used to provide consistency guarantees for read operations.
Consistency.Type
Consistency types
DefaultRetryHandler
Default retry handler.
DefinedTags
Cloud service only.
DeleteRequest
Represents the input to a `NoSQLHandle.delete(oracle.nosql.driver.ops.DeleteRequest)` operation.
DeleteResult
Represents the result of a `NoSQLHandle.delete(oracle.nosql.driver.ops.DeleteRequest)` operation.
DeploymentException
Cloud service only.
DoubleValue
A `FieldValue` instance representing a double value.
DropReplicaRequest
Cloud service only.
Durability
Defines the durability characteristics associated with a standalone write (put or update) operation.
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.
DurableRequest
Represents a base class for operations that support a `Durability` setting.
EvolutionLimitException
Cloud service only.
FieldRange
FieldRange defines a range of values to be used in a `NoSQLHandle.multiDelete(oracle.nosql.driver.ops.MultiDeleteRequest)` operation, as specified in `MultiDeleteRequest.setRange(oracle.nosql.driver.FieldRange)`.
FieldValue
FieldValue is the base class of all data items in the Oracle NoSQL Database Cloud system.
FieldValue.Type
The type of a field.
FreeFormTags
Cloud service only.
GetIndexesRequest
Represents the argument of a `NoSQLHandle.getIndexes(oracle.nosql.driver.ops.GetIndexesRequest)` operation which returns the information of a specific index or all indexes of the specified table, as returned in `GetIndexesResult`.
GetIndexesResult
Represents the result of a `NoSQLHandle.getIndexes(oracle.nosql.driver.ops.GetIndexesRequest)` operation.
GetIndexesResult.IndexInfo
IndexInfo represents the information about a single index including its name and field names.
GetRequest
Represents the input to a `NoSQLHandle.get(oracle.nosql.driver.ops.GetRequest)` operation which returns a single row based on the specified key.
GetResult
Represents the result of a `NoSQLHandle.get(oracle.nosql.driver.ops.GetRequest)` operation.
GetTableRequest
Represents the argument of a `NoSQLHandle.getTable(oracle.nosql.driver.ops.GetTableRequest)` operation which returns static information associated with a table, as returned in `TableResult`.
IndexExistsException
The operation attempted to create an index for a table but the named index already exists.
IndexLimitException
Cloud service only.
IndexNotFoundException
The operation attempted to access a index that does not exist or is not in a visible state.
IntegerValue
A `FieldValue` instance representing an integer value.
InvalidAuthorizationException
The exception is thrown if the application presents an invalid authorization string in a request.
JsonNullValue
A `FieldValue` instance representing an explicit JSON null value in a JSON object or array.
JsonOptions
JsonOptions allows applications to configure how JSON is parsed on input and generated on output.
JsonParseException
An exception indicating a problem parsing JSON.
JsonReader
JsonReader reads a file or string that has JSON objects in it that may represent rows and makes them available using the Iterable interface.
KeySizeLimitException
Cloud service only.
ListTablesRequest
Represents the argument of a `NoSQLHandle.listTables(oracle.nosql.driver.ops.ListTablesRequest)` operation which lists all available tables associated with the identity associated with the handle used for the operation.
ListTablesResult
Represents the result of a `NoSQLHandle.listTables(oracle.nosql.driver.ops.ListTablesRequest)` operation.
LongValue
A `FieldValue` instance representing a long value.
MapValue
MapValue represents a row in a NoSQL Database table.
MultiDeleteRequest
Represents the input to a `NoSQLHandle.multiDelete(oracle.nosql.driver.ops.MultiDeleteRequest)` operation which can be used to delete a range of values that match the primary key and range provided.
MultiDeleteResult
Represents the result of a `NoSQLHandle.multiDelete(oracle.nosql.driver.ops.MultiDeleteRequest)` operation.
NoSQLException
A base exception for most exceptions thrown by the driver.
NoSQLHandle
NoSQLHandle is a handle that can be used to access Oracle NoSQL tables.
NoSQLHandleConfig
NoSQLHandleConfig groups parameters used to configure a `NoSQLHandle`.
NoSQLHandleFactory
Factory class used to produce handles to operate on tables.
NullValue
A `FieldValue` instance representing a null or missing value in a fully-typed schema.
NumberValue
A `FieldValue` instance representing an arbitrary-precision numeric value.
OCIConfigFileReader
Cloud service only.
OCIConfigFileReader.OCIConfigFile
Cloud service only.
OperationNotSupportedException
The operation attempted is not supported.
OperationThrottlingException
Cloud service only.
PreparedStatement
A class encapsulating a prepared query statement.
PrepareQueryException
The query must be recompiled after DDL changes on the tables and/or indexes that are accessed by the query.
PrepareRequest
A request that encapsulates a query prepare call.
PrepareResult
The result of a prepare operation.
PutRequest
Represents the input to a `NoSQLHandle.put(oracle.nosql.driver.ops.PutRequest)` operation.
PutRequest.Option
Specifies a condition for the put operation.
PutResult
Represents the result of a `NoSQLHandle.put(oracle.nosql.driver.ops.PutRequest)` operation.
QueryIterableResult
QueryIterableResult represents an `Iterable` over all the query results.
QueryRequest
A request that represents a query.
QueryResult
QueryResult comprises a list of `MapValue` instances representing the query results.
RateLimiter
RateLimiter interface provides default methods that all rate limiters must implement.
ReadRequest
Represents a base class for read operations such as `NoSQLHandle.get(oracle.nosql.driver.ops.GetRequest)`.
ReadThrottlingException
Cloud service only.
Region
Cloud service only.
ReplicaStatsRequest
Cloud service only.
ReplicaStatsResult
Cloud service only.
ReplicaStatsResult.ReplicaStats
ReplicaStats contains information about replica lag for a specific replica.
Request
A request is an abstract class used as a base for all requests types.
RequestSizeLimitException
Cloud service only.
RequestTimeoutException
Thrown when a request cannot be processed because the configured timeout interval is exceeded.
ResourceExistsException
The operation attempted to create a resource but it already exists.
ResourceLimitException
Cloud service only.
ResourceNotFoundException
The operation attempted to access a resource that does not exist or is not in a visible state.
Result
Result is a base class for result classes for all supported operations.
RetryableException
A base exception for all exceptions that may be retried with a reasonable expectation that they may succeed on retry.
RetryHandler
RetryHandler is called by the request handling system when a `RetryableException` is thrown.
RetryStats
A class that maintains stats on retries during a request.
RowSizeLimitException
Cloud service only.
SDKVersion
Public class to manage SDK version information
SecurityInfoNotReadyException
Cloud service only.
SignatureProvider
Cloud service only.
SignatureProvider.ResourcePrincipalClaimKeys
Claim keys in the resource principal session token(RPST).
StatsControl
This interface allows user to control the collection of driver statistics at runtime.
StatsControl.Profile
A Profile that determines what stats are logged
StatsControl.StatsHandler
Handler interface that user can register to get access to stats at the end of the interval.
StoreAccessTokenProvider
On-premises only.
StringValue
A `FieldValue` instance representing a string value.
SystemException
An exception that is thrown when there is an internal system problem.
SystemRequest
On-premises only.
SystemResult
On-premises only.
SystemResult.State
On-premises only.
SystemStatusRequest
On-premises only.
TableBusyException
Deprecated.
this class is no longer used
TableExistsException
The operation attempted to create a table but the named table already exists.
TableLimitException
Cloud service only.
TableLimits
Cloud service only.
TableLimits.CapacityMode
Table limits option
TableNotFoundException
The operation attempted to access a table that does not exist or is not in a visible state.
TableNotReadyException
Cloud service only.
TableRequest
TableRequest is used to create, modify, and drop tables.
TableResult
TableResult is returned from `NoSQLHandle.getTable(oracle.nosql.driver.ops.GetTableRequest)` and `NoSQLHandle.tableRequest(oracle.nosql.driver.ops.TableRequest)` operations.
TableResult.Replica
Cloud service only.
TableResult.State
The current state of the table
TableSizeException
An exception indicating a table size limit has been exceeded by writing more data than the table can support.
TableUsageRequest
Cloud service only.
TableUsageResult
Cloud service only.
TableUsageResult.TableUsage
TableUsage represents a single usage record, or slice, that includes information about read and write throughput consumed during that period as well as the current information regarding storage capacity.
ThrottlingException
Cloud service only.
TimestampValue
A `FieldValue` instance representing a timestamp value.
TimeToLive
TimeToLive is a utility class that represents a period of time, similar to java.time.Duration in Java, but specialized to the needs of this driver.
UnauthorizedException
The exception is thrown if an application does not have sufficient permission to perform a request.
UnsupportedProtocolException
This exception is thrown if the server does not support the current driver protocol version.
UnsupportedQueryVersionException
This exception is thrown if the server does not support the current query protocol version.
UserInfo
On-premises only.
Version
Version is an opaque class that represents the version of a row in the database.
WriteMultipleRequest
Represents the input to a `NoSQLHandle.writeMultiple(oracle.nosql.driver.ops.WriteMultipleRequest)` operation.
WriteMultipleResult
Represents the result of a `NoSQLHandle.writeMultiple(oracle.nosql.driver.ops.WriteMultipleRequest)` operation.
WriteMultipleResult.OperationResult
The Result associated with the execution of an individual operation in the request.
WriteRequest
Represents a base class for the single row modifying operations `NoSQLHandle.put(oracle.nosql.driver.ops.PutRequest)` and `NoSQLHandle.delete(oracle.nosql.driver.ops.DeleteRequest)`.
WriteResult
A base class for results of single row modifying operations such as put and delete.
WriteThrottlingException
Cloud service only.