cache

Documentation

Index

• Variables
• func NewRedisClient(opts *redis.Options, logger *zap.Logger) *redis.Client
• type Cache
  • func New[T any]() *Cache[T]
  • func NewWithTimeout[T any](dur time.Duration) *Cache[T]
  • func (ct *Cache[T]) Del(key string) error
  • func (ct *Cache[T]) Get(key string) (T, bool)
  • func (ct *Cache[T]) Keys() []string
  • func (ct *Cache[T]) Set(key string, value T)
• type CacheConfig
• type CacheProvider
  • func NewCacheProvider[T any](t time.Duration) CacheProvider[T]
• type CacheRam
  • func NewRAMCacheProvider[T any](t time.Duration) *CacheRam[T]
  • func (cc *CacheRam[T]) Del(key string) error
  • func (cc *CacheRam[T]) Get(key string) (T, bool)
  • func (cc *CacheRam[T]) Keys() []string
  • func (cc *CacheRam[T]) Set(key string, value T)
• type CacheWithTTL
• type CachedList
  • func NewCachedList[T any](prefix string, dur time.Duration) CachedList[T]
• type CachedListRedis
  • func (ll *CachedListRedis[T]) Append(ctx context.Context, key string, raw ...T) error
  • func (ll *CachedListRedis[T]) Del(ctx context.Context, key string) error
  • func (ll *CachedListRedis[T]) GetAll(ctx context.Context, key string) ([]T, error)
• type DisabledCache
  • func (dd *DisabledCache[T]) Del(key string) error
  • func (dd *DisabledCache[T]) Get(key string) (T, bool)
  • func (dd *DisabledCache[T]) Keys() []string
  • func (dd *DisabledCache[T]) Set(key string, value T)
• type Hash
  • func NewRedisHashService(client *redis.Client, logger *zap.Logger) Hash
• type RedisConfig
• type RedisHashService
  • func (rs *RedisHashService) Existed(ctx context.Context, key string) (bool, error)
  • func (rs *RedisHashService) GetValues(ctx context.Context, key string, fields ...string) ([]any, error)
  • func (rs *RedisHashService) SetTTL(ctx context.Context, key string, ttl time.Duration)
  • func (rs *RedisHashService) SetValues(ctx context.Context, key string, values map[string]any) error
• type RedisProvider
  • func (r *RedisProvider[T]) Del(key string) error
  • func (r *RedisProvider[T]) Get(key string) (T, bool)
  • func (r *RedisProvider[T]) Keys() []string
  • func (r *RedisProvider[T]) Set(key string, value T)
• type WithKey

Variables

var DefaultLocalCacheItems = 0 //local cache items. it's important for performance & if redis failed.

var DefaultTimeout time.Duration = 30 * time.Minute

Functions

func NewRedisClient

func NewRedisClient(opts *redis.Options, logger *zap.Logger) *redis.Client

Types

type Cache

type Cache[T any] struct {
	// contains filtered or unexported fields
}

func New

func New[T any]() *Cache[T]

func NewWithTimeout

func NewWithTimeout[T any](dur time.Duration) *Cache[T]

func (*Cache[T]) Del

func (ct *Cache[T]) Del(key string) error

func (*Cache[T]) Get

func (ct *Cache[T]) Get(key string) (T, bool)

func (*Cache[T]) Keys

func (ct *Cache[T]) Keys() []string

func (*Cache[T]) Set

func (ct *Cache[T]) Set(key string, value T)

type CacheConfig

type CacheConfig struct {
	Disalbed   bool
	LocalItems int
	TTL        time.Duration
}

type CacheProvider

type CacheProvider[T any] interface {
	Set(key string, value T)
	Get(key string) (T, bool)
	Del(key string) error
	Keys() []string
}

func NewCacheProvider

func NewCacheProvider[T any](t time.Duration) CacheProvider[T]

type CacheRam

type CacheRam[T any] struct {
	// contains filtered or unexported fields
}

func NewRAMCacheProvider

