rediscache

Documentation

Overview

Package rediscache handles Put, Get etc to Datastore and provides caching by Redis. How the cache is used is explained in the storagecache package's document.

Related document.

https://godoc.org/go.mercari.io/datastore/dsmiddleware/storagecache

Example (HowToUse)

package main

import (
	"context"
	"net"
	"time"

	"github.com/garyburd/redigo/redis"
	"go.mercari.io/datastore/clouddatastore"
	"go.mercari.io/datastore/dsmiddleware/rediscache"
	"go.mercari.io/datastore/internal/testutils"
)

const redisAddress = ":6379"

func main() {
	ctx := context.Background()
	client, err := clouddatastore.FromContext(ctx)
	if err != nil {
		panic(err)
	}
	defer client.Close()
	defer testutils.CleanUpAllEntities(ctx, client)

	dial, err := net.Dial("tcp", redisAddress)
	if err != nil {
		panic(err)
	}
	defer dial.Close()
	conn := redis.NewConn(dial, 100*time.Millisecond, 100*time.Millisecond)
	defer conn.Close()

	mw := rediscache.New(conn)
	client.AppendMiddleware(mw)
}

Index

• func New(conn redis.Conn, opts ...CacheOption) interface{ ... }
• type CacheOption
  • func WithCacheKey(f func(key datastore.Key) string) CacheOption
  • func WithExcludeKinds(kinds ...string) CacheOption
  • func WithExpireDuration(d time.Duration) CacheOption
  • func WithIncludeKinds(kinds ...string) CacheOption
  • func WithKeyFilter(f storagecache.KeyFilter) CacheOption
  • func WithLogger(logf func(ctx context.Context, format string, args ...interface{})) CacheOption

Examples

• Package (HowToUse)

Functions

func New

func New(conn redis.Conn, opts ...CacheOption) interface {
	datastore.Middleware
	storagecache.Storage
}

New Redis cache middleware creates & returns.

Types

type CacheOption

type CacheOption interface {
	Apply(*cacheHandler)
}

A CacheOption is an cache option for a Redis cache middleware.

func WithCacheKey

func WithCacheKey(f func(key datastore.Key) string) CacheOption

WithCacheKey creates a ClientOption that specifies how to generate a cache key from datastore.Key.

func WithExcludeKinds

func WithExcludeKinds(kinds ...string) CacheOption

WithExcludeKinds creates a ClientOption that selects the Kind unspecified as the cache target.

func WithExpireDuration

func WithExpireDuration(d time.Duration) CacheOption

WithExpireDuration creates a ClientOption to expire at a specified time.

func WithIncludeKinds

func WithIncludeKinds(kinds ...string) CacheOption

WithIncludeKinds creates a ClientOption that selects the Kind specified as the cache target.

func WithKeyFilter

func WithKeyFilter(f storagecache.KeyFilter) CacheOption

WithKeyFilter creates a ClientOption that selects the Keys specified as the cache target.

func WithLogger

func WithLogger(logf func(ctx context.Context, format string, args ...interface{})) CacheOption

WithLogger creates a ClientOption that uses the specified logger.