xormrediscache

README

xorm-redis-cache

XORM Redis Cache is a cacher implementation for XORM cache.

Documentation

Index

• Constants
• type RedisCacher
  • func MakeRedisCacher(pool *redis.Pool, defaultExpiration time.Duration, logger log.ContextLogger) *RedisCacher
  • func NewRedisCacher(host string, password string, defaultExpiration time.Duration, ...) *RedisCacher
  • func (c *RedisCacher) ClearBeans(tableName string)
  • func (c *RedisCacher) ClearIds(tableName string)
  • func (c *RedisCacher) DelBean(tableName string, id string)
  • func (c *RedisCacher) DelIds(tableName, sql string)
  • func (c *RedisCacher) Flush() error
  • func (c *RedisCacher) GetBean(tableName string, id string) interface{}
  • func (c *RedisCacher) GetIds(tableName, sql string) interface{}
  • func (c *RedisCacher) GetPool() (*redis.Pool, error)
  • func (c *RedisCacher) PutBean(tableName string, id string, obj interface{})
  • func (c *RedisCacher) PutIds(tableName, sql string, ids interface{})
  • func (c *RedisCacher) SetPool(pool *redis.Pool)

Constants

const (
	DEFAULT_EXPIRATION = time.Duration(0)
	FOREVER_EXPIRATION = time.Duration(-1)

	LOGGING_PREFIX = "[redis_cacher]"
)

Types

type RedisCacher

type RedisCacher struct {
	Logger log.ContextLogger
	// contains filtered or unexported fields
}

RedisCacher wraps the Redis client to meet the Cache interface.

func MakeRedisCacher

func MakeRedisCacher(pool *redis.Pool, defaultExpiration time.Duration, logger log.ContextLogger) *RedisCacher

MakeRedisCacher build a cacher based on redis.Pool

func NewRedisCacher

func NewRedisCacher(host string, password string, defaultExpiration time.Duration, logger log.ContextLogger) *RedisCacher

NewRedisCacher creates a Redis Cacher, host as IP endpoint, i.e., localhost:6379, provide empty string or nil if Redis server doesn't require AUTH command, defaultExpiration sets the expire duration for a key to live. Until redigo supports sharding/clustering, only one host will be in hostList

engine.SetDefaultCacher(xormrediscache.NewRedisCacher("localhost:6379", "", xormrediscache.DEFAULT_EXPIRATION, engine.Logger))

or set MapCacher

engine.MapCacher(&user, xormrediscache.NewRedisCacher("localhost:6379", "", xormrediscache.DEFAULT_EXPIRATION, engine.Logger))

func (*RedisCacher) ClearBeans

func (c *RedisCacher) ClearBeans(tableName string)

func (*RedisCacher) ClearIds

func (c *RedisCacher) ClearIds(tableName string)

func (*RedisCacher) DelBean

func (c *RedisCacher) DelBean(tableName string, id string)

func (*RedisCacher) DelIds

func (c *RedisCacher) DelIds(tableName, sql string)

func (*RedisCacher) Flush

func (c *RedisCacher) Flush() error

Flush deletes all xorm cached objects

func (*RedisCacher) GetBean

func (c *RedisCacher) GetBean(tableName string, id string) interface{}

func (*RedisCacher) GetIds

func (c *RedisCacher) GetIds(tableName, sql string) interface{}

func (*RedisCacher) GetPool

func (c *RedisCacher) GetPool() (*redis.Pool, error)

func (*RedisCacher) PutBean

func (c *RedisCacher) PutBean(tableName string, id string, obj interface{})

func (*RedisCacher) PutIds

func (c *RedisCacher) PutIds(tableName, sql string, ids interface{})

func (*RedisCacher) SetPool

func (c *RedisCacher) SetPool(pool *redis.Pool)