README
¶
redis.go
redis.go is a client for the redis key-value store.
Some features include:
- Designed for Redis 2.6.x.
- Support for all redis types - strings, lists, sets, sorted sets, and hashes
- Very simple usage
- Connection pooling ( with configurable size )
- Support for concurrent access
- Manages connections to the redis server, including dropped and timed out connections
- Marshaling/Unmarshaling go types to hashes
This library is stable and is used in production environments. However, some commands have not been tested as thoroughly as others. If you find any bugs please file an issue!
Installation
Just run go get github.com/hoisie/redis
Examples
Most of the examples connect to a redis database running in the default port -- 6379.
Hello World example
package main
import "github.com/hoisie/redis"
func main() {
var client redis.Client
var key = "hello"
client.Set(key, []byte("world"))
val, _ := client.Get("hello")
println(key, string(val))
}
Strings
var client redis.Client
client.Set("a", []byte("hello"))
val, _ := client.Get("a")
println(string(val))
client.Del("a")
Lists
var client redis.Client
vals := []string{"a", "b", "c", "d", "e"}
for _, v := range vals {
client.Rpush("l", []byte(v))
}
dbvals,_ := client.Lrange("l", 0, 4)
for i, v := range dbvals {
println(i,":",string(v))
}
client.Del("l")
Publish/Subscribe
sub := make(chan string, 1)
sub <- "foo"
messages := make(chan Message, 0)
go client.Subscribe(sub, nil, nil, nil, messages)
time.Sleep(10 * 1000 * 1000)
client.Publish("foo", []byte("bar"))
msg := <-messages
println("received from:", msg.Channel, " message:", string(msg.Message))
close(sub)
close(messages)
More examples coming soon. See redis_test.go for more usage examples.
Commands not supported yet
- MULTI/EXEC/DISCARD/WATCH/UNWATCH
- SORT
- ZUNIONSTORE / ZINTERSTORE
Documentation
¶
Index ¶
- type Client
- func (client *Client) Append(key string, val []byte) error
- func (client *Client) Auth(password string) error
- func (client *Client) Bgrewriteaof() error
- func (client *Client) Bgsave() error
- func (client *Client) Blpop(keys []string, timeoutSecs uint) (*string, []byte, error)
- func (client *Client) Brpop(keys []string, timeoutSecs uint) (*string, []byte, error)
- func (client *Client) Dbsize() (int, error)
- func (client *Client) Decr(key string) (int64, error)
- func (client *Client) Decrby(key string, val int64) (int64, error)
- func (client *Client) Del(key string) (bool, error)
- func (client *Client) Exists(key string) (bool, error)
- func (client *Client) Expire(key string, time int64) (bool, error)
- func (client *Client) Flush(all bool) error
- func (client *Client) Get(key string) ([]byte, error)
- func (client *Client) Getset(key string, val []byte) ([]byte, error)
- func (client *Client) Hdel(key string, field string) (bool, error)
- func (client *Client) Hexists(key string, field string) (bool, error)
- func (client *Client) Hget(key string, field string) ([]byte, error)
- func (client *Client) Hgetall(key string, val interface{}) error
- func (client *Client) Hincrby(key string, field string, val int64) (int64, error)
- func (client *Client) Hkeys(key string) ([]string, error)
- func (client *Client) Hlen(key string) (int, error)
- func (client *Client) Hmget(key string, fields ...string) ([][]byte, error)
- func (client *Client) Hmset(key string, mapping interface{}) error
- func (client *Client) Hset(key string, field string, val []byte) (bool, error)
- func (client *Client) Hvals(key string) ([][]byte, error)
- func (client *Client) Incr(key string) (int64, error)
- func (client *Client) Incrby(key string, val int64) (int64, error)
- func (client *Client) Keys(pattern string) ([]string, error)
- func (client *Client) Lastsave() (int64, error)
- func (client *Client) Lindex(key string, index int) ([]byte, error)
- func (client *Client) Llen(key string) (int, error)
- func (client *Client) Lpop(key string) ([]byte, error)
- func (client *Client) Lpush(key string, val []byte) error
- func (client *Client) Lrange(key string, start int, end int) ([][]byte, error)
- func (client *Client) Lrem(key string, count int, value []byte) (int, error)
- func (client *Client) Lset(key string, index int, value []byte) error
- func (client *Client) Ltrim(key string, start int, end int) error
- func (client *Client) Mget(keys ...string) ([][]byte, error)
- func (client *Client) Move(key string, dbnum int) (bool, error)
- func (client *Client) Mset(mapping map[string][]byte) error
- func (client *Client) Msetnx(mapping map[string][]byte) (bool, error)
- func (client *Client) Publish(channel string, val []byte) error
- func (client *Client) Randomkey() (string, error)
- func (client *Client) Rename(src string, dst string) error
- func (client *Client) Renamenx(src string, dst string) (bool, error)
- func (client *Client) Rpop(key string) ([]byte, error)
- func (client *Client) Rpoplpush(src string, dst string) ([]byte, error)
- func (client *Client) Rpush(key string, val []byte) error
- func (client *Client) Sadd(key string, value []byte) (bool, error)
- func (client *Client) Save() error
- func (client *Client) Scard(key string) (int, error)
- func (client *Client) Sdiff(key1 string, keys []string) ([][]byte, error)
- func (client *Client) Sdiffstore(dst string, key1 string, keys []string) (int, error)
- func (client *Client) Set(key string, val []byte) error
- func (client *Client) Setex(key string, time int64, val []byte) error
- func (client *Client) Setnx(key string, val []byte) (bool, error)
- func (client *Client) Sinter(keys ...string) ([][]byte, error)
- func (client *Client) Sinterstore(dst string, keys ...string) (int, error)
- func (client *Client) Sismember(key string, value []byte) (bool, error)
- func (client *Client) Smembers(key string) ([][]byte, error)
- func (client *Client) Smove(src string, dst string, val []byte) (bool, error)
- func (client *Client) Spop(key string) ([]byte, error)
- func (client *Client) Srandmember(key string) ([]byte, error)
- func (client *Client) Srem(key string, value []byte) (bool, error)
- func (client *Client) Strlen(key string) (int, error)
- func (client *Client) Subscribe(subscribe <-chan string, unsubscribe <-chan string, psubscribe <-chan string, ...) error
- func (client *Client) Substr(key string, start int, end int) ([]byte, error)
- func (client *Client) Sunion(keys ...string) ([][]byte, error)
- func (client *Client) Sunionstore(dst string, keys ...string) (int, error)
- func (client *Client) Ttl(key string) (int64, error)
- func (client *Client) Type(key string) (string, error)
- func (client *Client) Zadd(key string, value []byte, score float64) (bool, error)
- func (client *Client) Zcard(key string) (int, error)
- func (client *Client) Zcount(key string, min float64, max float64) (int, error)
- func (client *Client) ZcountAll(key string) (int, error)
- func (client *Client) Zincrby(key string, value []byte, score float64) (float64, error)
- func (client *Client) Zrange(key string, start int, end int) ([][]byte, error)
- func (client *Client) Zrangebyscore(key string, start float64, end float64) ([][]byte, error)
- func (client *Client) Zrank(key string, value []byte) (int, error)
- func (client *Client) Zrem(key string, value []byte) (bool, error)
- func (client *Client) Zremrangebyrank(key string, start int, end int) (int, error)
- func (client *Client) Zremrangebyscore(key string, start float64, end float64) (int, error)
- func (client *Client) Zrevrange(key string, start int, end int) ([][]byte, error)
- func (client *Client) Zrevrank(key string, value []byte) (int, error)
- func (client *Client) Zscore(key string, member []byte) (float64, error)
- type Message
- type RedisError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
Addr string
Db int
Password string
MaxPoolSize int
// contains filtered or unexported fields
}
func (*Client) Bgrewriteaof ¶
func (*Client) Sdiffstore ¶
func (*Client) Sinterstore ¶
func (*Client) Subscribe ¶
func (client *Client) Subscribe(subscribe <-chan string, unsubscribe <-chan string, psubscribe <-chan string, punsubscribe <-chan string, messages chan<- Message) error
Subscribe to redis serve channels, this method will block until one of the sub/unsub channels are closed. There are two pairs of channels subscribe/unsubscribe & psubscribe/punsubscribe. The former does an exact match on the channel, the later uses glob patterns on the redis channels. Closing either of these channels will unblock this method call. Messages that are received are sent down the messages channel.
func (*Client) Sunionstore ¶
func (*Client) Zrangebyscore ¶
func (*Client) Zremrangebyrank ¶
func (*Client) Zremrangebyscore ¶
type Message ¶
Container for messages received from publishers on channels that we're subscribed to.
type RedisError ¶
type RedisError string
func (RedisError) Error ¶
func (err RedisError) Error() string
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.