redis

Documentation

Overview

Package redis is a simple redis cache implement. base on the package: https://github.com/gomodule/redigo

Example

package main

import (
	"fmt"

	"github.com/gookit/cache/redis"
)

func main() {
	// init driver
	c := redis.Connect("127.0.0.1:6379", "", 0)

	// set
	_ = c.Set("name", "cache value", 60)

	// get
	val := c.Get("name")

	// del
	_ = c.Del("name")

	// get: "cache value"
	fmt.Print(val)
}

Index

• Constants
• type Redigo
  • func Connect(url, pwd string, dbNum int) *Redigo
  • func New(url, pwd string, dbNum int) *Redigo
  • func (c *Redigo) Clear() error
  • func (c *Redigo) Close() error
  • func (c *Redigo) Connect() *Redigo
  • func (c *Redigo) Del(key string) (err error)
  • func (c *Redigo) DelMulti(keys []string) (err error)
  • func (c *Redigo) Get(key string) any
  • func (c *Redigo) GetAs(key string, ptr any) error
  • func (c *Redigo) GetMulti(keys []string) map[string]any
  • func (c *Redigo) Has(key string) bool
  • func (c *Redigo) Pool() *redis.Pool
  • func (c *Redigo) Set(key string, val any, ttl time.Duration) (err error)
  • func (c *Redigo) SetMulti(values map[string]any, ttl time.Duration) (err error)
  • func (c *Redigo) String() string
• type RedisCache

Examples

• Package

Constants

const Name = "redigo"

Name driver name

Types

type Redigo

type Redigo struct {
	cache.BaseDriver
	// contains filtered or unexported fields
}

Redigo driver definition. redigo doc link: https://pkg.go.dev/github.com/gomodule/redigo/redis#pkg-examples

func Connect

func Connect(url, pwd string, dbNum int) *Redigo

Connect create and connect to redis server

func New

func New(url, pwd string, dbNum int) *Redigo

New redis cache

func (*Redigo) Clear

func (c *Redigo) Clear() error

Clear all caches

func (*Redigo) Close

func (c *Redigo) Close() error

Close connection

func (*Redigo) Connect

func (c *Redigo) Connect() *Redigo

Connect to redis server

func (*Redigo) Del

func (c *Redigo) Del(key string) (err error)

Del value by key

func (*Redigo) DelMulti

func (c *Redigo) DelMulti(keys []string) (err error)

DelMulti values by keys

func (*Redigo) Get

func (c *Redigo) Get(key string) any

Get value by key

func (*Redigo) GetAs

func (c *Redigo) GetAs(key string, ptr any) error

GetAs get cache and unmarshal to ptr

func (*Redigo) GetMulti

func (c *Redigo) GetMulti(keys []string) map[string]any

GetMulti values by keys

func (*Redigo) Has

func (c *Redigo) Has(key string) bool

Has cache key

func (*Redigo) Pool

func (c *Redigo) Pool() *redis.Pool

Pool get

func (*Redigo) Set

func (c *Redigo) Set(key string, val any, ttl time.Duration) (err error)

Set value by key

func (*Redigo) SetMulti

func (c *Redigo) SetMulti(values map[string]any, ttl time.Duration) (err error)

SetMulti values

func (*Redigo) String

func (c *Redigo) String() string

String get

type RedisCache

type RedisCache = Redigo

RedisCache fallback alias