kvcache

type BaseCacheStore interface {
	kv.Store
	// SetStore sets a base key-value store.
	SetStore(s kv.Store)
	// RegisterCacheKeyPrefix registers a key header for the cache store.
	RegisterCacheKeyHeader(header kv.KeyHeader)
	// IsRegisteredCacheKey returns true if the specified key is registered to the cache store.
	IsRegisteredCacheKey(key kv.Key) bool
	// EraseCache deletes a cache for the specified key.
	EraseCache(key kv.Key) error
}

type BaseStore struct {
	plugins.Config
	kv.Store
	*CacheConfig
	// contains filtered or unexported fields
}

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

type CacheStatus interface {
	// CacheRequestCount returns the number of cache requests.
	CacheRequestCount() int64
	// CacheMissCount returns the number of cache misses.
	CacheHitCount() int64
}

type CacheStatusExt interface {
	// CacheMissCount returns the number of cache misses.
	CacheHitRate() float64
	// CacheMissCount returns the number of cache misses.
	CacheMissCount() int64
	// CacheMissRate returns the cache miss rate.
	CacheMissRate() float64
}

type CacheStore interface {
	BaseCacheStore
	// EnableDatabaseCache enables a cache for all databases.
	EnableDatabaseCache()
	// EnableCollectionCache enables a cache for all database collections.
	EnableCollectionCache()
	// EraseDatabaseCache deletes a cache for the specified database.
	EraseDatabaseCache(database string) error
	// EraseCollectionCache deletes a cache for the specified collection.
	EraseCollectionCache(database string, collection string) error
}

type Service interface {
	CacheStore
	CacheStatus
	CacheStatusExt
	plugins.Service
}