dbloader

Documentation

Index

• type Batch
  • func (b *Batch[K, V]) Keys() (output []K)
  • func (b *Batch[K, V]) Load(k K) *V
  • func (b *Batch[K, V]) Resolve(ctx context.Context) error
• type Loader
  • func LoaderFor[K comparable, V any](dbc *db.Connection, opts ...db.InvocationOption) Loader[K, V]
  • func (l Loader[K, V]) New() *Batch[K, V]

Types

type Batch

type Batch[K comparable, V any] struct {
	// contains filtered or unexported fields
}

func (*Batch[K, V]) Keys

func (b *Batch[K, V]) Keys() (output []K)

Keys returns the "scheduled" keys to be fetched.

func (*Batch[K, V]) Load

func (b *Batch[K, V]) Load(k K) *V

Load returns a promise to load a value with a given key.

func (*Batch[K, V]) Resolve

func (b *Batch[K, V]) Resolve(ctx context.Context) error

Resolve resoles the "promises" for the values for given keys and makes the stored pointers point at valid targets.

type Loader

type Loader[K comparable, V any] struct {
	Resolver func(context.Context, ...K) (map[K]V, error)
}

Loader is a specific "batch" of calls to the loader resolver.

func LoaderFor

func LoaderFor[K comparable, V any](dbc *db.Connection, opts ...db.InvocationOption) Loader[K, V]

LoaderFor returns a loader for a given type.

Specifically it uses a `GetMany` command on the dbc to fetch the keys for a given batch.

There are very specific constraints on the types we can use as the values here, specifically the types can only have (1) primary key, and the key values will be resolved with reflection incurring a bit of a performance hit.

func (Loader[K, V]) New

func (l Loader[K, V]) New() *Batch[K, V]