caches

package
v1.1.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 7, 2026 License: BSD-3-Clause Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source 
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

View Source 
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 any) error

Decode decode data

func Encode 

func Encode(data any) ([]byte, error)

Encode Encode data

func GenSqlKey 

func GenSqlKey(sql string, args any) string

GenSqlKey generates cache key

func GetCacheSql 

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

GetCacheSql returns cacher PKs via SQL

func GobDecode 

func GobDecode(data []byte, to any) error

GobDecode decode data with gob

func GobEncode 

func GobEncode(data any) ([]byte, error)

GobEncode encode data with gob

func JsonDecode 

func JsonDecode(data []byte, to any) error

JsonDecode decode data with json

func JsonEncode 

func JsonEncode(data any) ([]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 any) 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 any) error
	Get(key string) (any, error)
	Del(key string) error
}

CacheStore is a interface to store cache

type Cacher 

type Cacher interface {
	GetIds(tableName, sql string) any
	GetBean(tableName, id string) any
	PutIds(tableName, sql string, ids any)
	PutBean(tableName, id string, obj any)
	DelIds(tableName, sql string)
	DelBean(tableName, 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, 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, id string) any

GetBean returns bean according tableName and id from cache

func (*LRUCacher) GetIds 

func (m *LRUCacher) GetIds(tableName, sql string) any

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

func (*LRUCacher) PutBean 

func (m *LRUCacher) PutBean(tableName, id string, obj any)

PutBean puts beans into table

func (*LRUCacher) PutIds 

func (m *LRUCacher) PutIds(tableName, sql string, ids any)

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) (any, error)

Get implements CacheStore

func (*LevelDBStore) Put 

func (s *LevelDBStore) Put(key string, value any) 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) (any, error)

Get gets object from store

func (*MemoryStore) Put 

func (s *MemoryStore) Put(key string, value any) error

Put puts object into store

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.