Skip to content

Commit

Permalink
Add basic example how to use Redis Cluster. Unify comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
vmihailenco committed May 23, 2015
1 parent 1eb3e07 commit f6ef0fd
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
4 changes: 2 additions & 2 deletions cluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ type ClusterClient struct {
reloading uint32
}

// NewClusterClient initializes a new cluster-aware client using given options.
// A list of seed addresses must be provided.
// NewClusterClient returns a new Redis Cluster client as described in
// http://redis.io/topics/cluster-spec.
func NewClusterClient(opt *ClusterOptions) *ClusterClient {
client := &ClusterClient{
addrs: opt.Addrs,
Expand Down
14 changes: 13 additions & 1 deletion example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,22 @@ func ExampleNewClient() {
}

func ExampleNewFailoverClient() {
redis.NewFailoverClient(&redis.FailoverOptions{
// See http://redis.io/topics/sentinel for instructions how to
// setup Redis Sentinel.
client := redis.NewFailoverClient(&redis.FailoverOptions{
MasterName: "master",
SentinelAddrs: []string{":26379"},
})
client.Ping()
}

func ExampleNewClusterClient() {
// See http://redis.io/topics/cluster-tutorial for instructions
// how to setup Redis Cluster.
client := redis.NewClusterClient(&redis.ClusterOptions{
Addrs: []string{":7000", ":7001", ":7002", ":7003", ":7004", ":7005"},
})
client.Ping()
}

func ExampleClient() {
Expand Down
2 changes: 1 addition & 1 deletion sentinel.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ func (opt *FailoverOptions) options() *options {
}
}

// NewFailoverClient returns Redis client with automatic failover
// NewFailoverClient returns a Redis client with automatic failover
// capabilities using Redis Sentinel.
func NewFailoverClient(failoverOpt *FailoverOptions) *Client {
opt := failoverOpt.options()
Expand Down

0 comments on commit f6ef0fd

Please sign in to comment.