API Reference¶
borneo Package¶
Classes¶
Cloud service only |
|
AuthorizationProvider is a callback interface used by the driver to obtain an authorization string for a request. |
|
|
Cloud service only. |
Set the consistency for read requests. |
|
|
Durability defines the durability characteristics associated with a standalone write (put or update) operation. |
|
Default retry handler. |
Represents the input to a |
|
Represents the result of a |
|
Cloud service only |
|
|
FieldRange defines a range of values to be used in a |
Represents the argument of a |
|
Represents the result of a |
|
Represents the input to a |
|
Represents the result of a |
|
Represents the argument of a |
|
|
Exception class that is used when an invalid argument was passed, this could mean that the type is not the expected or the value is not valid for the specific case. |
|
Exception that is thrown when a method has been invoked at an illegal or inappropriate time. |
|
The operation attempted to create an index for a table but the named index already exists. |
|
IndexInfo represents the information about a single index including its name, field names and field types. |
|
The operation attempted to access a index that does not exist or is not in a visible state. |
|
The exception is thrown if the application presents an invalid authorization string in a request. |
Represents the argument of a |
|
Represents the result of a |
|
Represents the input to a |
|
Represents the result of a |
|
|
A base class for most exceptions thrown by the NoSQL driver. |
|
NoSQLHandle is a handle that can be used to access Oracle NoSQL tables. |
|
An instance of this class is required by |
|
The operation attempted is not supported. |
A single Result associated with the execution of an individual operation in a |
|
|
Cloud service only. |
|
A class encapsulating a prepared query statement. |
A request that encapsulates a query prepare call. |
|
The result of a prepare operation. |
|
Set the put option for put requests. |
|
Represents the input to a |
|
Represents the result of a |
|
A request that represents a query. |
|
|
QueryResult comprises a list of dict instances representing the query results. |
|
QueryIterableResult comprises an iterable list of dict instances representing all the query results. |
|
Cloud service only. |
|
Cloud service only. |
|
Cloud service only. |
|
Cloud service only |
ReplicaStats contains information about replica lag for a specific replica. |
|
Cloud service only |
|
Cloud service only |
|
|
A request is a class used as a base for all requests types. |
|
Cloud service only. |
|
Thrown when a request cannot be processed because the configured timeout interval is exceeded. |
|
The operation attempted to create a resource but it already exists. |
Claim keys in the resource principal session token(RPST). |
|
|
The operation attempted to access a resource that does not exist or is not in a visible state. |
|
Result is a base class for result classes for all supported operations. |
RetryHandler is called by the request handling system when a |
|
|
A base class for all exceptions that may be retried with a reasonable expectation that they may succeed on retry. |
|
Cloud service only. |
|
Represents the table state. |
|
StatsControl allows user to control the collection of driver statistics at |
|
The following semantics are attached to the StatsProfile values: |
|
An exception that is thrown when there is an internal system problem. |
On-premises only. |
|
On-premise only. |
|
On-premises only. |
|
On-premises only. |
|
|
The operation attempted to create a table but the named table already exists. |
|
Cloud service only. |
|
The operation attempted to access a table that does not exist or is not in a visible state. |
|
Cloud service only |
TableRequest is used to create, modify, and drop tables. |
|
TableResult is returned from |
|
|
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. |
Cloud service only. |
|
Cloud service only. |
|
|
Cloud service only. |
|
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. |
|
The time unit to use. |
|
The exception is thrown if the server does not support the current query protocol version :versionadded:: 5.4.2 |
|
On-premises only. |
|
Version is an opaque class that represents the version of a row in the database. |
Represents the input to a |
|
Represents the result of a |
|
|
Cloud service only. |
borneo.iam Package¶
Classes¶
|
Cloud service only. |
borneo.kv Package¶
Classes¶
|
On-premise only. |
|
On-premise only. |