caches

Documentation

Index

• Constants
• Variables
• func Decode(data []byte, to interface{}) error
• func Encode(data interface{}) ([]byte, error)
• func GenSqlKey(sql string, args interface{}) string
• func GetCacheSql(m Cacher, tableName, sql string, args interface{}) ([]schemas.PK, error)
• func GobDecode(data []byte, to interface{}) error
• func GobEncode(data interface{}) ([]byte, error)
• func JsonDecode(data []byte, to interface{}) error
• func JsonEncode(data interface{}) ([]byte, error)
• func Md5(str string) string
• func PutCacheSql(m Cacher, ids []schemas.PK, tableName, sql string, args interface{}) error
• type CacheStore
• type Cacher
• type LRUCacher
  • func NewLRUCacher(store CacheStore, maxElementSize int) *LRUCacher
  • func NewLRUCacher2(store CacheStore, expired time.Duration, maxElementSize int) *LRUCacher
  • func (m *LRUCacher) ClearBeans(tableName string)
  • func (m *LRUCacher) ClearIds(tableName string)
  • func (m *LRUCacher) DelBean(tableName string, id string)
  • func (m *LRUCacher) DelIds(tableName, sql string)
  • func (m *LRUCacher) GC()
  • func (m *LRUCacher) GetBean(tableName string, id string) interface{}
  • func (m *LRUCacher) GetIds(tableName, sql string) interface{}
  • func (m *LRUCacher) PutBean(tableName string, id string, obj interface{})
  • func (m *LRUCacher) PutIds(tableName, sql string, ids interface{})
  • func (m *LRUCacher) RunGC()
• type LevelDBStore
  • func NewLevelDBStore(dbfile string) (*LevelDBStore, error)
  • func (s *LevelDBStore) Close()
  • func (s *LevelDBStore) Del(key string) error
  • func (s *LevelDBStore) Get(key string) (interface{}, error)
  • func (s *LevelDBStore) Put(key string, value interface{}) error
• type Manager
  • func NewManager() *Manager
  • func (mgr *Manager) GetCacher(tableName string) Cacher
  • func (mgr *Manager) GetDefaultCacher() Cacher
  • func (mgr *Manager) SetCacher(tableName string, cacher Cacher)
  • func (mgr *Manager) SetDefaultCacher(cacher Cacher)
  • func (mgr *Manager) SetDisableGlobalCache(disable bool)
• type MemoryStore
  • func NewMemoryStore() *MemoryStore
  • func (s *MemoryStore) Del(key string) error
  • func (s *MemoryStore) Get(key string) (interface{}, error)
  • func (s *MemoryStore) Put(key string, value interface{}) error

Constants

const (
	// CacheExpired is default cache expired time
	CacheExpired = 60 * time.Minute
	// CacheMaxMemory is not use now
	CacheMaxMemory = 256
	// CacheGcInterval represents interval time to clear all expired nodes
	CacheGcInterval = 10 * time.Minute
	// CacheGcMaxRemoved represents max nodes removed when gc
	CacheGcMaxRemoved = 20
)

Variables

var (
	ErrCacheMiss = errors.New("xorm/cache: key not found")
	ErrNotStored = errors.New("xorm/cache: not stored")
	// ErrNotExist record does not exist error
	ErrNotExist = errors.New("Record does not exist")
)

list all the errors

Functions

func Decode

func Decode(data []byte, to interface{}) error

Decode decode data

func Encode

func Encode(data interface{}) ([]byte, error)

Encode Encode data

func GenSqlKey

func GenSqlKey(sql string, args interface{}) string

GenSqlKey generates cache key

func GetCacheSql

func GetCacheSql(m Cacher, tableName, sql string, args interface{}) ([]schemas.PK, error)

GetCacheSql returns cacher PKs via SQL

func GobDecode

func GobDecode(data []byte, to interface{}) error

GobDecode decode data with gob

func GobEncode

func GobEncode(data interface{}) ([]byte, error)

GobEncode encode data with gob

func JsonDecode

func JsonDecode(data []byte, to interface{}) error

JsonDecode decode data with json

func JsonEncode

func JsonEncode(data interface{}) ([]byte, error)

JsonEncode encode data with json

func Md5

func Md5(str string) string

Md5 return md5 hash string

func PutCacheSql

func PutCacheSql(m Cacher, ids []schemas.PK, tableName, sql string, args interface{}) error

PutCacheSql puts cacher SQL and PKs

Types

type CacheStore

type CacheStore interface {
	// key is primary key or composite primary key
	// value is struct's pointer
	// key format : <tablename>-p-<pk1>-<pk2>...
	Put(key string, value interface{}) error
	Get(key string) (interface{}, error)
	Del(key string) error
}

