cache

Sep 20, 2024

Changes in this version

type Cache

+ func (c *Cache) Client() redis.UniversalClient

type Option

+ func BatchMultiGets(batchSize int) Option

Aug 8, 2024

Changes in this version

+ func MGetValues[T any](ctx context.Context, c *Cache, keys ...string) ([]T, error)

Feb 29, 2024

Changes in this version

type MultiResult

+ func Scan[T any](ctx context.Context, c *Cache, pattern string) (MultiResult[T], error)

Dec 19, 2023

Changes in this version

type Cache

+ func (c *Cache) ScanKeys(ctx context.Context, pattern string) ([]string, error)

Oct 8, 2023

Changes in this version

type Cache

+ func (c *Cache) MSetWithTTL(ctx context.Context, keyvalues map[string]any, ttl time.Duration) error

+ type CommandError struct

+ Command string

+ Err error

+ Key string

+ func (r CommandError) Error() string

+ type CommandErrors []CommandError

+ func (r CommandErrors) Error() string

+ func (r CommandErrors) Keys() []string

Sep 29, 2023

Changes in this version

type Cache

+ func (c *Cache) MSet(ctx context.Context, keyvalues map[string]any, ttl time.Duration) error

type RedisClient

+ MSet func(ctx context.Context, values ...any) *redis.StatusCmd

+ Pipeline func() redis.Pipeliner

Aug 12, 2023

Changes in this version

+ const InfiniteTTL

+ const KeepTTL

+ func Version() string

type Cache

+ func New(client RedisClient, opts ...Option) *Cache

+ func (c *Cache) Expire(ctx context.Context, key string, ttl time.Duration) error

+ func (c *Cache) ExtendTTL(ctx context.Context, key string, dur time.Duration) error

+ func (c *Cache) GetAndExpire(ctx context.Context, key string, v any, ttl time.Duration) error

+ func (c *Cache) Healthy(ctx context.Context) bool

+ func (c *Cache) TTL(ctx context.Context, key string) (time.Duration, error)

+ func (hs *Cache) AddHook(hook Hook)

+ type CompressionHook func(data []byte) ([]byte, error)

+ type Hook interface

+ CompressHook func(next CompressionHook) CompressionHook

+ DecompressHook func(next CompressionHook) CompressionHook

+ MarshalHook func(next Marshaller) Marshaller

+ UnmarshallHook func(next Unmarshaller) Unmarshaller

type Option

+ func Brotli() Option

+ func JSON() Option

type RedisClient

+ Expire func(ctx context.Context, key string, expiration time.Duration) *redis.BoolCmd

+ GetEx func(ctx context.Context, key string, expiration time.Duration) *redis.StringCmd

+ Ping func(ctx context.Context) *redis.StatusCmd

+ TTL func(ctx context.Context, key string) *redis.DurationCmd

Jun 3, 2023

Changes in this version

+ type Codec interface

+ Deflate func(data []byte) ([]byte, error)

+ Flate func(data []byte) ([]byte, error)

+ func NewCodec(ct CodecType) Codec

+ type CodecType uint8

+ const Flate

+ const GZip

+ const LZ4

+ const None

type Option

+ func Compression(codec Codec) Option

Jan 15, 2023

Changes in this version

type Cache

+ func (c *Cache) Flush(ctx context.Context)

+ func (c *Cache) FlushAsync(ctx context.Context)

+ func (c *Cache) Keys(ctx context.Context) ([]string, error)

type RedisClient

+ FlushDB func(ctx context.Context) *redis.StatusCmd

+ FlushDBAsync func(ctx context.Context) *redis.StatusCmd

+ Scan func(ctx context.Context, cursor uint64, match string, count int64) *redis.ScanCmd

Jan 13, 2023

Changes in this version

+ func IsRetryable(err error) bool

+ func Upsert(ctx context.Context, c *Cache, key string, val T, cb UpsertCallback[T]) error

+ func UpsertTTL(ctx context.Context, c *Cache, key string, val T, cb UpsertCallback[T], ...) error

type RedisClient

+ Watch func(ctx context.Context, fn func(*redis.Tx) error, keys ...string) error

+ type RetryableError struct

+ func (e RetryableError) Error() string

+ func (e RetryableError) IsRetryable() bool

+ type UpsertCallback func(found bool, oldValue T, newValue T) T

Nov 22, 2022

Changes in this version

type Cache

+ func (c *Cache) SetIfAbsent(ctx context.Context, key string, v any, ttl time.Duration) (bool, error)

+ func (c *Cache) SetIfPresent(ctx context.Context, key string, v any, ttl time.Duration) (bool, error)

+ func (c *Cache) SetTTL(ctx context.Context, key string, v any, ttl time.Duration) error

+ type RedisClient interface

+ Del func(ctx context.Context, keys ...string) *redis.IntCmd

+ Get func(ctx context.Context, key string) *redis.StringCmd

+ MGet func(ctx context.Context, keys ...string) *redis.SliceCmd

+ Set func(ctx context.Context, key string, val any, ttl time.Duration) *redis.StatusCmd

+ SetNX func(ctx context.Context, key string, value interface{}, expiration time.Duration) *redis.BoolCmd

+ SetXX func(ctx context.Context, key string, value interface{}, expiration time.Duration) *redis.BoolCmd

Nov 21, 2022

Changes in this version

type Cache

+ func (c *Cache) MGet(ctx context.Context, keys []string, ...) error

+ type MultiResult map[string]T

+ func MGet(ctx context.Context, c *Cache, keys ...string) (MultiResult[R], error)

+ func (mr MultiResult[T]) Get(key string) (T, bool)

+ func (mr MultiResult[T]) IsEmpty() bool

+ func (mr MultiResult[T]) Keys() []string

+ func (mr MultiResult[T]) Values() []T

Nov 18, 2022

Changes in this version

+ var ErrKeyNotFound = errors.New("key not found")

+ type Cache struct

+ func NewCache(redis redisClient, opts ...Option) *Cache

+ func (c *Cache) Delete(ctx context.Context, keys ...string) error

+ func (c *Cache) Get(ctx context.Context, key string, v any) error

+ func (c *Cache) Set(ctx context.Context, key string, v any) error

+ func (c *Cache) SetWithTTL(ctx context.Context, key string, v any, ttl time.Duration) error

+ type Marshaller func(v any) ([]byte, error)

+ func DefaultMarshaller() Marshaller

+ type Option func(c *Cache)

+ func Serialization(mar Marshaller, unmar Unmarshaller) Option

+ type Unmarshaller func(b []byte, v any) error

+ func DefaultUnmarshaller() Unmarshaller