cache

Documentation

Index

• type Config
  • func FromAny(prov docs.Provider, value any) (conf Config, err error)
  • func NewConfig() Config
• type TTLItem
• type V1
  • func MetricsForCache(c V1, stats metrics.Type) V1

Types

type Config

type Config struct {
	Label  string `json:"label" yaml:"label"`
	Type   string `json:"type" yaml:"type"`
	Plugin any    `json:"plugin,omitempty" yaml:"plugin,omitempty"`
}

Config is the all encompassing configuration struct for all cache types. Deprecated: Do not add new components here. Instead, use the public plugin APIs. Examples can be found in: ./internal/impl.

func FromAny

func FromAny(prov docs.Provider, value any) (conf Config, err error)

func NewConfig

func NewConfig() Config

NewConfig returns a configuration struct fully populated with default values.

type TTLItem

type TTLItem struct {
	Value []byte
	TTL   *time.Duration
}

TTLItem contains a value to cache along with an optional TTL.

type V1

type V1 interface {
	// Get attempts to locate and return a cached value by its key, returns an
	// error if the key does not exist or if the command fails.
	Get(ctx context.Context, key string) ([]byte, error)

	// Set attempts to set the value of a key, returns an error if the command
	// fails.
	Set(ctx context.Context, key string, value []byte, ttl *time.Duration) error

	// SetMulti attempts to set the value of multiple keys, returns an error if
	// any of the keys fail.
	SetMulti(ctx context.Context, items map[string]TTLItem) error

	// Add attempts to set the value of a key only if the key does not already
	// exist, returns an error if the key already exists or if the command
	// fails.
	Add(ctx context.Context, key string, value []byte, ttl *time.Duration) error

	// Delete attempts to remove a key. Returns an error if a failure occurs.
	Delete(ctx context.Context, key string) error

	// Close the component, blocks until either the underlying resources are
	// cleaned up or the context is cancelled. Returns an error if the context
	// is cancelled.
	Close(ctx context.Context) error
}

V1 Defines a common interface of cache implementations.

func MetricsForCache

func MetricsForCache(c V1, stats metrics.Type) V1

MetricsForCache wraps a cache with a struct that adds standard metrics over each method.