Show / Hide Table of Contents

Class 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.

Inheritance
System.Object
AsyncQldbDriver
Implements
IAsyncQldbDriver
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Amazon.QLDB.Driver
Assembly: Amazon.QLDB.Driver.dll
Syntax
public class AsyncQldbDriver : IAsyncQldbDriver, IDisposable

Methods

| Improve this Doc View Source

Builder()

Retrieve a builder object for creating a AsyncQldbDriver.

Declaration
public static AsyncQldbDriverBuilder Builder()
Returns
Type Description
AsyncQldbDriverBuilder

The builder object for creating a AsyncQldbDriver.

| Improve this Doc View Source

Dispose()

Close this driver and end all sessions in the current pool. No-op if already closed.

Declaration
public void Dispose()
| Improve this Doc View Source

Execute(Func<AsyncTransactionExecutor, Task>, RetryPolicy, CancellationToken)

Declaration
public async Task Execute(Func<AsyncTransactionExecutor, Task> action, RetryPolicy retryPolicy, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Func<AsyncTransactionExecutor, System.Threading.Tasks.Task> action
RetryPolicy retryPolicy
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

Execute(Func<AsyncTransactionExecutor, Task>, CancellationToken)

Declaration
public async Task Execute(Func<AsyncTransactionExecutor, Task> action, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Func<AsyncTransactionExecutor, System.Threading.Tasks.Task> action
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

Execute<T>(Func<AsyncTransactionExecutor, Task<T>>, RetryPolicy, CancellationToken)

Declaration
public async Task<T> Execute<T>(Func<AsyncTransactionExecutor, Task<T>> func, RetryPolicy retryPolicy, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Func<AsyncTransactionExecutor, System.Threading.Tasks.Task<T>> func
RetryPolicy retryPolicy
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T
| Improve this Doc View Source

Execute<T>(Func<AsyncTransactionExecutor, Task<T>>, CancellationToken)

Declaration
public async Task<T> Execute<T>(Func<AsyncTransactionExecutor, Task<T>> func, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Func<AsyncTransactionExecutor, System.Threading.Tasks.Task<T>> func
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<T>
Type Parameters
Name Description
T
| Improve this Doc View Source

ListTableNames(CancellationToken)

Declaration
public async Task<IEnumerable<string>> ListTableNames(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.String>>

Implements

IAsyncQldbDriver
System.IDisposable
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX