Skip to content
/ zache Public

An in-memory key:value store/cache (similar to Memcached) library for Go, suitable for single-machine applications

License

Notifications You must be signed in to change notification settings

ztock/zache

Folders and files

NameName
Last commit message
Last commit date

Latest commit

315dedc · Jan 16, 2022

History

10 Commits
Mar 26, 2021
Mar 26, 2021
Mar 26, 2021
Apr 27, 2021
Jan 16, 2022
Mar 26, 2021
Apr 13, 2021

Repository files navigation

zache

GitHub release Github Build Status GoDoc

An in-memory key:value store/cache (similar to Memcached) library for Go, suitable for single-machine applications. A fork from patrickmn/go-cache project.

Any object can be stored, for a given duration or forever, and the cache can be safely used by multiple goroutines.

Although go-cache isn't meant to be used as a persistent datastore, the entire cache can be saved to and loaded from a file to recover from downtime quickly.

Installation

$ go get github.com/ztock/zache

Usage

import (
	"fmt"
	"time"

	"github.com/patrickmn/go-cache"
)

func main() {
	// Create a cache with a default expiration time of 5 minutes, and which
	// purges expired items every 10 minutes
	c := cache.New(5*time.Minute, 10*time.Minute)

	// Set the value of the key "foo" to "bar", with the default expiration time
	c.Set("foo", "bar", cache.DefaultExpiration)

	// Set the value of the key "baz" to 42, with no expiration time
	// (the item won't be removed until it is re-set, or removed using
	// c.Delete("baz")
	c.Set("baz", 42, cache.NoExpiration)

	// Get the string associated with the key "foo" from the cache
	foo, found := c.Get("foo")
	if found {
		fmt.Println(foo)
	}

	// Since Go is statically typed, and cache values can be anything, type
	// assertion is needed when values are being passed to functions that don't
	// take arbitrary types, (i.e. interface{}). The simplest way to do this for
	// values which will only be used once--e.g. for passing to another
	// function--is:
	foo, found := c.Get("foo")
	if found {
		MyFunction(foo.(string))
	}

	// This gets tedious if the value is used several times in the same function.
	// You might do either of the following instead:
	if x, found := c.Get("foo"); found {
		foo := x.(string)
		// ...
	}

	// or
	var foo string
	if x, found := c.Get("foo"); found {
		foo = x.(string)
	}

	// ...
	// foo can then be passed around freely as a string

	// Want performance? Store pointers!
	c.Set("foo", &MyStruct, cache.DefaultExpiration)
	if x, found := c.Get("foo"); found {
		foo := x.(*MyStruct)
			// ...
	}
}

Issues

License

MIT

About

An in-memory key:value store/cache (similar to Memcached) library for Go, suitable for single-machine applications

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages