dataloader

v1.0.8

dataloader v1.0.8 Dataloader.Source protocol View Source

Link to this section Summary

Types

batch_key()
item_key()
t()

Functions

fetch(source, batch_key, item_key)

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

load(source, batch_key, item_key)

Enqueue an item to be loaded under a given batch

pending_batches?(source)

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

put(source, batch_key, item_key, item)

Put a value into the results.

run(source)

Run any batches queued up for this source.

timeout(source)

Returns the timeout (in ms) for the source.

Link to this section Types

Link to this type

batch_key()

View Source 
batch_key() :: term()
Link to this type

item_key()

View Source 
item_key() :: term()
Link to this type

t()

View Source 
t() :: term()

Link to this section Functions

Link to this function

fetch(source, batch_key, item_key)

View Source 
fetch(t(), batch_key(), item_key()) :: {:ok, term()} | {:error, term()}

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

Link to this function

load(source, batch_key, item_key)

View Source 
load(t(), batch_key(), item_key()) :: t()

Enqueue an item to be loaded under a given batch

Link to this function

pending_batches?(source)

View Source 
pending_batches?(t()) :: boolean()

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

Link to this function

put(source, batch_key, item_key, item)

View Source 
put(t(), batch_key(), item_key(), term()) :: t()

Put a value into the results.

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

Link to this function

run(source)

View Source 
run(t()) :: t()

Run any batches queued up for this source.

Link to this function

timeout(source)

View Source 
timeout(t()) :: number()

Returns the timeout (in ms) for the source.

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