cache

Documentation

Index

• type UserLoader
  • func NewUserLoader(config UserLoaderConfig) *UserLoader
  • func (l *UserLoader) Clear(key string)
  • func (l *UserLoader) Load(key string) (*example.User, error)
  • func (l *UserLoader) LoadAll(keys []string) ([]*example.User, []error)
  • func (l *UserLoader) LoadAllThunk(keys []string) func() ([]*example.User, []error)
  • func (l *UserLoader) LoadThunk(key string) func() (*example.User, error)
  • func (l *UserLoader) Prime(key string, value *example.User) bool
• type UserLoaderCache
• type UserLoaderConfig
• type UserLoaderGoCache
  • func NewUserLoaderGoCache(conf UserLoaderGoCacheConfig) *UserLoaderGoCache
  • func (c *UserLoaderGoCache) ClearKey(key string)
  • func (c *UserLoaderGoCache) Get(key string) (*example.User, bool)
  • func (c *UserLoaderGoCache) Set(key string, value *example.User)
• type UserLoaderGoCacheConfig
• type UserLoaderMapCache
  • func NewUserLoaderMapCache() *UserLoaderMapCache
  • func (c *UserLoaderMapCache) ClearKey(key string)
  • func (c *UserLoaderMapCache) Get(key string) (*example.User, bool)
  • func (c *UserLoaderMapCache) Set(key string, value *example.User)

Types

type UserLoader

type UserLoader struct {
	// contains filtered or unexported fields
}

UserLoader batches and caches requests

func NewUserLoader

func NewUserLoader(config UserLoaderConfig) *UserLoader

NewUserLoader creates a new UserLoader given a fetch, wait, and maxBatch

func (*UserLoader) Clear

func (l *UserLoader) Clear(key string)

Clear the value at key from the cache, if it exists

func (*UserLoader) Load

func (l *UserLoader) Load(key string) (*example.User, error)

Load a User by key, batching and caching will be applied automatically

func (*UserLoader) LoadAll

func (l *UserLoader) LoadAll(keys []string) ([]*example.User, []error)

LoadAll fetches many keys at once. It will be broken into appropriate sized sub batches depending on how the loader is configured

func (*UserLoader) LoadAllThunk

func (l *UserLoader) LoadAllThunk(keys []string) func() ([]*example.User, []error)

LoadAllThunk returns a function that when called will block waiting for a Users. This method should be used if you want one goroutine to make requests to many different data loaders without blocking until the thunk is called.

func (*UserLoader) LoadThunk

func (l *UserLoader) LoadThunk(key string) func() (*example.User, error)

LoadThunk returns a function that when called will block waiting for a User. This method should be used if you want one goroutine to make requests to many different data loaders without blocking until the thunk is called.

func (*UserLoader) Prime

func (l *UserLoader) Prime(key string, value *example.User) bool

Prime the cache with the provided key and value. If the key already exists, no change is made and false is returned. (To forcefully prime the cache, clear the key first with loader.clear(key).prime(key, value).)

type UserLoaderCache

type UserLoaderCache interface {
	Get(key string) (*example.User, bool)
	Set(key string, value *example.User)
	ClearKey(key string)
}

UserLoaderCache can be used to cache results. A default map based implementation is used by default.

type UserLoaderConfig

type UserLoaderConfig struct {
	// Fetch is a method that provides the data for the loader
	Fetch func(keys []string) ([]*example.User, []error)

	// Wait is how long wait before sending a batch
	Wait time.Duration

	// MaxBatch will limit the maximum number of keys to send in one batch, 0 = not limit
	MaxBatch int

	// Cache is the datastructure used to cache fetched data
	Cache UserLoaderCache
}

UserLoaderConfig captures the config to create a new UserLoader

type UserLoaderGoCache

type UserLoaderGoCache struct {
	// contains filtered or unexported fields
}

func NewUserLoaderGoCache

func NewUserLoaderGoCache(conf UserLoaderGoCacheConfig) *UserLoaderGoCache

func (*UserLoaderGoCache) ClearKey

func (c *UserLoaderGoCache) ClearKey(key string)

func (*UserLoaderGoCache) Get

func (c *UserLoaderGoCache) Get(key string) (*example.User, bool)

func (*UserLoaderGoCache) Set

func (c *UserLoaderGoCache) Set(key string, value *example.User)

type UserLoaderGoCacheConfig

type UserLoaderGoCacheConfig struct {
	DefaultExpiration time.Duration
	CleanupInterval   time.Duration
}

type UserLoaderMapCache

type UserLoaderMapCache struct {
	// contains filtered or unexported fields
}

func NewUserLoaderMapCache

func NewUserLoaderMapCache() *UserLoaderMapCache

func (*UserLoaderMapCache) ClearKey

func (c *UserLoaderMapCache) ClearKey(key string)

func (*UserLoaderMapCache) Get

func (c *UserLoaderMapCache) Get(key string) (*example.User, bool)

func (*UserLoaderMapCache) Set

func (c *UserLoaderMapCache) Set(key string, value *example.User)