Module graphql.dataloader
ballerina/graphql.dataloader Ballerina library
This package does not have any public APIs.
Classes
graphql.dataloader: DefaultDataLoader
Represents a default implementation of the DataLoader.
Constructor
Initializes the DataLoader with the given batch function.
init (BatchLoadFunction loadFunction)- loadFunction BatchLoadFunction - The batch function to be used
add
function add(anydata key)Collects a key to perform a batch operation at a later time.
Parameters
- key anydata - The key to load later
get
function get(anydata key, typedesc<anydata> 'type) returns 'type|errorRetrieves the result for a particular key.
Parameters
- key anydata - The key to retrieve the result
- 'type typedesc<anydata> (default <>) - The type of the result
Return Type
- 'type|error - The result for the key on success, error on failure
dispatch
function dispatch()Dispatches a user-defined batch load operation for all keys that have been collected.
clearAll
function clearAll()Clears all the keys and results from the data loader cache.
Object types
graphql.dataloader: DataLoader
Represents a DataLoader object that can be used to load data from a data source.
add
function add(anydata key)Collects a key to perform a batch operation at a later time.
Parameters
- key anydata - The key to load later
get
function get(anydata key, typedesc<anydata> 'type) returns 'type|errorRetrieves the result for a particular key.
Parameters
- key anydata - The key to retrieve the result
- 'type typedesc<anydata> (default <>) - The type of the result
Return Type
- 'type|error - The result for the key on success, error on failure
dispatch
function dispatch()Dispatches a user-defined batch load operation for all keys that have been collected.
clearAll
function clearAll()Clears all the keys and results from the data loader cache.
Function types
graphql.dataloader: BatchLoadFunction
function(readonly & anydata[]) returns (anydata[]|error)BatchLoadFunction
Represents the type of the batch function to be used in the DataLoader.