name: Cache Module

sort: 2

Cache Module

Beego’s cache module is used for caching data, inspired by database/sql. It supports four cache providers: file, memcache, memory and redis. You can install it by:

github.com/beego/beego/v2/client/cache

If you use the memcache or redis provider, you should first install:

go get -u github.com/beego/beego/v2/client/cache/memcache

and then import:

import _ "github.com/beego/beego/v2/client/cache/memcache"

Basic Usage

First step is importing the package:

import (
    "github.com/beego/beego/v2/client/cache"
)

Then initialize a global variable object:

bm, err := cache.NewCache("memory", `{"interval":60}`)

Then we can use bm to modify the cache:

bm.Put("astaxie", 1, 10*time.Second)
bm.Get("astaxie")
bm.IsExist("astaxie")
bm.Delete("astaxie")

Provider Settings

Here is how to configure the four providers:

memory

interval stands for GC time, which means the cache will be cleared every 60s:
```
  {"interval":60}
```

file

  {"CachePath":"./cache","FileSuffix":".cache","DirectoryLevel":2,"EmbedExpiry":120}

redis

redis uses redigo
```
  {"key":"collectionName","conn":":6039","dbNum":"0","password":"thePassWord"}
```
- key: the Redis collection name
- conn: Redis connection info
- dbNum: Select the DB having the specified zero-based numeric index.
- password: the password for connecting password-protected Redis server

memcache

memcache uses vitess
```
  {"conn":"127.0.0.1:11211"}
```

Creating your own provider

The cache module uses the Cache interface, so you can create your own cache provider by implementing this interface and registering it.

type Cache interface {
    // Get a cached value by key.
    Get(ctx context.Context, key string) (interface{}, error)
    // GetMulti is a batch version of Get.
    GetMulti(ctx context.Context, keys []string) ([]interface{}, error)
    // Set a cached value with key and expire time.
    Put(ctx context.Context, key string, val interface{}, timeout time.Duration) error
    // Delete cached value by key.
    Delete(ctx context.Context, key string) error
    // Increment a cached int value by key, as a counter.
    Incr(ctx context.Context, key string) error
    // Decrement a cached int value by key, as a counter.
    Decr(ctx context.Context, key string) error
    // Check if a cached value exists or not.
    IsExist(ctx context.Context, key string) (bool, error)
    // Clear all cache.
    ClearAll(ctx context.Context) error
    // Start gc routine based on config string settings.
    StartAndGC(config string) error
}

func init() {
    cache.Register("myowncache", NewOwnCache())
}