func NewRAMCacheProvider[T any](t time.Duration) *CacheRam[T]

func (*CacheRam[T]) Del

func (cc *CacheRam[T]) Del(key string) error

func (*CacheRam[T]) Get

func (cc *CacheRam[T]) Get(key string) (T, bool)

func (*CacheRam[T]) Keys

func (cc *CacheRam[T]) Keys() []string

func (*CacheRam[T]) Set

func (cc *CacheRam[T]) Set(key string, value T)

type CacheWithTTL

type CacheWithTTL interface {
	GetTTL() time.Duration
}

type CachedList

type CachedList[T any] interface {
	Append(ctx context.Context, key string, raw ...T) error
	GetAll(ctx context.Context, key string) ([]T, error)
	Del(ctx context.Context, key string) error
}

func NewCachedList

func NewCachedList[T any](prefix string, dur time.Duration) CachedList[T]

type CachedListRedis

type CachedListRedis[T any] struct {
	Logger  *zap.Logger
	Client  *redis.Client
	Prefix  string
	Timeout time.Duration
}

func (*CachedListRedis[T]) Append

func (ll *CachedListRedis[T]) Append(ctx context.Context, key string, raw ...T) error

func (*CachedListRedis[T]) Del

func (ll *CachedListRedis[T]) Del(ctx context.Context, key string) error

func (*CachedListRedis[T]) GetAll

func (ll *CachedListRedis[T]) GetAll(ctx context.Context, key string) ([]T, error)

type DisabledCache

type DisabledCache[T any] struct {
	// contains filtered or unexported fields
}

func (*DisabledCache[T]) Del

func (dd *DisabledCache[T]) Del(key string) error

func (*DisabledCache[T]) Get

func (dd *DisabledCache[T]) Get(key string) (T, bool)

func (*DisabledCache[T]) Keys

func (dd *DisabledCache[T]) Keys() []string

func (*DisabledCache[T]) Set

func (dd *DisabledCache[T]) Set(key string, value T)

type Hash

type Hash interface {
	Existed(ctx context.Context, key string) (bool, error)
	SetTTL(ctx context.Context, key string, ttl time.Duration)
	GetValues(ctx context.Context, key string, fields ...string) ([]any, error)
	SetValues(ctx context.Context, key string, values map[string]any) error
}

func NewRedisHashService

func NewRedisHashService(client *redis.Client, logger *zap.Logger) Hash

type RedisConfig

type RedisConfig struct {
	Host       string
	Port       uint
	Account    string
	Passwd     string
	Caroot     string // where is the ca pem file.
	Tls        bool   //TLS enabled ?
	DB         int    // 0: dev, 1: uat, 3: prd
	PoolSize   int
	MinIdle    int
	ClientName string
}

type RedisHashService

type RedisHashService struct {
	Client *redis.Client
	Logger *zap.Logger
}

func (*RedisHashService) Existed

func (rs *RedisHashService) Existed(ctx context.Context, key string) (bool, error)

func (*RedisHashService) GetValues

func (rs *RedisHashService) GetValues(ctx context.Context, key string, fields ...string) ([]any, error)

func (*RedisHashService) SetTTL

func (rs *RedisHashService) SetTTL(ctx context.Context, key string, ttl time.Duration)

func (*RedisHashService) SetValues

func (rs *RedisHashService) SetValues(ctx context.Context, key string, values map[string]any) error

type RedisProvider

type RedisProvider[T any] struct {
	Client *redis.Client
	// contains filtered or unexported fields
}

func (*RedisProvider[T]) Del

func (r *RedisProvider[T]) Del(key string) error

func (*RedisProvider[T]) Get

func (r *RedisProvider[T]) Get(key string) (T, bool)

Get implements CacheProvider.

func (*RedisProvider[T]) Keys

func (r *RedisProvider[T]) Keys() []string

func (*RedisProvider[T]) Set

func (r *RedisProvider[T]) Set(key string, value T)

Set implements CacheProvider.

type WithKey

type WithKey interface {
	Key() string
}