cache

go-cache

go-cache is a simple redis cache dependency system on-top of the famous redigo package

Table of Contents

• Installation
• Documentation
• Examples & Tests
• Benchmarks
• Code Standards
• Usage
• Maintainers
• Contributing
• License

Installation

go-cache requires a supported release of Go and dep.

$ go get -u github.com/mrz1836/go-cache

Updating dependencies in go-cache:

$ cd ../go-cache
$ dep ensure -update -v

Package Dependencies

• Gary Burd's Redigo
• Knowledge of Redis

Documentation

You can view the generated documentation here.

Features

• Cache Dependencies Between Keys
• Connect via URL
• Better Pool Management & Creation
• Register Scripts
• Helper Methods (Get, Set, HashGet, etc)

Examples & Tests

All unit tests and examples run via Travis CI and uses Go version 1.12.x. View the deployment configuration file.

Run all tests (including integration tests)

$ cd ../go-cache
$ go test ./... -v

Run tests (excluding integration tests)

$ cd ../go-cache
$ go test ./... -v -test.short

View and run the examples:

$ cd ../go-cache/examples
$ go run examples.go

Benchmarks

Run the Go benchmarks:

$ cd ../go-cache
$ go test -bench . -benchmem

Code Standards

Read more about this Go project's code standards.

Usage

View the examples

Basic implementation:

package main

import (
	"log"

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

func main() {

	// Create the pool and first connection
	_ = cache.Connect("redis://localhost:6379", 0, 10, 0, 240)

	// Set a key
	_ = cache.Set("key-name", "the-value", "dependent-key-1", "dependent-key-2")

	// Get a key
	value, _ := cache.Get("key-name")
	log.Println("Got value:", value)
	//Output: Got Value: the-value

	// Kill keys by dependency
	keys, _ := cache.KillByDependency("dependent-key-1")
	log.Println("Keys Removed:", keys)
	//Output: Keys Removed: 2
}

Maintainers

@MrZ1836 | @kayleg

Contributing

This project uses Gary Burd's Redigo package.

View the contributing guidelines and follow the code of conduct.

Support the development of this project 🙏

License