CacheStore is a interface to store cache

type Cacher

type Cacher interface {
	GetIds(tableName, sql string) interface{}
	GetBean(tableName string, id string) interface{}
	PutIds(tableName, sql string, ids interface{})
	PutBean(tableName string, id string, obj interface{})
	DelIds(tableName, sql string)
	DelBean(tableName string, id string)
	ClearIds(tableName string)
	ClearBeans(tableName string)
}

Cacher is an interface to provide cache id format : u-<pk1>-<pk2>...

type LRUCacher

type LRUCacher struct {
	MaxElementSize int
	Expired        time.Duration
	GcInterval     time.Duration
	// contains filtered or unexported fields
}

LRUCacher implments cache object facilities

func NewLRUCacher

func NewLRUCacher(store CacheStore, maxElementSize int) *LRUCacher

NewLRUCacher creates a cacher

func NewLRUCacher2

func NewLRUCacher2(store CacheStore, expired time.Duration, maxElementSize int) *LRUCacher

NewLRUCacher2 creates a cache include different params

func (*LRUCacher) ClearBeans

func (m *LRUCacher) ClearBeans(tableName string)

ClearBeans clears all beans in some table

func (*LRUCacher) ClearIds

func (m *LRUCacher) ClearIds(tableName string)

ClearIds clears all sql-ids mapping on table tableName from cache

func (*LRUCacher) DelBean

func (m *LRUCacher) DelBean(tableName string, id string)

DelBean deletes beans in some table

func (*LRUCacher) DelIds

func (m *LRUCacher) DelIds(tableName, sql string)

DelIds deletes ids

func (*LRUCacher) GC

func (m *LRUCacher) GC()

GC check ids lit and sql list to remove all element expired

func (*LRUCacher) GetBean

func (m *LRUCacher) GetBean(tableName string, id string) interface{}

GetBean returns bean according tableName and id from cache

func (*LRUCacher) GetIds

func (m *LRUCacher) GetIds(tableName, sql string) interface{}

GetIds returns all bean's ids according to sql and parameter from cache

func (*LRUCacher) PutBean

func (m *LRUCacher) PutBean(tableName string, id string, obj interface{})

PutBean puts beans into table

func (*LRUCacher) PutIds

func (m *LRUCacher) PutIds(tableName, sql string, ids interface{})

PutIds pus ids into table

func (*LRUCacher) RunGC

func (m *LRUCacher) RunGC()

RunGC run once every m.GcInterval

type LevelDBStore

type LevelDBStore struct {
	Debug bool
	// contains filtered or unexported fields
}

LevelDBStore implements CacheStore provide local machine

func NewLevelDBStore

func NewLevelDBStore(dbfile string) (*LevelDBStore, error)

NewLevelDBStore creates a leveldb store

func (*LevelDBStore) Close

func (s *LevelDBStore) Close()

Close implements CacheStore

func (*LevelDBStore) Del

func (s *LevelDBStore) Del(key string) error

Del implements CacheStore

func (*LevelDBStore) Get

func (s *LevelDBStore) Get(key string) (interface{}, error)

Get implements CacheStore

func (*LevelDBStore) Put

func (s *LevelDBStore) Put(key string, value interface{}) error

Put implements CacheStore

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager represents a cache manager

func NewManager

func NewManager() *Manager

NewManager creates a cache manager

func (*Manager) GetCacher

func (mgr *Manager) GetCacher(tableName string) Cacher

GetCacher returns a cache of a table

func (*Manager) GetDefaultCacher

func (mgr *Manager) GetDefaultCacher() Cacher

GetDefaultCacher returns the default cacher

func (*Manager) SetCacher

func (mgr *Manager) SetCacher(tableName string, cacher Cacher)

SetCacher set cacher of table

func (*Manager) SetDefaultCacher

func (mgr *Manager) SetDefaultCacher(cacher Cacher)

SetDefaultCacher set the default cacher. Xorm's default not enable cacher.

func (*Manager) SetDisableGlobalCache

func (mgr *Manager) SetDisableGlobalCache(disable bool)

SetDisableGlobalCache disable global cache or not

type MemoryStore

type MemoryStore struct {
	// contains filtered or unexported fields
}

MemoryStore represents in-memory store

func NewMemoryStore

func NewMemoryStore() *MemoryStore

NewMemoryStore creates a new store in memory

func (*MemoryStore) Del

func (s *MemoryStore) Del(key string) error

Del deletes object

func (*MemoryStore) Get

func (s *MemoryStore) Get(key string) (interface{}, error)

Get gets object from store

func (*MemoryStore) Put

func (s *MemoryStore) Put(key string, value interface{}) error

Put puts object into store