Class BatchDataLoader<TKey, TValue>

Namespace

GreenDonut

Assembly

GreenDonut.dll

The BatchDataLoader is the most commonly used variant of DataLoader and is optimized to fetch multiple items in a single batch from the database.

public abstract class BatchDataLoader<TKey, TValue> : DataLoaderBase<TKey, TValue>, IDataLoader<TKey, TValue>, IDataLoader, IDisposable where TKey : notnull

Type Parameters

TKey

A key type.

TValue

A value type.

Inheritance

object

DataLoaderBase<TKey, TValue>

BatchDataLoader<TKey, TValue>

Implements

IDataLoader<TKey, TValue>

IDataLoader

IDisposable

Inherited Members

DataLoaderBase<TKey, TValue>.LoadAsync(TKey, CancellationToken)

DataLoaderBase<TKey, TValue>.LoadAsync(IReadOnlyCollection<TKey>, CancellationToken)

DataLoaderBase<TKey, TValue>.Remove(TKey)

DataLoaderBase<TKey, TValue>.Set(TKey, Task<TValue>)

DataLoaderBase<TKey, TValue>.TryAddToCache<TItem, TK, TV>(string, IEnumerable<TItem>, Func<TItem, TK>, Func<TItem, TV>)

DataLoaderBase<TKey, TValue>.TryAddToCache<TK, TV>(string, TK, TV)

DataLoaderBase<TKey, TValue>.GetCacheKeyType<TDataLoader>()

DataLoaderBase<TKey, TValue>.GetCacheKeyType(Type)

DataLoaderBase<TKey, TValue>.Dispose()

DataLoaderBase<TKey, TValue>.Dispose(bool)

DataLoaderBase<TKey, TValue>.FetchAsync(IReadOnlyList<TKey>, Memory<Result<TValue>>, CancellationToken)

DataLoaderBase<TKey, TValue>.Clear()

DataLoaderBase<TKey, TValue>.Cache

DataLoaderBase<TKey, TValue>.CacheKeyType

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

DataLoaderExtensions.LoadAsync(IDataLoader, object)

DataLoaderExtensions.LoadAsync(IDataLoader, params object[])

DataLoaderExtensions.LoadAsync(IDataLoader, CancellationToken, params object[])

DataLoaderExtensions.Set(IDataLoader, object, object?)

DataLoaderExtensions.LoadAsync<TKey, TValue>(IDataLoader<TKey, TValue>, params TKey[])

DataLoaderExtensions.LoadAsync<TKey, TValue>(IDataLoader<TKey, TValue>, CancellationToken, params TKey[])

DataLoaderExtensions.Set<TKey, TValue>(IDataLoader<TKey, TValue>, TKey, TValue)

Constructors

BatchDataLoader(IBatchScheduler, DataLoaderOptions?)

Initializes a new instance of the BatchDataLoader<TKey, TValue> class.

protected BatchDataLoader(IBatchScheduler batchScheduler, DataLoaderOptions? options = null)

Parameters

batchScheduler IBatchScheduler

A scheduler to tell the DataLoader when to dispatch buffered batches.

options DataLoaderOptions

An options object to configure the behavior of this particular BatchDataLoader<TKey, TValue>.

Exceptions

ArgumentNullException

Throws if options is null.

Methods

FetchAsync(IReadOnlyList<TKey>, Memory<Result<TValue>>, CancellationToken)

protected override sealed ValueTask FetchAsync(IReadOnlyList<TKey> keys, Memory<Result<TValue>> results, CancellationToken cancellationToken)

Parameters

keys IReadOnlyList<TKey>

results Memory<Result<TValue>>

cancellationToken CancellationToken

Returns

ValueTask

LoadBatchAsync(IReadOnlyList<TKey>, CancellationToken)

Loads the data for a batch from the data source.

protected abstract Task<IReadOnlyDictionary<TKey, TValue>> LoadBatchAsync(IReadOnlyList<TKey> keys, CancellationToken cancellationToken)

Parameters

keys IReadOnlyList<TKey>

The keys that shall be fetched in a batch.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IReadOnlyDictionary<TKey, TValue>>

Returns a dictionary holding the fetched data.