Namespace Oracle.NoSQL.SDK

Classes

AddReplicaOptions

Cloud Service only. Represents options passed to AddReplicaAsync and AddReplicaWithCompletionAsync APIs.

AddReplicaRequest

Represents information about operation performed by AddReplicaAsync and AddReplicaWithCompletionAsync APIs.

AdminOptions

On-premise only. Represents options for admin DDL passed to methods ExecuteAdminAsync and ExecuteAdminWithCompletionAsync.

AdminRequest

On-premise only. Represents information about admin DDL operation performed by ExecuteAdminAsync and ExecuteAdminWithCompletionAsync methods.

AdminResult

On-premise only. Represents the status of an admin DDL operation and related information.

AdminState

On-premise only. Represents the state of the operation performed by ExecuteAdminAsync or ExecuteAdminWithCompletionAsync.

AdminStatusRequest

On-premise only. Represents information about an operation performed by GetAdminStatusAsync(AdminResult, GetAdminStatusOptions, CancellationToken) API.

ArrayValue

Represents an array of FieldValue instances.

AuthorizationException

The exception that is thrown while trying to obtain the authorization information needed to perform an operation on the Oracle NoSQL Database.

AuthorizationStringProvider

Implementation of IAuthorizationProvider that provides the authorization string.

BadProtocolException

The exception that is thrown when an invalid protocol message is received by the driver or the service.

BatchOperationNumberLimitException

Cloud Service/Cloud Simulator only. The exception that is thrown when the number of write operations passed to WriteManyAsync, PutManyAsync(String, IReadOnlyCollection<MapValue>, PutManyOptions, CancellationToken) or DeleteManyAsync(String, IReadOnlyCollection<MapValue>, DeleteManyOptions, CancellationToken) exceeds the system-defined limit.

CapacityMode

For Cloud Service/Cloud Simulator only. CapacityMode specifies the type of capacity that will be set on a table. It is used in table creation and table capacity updates.

ConnectionOptions

Represents options for network connections to Oracle NoSQL Database.

Consistency

Consistency is used to provide consistency guarantees for read operations.

ConsumedCapacity

Cloud Service/Cloud Simulator only. Represents read and write throughput consumed by the operation.

ControlOperationThrottlingException

Cloud Service/Cloud Simulator only. The exception that is thrown when a non-data operation is throttled.

DbType

Represents the type of FieldValue instance. Generally every subclass of FieldValue is represented by its own DbType value, with the exception of MapValue and RecordValue both represented by Map.

DeleteIfVersionOperation

Represents a DeleteIfVersion operation that is part of WriteOperationCollection.

DeleteIfVersionRequest<TRow>

Represents information about Put operation performed by DeleteIfVersionAsync(String, MapValue, RowVersion, DeleteOptions, CancellationToken) API.

DeleteManyOptions

Represents options passed to DeleteManyAsync(String, IReadOnlyCollection<MapValue>, DeleteManyOptions, CancellationToken) API.

DeleteOperation

Represents a Delete operation that is part of WriteOperationCollection.

DeleteOptions

Represent options for the Delete operation.

DeleteRangeContinuationKey

Represents the continuation key for the DeleteRange operation.

DeleteRangeOptions

Represents options for the DeleteRange operation.

DeleteRangeRequest

Represents information about DeleteRange operation performed by DeleteRangeAsync and GetDeleteRangeAsyncEnumerable APIs.

DeleteRangeResult

Represents the result of the DeleteRange operation.

DeleteRequest<TRow>

Represents information about Delete operation performed by DeleteAsync(String, MapValue, DeleteOptions, CancellationToken) API.

DeleteResult<TRow>

Represents the result of the Delete operation.

DeploymentLimitException

Cloud Service/Cloud Simulator only. The exception that is thrown when supplied table limits exceed the maximum allowed.

DoubleValue

Represents a double precision floating point value.

DropReplicaOptions

Cloud Service only. Represents options passed to DropReplicaAsync and DropReplicaWithCompletionAsync APIs.

DropReplicaRequest

Represents information about operation performed by DropReplicaAsync and DropReplicaWithCompletionAsync APIs.

Durability

On-Premise only. Durability specifies the master and replica sync and ack policies to be used for a write operation.

ETagMismatchException

Cloud Service only. The exception that is thrown by table DDL and add/drop replica operations that indicates that MatchETag provided for the operation does not match the current ETag of the table.

EvolutionLimitException

Cloud Service/Cloud Simulator only. The exception that is thrown when an attempt has been made to evolve the schema of a table more times than allowed by the system defined limit.

FieldRange

Defines a range of values to be used in a DeleteRange operation.

FieldValue

FieldValue is the base class for all data items in Oracle NoSQL Database.

GetReplicaStatsOptions

Cloud Service only. Represents options passed to GetReplicaStatsAsync API.

GetReplicaStatsRequest

Represents information about operation performed by GetReplicaStatsAsync API.

GetRequest<TRow>

Represents information about operation performed by GetAsync(String, MapValue, GetOptions, CancellationToken) API.

GetResult<TRow>

Represents the result of GetAsync(String, MapValue, GetOptions, CancellationToken) operation.

GetTableOptions

Represents options passed to GetTableAsync APIs.

GetTableRequest

Represents information about operation performed by GetTableAsync API.

GetTableUsageOptions

Cloud Service/Cloud Simulator only. Represents options passed to GetTableUsageAsync(String, GetTableUsageOptions, CancellationToken) API.

GetTableUsageRequest

Represents information about operation performed by GetTableUsageAsync(String, GetTableUsageOptions, CancellationToken) method.

IAMAuthorizationProvider

Authorization provider for the Oracle NoSQL Database Cloud Service.

IAMCredentials

Represents the credentials used by IAMAuthorizationProvider when authenticating using the specific user identity.

IndexExistsException

The exception that is thrown when attempting to create an index for a table when an index with the same name already exists.

IndexLimitException

Cloud Service/Cloud Simulator only. The exception that is thrown when an attempt has been made to create more indexes on a table than allowed by the system defined limit.

IndexNotFoundException

The exception that is thrown when an operation attempted to access an index that does not exist or is not in a visible state.

IndexResult

Represents the information about a single index including its name and field names.

InstanceMetadataClient

Cloud Service only. A class that allows to retrieve OCI instance metadata.

IntegerValue

Represents a 32-bit signed integer value.

InvalidAuthorizationException

The exception that is thrown when a request presents invalid authorization information to the service.

JsonInputOptions

Represents options passed to FromJsonString(String, JsonInputOptions) and DeserializeFromJson(ref Utf8JsonReader, JsonInputOptions).

JsonOutputOptions

Represents options passed to ToJsonString(JsonOutputOptions) and SerializeAsJson(Utf8JsonWriter, JsonOutputOptions).

JsonParseException

The exception that is thrown by FromJsonString(String, JsonInputOptions) when failed to parse JSON.

KeySizeLimitException

Cloud Service/Cloud Simulator only. The exception that is thrown when an attempt has been made to create a row with a primary key or index key size that exceeds the system defined limit.

KVStoreAuthorizationProvider

Authorization provider for the secure On-Premise Oracle NoSQL Database.

KVStoreCredentials

Represents user credentials used by KVStoreAuthorizationProvider.

ListTablesOptions

Represents options passed to ListTablesAsync(ListTablesOptions, CancellationToken) and GetListTablesAsyncEnumerable(ListTablesOptions, CancellationToken) APIs.

ListTablesRequest

Represents information about operation performed by ListTablesAsync and GetListTablesAsyncEnumerable APIs.

ListTablesResult

Represents the result of ListTables operation.

LongValue

Represents a 64-bit signed integer value.

MapValue

Represents an unordered dictionary with string keys and values of type FieldValue.

