gache

README

gache

gache is thinnest cache library for go application

Requirement

Go 1.11

Installation

go get github.com/kpango/gache

Example

	// data sets
	var (
		key1 = "key"
		key2 = 5050
		key3 = struct{}{}

		value1 = "value"
		value2 = 88888
		value3 = struct{}{}
	)

	// store cache default expire is 30 Seconds
	gache.Set(key1, value3)
	gache.Set(key2, value2)
	gache.Set(key3, value1)

	// load cache data
	v1, ok := gache.Get(key1)

	v2, ok := gache.Get(key2)

	v3, ok := gache.Get(key3)


	gache.Write(context.Background(), glg.FileWriter("./gache-sample.gdb", 0755))
	gache.New().SetDefaultExpire(time.Minute).Read(glg.FileWriter("./gache-sample.gdb", 0755))

Benchmarks

gache vs gocache vs normal map with lock vs go-cache vs gcache vs freecache vs bigcache vs go-mcache

go test -count=5 -run=NONE -bench . -benchmem
goos: darwin
goarch: amd64
pkg: github.com/kpango/gache
BenchmarkGacheWithSmallDataset-8       	 5000000	       291 ns/op	     320 B/op	      16 allocs/op
BenchmarkGacheWithSmallDataset-8       	 5000000	       295 ns/op	     320 B/op	      16 allocs/op
BenchmarkGacheWithSmallDataset-8       	 5000000	       298 ns/op	     320 B/op	      16 allocs/op
BenchmarkGacheWithSmallDataset-8       	 5000000	       294 ns/op	     320 B/op	      16 allocs/op
BenchmarkGacheWithSmallDataset-8       	 5000000	       299 ns/op	     320 B/op	      16 allocs/op
BenchmarkGacheWithBigDataset-8         	     500	   3452521 ns/op	  799990 B/op	   39999 allocs/op
BenchmarkGacheWithBigDataset-8         	     500	   3445126 ns/op	  799985 B/op	   39999 allocs/op
BenchmarkGacheWithBigDataset-8         	     500	   3444726 ns/op	  799991 B/op	   39999 allocs/op
BenchmarkGacheWithBigDataset-8         	     500	   3463403 ns/op	  799991 B/op	   39999 allocs/op
BenchmarkGacheWithBigDataset-8         	     500	   3494554 ns/op	  799985 B/op	   39999 allocs/op
BenchmarkGocacheWithSmallDataset-8     	 5000000	       340 ns/op	     320 B/op	      16 allocs/op
BenchmarkGocacheWithSmallDataset-8     	 5000000	       338 ns/op	     320 B/op	      16 allocs/op
BenchmarkGocacheWithSmallDataset-8     	 5000000	       342 ns/op	     320 B/op	      16 allocs/op
BenchmarkGocacheWithSmallDataset-8     	 5000000	       345 ns/op	     320 B/op	      16 allocs/op
BenchmarkGocacheWithSmallDataset-8     	 5000000	       342 ns/op	     320 B/op	      16 allocs/op
BenchmarkGocacheWithBigDataset-8       	     300	   3634880 ns/op	  803100 B/op	   40047 allocs/op
BenchmarkGocacheWithBigDataset-8       	     300	   3617405 ns/op	  804285 B/op	   40050 allocs/op
BenchmarkGocacheWithBigDataset-8       	     300	   3728884 ns/op	  806466 B/op	   40057 allocs/op
BenchmarkGocacheWithBigDataset-8       	     300	   3753736 ns/op	  809177 B/op	   40092 allocs/op
BenchmarkGocacheWithBigDataset-8       	     300	   3763500 ns/op	  808783 B/op	   40094 allocs/op
BenchmarkMapWithSmallDataset-8         	 1000000	      1433 ns/op	     128 B/op	       8 allocs/op
BenchmarkMapWithSmallDataset-8         	 1000000	      1376 ns/op	     128 B/op	       8 allocs/op
BenchmarkMapWithSmallDataset-8         	 1000000	      1352 ns/op	     128 B/op	       8 allocs/op
BenchmarkMapWithSmallDataset-8         	 1000000	      1340 ns/op	     128 B/op	       8 allocs/op
BenchmarkMapWithSmallDataset-8         	 1000000	      1338 ns/op	     128 B/op	       8 allocs/op
BenchmarkMapWithBigDataset-8           	     100	  10181335 ns/op	  332736 B/op	   20001 allocs/op
BenchmarkMapWithBigDataset-8           	     100	  10135521 ns/op	  332758 B/op	   20001 allocs/op
BenchmarkMapWithBigDataset-8           	     100	  10147527 ns/op	  332748 B/op	   20001 allocs/op
BenchmarkMapWithBigDataset-8           	     100	  10191556 ns/op	  332700 B/op	   20001 allocs/op
BenchmarkMapWithBigDataset-8           	     100	  10203600 ns/op	  332779 B/op	   20001 allocs/op
BenchmarkGoCacheWithSmallDataset-8     	 1000000	      1548 ns/op	      64 B/op	       4 allocs/op
BenchmarkGoCacheWithSmallDataset-8     	 1000000	      1514 ns/op	      64 B/op	       4 allocs/op
BenchmarkGoCacheWithSmallDataset-8     	 1000000	      1507 ns/op	      64 B/op	       4 allocs/op
BenchmarkGoCacheWithSmallDataset-8     	 1000000	      1503 ns/op	      64 B/op	       4 allocs/op
BenchmarkGoCacheWithSmallDataset-8     	 1000000	      1502 ns/op	      64 B/op	       4 allocs/op
BenchmarkGoCacheWithBigDataset-8       	     100	  10247210 ns/op	  175679 B/op	   10002 allocs/op
BenchmarkGoCacheWithBigDataset-8       	     100	  10286331 ns/op	  175747 B/op	   10002 allocs/op
BenchmarkGoCacheWithBigDataset-8       	     100	  10341409 ns/op	  175810 B/op	   10002 allocs/op
BenchmarkGoCacheWithBigDataset-8       	     100	  10285768 ns/op	  175775 B/op	   10002 allocs/op
BenchmarkGoCacheWithBigDataset-8       	     100	  10285459 ns/op	  175706 B/op	   10002 allocs/op
BenchmarkGCacheLRUWithSmallDataset-8   	  500000	      2482 ns/op	     320 B/op	      16 allocs/op
BenchmarkGCacheLRUWithSmallDataset-8   	  500000	      2463 ns/op	     320 B/op	      16 allocs/op
BenchmarkGCacheLRUWithSmallDataset-8   	  500000	      2506 ns/op	     320 B/op	      16 allocs/op
BenchmarkGCacheLRUWithSmallDataset-8   	  500000	      2505 ns/op	     320 B/op	      16 allocs/op
BenchmarkGCacheLRUWithSmallDataset-8   	  500000	      2518 ns/op	     320 B/op	      16 allocs/op
BenchmarkGCacheLRUWithBigDataset-8     	     100	  21187149 ns/op	 1976314 B/op	   60152 allocs/op
BenchmarkGCacheLRUWithBigDataset-8     	     100	  21365157 ns/op	 1974912 B/op	   60146 allocs/op
BenchmarkGCacheLRUWithBigDataset-8     	     100	  21295620 ns/op	 1971798 B/op	   60136 allocs/op
BenchmarkGCacheLRUWithBigDataset-8     	     100	  20833879 ns/op	 1975621 B/op	   60147 allocs/op
BenchmarkGCacheLRUWithBigDataset-8     	     100	  20802686 ns/op	 1976400 B/op	   60151 allocs/op
BenchmarkGCacheLFUWithSmallDataset-8   	  500000	      3081 ns/op	     512 B/op	      20 allocs/op
BenchmarkGCacheLFUWithSmallDataset-8   	  500000	      3023 ns/op	     512 B/op	      20 allocs/op
BenchmarkGCacheLFUWithSmallDataset-8   	  500000	      2918 ns/op	     512 B/op	      20 allocs/op
BenchmarkGCacheLFUWithSmallDataset-8   	  500000	      2928 ns/op	     512 B/op	      20 allocs/op
BenchmarkGCacheLFUWithSmallDataset-8   	  500000	      2894 ns/op	     512 B/op	      20 allocs/op
BenchmarkGCacheLFUWithBigDataset-8     	     100	  21955102 ns/op	 1439551 B/op	   49986 allocs/op
BenchmarkGCacheLFUWithBigDataset-8     	     100	  21821424 ns/op	 1440684 B/op	   49992 allocs/op
BenchmarkGCacheLFUWithBigDataset-8     	     100	  21668914 ns/op	 1439789 B/op	   49987 allocs/op
BenchmarkGCacheLFUWithBigDataset-8     	     100	  21698323 ns/op	 1440822 B/op	   49993 allocs/op
BenchmarkGCacheLFUWithBigDataset-8     	     100	  21813723 ns/op	 1440316 B/op	   49990 allocs/op
BenchmarkGCacheARCWithSmallDataset-8   	  500000	      3198 ns/op	     320 B/op	      16 allocs/op
BenchmarkGCacheARCWithSmallDataset-8   	  500000	      3069 ns/op	     320 B/op	      16 allocs/op
BenchmarkGCacheARCWithSmallDataset-8   	  500000	      3090 ns/op	     320 B/op	      16 allocs/op
BenchmarkGCacheARCWithSmallDataset-8   	  500000	      3095 ns/op	     320 B/op	      16 allocs/op
BenchmarkGCacheARCWithSmallDataset-8   	  500000	      3076 ns/op	     320 B/op	      16 allocs/op
BenchmarkGCacheARCWithBigDataset-8     	      30	  61898429 ns/op	 3002668 B/op	   80286 allocs/op
BenchmarkGCacheARCWithBigDataset-8     	      30	  63439372 ns/op	 2984606 B/op	   80233 allocs/op
BenchmarkGCacheARCWithBigDataset-8     	      30	  62344244 ns/op	 3001549 B/op	   80292 allocs/op
BenchmarkGCacheARCWithBigDataset-8     	      30	  63272118 ns/op	 2991984 B/op	   80250 allocs/op
BenchmarkGCacheARCWithBigDataset-8     	      30	  62868651 ns/op	 3012101 B/op	   80355 allocs/op
BenchmarkFreeCacheWithSmallDataset-8   	 1000000	      1221 ns/op	      26 B/op	       4 allocs/op
BenchmarkFreeCacheWithSmallDataset-8   	 1000000	      1216 ns/op	      26 B/op	       4 allocs/op
BenchmarkFreeCacheWithSmallDataset-8   	 1000000	      1212 ns/op	      26 B/op	       4 allocs/op
BenchmarkFreeCacheWithSmallDataset-8   	 1000000	      1215 ns/op	      26 B/op	       4 allocs/op
BenchmarkFreeCacheWithSmallDataset-8   	 1000000	      1212 ns/op	      26 B/op	       4 allocs/op
BenchmarkFreeCacheWithBigDataset-8     	     100	  19999670 ns/op	126810752 B/op	   39937 allocs/op
BenchmarkFreeCacheWithBigDataset-8     	     100	  19969249 ns/op	126810741 B/op	   39937 allocs/op
BenchmarkFreeCacheWithBigDataset-8     	     100	  20030303 ns/op	126810746 B/op	   39937 allocs/op
BenchmarkFreeCacheWithBigDataset-8     	     100	  20055135 ns/op	126810783 B/op	   39937 allocs/op
BenchmarkFreeCacheWithBigDataset-8     	     100	  20039316 ns/op	126810721 B/op	   39937 allocs/op
BenchmarkBigCacheWithSmallDataset-8    	 1000000	      1409 ns/op	     418 B/op	       8 allocs/op
BenchmarkBigCacheWithSmallDataset-8    	 1000000	      1303 ns/op	     418 B/op	       8 allocs/op
BenchmarkBigCacheWithSmallDataset-8    	 1000000	      1281 ns/op	     418 B/op	       8 allocs/op
BenchmarkBigCacheWithSmallDataset-8    	 1000000	      1322 ns/op	     418 B/op	       8 allocs/op
BenchmarkBigCacheWithSmallDataset-8    	 1000000	      1282 ns/op	     418 B/op	       8 allocs/op
BenchmarkBigCacheWithBigDataset-8      	      20	  64710802 ns/op	218923337 B/op	   30322 allocs/op
BenchmarkBigCacheWithBigDataset-8      	      30	  81748764 ns/op	228873497 B/op	   30236 allocs/op
BenchmarkBigCacheWithBigDataset-8      	      30	  60661622 ns/op	228847402 B/op	   30232 allocs/op
BenchmarkBigCacheWithBigDataset-8      	      30	  47265941 ns/op	228855801 B/op	   30232 allocs/op
BenchmarkBigCacheWithBigDataset-8      	      30	  43173717 ns/op	228862094 B/op	   30234 allocs/op
BenchmarkMCacheWithSmallDataset-8      	  200000	     13406 ns/op	    4385 B/op	      40 allocs/op
BenchmarkMCacheWithSmallDataset-8      	  200000	     21958 ns/op	    4380 B/op	      40 allocs/op
BenchmarkMCacheWithSmallDataset-8      	  100000	     30215 ns/op	    4393 B/op	      40 allocs/op
BenchmarkMCacheWithSmallDataset-8      	  100000	     22808 ns/op	    2102 B/op	      31 allocs/op
BenchmarkMCacheWithSmallDataset-8      	  100000	     19290 ns/op	    2496 B/op	      36 allocs/op
BenchmarkMCacheWithBigDataset-8        	      20	  79083650 ns/op	 6239998 B/op	   90001 allocs/op
BenchmarkMCacheWithBigDataset-8        	      30	  76086004 ns/op	 6240040 B/op	   90001 allocs/op
BenchmarkMCacheWithBigDataset-8        	      30	 106160223 ns/op	 6240044 B/op	   90001 allocs/op
BenchmarkMCacheWithBigDataset-8        	      30	  49614440 ns/op	 5966882 B/op	   85998 allocs/op
BenchmarkMCacheWithBigDataset-8        	      30	  51878904 ns/op	 5781447 B/op	   85224 allocs/op
PASS
ok  	github.com/kpango/gache	249.928s

