cachex

Documentation

Index

• type BadgerConfig
• type Cache
  • func InitCache(ctx context.Context) (Cache, func(), error)
  • func NewBadgerCache(cfg BadgerConfig, opts ...Option) Cache
  • func NewMemoryCache(cfg MemoryConfig, opts ...Option) Cache
  • func NewRedisCache(cfg RedisConfig, opts ...Option) Cache
  • func NewRedisCacheWithClient(cli *redis.Client, opts ...Option) Cache
  • func NewRedisCacheWithClusterClient(cli *redis.ClusterClient, opts ...Option) Cache
• type MemoryConfig
• type Option
  • func WithDelimiter(delimiter string) Option
• type RedisConfig

Types

type BadgerConfig

type BadgerConfig struct {
	Path string
}

type Cache

type Cache interface {
	Set(ctx context.Context, ns, key, value string, expiration ...time.Duration) error
	Get(ctx context.Context, ns, key string) (string, bool, error)
	GetAndDelete(ctx context.Context, ns, key string) (string, bool, error)
	Exists(ctx context.Context, ns, key string) (bool, error)
	Delete(ctx context.Context, ns, key string) error
	Iterator(ctx context.Context, ns string, fn func(ctx context.Context, key, value string) bool) error
	Close(ctx context.Context) error
}

func InitCache

func InitCache(ctx context.Context) (Cache, func(), error)

func NewBadgerCache

func NewBadgerCache(cfg BadgerConfig, opts ...Option) Cache

func NewMemoryCache

func NewMemoryCache(cfg MemoryConfig, opts ...Option) Cache

func NewRedisCache

func NewRedisCache(cfg RedisConfig, opts ...Option) Cache

func NewRedisCacheWithClient

func NewRedisCacheWithClient(cli *redis.Client, opts ...Option) Cache

func NewRedisCacheWithClusterClient

func NewRedisCacheWithClusterClient(cli *redis.ClusterClient, opts ...Option) Cache

type MemoryConfig

type MemoryConfig struct {
	CleanupInterval time.Duration
}

type Option

type Option func(*options)

func WithDelimiter

func WithDelimiter(delimiter string) Option

type RedisConfig

type RedisConfig struct {
	Addr     string
	Username string
	Password string
	DB       int
}