dataloader v1.0.4 Dataloader.Source protocol

Link to this section Summary

Functions

Fetch the result found under the given batch and item keys

Enqueue an item to be loaded under a given batch

Determine if there are any batches that have not yet been run

Put a value into the results

Run any batches queued up for this source

Returns the timeout (in ms) for the source

Link to this section Types

Link to this type batch_key()
batch_key() :: term()
Link to this type item_key()
item_key() :: term()

Link to this section Functions

Link to this function fetch(source, batch_key, item_key)

Fetch the result found under the given batch and item keys.

Link to this function load(source, batch_key, item_key)

Enqueue an item to be loaded under a given batch

Link to this function pending_batches?(source)

Determine if there are any batches that have not yet been run.

Link to this function put(source, batch_key, item_key, item)

Put a value into the results.

Useful for warming caches. The source is permitted to reject the value.

Run any batches queued up for this source.

Link to this function timeout(source)

Returns the timeout (in ms) for the source.

This is important for ensuring the dataloader obeys the timeouts when running multiple sources concurrently