Contribution

1. Fork it ( https://github.com/kpango/gache/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Author

kpango

LICENSE

gache released under MIT license, refer LICENSE file.

Documentation

Index

• func Clear()
• func Delete(key string)
• func DeleteExpired(ctx context.Context) uint64
• func Get(key string) (interface{}, bool)
• func GetWithExpire(key string) (interface{}, int64, bool)
• func Len() int
• func Read(r io.Reader) error
• func Set(key string, val interface{})
• func SetWithExpire(key string, val interface{}, expire time.Duration)
• func ToMap(ctx context.Context) *sync.Map
• func ToRawMap(ctx context.Context) map[string]interface{}
• func Write(ctx context.Context, w io.Writer) error
• type Gache
  • func DisableExpiredHook() Gache
  • func EnableExpiredHook() Gache
  • func Foreach(ctx context.Context, f func(string, interface{}, int64) bool) Gache
  • func GetGache() Gache
  • func New() Gache
  • func SetDefaultExpire(ex time.Duration) Gache
  • func SetExpiredHook(f func(context.Context, string)) Gache

Functions

func Clear

func Clear()

Clear deletes all key and value present in the Gache.

func Delete

func Delete(key string)

Delete deletes value from Gache using key

func DeleteExpired

func DeleteExpired(ctx context.Context) uint64

DeleteExpired deletes expired value from Gache it can be cancel using context

func Get

func Get(key string) (interface{}, bool)

Get returns value & exists from key

func GetWithExpire

func GetWithExpire(key string) (interface{}, int64, bool)

GetWithExpire returns value & expire & exists from key

func Len

func Len() int

Len returns stored object length

func Read

func Read(r io.Reader) error

Read reads reader data to cache

func Set

func Set(key string, val interface{})

Set sets key-value to Gache using default expiration

func SetWithExpire

func SetWithExpire(key string, val interface{}, expire time.Duration)

SetWithExpire sets key-value & expiration to Gache

func ToMap

func ToMap(ctx context.Context) *sync.Map

ToMap returns All Cache Key-Value sync.Map

func ToRawMap

func ToRawMap(ctx context.Context) map[string]interface{}

ToRawMap returns All Cache Key-Value map

func Write

func Write(ctx context.Context, w io.Writer) error

Write writes all cached data to writer

Types

type Gache

type Gache interface {
	Clear()
	Delete(string)
	DeleteExpired(context.Context) uint64
	DisableExpiredHook() Gache
	EnableExpiredHook() Gache
	Foreach(context.Context, func(string, interface{}, int64) bool) Gache
	Get(string) (interface{}, bool)
	GetWithExpire(string) (interface{}, int64, bool)
	Read(io.Reader) error
	Set(string, interface{})
	SetDefaultExpire(time.Duration) Gache
	SetExpiredHook(f func(context.Context, string)) Gache
	SetWithExpire(string, interface{}, time.Duration)
	StartExpired(context.Context, time.Duration) Gache
	Len() int
	ToMap(context.Context) *sync.Map
	ToRawMap(context.Context) map[string]interface{}
	Write(context.Context, io.Writer) error
}

Gache is base interface type

func DisableExpiredHook

func DisableExpiredHook() Gache

DisableExpiredHook disables expired hook function

func EnableExpiredHook

func EnableExpiredHook() Gache

EnableExpiredHook enables expired hook function

func Foreach

func Foreach(ctx context.Context, f func(string, interface{}, int64) bool) Gache

Foreach calls f sequentially for each key and value present in the Gache.

func GetGache

func GetGache() Gache

GetGache returns Gache (*gache) instance

func New

func New() Gache

New returns Gache (*gache) instance

func SetDefaultExpire

func SetDefaultExpire(ex time.Duration) Gache

SetDefaultExpire set expire duration

func SetExpiredHook

func SetExpiredHook(f func(context.Context, string)) Gache

SetExpiredHook set expire hooked function