Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var DefaultOptions = Options{ Address: "localhost:6379", Codec: encoding.JSON, KeyPrefix: "gokv", }
DefaultOptions is an Options object with default values. Address: "localhost:6379", Password: "", DB: 0, Codec: encoding.JSON
Functions ¶
func DefaultKeyFunc ¶
DefaultKeyFunc is the default implementation of cache keys All it does is to preprend "gokv:" to the key sent in by client code
Types ¶
type Options ¶
type Options struct {
// Address of the Redis server, including the port.
// Optional ("localhost:6379" by default).
Address string
// Password for the Redis server.
// Optional ("" by default).
Password string
// DB to use.
// Optional (0 by default).
DB int
// Encoding format.
// Optional (encoding.JSON by default).
Codec encoding.Codec
// key fn
KeyFn KeyFunc
// key prefix
KeyPrefix string
}
Options are the options for the Redis client.
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
Store is a io.Store implementation for Redis.
func New ¶
NewClient creates a new Redis client.
You must call the Close() method on the client when you're done working with it.
func (*Store) Delete ¶
Delete deletes the stored value for the given key. Deleting a non-existing key-value pair does NOT lead to an error. The key must not be "".
func (*Store) Get ¶
Get retrieves the stored value for the given key. You need to pass a pointer to the value, so in case of a struct the automatic unmarshalling can populate the fields of the object that v points to with the values of the retrieved object's values. If no value is found it returns (false, nil). The key must not be "" and the pointer must not be nil.
Source Files