NoSQLClient class provides access to Oracle NoSQL Database and can be used both with Oracle NoSQL Database Cloud Service and with On-Premise Oracle NoSQL Database. Methods of this class are used to create and manage tables and indexes, and to read and write data. When used on-premise, they also support admin operations such as managing namespaces, users and roles. All operations are asynchronous and may be used with async/await.

NoSQLConfig

Represents configuration required to instantiate NoSQLClient instance.

NoSQLException

The base class for most exceptions thrown by the driver.

NoSQLRateLimiter

Cloud Service or Cloud Simulator only. Default rate limiter used by the SDK.

NoSQLRetryHandler

Represents the built-in retry handler.

NullValue

Represents SQL NULL value.

NumberValue

Represents a decimal number value.

PreparedStatement

Represents a prepared query statement.

PrepareOptions

Represents options passed to PrepareAsync(String, PrepareOptions, CancellationToken).

PrepareRequest

Represents information about the Prepare operation performed by PrepareAsync(String, PrepareOptions, CancellationToken) API.

PutIfAbsentOperation

Represents a PutIfAbsent operation that is part of WriteOperationCollection.

PutIfAbsentRequest<TRow>

Represents information about Put operation performed by PutIfAbsentAsync(String, MapValue, PutOptions, CancellationToken) API.

PutIfPresentOperation

Represents a PutIfPresent operation that is part of WriteOperationCollection.

PutIfPresentRequest<TRow>

Represents information about Put operation performed by PutIfPresentAsync(String, MapValue, PutOptions, CancellationToken) API.

PutIfVersionOperation

Represents a PutIfVersion operation that is part of WriteOperationCollection.

PutIfVersionRequest<TRow>

Represents information about Put operation performed by PutIfVersionAsync(String, MapValue, RowVersion, PutOptions, CancellationToken) API.

PutManyOptions

Represents options passed to PutManyAsync(String, IReadOnlyCollection<MapValue>, PutManyOptions, CancellationToken) API.

PutOperation

Represents a Put operation that is part of WriteOperationCollection.

PutOptions

Represent options for the Put operation.

PutRequest<TRow>

Represents information about Put operation performed by PutAsync(String, MapValue, PutOptions, CancellationToken) API.

PutResult<TRow>

Represents the result of the Put operation.

QueryContinuationKey

Represents the continuation key for the Query operation.

QueryOptions

Represents options for the Query operation.

QueryRequest

Base class for QueryRequest<TRow>. Only used internally.

QueryRequest<TRow>

Represents information about Query operation performed by QueryAsync and GetQueryAsyncEnumerable APIs.

QueryRequestBase

Base class for prepare and query requests. Only used internally.

QueryResult<TRow>

Represents the result of the Query operation.

ReadRequest

Base class for information about all operations that read a row from a table.

ReadThrottlingException

Cloud Service/Cloud Simulator only. The exception that is thrown when the provisioned read throughput has been exceeded.

RecordValue

Represents an order-preserving dictionary with string keys and values of type FieldValue.

Region

Cloud Service only. Represents the region in the Oracle Cloud Infrastructure.

ReplicaAckPolicy

On-Premise only. ReplicaAckPolicy defines the policy for how commits are handled in a replicated environment.

ReplicaInfo

Cloud Service only. Represents information about a single remote replica of a Global Active table.

ReplicaStatsRecord

Cloud Service only. Instances of this class contain information about replica lag for a specific replica.

ReplicaStatsResult

Cloud Service only. Result returned by GetReplicaStatsAsync. It contains replica statistics for the requested table.

Request

A base class for the requests classes that represent information about operations issued by NoSQLClient APIs.

RequestSizeLimitException

Cloud Service/Cloud Simulator only. The exception that is thrown when the size of a request exceeds the system defined limit.

RequestWithTable

Base class for information about all operations on a specific table.

ResourceExistsException

The exception that is thrown when an operation attempted to create a resource that already exists.

ResourceNotFoundException

The exception that is thrown when an operation attempted to access a resource that does not exist or is not in a visible state.

RetryableException

Base class for all exceptions that may be retried with a reasonable expectation that the retry may succeed.

