Namespace Amazon.QLDB.Driver

Classes

AsyncBufferedResult

Implementation of a result which asynchronously buffers all values in memory, rather than stream them from QLDB during retrieval. This implementation should only be used when the result is to be returned after the parent transaction is to be committed.

AsyncQldbDriver

Represents a factory for accessing a specific ledger within QLDB. This class or QldbDriver should be the main entry points to any interaction with QLDB.

This factory pools sessions and attempts to return unused but available sessions when getting new sessions. The pool does not remove stale sessions until a new session is retrieved. The default pool size is the maximum amount of connections the session client allows set in the . Dispose() should be called when this factory is no longer needed in order to clean up resources, ending all sessions in the pool.

AsyncQldbDriverBuilder

Builder object for creating an AsyncQldbDriver, allowing for configuration of the parameters of construction.

AsyncTransactionExecutor

Transaction object used within asynchronous lambda executions to provide a reduced view that allows only the operations that are valid within the context of an active managed transaction.

BaseBufferedResult

Base class for Buffered Result.

BaseQldbDriverBuilder<TBuilder>

BufferedResult

Implementation of a result which buffers all values in memory, rather than stream them from QLDB during retrieval. This implementation should only be used when the result is to be returned after the parent transaction is to be committed.

ExponentBackoffStrategy

The exponential backoff strategy with an equal jitter.

QldbDriver

Represents a factory for accessing a specific ledger within QLDB. This class or AsyncQldbDriver should be the main entry points to any interaction with QLDB.

This factory pools sessions and attempts to return unused but available sessions when getting new sessions. The pool does not remove stale sessions until a new session is retrieved. The default pool size is the maximum amount of connections the session client allows set in the Amazon.Runtime.ClientConfig. Dispose() should be called when this factory is no longer needed in order to clean up resources, ending all sessions in the pool.

QldbDriverBuilder

Builder object for creating a QldbDriver, allowing for configuration of the parameters of construction.

QldbDriverException

Exception type representing exceptions that originate from the QLDB driver, rather than QLDB itself.

QldbTransactionException

The root exception for all transaction related exceptions. It reports back the transaction ID.

RetryPolicy

RetryPolicy used to retry the transactions. The default max retries is 4, and the default backoff strategy is ExponentBackoffStrategy.

RetryPolicy.RetryPolicyBuilder

The builder class of RetryPolicy.

TransactionAbortedException

Exception type representing the abort of a transaction within a lambda execution block. Signals that the lambda should cease to execute and the current transaction should be aborted.

TransactionExecutor

Transaction object used within lambda executions to provide a reduced view that allows only the operations that are valid within the context of an active managed transaction.

Structs

IOUsage

IOUsage struct containing metrics for the amount of IO requests.

RetryPolicyContext

Data struct used to pass retry policy context.

TimingInformation

TimingInformation struct containing metrics for server-side processing time.

Interfaces

IAsyncExecutable

Interface for asynchronous executions of a statement within an active transaction to QLDB.

IAsyncQldbDriver

Interface for the Async QLDB driver.

IAsyncResult

Interface for the result of executing a statement in QLDB. Implements IAsyncEnumerable to allow iteration over Ion values within the result.

Note that due to the fact that a result can only be retrieved from QLDB once, the IAsyncResult may only be iterated over once and is not thread-safe. Attempts to do so multiple times will result in an exception.

IBackoffStrategy

Interface of Backoff Strategy.

IExecutable

Interface for executions of a statement within an active transaction to QLDB.

IQldbDriver

Interface for the QLDB driver.

IQuery<T>

An object encapsulating a query which can be executed against QLDB. The generic type T is the type of each document returned from the database.

IResult

Interface for the result of executing a statement in QLDB. Implements IEnumerable to allow iteration over Ion values within the result.

Note that due to the fact that a result can only be retrieved from QLDB once, the IResult may only be iterated over once and is not thread-safe. Attempts to do so multiple times will result in an exception.

ISerializer

Interface for the Ion serializer.