RowSizeLimitException

Cloud Service/Cloud Simulator only. The exception that is thrown when an has been made to create a row with a size that exceeds the system defined limit.

RowVersion

Represents the version of a row in the database.

SecurityInfoNotReadyException

Cloud Service only. The exception that is thrown when security information is not ready in the system.

ServerException

The exception that indicates an internal service problem.

ServiceResponseException

The exception that is thrown when the service returns unsuccessful HTTP response.

ServiceType

Specifies the type of Oracle NoSQL service that is used by a NoSQLClient instance.

ServiceUnavailableException

The exception that is thrown when the service is unavailable.

StringValue

Represents a string value.

SyncPolicy

On-Premise only. SyncPolicy defines the synchronization policy to be used when committing a transaction.

TableBusyException

The exception that is thrown when a table operation fails because the table is in use or busy.

TableCompletionOptions

Represents options passed to WaitForTableStateAsync(String, TableState, TableCompletionOptions, CancellationToken) and WaitForLocalReplicaInitAsync methods.

TableDDLOptions

Represents options for table DDL passed to methods ExecuteTableDDLAsync ExecuteTableDDLWithCompletionAsync, SetTableLimitsAsync(String, TableLimits, TableDDLOptions, CancellationToken), SetTableLimitsWithCompletionAsync(String, TableLimits, TableDDLOptions, CancellationToken), SetTableTagsAsync(String, IDictionary<String, IDictionary<String, String>>, IDictionary<String, String>, TableDDLOptions, CancellationToken) and SetTableTagsWithCompletionAsync(String, IDictionary<String, IDictionary<String, String>>, IDictionary<String, String>, TableDDLOptions, CancellationToken),

TableDDLRequest

Represents information about table DDL operation performed by ExecuteTableDDLAsync and ExecuteTableDDLWithCompletionAsync methods.

TableExistsException

The exception that is thrown when attempting to a table when a table with the same name already exists.

TableLimitException

Cloud Service/Cloud Simulator only. The exception that is thrown when an attempt has been made to create a number of tables that exceeds the system defined limit.

TableLimits

For Cloud Service/Cloud Simulator only. Table limits are used during table creation to specify the throughput and capacity to be consumed by the table as well as in an operation to change the limits of an existing table.

TableLimitsRequest

Cloud Service Only. Represents information about operation performed by SetTableLimitsAsync(String, TableLimits, TableDDLOptions, CancellationToken) and SetTableLimitsWithCompletionAsync(String, TableLimits, TableDDLOptions, CancellationToken) methods.

TableNotFoundException

The exception that is thrown when an operation attempted to access a table that does not exist or is not in a visible state.

TableNotReadyException

Cloud service only. The exception that is thrown when an operation is attempted on a replicated table that is not yet fully initialized.

TableOperationRequest

Base class for table-level operations such as table DDL, setting table limits, adding and dropping replicas, etc.

TableResult

Represents the static information about a table.

TableSizeLimitException

The exception that is thrown when table size limit has been exceeded by writing more data than the table can support.

TableState

Describes the current state of the table.

TableTagsRequest

Cloud Service Only. Represents information about operation performed by SetTableTagsAsync(String, IDictionary<String, IDictionary<String, String>>, IDictionary<String, String>, TableDDLOptions, CancellationToken) and SetTableTagsWithCompletionAsync(String, IDictionary<String, IDictionary<String, String>>, IDictionary<String, String>, TableDDLOptions, CancellationToken) methods.

TableUsageRecord

Cloud Service/Cloud Simulator only. Table usage records are part of TableUsageResult. Each 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 the storage capacity. In addition the count of throttling exceptions for the period is reported.

Represents information about WriteMany operations performed by WriteManyAsync, PutManyAsync(String, IReadOnlyCollection<MapValue>, PutManyOptions, CancellationToken) and DeleteManyAsync(String, IReadOnlyCollection<MapValue>, DeleteManyOptions, CancellationToken) APIs.