欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  php教程

phpredis中文手册—《redis中文手册》 php版

程序员文章站 2022-03-05 23:09:49
...
本文是参考《redis中文手册》,将示例代码用php来实现,注意php-redis与redis_cli的区别(主要是返回值类型和参数用法)。

redis中文手册下载地址http://www.php.cn/xiazai/shouce/54

redis中文在线手册:http://www.php.cn/course/49.html

目录(使用CTRL+F快速查找命令):

Key String Hash List Set


  • 键(Key)

    • DEL

    • KEYS

    • RANDOMKEY

    • TTL

    • EXISTS

    • MOVE

    • RENAME

    • RENAMENX

    • TYPE

    • EXPIRE

    • EXPIREAT

    • OBJECT

    • PERSIST

    • SORT


  • 字符串(String)

    • SET

    • SETNX

    • SETEX

    • SETRANGE

    • MSET

    • MSETNX

    • APPEND

    • GET

    • MGET

    • GETRANGE

    • GETSET

    • STRLEN

    • INCR

    • INCRBY

    • DECR

    • DECRBY

    • SETBIT

    • GETBIT


  • 哈希表(Hash)

    • HSET

    • HSETNX

    • HMSET

    • HGET

    • HMGET

    • HGETALL

    • HDEL

    • HLEN

    • HEXISTS

    • HINCRBY

    • HKEYS

    • HVALS


  • 表(List)

    • LPUSH

    • LPUSHX

    • RPUSH

    • RPUSHX

    • LPOP

    • RPOP

    • BLPOP

    • BRPOP

    • LLEN

    • LRANGE

    • LREM

    • LSET

    • LTRIM

    • LINDEX

    • LINSERT

    • RPOPLPUSH

    • BRPOPLPUSH


  • 集合(Set)

    • SADD

    • SREM

    • SMEMBERS

    • SISMEMBER

    • SCARD

    • SMOVE

    • SPOP

    • SRANDMEMBER

    • SINTER

    • SINTERSTORE

    • SUNION

    • SUNIONSTORE

    • SDIFF

    • SDIFFSTORE


Sorted Set Pub/Sub Transaction Connection Server


  • 有序集(Sorted Set)

    • ZADD

    • ZREM

    • ZCARD

    • ZCOUNT

    • ZSCORE

    • ZINCRBY

    • ZRANGE

    • ZREVRANGE

    • ZRANGEBYSCORE

    • ZREVRANGEBYSCORE

    • ZRANK

    • ZREVRANK

    • ZREMRANGEBYRANK

    • ZREMRANGEBYSCORE

    • ZINTERSTORE

    • ZUNIONSTORE


  • 发布/订阅(Pub/Sub)

    • PUBLISH

    • SUBSCRIBE

    • PSUBSCRIBE

    • UNSUBSCRIBE

    • PUNSUBSCRIBE


  • 事务(Transaction)

    • WATCH

    • UNWATCH

    • MULTI

    • EXEC

    • DISCARD


  • 连接(Connection)

    • AUTH

    • PING

    • SELECT

    • ECHO

    • QUIT


  • 服务器(Server)

    • BGREWRITEAOF

    • BGSAVE

    • SAVE

    • LASTSAVE

    • DBSIZE

    • SLAVEOF

    • FLUSHALL

    • FLUSHDB

    • SHUTDOWN

    • SLOWLOG

    • INFO

    • CONFIG GET

    • CONFIG SET

    • CONFIG RESETSTAT

    • DEBUG OBJECT

    • DEBUG SEGFAULT

    • MONITOR

    • SYNC

phpredis是redis的php的一个扩展,效率是相当高有链表排序功能,对创建内存级的模块业务关系

很有用;以下是redis官方提供的命令使用技巧:

下载地址如下:

https://github.com/owlient/phpredis(支持redis 2.0.4)

Redis::__construct构造函数
$redis = new Redis();

connect, open 链接redis服务
参数
host: string,服务地址
port: int,端口号
timeout: float,链接时长 (可选, 默认为 0 ,不限链接时间)
注: 在redis.conf中也有时间,默认为300

pconnect, popen 不会主动关闭的链接
参考上面

setOption 设置redis模式

getOption 查看redis设置的模式

ping 查看连接状态

KEY相关操作

DEL

移除给定的一个或多个key

如果key不存在,则忽略该命令。

  • 时间复杂度:

  • O(N),N为要移除的key的数量。

  • 移除单个字符串类型的key,时间复杂度为O(1)。

    移除单个列表、集合、有序集合或哈希表类型的key,时间复杂度为O(M),M为以上数据结构内的元素数量。

  • 返回值:

  • 被移除key的数量。

->set('myname','ikodota');
 ->get('myname').'<br>'; 
->del('myname');(->get('myname')); 
(!->exists('fake_key')) (->del('fake_key')); 
=('first_key'=>'first_val',
          'second_key'=>'second_val',
          'third_key'=>'third_val');
->mset(); =('first_key','second_key','third_key');
(->mget()); 
->(); (->mget());
  • KEYS

  • KEYS pattern

  • 查找符合给定模式的key

KEYS *命中数据库中所有key

KEYS h?llo命中hellohallo and hxllo等。

KEYS h*llo命中hlloheeeeello等。

KEYS h[ae]llo命中hellohallo,但不命中hillo

特殊符号用"\"隔开

  • 时间复杂度:

  • O(N),N为数据库中key的数量。

  • 返回值:

  • 符合给定模式的key列表。

警告 :KEYS的速度非常快,但在一个大的数据库中使用它仍然可能造成性能问题,如果你需要从一个数据集中查找特定的key,你最好还是用集合(Set)

=('one'=>'1',
          'two'=>'2',
          'three '=>'3',
          'four'=>'4');
->mset(); (->keys('*o*')); (->keys('t??')); (->keys('t[w]*')); (->keys('*'));

RANDOMKEY

从当前数据库中随机返回(不删除)一个key

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 当数据库不为空时,返回一个key

    当数据库为空时,返回nil。

->FLUSHALL();
=('fruit'=>'apple',
                'drink'=>'beer',
                'food'=>'cookis');
->mset();
 ->randomkey(); 
(->keys('*')); 
->flushdb();  (-> randomkey());
  • TTL
    TTL key

返回给定key的剩余生存时间(time to live)(以秒为单位)。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • key的剩余生存时间(以秒为单位)。

    key不存在或没有设置生存时间时,返回-1

->flushdb();
->expire('name',30);   ->get('name');  ->ttl('name'); (->get('name')); 
->set('site','wikipedia.org');(->ttl('site'));
->EXISTS('not_exists_key');(->TTL('not_exists_key'));
  • EXISTS

  • EXISTS key

检查给定key是否存在。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • key存在,返回1,否则返回0

 '<br>EXISTS<br>';
->set('db',"redis"); (->exists('db'));  ->del('db');   (->exists('db'))

MOVE
MOVE key db

将当前数据库(默认为0)的key移动到给定的数据库db当中。

如果当前数据库(源数据库)和给定数据库(目标数据库)有相同名字的给定key,或者key不存在于当前数据库,那么MOVE没有任何效果。

因此,也可以利用这一特性,将MOVE当作锁(locking)原语。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 移动成功返回1,失败则返回0

 '<br><br>MOVE<br>';
->SELECT(0);  ->SET('song',"secret base - Zone");  (->MOVE('song',1));  
->SELECT(1);
 (->EXISTS('fake_key'));(->MOVE('fake_key', 0));  
->SELECT(0); (->EXISTS('fake_key'));  

->SELECT(0);  ->SET('favorite_fruit',"banana");

->SELECT(1);  ->SET('favorite_fruit',"apple");

->SELECT(0);  (->MOVE('favorite_fruit',1));   ->GET('favorite_fruit');  
->SELECT(1);
 ->GET('favorite_fruit');

RENAME

  • RENAME key newkey

key改名为newkey

keynewkey相同或者key不存在时,返回一个错误。

newkey已经存在时,RENAME命令将覆盖旧值。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 改名成功时提示OK,失败时候返回一个错误。

 '<br><br>RENAME<br>';
->SET('message',"hello world");
(->('message','greeting'));  (->EXISTS('message'));  (->EXISTS('greeting'));   
(->('fake_key','never_exists'));  
->SET('pc',"lenovo");
->SET('personal_computer',"dell"); 
(->('pc','personal_computer')); (->GET('pc')); (->GET('personal_computer'));
  • RENAMENX

  • RENAMENX key newkey

当且仅当newkey不存在时,将key改为newkey

出错的情况和RENAME一样(key不存在时报错)。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 修改成功时,返回1

    如果newkey已经存在,返回0

 '<br><br>RENAMENX<br>';

->SET('player',"MPlyaer");
->EXISTS('best_player'); (->RENAMENX('player','best_player')); 
->SET('animal',"bear");
->SET('favorite_animal', "butterfly");

(->RENAMENX('animal', 'favorite_animal'));
(->get('animal')); (->get('favorite_animal'));
  • TYPE

  • TYPE key

返回key所储存的值的类型。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • none(key不存在) int(0)

    string(字符串) int(1)

    list(列表) int(3)

    set(集合) int(2)

    zset(有序集) int(4)

    hash(哈希表) int(5)

->flushALL();
 '<br><br>TYPE<br>';

(->TYPE('fake_key')); 
->SET('weather',"sunny");  (->TYPE('weather'));
->SADD('pat',"dog");  (->TYPE('pat')); 
->LPUSH('book_list',"programming in scala");  (->TYPE('book_list'));
->ZADD('pats',1,'cat');  ->ZADD('pats',2,'dog');
->ZADD('pats',3,'pig');
(->zRange('pats',0,-1)); (->TYPE('pats')); 
->HSET('website','google','www.g.cn');   (->HGET('website','google')); (->TYPE('website'));

EXPIRE

EXPIRE key seconds

为给定key设置生存时间。

key过期时,它会被自动删除。

在Redis中,带有生存时间的key被称作“易失的”(volatile)。

在低于2.1.3版本的Redis中,已存在的生存时间不可覆盖。

从2.1.3版本开始,key的生存时间可以被更新,也可以被PERSIST命令移除。(详情参见 http://redis.io/topics/expire)。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 设置成功返回1

    key不存在或者不能为key设置生存时间时(比如在低于2.1.3中你尝试更新key的生存时间),返回0


phpredis中文手册—《redis中文手册》 php版

->select(7);

 '<br><br>EXPIRE<br>';
->SET('cache_page',"www.cnblogs.com/ikodota");
->EXPIRE('cache_page', 30);  (6);
 ->TTL('cache_page').'<br>';   
->EXPIRE('cache_page', 3000);  (4);
 ->TTL('cache_page').'<br>';

phpredis中文手册—《redis中文手册》 php版

  • EXPIREAT

  • EXPIREAT key timestamp

EXPIREAT的作用和EXPIRE一样,都用于为key设置生存时间。

不同在于EXPIREAT命令接受的时间参数是UNIX时间戳(unix timestamp)。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 如果生存时间设置成功,返回1

    key不存在或没办法设置生存时间,返回0


 '<br><br>EXPIREAT<br>';
->SET('cache','www.google.com');
 ->EXPIREAT('cache','1355292000'); 
 (->TTL('cache'));

  • OBJECT

  • OBJECT subcommand [arguments [arguments]]

OBJECT命令允许从内部察看给定key的Redis对象。


它通常用在除错(debugging)或者了解为了节省空间而对key使用特殊编码的情况。

当将Redis用作缓存程序时,你也可以通过OBJECT命令中的信息,决定key的驱逐策略(eviction policies)。

OBJECT命令有多个子命令:

  • OBJECT REFCOUNT <key>返回给定key引用所储存的值的次数。此命令主要用于除错。

  • OBJECT ENCODING <key>返回给定key锁储存的值所使用的内部表示(representation)。

  • OBJECT IDLETIME <key>返回给定key自储存以来的空转时间(idle, 没有被读取也没有被写入),以秒为单位。


对象可以以多种方式编码:

  • 字符串可以被编码为raw(一般字符串)或int(用字符串表示64位数字是为了节约空间)。

  • 列表可以被编码为ziplistlinkedlistziplist是为节约大小较小的列表空间而作的特殊表示。

  • 集合可以被编码为intset或者hashtableintset是只储存数字的小集合的特殊表示。

  • 哈希表可以编码为zipmap或者hashtablezipmap是小哈希表的特殊表示。

  • 有序集合可以被编码为ziplist或者skiplist格式。ziplist用于表示小的有序集合,而skiplist则用于表示任何大小的有序集合。


假如你做了什么让Redis没办法再使用节省空间的编码时(比如将一个只有1个元素的集合扩展为一个有100万个元素的集合),特殊编码类型(specially encoded types)会自动转换成通用类型(general type)。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • REFCOUNTIDLETIME返回数字。

    ENCODING返回相应的编码类型。


phpredis中文手册—《redis中文手册》 php版

->select(8);
 '<br><br>OBJECT<br>';
->SET('game',"WOW");  ->('REFCOUNT','game');   ->('IDLETIME','game');  (->('ENCODING','game'));  ->SET('phone',15820123123);  (->('ENCODING','phone')); ->SET('age',20);  (->('ENCODING','age'));

phpredis中文手册—《redis中文手册》 php版

  • PERSIST

  • PERSIST key


移除给定key的生存时间。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 当生存时间移除成功时,返回1.

    如果key不存在或key没有设置生存时间,返回0


phpredis中文手册—《redis中文手册》 php版

 '<br><br>PERSIST<br>';
->SET('time_to_say_goodbye',"886...");
->EXPIRE('time_to_say_goodbye', 300);
(3);
 ->TTL('time_to_say_goodbye');  '<br>';

->PERSIST('time_to_say_goodbye');   ->TTL('time_to_say_goodbye');

phpredis中文手册—《redis中文手册》 php版


SORT

  • SORT key [BY pattern] [LIMIT offset count] [GET pattern [GET pattern ...]] [ASC | DESC] [ALPHA] [STORE destination]


排序,分页等
参数

array(
‘by’ => ‘some_pattern_*’,
‘limit’ => array(0, 1),
‘get’ => ‘some_other_pattern_*’ or an array of patterns,
‘sort’ => ‘asc’ or ‘desc’,
‘alpha’ => TRUE,
‘store’ => ‘external-key’
)

返回或保存给定列表、集合、有序集合key中经过排序的元素。

排序默认以数字作为对象,值被解释为双精度浮点数,然后进行比较。

一般SORT用法

最简单的SORT使用方法是SORT key

假设today_cost是一个保存数字的列表,SORT命令默认会返回该列表值的递增(从小到大)排序结果。


phpredis中文手册—《redis中文手册》 php版

->LPUSH('today_cost', 30);
->LPUSH('today_cost', 1.5);
->LPUSH('today_cost', 10);
->LPUSH('today_cost', 8);

(->('today_cost'));

phpredis中文手册—《redis中文手册》 php版

当数据集中保存的是字符串值时,你可以用ALPHA修饰符(modifier)进行排序。


phpredis中文手册—《redis中文手册》 php版

->LPUSH('website', "www.reddit.com");
->LPUSH('website', "www.slashdot.com");
->LPUSH('website', "www.infoq.com");
(->('website'));
(->('website', ('ALPHA'=>)));

phpredis中文手册—《redis中文手册》 php版

如果你正确设置了!LC_COLLATE环境变量的话,Redis能识别UTF-8编码。


排序之后返回的元素数量可以通过LIMIT修饰符进行限制。

LIMIT修饰符接受两个参数:offsetcount

offset指定要跳过的元素数量,count指定跳过offset个指定的元素之后,要返回多少个对象。

以下例子返回排序结果的前5个对象(offset0表示没有元素被跳过)。


phpredis中文手册—《redis中文手册》 php版

->LPUSH('rank', 30); ->LPUSH('rank', 56); ->LPUSH('rank', 42); ->LPUSH('rank', 22); ->LPUSH('rank', 0);  ->LPUSH('rank', 11); ->LPUSH('rank', 32); ->LPUSH('rank', 67); ->LPUSH('rank', 50); ->LPUSH('rank', 44); ->LPUSH('rank', 55); 
=('LIMIT'=>(0,5));
(->('rank',));

phpredis中文手册—《redis中文手册》 php版

修饰符可以组合使用。以下例子返回降序(从大到小)的前5个对象。


=(
            'LIMIT'=>(0,5),
            'SORT'=>'DESC'
            );
(->('rank',));

使用外部key进行排序

有时候你会希望使用外部的key作为权重来比较元素,代替默认的对比方法。

假设现在有用户(user)数据如下:

id    name    level
-------------------------------
1    admin    9999
2    huangz   10
59230  jack     3
222    hacker    9999

id数据保存在key名为user_id的列表中。
name数据保存在key名为user_name_{id}的列表中
level数据保存在user_level_{id}的key中。


phpredis中文手册—《redis中文手册》 php版

->LPUSH('user_id', 1);->SET('user_name_1', 'admin');
->SET('user_level_1',9999);

->LPUSH('user_id', 2);->SET('user_name_2', 'huangz');
->SET('user_level_2', 10);

->LPUSH('user_id', 59230);->SET('user_name_59230','jack');
->SET('user_level_59230', 3);

->LPUSH('user_id', 222);  ->SET('user_name_222', 'hacker');
->SET('user_level_222', 9999);

phpredis中文手册—《redis中文手册》 php版

如果希望按level从大到小排序user_id,可以使用以下命令:


phpredis中文手册—《redis中文手册》 php版

=('BY'=>'user_level_*',
            'SORT'=>'DESC'
            );
(->('user_id',));

phpredis中文手册—《redis中文手册》 php版

但是有时候只是返回相应的id没有什么用,你可能更希望排序后返回id对应的用户名,这样更友好一点,使用GET选项可以做到这一点:


phpredis中文手册—《redis中文手册》 php版

=('BY'=>'user_level_*',
            'SORT'=>'DESC',
            'GET'=>'user_name_*'
            );
(->('user_id', ));
#1) "hacker"#2) "admin"#3) "huangz"#4) "jack"

phpredis中文手册—《redis中文手册》 php版

可以多次地、有序地使用GET操作来获取更多外部key

比如你不但希望获取用户名,还希望连用户的密码也一并列出,可以使用以下命令:


phpredis中文手册—《redis中文手册》 php版

->SET('user_password_222', "hey,im in");
->SET('user_password_1', "a_long_long_password");
->SET('user_password_2', "nobodyknows");
->SET('user_password_59230', "jack201022");

=('BY'=>'user_level_*',
            'SORT'=>'DESC',
            'GET'=>('user_name_*','user_password_*')
            );
(->('user_id',));

phpredis中文手册—《redis中文手册》 php版

# 注意GET操作是有序的,GET user_name_* GET user_password_* 和 GET user_password_* GET user_name_*返回的结果位置不同


phpredis中文手册—《redis中文手册》 php版

=('BY'=>'user_level_*',
            'SORT'=>'DESC',
            'GET'=>('','')
            );
(->('user_id',));

phpredis中文手册—《redis中文手册》 php版

GET还有一个特殊的规则——"GET #",用于获取被排序对象(我们这里的例子是user_id)的当前元素。

比如你希望user_idlevel排序,还要列出idnamepassword,可以使用以下命令:


phpredis中文手册—《redis中文手册》 php版

=('BY'=>'user_level_*',
            'SORT'=>'DESC',
            'GET'=>('#','user_password_*','user_name_*')
            );
(->('user_id',));

phpredis中文手册—《redis中文手册》 php版

只获取对象而不排序

BY修饰符可以将一个不存在的key当作权重,让SORT跳过排序操作。

该方法用于你希望获取外部对象而又不希望引起排序开销时使用。


phpredis中文手册—《redis中文手册》 php版

->EXISTS('fake_key');
=('BY'=>'fake_key',
            'SORT'=>'DESC',
            'GET'=>('#','user_name_*','user_password_*')
            );
(->('user_id',));

phpredis中文手册—《redis中文手册》 php版

保存排序结果

默认情况下,SORT操作只是简单地返回排序结果,如果你希望保存排序结果,可以给STORE选项指定一个key作为参数,排序结果将以列表的形式被保存到这个key上。(若指定key已存在,则覆盖。)


phpredis中文手册—《redis中文手册》 php版

->EXISTS('user_info_sorted_by_level');  =('BY'=>'user_level_*',
            'GET'=>('#','user_name_*','user_password_*'),
            'STORE'=>'user_info_sorted_by_level'
            );

(->('user_id',)); (->LRANGE('user_info_sorted_by_level', 0 ,11));

phpredis中文手册—《redis中文手册》 php版

一个有趣的用法是将SORT结果保存,用EXPIRE为结果集设置生存时间,这样结果集就成了SORT操作的一个缓存。

这样就不必频繁地调用SORT操作了,只有当结果集过期时,才需要再调用一次SORT操作。

有时候为了正确实现这一用法,你可能需要加锁以避免多个客户端同时进行缓存重建(也就是多个客户端,同一时间进行SORT操作,并保存为结果集),具体参见SETNX命令。

在GET和BY中使用哈希表

可以使用哈希表特有的语法,在SORT命令中进行GET和BY操作。


phpredis中文手册—《redis中文手册》 php版

=(1=>'23131283',
                2=>'23810573',
                222=>'502342349',
                59230=>'2435829758'
                );

->HMSET('serial',);

=('BY'=>'*->serial');
(->('user_id', ));

phpredis中文手册—《redis中文手册》 php版

符号"->"用于分割哈希表的关键字(key name)和索引域(hash field),格式为"key->field"

除此之外,哈希表的BYGET操作和上面介绍的其他数据结构(列表、集合、有序集合)没有什么不同。

  • 时间复杂度:


  • O(N+M*log(M)),N为要排序的列表或集合内的元素数量,M为要返回的元素数量。

    如果只是使用SORT命令的GET选项获取数据而没有进行排序,时间复杂度O(N)。

  • 返回值:


  • 没有使用STORE参数,返回列表形式的排序结果。

    使用STORE参数,返回排序结果的元素数量。

字符串(String)

SET

  • SET key value


将字符串值value关联到key

如果key已经持有其他值,SET就覆写旧值,无视类型。


时间复杂度:O(1)返回值:总是返回OK(TRUE),因为SET不可能失败。


phpredis中文手册—《redis中文手册》 php版

->SET('apple', 'www.apple.com');->GET('apple');
->LPUSH('greet_list', "hello");  ->TYPE('greet_list');
->SET('greet_list', "yooooooooooooooooo");   ->TYPE('greet_list');

phpredis中文手册—《redis中文手册》 php版

SETNX

  • SETNX key value


key的值设为value,当且仅当key不存在。

若给定的key已经存在,则SETNX不做任何动作。

SETNX是”SET if Not eXists”(如果不存在,则SET)的简写。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 设置成功,返回1

    设置失败,返回0


 '<br><br>SETNX<br>';
->EXISTS('job');  ->SETNX('job', "programmer");  ->SETNX('job', "code-farmer");   ->GET('job');

设计模式(Design pattern): 将SETNX用于加锁(locking)

SETNX可以用作加锁原语(locking primitive)。比如说,要对关键字(key)foo加锁,客户端可以尝试以下方式:

SETNX lock.foo <current Unix time + lock timeout + 1>

如果SETNX返回1,说明客户端已经获得了锁,key设置的unix时间则指定了锁失效的时间。之后客户端可以通过DEL lock.foo来释放锁。

如果SETNX返回0,说明key已经被其他客户端上锁了。如果锁是非阻塞(non blocking lock)的,我们可以选择返回调用,或者进入一个重试循环,直到成功获得锁或重试超时(timeout)。

处理死锁(deadlock)

上面的锁算法有一个问题:如果因为客户端失败、崩溃或其他原因导致没有办法释放锁的话,怎么办?

这种状况可以通过检测发现——因为上锁的key保存的是unix时间戳,假如key值的时间戳小于当前的时间戳,表示锁已经不再有效。

但是,当有多个客户端同时检测一个锁是否过期并尝试释放它的时候,我们不能简单粗暴地删除死锁的key,再用SETNX上锁,因为这时竞争条件(race condition)已经形成了:

  • C1和C2读取lock.foo并检查时间戳,SETNX都返回0,因为它已经被C3锁上了,但C3在上锁之后就崩溃(crashed)了。

  • C1向lock.foo发送DEL命令。

  • C1向lock.foo发送SETNX并成功。

  • C2向lock.foo发送DEL命令。

  • C2向lock.foo发送SETNX并成功。

  • 出错:因为竞争条件的关系,C1和C2两个都获得了锁。

幸好,以下算法可以避免以上问题。来看看我们聪明的C4客户端怎么办:

  • C4向lock.foo发送SETNX命令。

  • 因为崩溃掉的C3还锁着lock.foo,所以Redis向C4返回0

  • C4向lock.foo发送GET命令,查看lock.foo的锁是否过期。如果不,则休眠(sleep)一段时间,并在之后重试。

  • 另一方面,如果lock.foo内的unix时间戳比当前时间戳老,C4执行以下命令:

GETSET lock.foo <current Unix timestamp + lock timeout + 1>

  • 因为GETSET的作用,C4可以检查看GETSET的返回值,确定lock.foo之前储存的旧值仍是那个过期时间戳,如果是的话,那么C4获得锁。

  • 如果其他客户端,比如C5,比C4更快地执行了GETSET操作并获得锁,那么C4的GETSET操作返回的就是一个未过期的时间戳(C5设置的时间戳)。C4只好从第一步开始重试。


注意,即便C4的GETSET操作对key进行了修改,这对未来也没什么影响。

(这里是不是有点问题?C4的确是可以重试,但C5怎么办?它的锁的过期被C4修改了。——译注)

警告

为了让这个加锁算法更健壮,获得锁的客户端应该常常检查过期时间以免锁因诸如DEL等命令的执行而被意外解开,因为客户端失败的情况非常复杂,不仅仅是崩溃这么简单,还可能是客户端因为某些操作被阻塞了相当长时间,紧接着DEL命令被尝试执行(但这时锁却在另外的客户端手上)。

SETEX

SETEX key seconds value

将值value关联到key,并将key的生存时间设为seconds(以秒为单位)。

如果key 已经存在,SETEX命令将覆写旧值。

这个命令类似于以下两个命令:


->SET('key', 'value');
->EXPIRE('key','seconds');

不同之处是,SETEX是一个原子性(atomic)操作,关联值和设置生存时间两个动作会在同一时间内完成,该命令在Redis用作缓存时,非常实用。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 设置成功时返回OK

    seconds参数不合法时,返回一个错误。


phpredis中文手册—《redis中文手册》 php版

->SETEX('cache_user_id', 60,10086); ->GET('cache_user_id');  
(4);
 ->TTL('cache_user_id');  
->SET('cd', "timeless"); ->SETEX('cd', 3000,"goodbye my love");  ->GET('cd');

phpredis中文手册—《redis中文手册》 php版

SETRANGE

SETRANGE key offset value

value参数覆写(Overwrite)给定key所储存的字符串值,从偏移量offset开始。

不存在的key当作空白字符串处理。

SETRANGE命令会确保字符串足够长以便将value设置在指定的偏移量上,如果给定key原来储存的字符串长度比偏移量小(比如字符串只有5个字符长,但你设置的offset10),那么原字符和偏移量之间的空白将用零比特(zerobytes,"\x00")来填充。

注意你能使用的最大偏移量是2^29-1(536870911),因为Redis的字符串被限制在512兆(megabytes)内。如果你需要使用比这更大的空间,你得使用多个key

  • 时间复杂度:


  • 对小(small)的字符串,平摊复杂度O(1)。(关于什么字符串是”小”的,请参考APPEND命令)

    否则为O(M),M为value参数的长度。

  • 返回值:

  • 被SETRANGE修改之后,字符串的长度。

警告

当生成一个很长的字符串时,Redis需要分配内存空间,该操作有时候可能会造成服务器阻塞(block)。在2010年的Macbook Pro上,设置偏移量为536870911(512MB内存分配),耗费约300毫秒, 设置偏移量为134217728(128MB内存分配),耗费约80毫秒,设置偏移量33554432(32MB内存分配),耗费约30毫秒,设置偏移量为8388608(8MB内存分配),耗费约8毫秒。 注意若首次内存分配成功之后,再对同一个key调用SETRANGE操作,无须再重新内存。

模式

因为有了SETRANGE和GETRANGE命令,你可以将Redis字符串用作具有O(1)随机访问时间的线性数组。这在很多真实用例中都是非常快速且高效的储存方式。


phpredis中文手册—《redis中文手册》 php版

->SET('greeting', "hello world");
->SETRANGE('greeting', 6, "Redis"); ->GET('greeting');
->EXISTS('empty_string');->SETRANGE('empty_string', 5 ,"Redis!");  (->GET('empty_string'));

phpredis中文手册—《redis中文手册》 php版

MSET
MSET key value [key value ...]

同时设置一个或多个key-value对。

当发现同名的key存在时,MSET会用新值覆盖旧值,如果你不希望覆盖同名key,请使用MSETNX命令。

MSET是一个原子性(atomic)操作,所有给定key都在同一时间内被设置,某些给定key被更新而另一些给定key没有改变的情况,不可能发生。

  • 时间复杂度:

  • O(N),N为要设置的key数量。

  • 返回值:

  • 总是返回OK(因为MSET不可能失败)



phpredis中文手册—《redis中文手册》 php版

 '<br><br>MSET<br>';
->select(0);
->flushdb();
=('date'=>'2012.3.5',
        'time'=>'9.09a.m.',
        'weather'=>'sunny'
        );
->MSET(); 
(->KEYS('*'));   
(->SET('google', "google.cn"));   (->MSET('google',"google.hk"));  ->GET('google');

phpredis中文手册—《redis中文手册》 php版

MSETNX

  • MSETNX key value [key value ...]


同时设置一个或多个key-value对,当且仅当key不存在。

即使只有一个key已存在,MSETNX也会拒绝所有传入key的设置操作

MSETNX是原子性的,因此它可以用作设置多个不同key表示不同字段(field)的唯一性逻辑对象(unique logic object),所有字段要么全被设置,要么全不被设置。

  • 时间复杂度:

  • O(N),N为要设置的key的数量。

  • 返回值:


  • 当所有key都成功设置,返回1

    如果所有key都设置失败(最少有一个key已经存在),那么返回0


phpredis中文手册—《redis中文手册》 php版

=('rmdbs'=>'MySQL',
        'nosql'=>'MongoDB',
        'key-value-store'=>'redis'
        );
->MSETNX();

=('rmdbs'=>'Sqlite',
        'language'=>'python'
        );
(->MSETNX());  (->EXISTS('language'));  
 ->GET('rmdbs');  
=( 'rmdbs', 'nosql', 'key-value-store');
(->MGET());

phpredis中文手册—《redis中文手册》 php版

APPEND

  • APPEND key value


如果key已经存在并且是一个字符串,APPEND命令将value追加到key原来的值之后。

如果key不存在,APPEND就简单地将给定key设为value,就像执行SET key value一样。

  • 时间复杂度:

  • 平摊复杂度O(1)

  • 返回值:

  • 追加value之后,key中字符串的长度。


->EXISTS('myphone');  ->APPEND('myphone',"nokia");  
->APPEND('myphone', " - 1110");
 ->GET('myphone');

GET

  • GET key


返回key所关联的字符串值。

如果key不存在则返回特殊值nil

假如key储存的值不是字符串类型,返回一个错误,因为GET只能用于处理字符串值。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • key的值。

    如果key不存在,返回nil


(->GET('fake_key')); ->SET('animate', "anohana"); (->GET('animate'));

MGET

  • MGET key [key ...]


返回所有(一个或多个)给定key的值。

如果某个指定key不存在,那么返回特殊值nil。因此,该命令永不失败。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 一个包含所有给定key的值的列表。


phpredis中文手册—《redis中文手册》 php版

 '<br><br>MGET<br>';
=('name'=>'ikodota','blog'=>'cnblogs.com/ikodota');
->MSET();
=('name','blog');
(->MGET()); 
->EXISTS('fake_key'); 
=('name','fake_key');
(->MGET());

phpredis中文手册—《redis中文手册》 php版

GETRANGE

  • GETRANGE key start end


返回key中字符串值的子字符串,字符串的截取范围由startend两个偏移量决定(包括startend在内)。

负数偏移量表示从字符串最后开始计数,-1表示最后一个字符,-2表示倒数第二个,以此类推。

GETRANGE通过保证子字符串的值域(range)不超过实际字符串的值域来处理超出范围的值域请求。

  • 时间复杂度:


  • O(N),N为要返回的字符串的长度。

    复杂度最终由返回值长度决定,但因为从已有字符串中建立子字符串的操作非常廉价(cheap),所以对于长度不大的字符串,该操作的复杂度也可看作O(1)。

  • 返回值:

  • 截取得出的子字符串。

注解:在<=2.0的版本里,GETRANGE被叫作SUBSTR。


phpredis中文手册—《redis中文手册》 php版

 '<br><br>GETRANGE<br>';
->SET('greeting', "hello, my friend");
 ->GETRANGE('greeting', 0, 4).'<br>';   ->GETRANGE('greeting', -1 ,-5).'<br>';   ->GETRANGE('greeting', -3 ,-1).'<br>';   ->GETRANGE('greeting', 0, -1).'<br>';   ->GETRANGE('greeting', 0, 1008611).'<br>';

phpredis中文手册—《redis中文手册》 php版

GETSET

  • GETSET key value


将给定key的值设为value,并返回key的旧值。

key存在但不是字符串类型时,返回一个错误。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 返回给定key的旧值(old value)。

    key没有旧值时,返回nil


 '<br><br>GETSET<br>';
(->EXISTS('mail'));(->GETSET('mail','xxx@google.com'));  
(->GETSET('mail','xxx@yahoo.com'));

设计模式

GETSET可以和INCR组合使用,实现一个有原子性(atomic)复位操作的计数器(counter)。

举例来说,每次当某个事件发生时,进程可能对一个名为mycountkey调用INCR操作,通常我们还要在一个原子时间内同时完成获得计数器的值和将计数器值复位为0两个操作。

可以用命令GETSET mycounter 0来实现这一目标。


->SELECT(2);
 ->INCR('mycount').'<br>'; 
(->GET('mycount')>19){
 ->GETSET('mycount', 0).'<br>';  }
 ->GET('mycount');

STRLEN

  • STRLEN key


返回key所储存的字符串值的长度。

key储存的不是字符串值时,返回一个错误。

  • 复杂度:

  • O(1)

  • 返回值:


  • 字符串值的长度。

    key不存在时,返回0


->SET('mykey', "Hello world");
 ->('mykey');  ->('nonexisting');

INCR

  • INCR key


key中储存的数字值增一。

如果key不存在,以0key的初始值,然后执行INCR操作。

如果值包含错误的类型,或字符串类型的值不能表示为数字,那么返回一个错误。

本操作的值限制在64位(bit)有符号数字表示之内。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 执行INCR命令之后key的值。

注解:这是一个针对字符串的操作,因为Redis没有专用的整数类型,所以key内储存的字符串被解释为十进制64位有符号整数来执行INCR操作。


->SET('page_view', 20);
(->INCR('page_view')); (->GET('page_view'));

INCRBY

  • INCRBY key increment


key所储存的值加上增量increment

如果key不存在,以0key的初始值,然后执行INCRBY命令。

如果值包含错误的类型,或字符串类型的值不能表示为数字,那么返回一个错误。

本操作的值限制在64位(bit)有符号数字表示之内。

关于更多递增(increment)/递减(decrement)操作信息,参见INCR命令。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 加上increment之后,key的值。


phpredis中文手册—《redis中文手册》 php版

 '<br><br>INCRBY<br>';
->SET('rank', 50);  ->INCRBY('rank', 20);  (->GET('rank')); 
->EXISTS('counter'); ->INCRBY('counter'); (->GET('counter')); 
->SET('book', "long long ago...");
(->INCRBY('book', 200));

phpredis中文手册—《redis中文手册》 php版

DECR

  • DECR key


key中储存的数字值减一。

如果key不存在,以0key的初始值,然后执行DECR操作。

如果值包含错误的类型,或字符串类型的值不能表示为数字,那么返回一个错误。

本操作的值限制在64位(bit)有符号数字表示之内。

关于更多递增(increment)/递减(decrement)操作信息,参见INCR命令。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 执行DECR命令之后key的值。


phpredis中文手册—《redis中文手册》 php版

->SELECT(3);
->flushdb();
 '<br><br>DECR<br>';
->SET('failure_times', 10);
->DECR('failure_times');  ->GET('failure_times').'<br>';  
->EXISTS('count'); ->DECR('count');   ->GET('count').'<br>'; 
->SET('company', 'YOUR_CODE_SUCKS.LLC');
(->DECR('company'));  ->GET('company').'<br>';

phpredis中文手册—《redis中文手册》 php版

DECRBY

  • DECRBY key decrement


key所储存的值减去减量decrement

如果key不存在,以0key的初始值,然后执行DECRBY操作。

如果值包含错误的类型,或字符串类型的值不能表示为数字,那么返回一个错误。

本操作的值限制在64位(bit)有符号数字表示之内。

关于更多递增(increment)/递减(decrement)操作信息,参见INCR命令。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 减去decrement之后,key的值。


phpredis中文手册—《redis中文手册》 php版

->SET('count', 100);
(->DECRBY('count', 20)); (->GET('count'));  
->EXISTS('pages');(->DECRBY('pages', 10));  (->GET('pages'));

phpredis中文手册—《redis中文手册》 php版

SETBIT

  • SETBIT key offset value


key所储存的字符串值,设置或清除指定偏移量上的位(bit)。

位的设置或清除取决于value参数,可以是0也可以是1

key不存在时,自动生成一个新的字符串值。

字符串会增长(grown)以确保它可以将value保存在指定的偏移量上。当字符串值增长时,空白位置以0填充。

offset参数必须大于或等于0,小于2^32(bit映射被限制在512MB内)。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 指定偏移量原来储存的位("0"或"1").

警告:对使用大的offset的SETBIT操作来说,内存分配可能造成Redis服务器被阻塞。具体参考SETRANGE命令,warning(警告)部分。


phpredis中文手册—《redis中文手册》 php版

 '<br><br>SETBIT<br>';
=67;
 ().'<br>'; (->SETBIT('bit',1,1));(->SETBIT('bit',2,0));(->SETBIT('bit',3,0));(->SETBIT('bit',4,0));(->SETBIT('bit',5,0));(->SETBIT('bit',6,1));(->SETBIT('bit',7,1));
(->GET('bit')); 
(->GETBIT('bit', 6 )); 
(->SETBIT('bit',5,1));(->SETBIT('bit',6,0));
(->GET('bit'));

phpredis中文手册—《redis中文手册》 php版

GETBIT

  • GETBIT key offset


key所储存的字符串值,获取指定偏移量上的位(bit)。

offset比字符串值的长度大,或者key不存在时,返回0

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 字符串值指定偏移量上的位(bit)。


#参见SETBIT的示例

哈希表(Hash)

HSET

  • HSET key field value


将哈希表key中的域field的值设为value

如果key不存在,一个新的哈希表被创建并进行HSET操作。

如果域field已经存在于哈希表中,旧值将被覆盖。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 如果field是哈希表中的一个新建域,并且值设置成功,返回1

    如果哈希表中域field已经存在且旧值已被新值覆盖,返回0

HSETNX

  • HSETNX key field value


将哈希表key中的域field的值设置为value,当且仅当域field不存在。

若域field已经存在,该操作无效。

如果key不存在,一个新哈希表被创建并执行HSETNX命令。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 设置成功,返回1

    如果给定域已经存在且没有操作被执行,返回0

HMSET

  • HMSET key field value [field value ...]


同时将多个field - value(域-值)对设置到哈希表key中。

此命令会覆盖哈希表中已存在的域。

如果key不存在,一个空哈希表被创建并执行HMSET操作。

  • 时间复杂度:

  • O(N),Nfield - value对的数量。

  • 返回值:


  • 如果命令执行成功,返回OK

    key不是哈希表(hash)类型时,返回一个错误。

HGET

  • HGET key field


返回哈希表key中给定域field的值。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 给定域的值。

    当给定域不存在或是给定key不存在时,返回nil

HMGET

  • HMGET key field [field ...]


返回哈希表key中,一个或多个给定域的值。

如果给定的域不存在于哈希表,那么返回一个nil值。

因为不存在的key被当作一个空哈希表来处理,所以对一个不存在的key进行HMGET操作将返回一个只带有nil值的表。

  • 时间复杂度:

  • O(N),N为给定域的数量。

  • 返回值:

  • 一个包含多个给定域的关联值的表,表值的排列顺序和给定域参数的请求顺序一样。

HGETALL

  • HGETALL key


返回哈希表key中,所有的域和值。

在返回值里,紧跟每个域名(field name)之后是域的值(value),所以返回值的长度是哈希表大小的两倍。

  • 时间复杂度:

  • O(N),N为哈希表的大小。

  • 返回值:

  • 以列表形式返回哈希表的域和域的值。 若key不存在,返回空列表。

HDEL

  • HDEL key field [field ...]


删除哈希表key中的一个或多个指定域,不存在的域将被忽略。

  • 时间复杂度:

  • O(N),N为要删除的域的数量。

  • 返回值:

  • 被成功移除的域的数量,不包括被忽略的域。

注解:在Redis2.4以下的版本里,HDEL每次只能删除单个域,如果你需要在一个原子时间内删除多个域,请将命令包含在MULTI/ EXEC块内。

HLEN

  • HLEN key


返回哈希表key中域的数量。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 哈希表中域的数量。

    key不存在时,返回0

HEXISTS

  • HEXISTS key field


查看哈希表key中,给定域field是否存在。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 如果哈希表含有给定域,返回1

    如果哈希表不含有给定域,或key不存在,返回0

HINCRBY

  • HINCRBY key field increment


为哈希表key中的域field的值加上增量increment

增量也可以为负数,相当于对给定域进行减法操作。

如果key不存在,一个新的哈希表被创建并执行HINCRBY命令。

如果域field不存在,那么在执行命令前,域的值被初始化为0

对一个储存字符串值的域field执行HINCRBY命令将造成一个错误。

本操作的值限制在64位(bit)有符号数字表示之内。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 执行HINCRBY命令之后,哈希表key中域field的值。

HKEYS

  • HKEYS key


返回哈希表key中的所有域。

  • 时间复杂度:

  • O(N),N为哈希表的大小。

  • 返回值:


  • 一个包含哈希表中所有域的表。

    key不存在时,返回一个空表。

HVALS

  • HVALS key


返回哈希表key中的所有值。

  • 时间复杂度:

  • O(N),N为哈希表的大小。

  • 返回值:


  • 一个包含哈希表中所有值的表。

    key不存在时,返回一个空表。

表(List)

头元素和尾元素

头元素指的是列表左端/前端第一个元素,尾元素指的是列表右端/后端第一个元素。

举个例子,列表list包含三个元素:x, y, z,其中x是头元素,而z则是尾元素。

空列表

指不包含任何元素的列表,Redis将不存在的key也视为空列表。

LPUSH

  • LPUSH key value [value ...]


将一个或多个值value插入到列表key表头

如果有多个value值,那么各个value值按从左到右的顺序依次插入到表头:比如对一个空列表(mylist)执行LPUSH mylist a b c,则结果列表为c b a,等同于执行执行命令LPUSH mylist aLPUSH mylist bLPUSH mylist c

如果key不存在,一个空列表会被创建并执行LPUSH操作。

key存在但不是列表类型时,返回一个错误。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 执行LPUSH命令后,列表的长度。

注解:在Redis 2.4版本以前的LPUSH命令,都只接受单个value值。

LPUSHX

  • LPUSHX key value


将值value插入到列表key的表头,当且仅当key存在并且是一个列表。

和LPUSH命令相反,当key不存在时,LPUSHX命令什么也不做。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • LPUSHX命令执行之后,表的长度。

RPUSH

  • RPUSH key value [value ...]


将一个或多个值value插入到列表key表尾

如果有多个value值,那么各个value值按从左到右的顺序依次插入到表尾:比如对一个空列表(mylist)执行RPUSH mylist a b c,则结果列表为a b c,等同于执行命令RPUSHmylist aRPUSH mylist bRPUSH mylist c

如果key不存在,一个空列表会被创建并执行RPUSH操作。

key存在但不是列表类型时,返回一个错误。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 执行RPUSH操作后,表的长度。

注解:在Redis 2.4版本以前的RPUSH命令,都只接受单个value值。

RPUSHX

  • RPUSHX key value


将值value插入到列表key的表尾,当且仅当key存在并且是一个列表。

和RPUSH命令相反,当key不存在时,RPUSHX命令什么也不做。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • RPUSHX命令执行之后,表的长度。

LPOP

  • LPOP key


移除并返回列表key的头元素。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 列表的头元素。

    key不存在时,返回nil

RPOP

  • RPOP key


移除并返回列表key的尾元素。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 列表的尾元素。

    key不存在时,返回nil

BLPOP

  • BLPOP key [key ...] timeout


BLPOP是列表的阻塞式(blocking)弹出原语。

它是LPOP命令的阻塞版本,当给定列表内没有任何元素可供弹出的时候,连接将被BLPOP命令阻塞,直到等待超时或发现可弹出元素为止。

当给定多个key参数时,按参数key的先后顺序依次检查各个列表,弹出第一个非空列表的头元素。

非阻塞行为

当BLPOP被调用时,如果给定key内至少有一个非空列表,那么弹出遇到的第一个非空列表的头元素,并和被弹出元素所属的列表的名字一起,组成结果返回给调用者。

当存在多个给定key时,BLPOP按给定key参数排列的先后顺序,依次检查各个列表。

假设现在有jobcommandrequest三个列表,其中job不存在,commandrequest都持有非空列表。考虑以下命令:

BLPOP job command request 0

BLPOP保证返回的元素来自command,因为它是按”查找job -> 查找command -> 查找request“这样的顺序,第一个找到的非空列表。

阻塞行为

如果所有给定key都不存在或包含空列表,那么BLPOP命令将阻塞连接,直到等待超时,或有另一个客户端对给定key的任意一个执行LPUSH或RPUSH命令为止。

超时参数timeout接受一个以秒为单位的数字作为值。超时参数设为0表示阻塞时间可以无限期延长(block indefinitely) 。

相同的key被多个客户端同时阻塞


相同的key可以被多个客户端同时阻塞。

不同的客户端被放进一个队列中,按”先阻塞先服务”(first-BLPOP,first-served)的顺序为key执行BLPOP命令。

在MULTI/EXEC事务中的BLPOP

BLPOP可以用于流水线(pipline,批量地发送多个命令并读入多个回复),但把它用在MULTI/EXEC块当中没有意义。因为这要求整个服务器被阻塞以保证块执行时的原子性,该行为阻止了其他客户端执行LPUSH或RPUSH命令。

因此,一个被包裹在MULTI/EXEC块内的BLPOP命令,行为表现得就像LPOP一样,对空列表返回nil,对非空列表弹出列表元素,不进行任何阻塞操作。

时间复杂度:O(1)返回值:


如果列表为空,返回一个nil

反之,返回一个含有两个元素的列表,第一个元素是被弹出元素所属的key,第二个元素是被弹出元素的值。

BRPOP

  • BRPOP key [key ...] timeout


BRPOP是列表的阻塞式(blocking)弹出原语。

它是RPOP命令的阻塞版本,当给定列表内没有任何元素可供弹出的时候,连接将被BRPOP命令阻塞,直到等待超时或发现可弹出元素为止。

当给定多个key参数时,按参数key的先后顺序依次检查各个列表,弹出第一个非空列表的尾部元素。

关于阻塞操作的更多信息,请查看BLPOP命令,BRPOP除了弹出元素的位置和BLPOP不同之外,其他表现一致。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 假如在指定时间内没有任何元素被弹出,则返回一个nil和等待时长。

    反之,返回一个含有两个元素的列表,第一个元素是被弹出元素所属的key,第二个元素是被弹出元素的值。

LLEN

  • LLEN key


返回列表key的长度。

如果key不存在,则key被解释为一个空列表,返回0.

如果key不是列表类型,返回一个错误。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 列表key的长度。

LRANGE

  • LRANGE key start stop


返回列表key中指定区间内的元素,区间以偏移量startstop指定。

下标(index)参数startstop都以0为底,也就是说,以0表示列表的第一个元素,以1表示列表的第二个元素,以此类推。

你也可以使用负数下标,以-1表示列表的最后一个元素,-2表示列表的倒数第二个元素,以此类推。

注意LRANGE命令和编程语言区间函数的区别

假如你有一个包含一百个元素的列表,对该列表执行LRANGE list 0 10,结果是一个包含11个元素的列表,这表明stop下标也在LRANGE命令的取值范围之内(闭区间),这和某些语言的区间函数可能不一致,比如Ruby的Range.newArray#slice和Python的range()函数。

超出范围的下标

超出范围的下标值不会引起错误。

如果start下标比列表的最大下标end(LLEN list减去1)还要大,或者start > stop,LRANGE返回一个空列表。

如果stop下标比end下标还要大,Redis将stop的值设置为end

  • 时间复杂度:

  • O(S+N),S为偏移量startN为指定区间内元素的数量。

  • 返回值:

  • 一个列表,包含指定区间内的元素。

LREM

  • LREM key count value


根据参数count的值,移除列表中与参数value相等的元素。

  • count的值可以是以下几种:


    • count > 0: 从表头开始向表尾搜索,移除与value相等的元素,数量为count

    • count < 0: 从表尾开始向表头搜索,移除与value相等的元素,数量为count的绝对值。

    • count = 0: 移除表中所有与value相等的值。

  • 时间复杂度:

  • O(N),N为列表的长度。

  • 返回值:


  • 被移除元素的数量。

    因为不存在的key被视作空表(empty list),所以当key不存在时,LREM命令总是返回0

LSET

  • LSET key index value


将列表key下标为index的元素的值甚至为value

更多信息请参考LINDEX操作。

index参数超出范围,或对一个空列表(key不存在)进行LSET时,返回一个错误。

  • 时间复杂度:


  • 对头元素或尾元素进行LSET操作,复杂度为O(1)。

    其他情况下,为O(N),N为列表的长度。

  • 返回值:

  • 操作成功返回ok,否则返回错误信息

LTRIM

  • LTRIM key start stop


对一个列表进行修剪(trim),就是说,让列表只保留指定区间内的元素,不在指定区间之内的元素都将被删除。

举个例子,执行命令LTRIM list 0 2,表示只保留列表list的前三个元素,其余元素全部删除。

下标(index)参数startstop都以0为底,也就是说,以0表示列表的第一个元素,以1表示列表的第二个元素,以此类推。

你也可以使用负数下标,以-1表示列表的最后一个元素,-2表示列表的倒数第二个元素,以此类推。

key不是列表类型时,返回一个错误。

LTRIM命令通常和LPUSH命令或RPUSH命令配合使用,举个例子:

这个例子模拟了一个日志程序,每次将最新日志newest_log放到log列表中,并且只保留最新的100项。注意当这样使用LTRIM命令时,时间复杂度是O(1),因为平均情况下,每次只有一个元素被移除。

注意LTRIM命令和编程语言区间函数的区别

假如你有一个包含一百个元素的列表list,对该列表执行LTRIM list 0 10,结果是一个包含11个元素的列表,这表明stop下标也在LTRIM命令的取值范围之内(闭区间),这和某些语言的区间函数可能不一致,比如Ruby的Range.newArray#slice和Python的range()函数。

超出范围的下标

超出范围的下标值不会引起错误。

如果start下标比列表的最大下标end(LLEN list减去1)还要大,或者start > stop,LTRIM返回一个空列表(因为LTRIM已经将整个列表清空)。

如果stop下标比end下标还要大,Redis将stop的值设置为end

  • 时间复杂度:

  • O(N),N为被移除的元素的数量。

  • 返回值:


  • 命令执行成功时,返回ok

LINDEX

  • LINDEX key index


返回列表key中,下标为index的元素。

下标(index)参数startstop都以0为底,也就是说,以0表示列表的第一个元素,以1表示列表的第二个元素,以此类推。

你也可以使用负数下标,以-1表示列表的最后一个元素,-2表示列表的倒数第二个元素,以此类推。

如果key不是列表类型,返回一个错误。

  • 时间复杂度:


  • O(N),N为到达下标index过程中经过的元素数量。

    因此,对列表的头元素和尾元素执行LINDEX命令,复杂度为O(1)。

  • 返回值:


  • 列表中下标为index的元素。

    如果index参数的值不在列表的区间范围内(out of range),返回nil

LINSERT

  • LINSERT key BEFORE|AFTER pivot value


将值value插入到列表key当中,位于值pivot之前或之后。

pivot不存在于列表key时,不执行任何操作。

key不存在时,key被视为空列表,不执行任何操作。

如果key不是列表类型,返回一个错误。

  • 时间复杂度:

  • O(N),N为寻找pivot过程中经过的元素数量。

  • 返回值:


  • 如果命令执行成功,返回插入操作完成之后,列表的长度。

    如果没有找到pivot,返回-1

    如果key不存在或为空列表,返回0

RPOPLPUSH

  • RPOPLPUSH source destination


命令RPOPLPUSH在一个原子时间内,执行以下两个动作:

  • 将列表source中的最后一个元素(尾元素)弹出,并返回给客户端。

  • source弹出的元素插入到列表destination,作为destination列表的的头元素。

举个例子,你有两个列表sourcedestinationsource列表有元素a, b, cdestination列表有元素x, y, z,执行RPOPLPUSH source destination之后,source列表包含元素a, bdestination列表包含元素c, x, y, z ,并且元素c被返回。

如果source不存在,值nil被返回,并且不执行其他动作。

如果sourcedestination相同,则列表中的表尾元素被移动到表头,并返回该元素,可以把这种特殊情况视作列表的旋转(rotation)操作。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 被弹出的元素。

设计模式: 一个安全的队列

Redis的列表经常被用作队列(queue),用于在不同程序之间有序地交换消息(message)。一个程序(称之为生产者,producer)通过LPUSH命令将消息放入队列中,而另一个程序(称之为消费者,consumer)通过RPOP命令取出队列中等待时间最长的消息。

不幸的是,在这个过程中,一个消费者可能在获得一个消息之后崩溃,而未执行完成的消息也因此丢失。

使用RPOPLPUSH命令可以解决这个问题,因为它在返回一个消息之余,还将该消息添加到另一个列表当中,另外的这个列表可以用作消息的备份表:假如一切正常,当消费者完成该消息的处理之后,可以用LREM命令将该消息从备份表删除。

另一方面,助手(helper)程序可以通过监视备份表,将超过一定处理时限的消息重新放入队列中去(负责处理该消息的消费者可能已经崩溃),这样就不会丢失任何消息了。

BRPOPLPUSH

  • BRPOPLPUSH source destination timeout


BRPOPLPUSH是RPOPLPUSH的阻塞版本,当给定列表source不为空时,BRPOPLPUSH的表现和RPOPLPUSH一样。

当列表source为空时,BRPOPLPUSH命令将阻塞连接,直到等待超时,或有另一个客户端对source执行LPUSH或RPUSH命令为止。

超时参数timeout接受一个以秒为单位的数字作为值。超时参数设为0表示阻塞时间可以无限期延长(block indefinitely) 。

更多相关信息,请参考RPOPLPUSH命令。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 假如在指定时间内没有任何元素被弹出,则返回一个nil和等待时长。

    反之,返回一个含有两个元素的列表,第一个元素是被弹出元素的值,第二个元素是等待时长。

集合(Set)

附录,常用集合运算:

A = {'a', 'b', 'c'}
B = {'a', 'e', 'i', 'o', 'u'}

inter(x, y): 交集,在集合x和集合y中都存在的元素。
inter(A, B) = {'a'}

union(x, y): 并集,在集合x中或集合y中的元素,如果一个元素在x和y中都出现,那只记录一次即可。
union(A,B) = {'a', 'b', 'c', 'e', 'i', 'o', 'u'}

diff(x, y): 差集,在集合x中而不在集合y中的元素。
diff(A,B) = {'b', 'c'}

card(x): 基数,一个集合中元素的数量。
card(A) = 3

空集: 基数为0的集合。

SADD

  • SADD key member [member ...]


将一个或多个member元素加入到集合key当中,已经存在于集合的member元素将被忽略。

假如key不存在,则创建一个只包含member元素作成员的集合。

key不是集合类型时,返回一个错误。

  • 时间复杂度:

  • O(N),N是被添加的元素的数量。

  • 返回值:

  • 被添加到集合中的元素的数量,不包括被忽略的元素。

注解:在Redis2.4版本以前,SADD只接受单个member值。

SREM

  • SREM key member [member ...]


移除集合key中的一个或多个member元素,不存在的member元素会被忽略。

key不是集合类型,返回一个错误。

  • 时间复杂度:

  • O(N),N为给定member元素的数量。

  • 返回值:

  • 被成功移除的元素的数量,不包括被忽略的元素。

注解:在Redis2.4版本以前,SREM只接受单个member值。

SMEMBERS

  • SMEMBERS key


返回集合key中的所有成员。

  • 时间复杂度:

  • O(N),N为集合的基数。

  • 返回值:

  • 集合中的所有成员。

SISMEMBER

  • SISMEMBER key member


判断member元素是否是集合key的成员。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 如果member元素是集合的成员,返回1

    如果member元素不是集合的成员,或key不存在,返回0

SCARD

  • SCARD key


返回集合key基数(集合中元素的数量)。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 集合的基数。

    key不存在时,返回0

SMOVE

  • SMOVE source destination member


member元素从source集合移动到destination集合。

SMOVE是原子性操作。

如果source集合不存在或不包含指定的member元素,则SMOVE命令不执行任何操作,仅返回0。否则,member元素从source集合中被移除,并添加到destination集合中去。

destination集合已经包含member元素时,SMOVE命令只是简单地将source集合中的member元素删除。

sourcedestination不是集合类型时,返回一个错误。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 如果member元素被成功移除,返回1

    如果member元素不是source集合的成员,并且没有任何操作对destination集合执行,那么返回0

SPOP

  • SPOP key


移除并返回集合中的一个随机元素。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • 被移除的随机元素。

    key不存在或key是空集时,返回nil

也可以参考:如果只想获取一个随机元素,但不想该元素从集合中被移除的话,可以使用SRANDMEMBER命令。

SRANDMEMBER

  • SRANDMEMBER key


返回集合中的一个随机元素。

该操作和SPOP相似,但SPOP将随机元素从集合中移除并返回,而SRANDMEMBER则仅仅返回随机元素,而不对集合进行任何改动。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 被选中的随机元素。 当key不存在或key是空集时,返回nil

SINTER

  • SINTER key [key ...]


返回一个集合的全部成员,该集合是所有给定集合的交集

不存在的key被视为空集。

当给定集合当中有一个空集时,结果也为空集(根据集合运算定律)。

  • 时间复杂度:

  • O(N * M),N为给定集合当中基数最小的集合,M为给定集合的个数。

  • 返回值:

  • 交集成员的列表。

SINTERSTORE

  • SINTERSTORE destination key [key ...]


此命令等同于SINTER,但它将结果保存到destination集合,而不是简单地返回结果集。

如果destination集合已经存在,则将其覆盖。

destination可以是key本身。

  • 时间复杂度:

  • O(N * M),N为给定集合当中基数最小的集合,M为给定集合的个数。

  • 返回值:

  • 结果集中的成员数量。

SUNION

  • SUNION key [key ...]


返回一个集合的全部成员,该集合是所有给定集合的并集

不存在的key被视为空集。

  • 时间复杂度:

  • O(N),N是所有给定集合的成员数量之和。

  • 返回值:

  • 并集成员的列表。

SUNIONSTORE

  • SUNIONSTORE destination key [key ...]


此命令等同于SUNION,但它将结果保存到destination集合,而不是简单地返回结果集。

如果destination已经存在,则将其覆盖。

destination可以是key本身。

  • 时间复杂度:

  • O(N),N是所有给定集合的成员数量之和。

  • 返回值:

  • 结果集中的元素数量。

SDIFF

  • SDIFF key [key ...]


返回一个集合的全部成员,该集合是所有给定集合的差集

不存在的key被视为空集。

  • 时间复杂度:

  • O(N),N是所有给定集合的成员数量之和。

  • 返回值:

  • 交集成员的列表。

SDIFFSTORE

  • SDIFFSTORE destination key [key ...]


此命令等同于SDIFF,但它将结果保存到destination集合,而不是简单地返回结果集。

如果destination集合已经存在,则将其覆盖。

destination可以是key本身。

  • 时间复杂度:

  • O(N),N是所有给定集合的成员数量之和。

  • 返回值:

  • 结果集中的元素数量。

有序集(Sorted Set)

ZADD

  • ZADD key score member [[score member] [score member] ...]


将一个或多个member元素及其score值加入到有序集key当中。

如果某个member已经是有序集的成员,那么更新这个memberscore值,并通过重新插入这个member元素,来保证该member在正确的位置上。

score值可以是整数值或双精度浮点数。

如果key不存在,则创建一个空的有序集并执行ZADD操作。

key存在但不是有序集类型时,返回一个错误。

对有序集的更多介绍请参见sorted set。

  • 时间复杂度:

  • O(M*log(N)),N是有序集的基数,M为成功添加的新成员的数量。

  • 返回值:

  • 被成功添加的成员的数量,不包括那些被更新的、已经存在的成员。

注解:在Redis2.4版本以前,ZADD每次只能添加一个元素。

ZREM

  • ZREM key member [member ...]


移除有序集key中的一个或多个成员,不存在的成员将被忽略。

key存在但不是有序集类型时,返回一个错误。

  • 时间复杂度:

  • O(M*log(N)),N为有序集的基数,M为被成功移除的成员的数量。

  • 返回值:

  • 被成功移除的成员的数量,不包括被忽略的成员。

注解:在Redis2.4版本以前,ZREM每次只能删除一个元素。

ZCARD

  • ZCARD key


返回有序集key的基数。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • key存在且是有序集类型时,返回有序集的基数。

    key不存在时,返回0

ZCOUNT

  • ZCOUNT key min max


返回有序集key中,score值在minmax之间(默认包括score值等于minmax)的成员。

关于参数minmax的详细使用方法,请参考ZRANGEBYSCORE命令。

  • 时间复杂度:

  • O(log(N)+M),N为有序集的基数,M为值在minmax之间的元素的数量。

  • 返回值:

  • score值在minmax之间的成员的数量。

ZSCORE

  • ZSCORE key member


返回有序集key中,成员memberscore值。

如果member元素不是有序集key的成员,或key不存在,返回nil

  • 时间复杂度:

  • O(1)

  • 返回值:

  • member成员的score值,以字符串形式表示。

ZINCRBY

  • ZINCRBY key increment member


为有序集key的成员memberscore值加上增量increment

你也可以通过传递一个负数值increment,让score减去相应的值,比如ZINCRBY key -5 member,就是让memberscore值减去5

key不存在,或member不是key的成员时,ZINCRBY key increment member等同于ZADD key increment member

key不是有序集类型时,返回一个错误。

score值可以是整数值或双精度浮点数。

  • 时间复杂度:

  • O(log(N))

  • 返回值:

  • member成员的新score值,以字符串形式表示。

ZRANGE

  • ZRANGE key start stop [WITHSCORES]


返回有序集key中,指定区间内的成员。

其中成员的位置按score值递增(从小到大)来排序。

具有相同score值的成员按字典序(lexicographical order)来排列。

如果你需要成员按score值递减(从大到小)来排列,请使用ZREVRANGE命令。


下标参数startstop都以0为底,也就是说,以0表示有序集第一个成员,以1表示有序集第二个成员,以此类推。

你也可以使用负数下标,以-1表示最后一个成员,-2表示倒数第二个成员,以此类推。


超出范围的下标并不会引起错误。

比如说,当start的值比有序集的最大下标还要大,或是start > stop时,ZRANGE命令只是简单地返回一个空列表。

另一方面,假如stop参数的值比有序集的最大下标还要大,那么Redis将stop当作最大下标来处理。


可以通过使用WITHSCORES选项,来让成员和它的score值一并返回,返回列表以value1,score1, ..., valueN,scoreN的格式表示。

客户端库可能会返回一些更复杂的数据类型,比如数组、元组等。

  • 时间复杂度:

  • O(log(N)+M),N为有序集的基数,而M为结果集的基数。

  • 返回值:

  • 指定区间内,带有score值(可选)的有序集成员的列表。

ZREVRANGE

  • ZREVRANGE key start stop [WITHSCORES]


返回有序集key中,指定区间内的成员。


其中成员的位置按score值递减(从大到小)来排列。

具有相同score值的成员按字典序的反序(reverse lexicographical order)排列。

除了成员按score值递减的次序排列这一点外,ZREVRANGE命令的其他方面和ZRANGE命令一样。

  • 时间复杂度:

  • O(log(N)+M),N为有序集的基数,而M为结果集的基数。

  • 返回值:

  • 指定区间内,带有score值(可选)的有序集成员的列表。

ZRANGEBYSCORE

  • ZRANGEBYSCORE key min max [WITHSCORES] [LIMIT offset count]


返回有序集key中,所有score值介于minmax之间(包括等于minmax)的成员。有序集成员按score值递增(从小到大)次序排列。

具有相同score值的成员按字典序(lexicographical order)来排列(该属性是有序集提供的,不需要额外的计算)。

可选的LIMIT参数指定返回结果的数量及区间(就像SQL中的SELECT LIMIT offset, count),注意当offset很大时,定位offset的操作可能需要遍历整个有序集,此过程最坏复杂度为O(N)时间。


可选的WITHSCORES参数决定结果集是单单返回有序集的成员,还是将有序集成员及其score值一起返回。

该选项自Redis 2.0版本起可用。

区间及无限

minmax可以是-inf+inf,这样一来,你就可以在不知道有序集的最低和最高score值的情况下,使用ZRANGEBYSCORE这类命令。

默认情况下,区间的取值使用闭区间(小于等于或大于等于),你也可以通过给参数前增加(符号来使用可选的开区间(小于或大于)。

举个例子:

返回所有符合条件1 < score <= 5的成员;

返回所有符合条件5 < score < 10的成员。

  • 时间复杂度:

  • O(log(N)+M),N为有序集的基数,M为被结果集的基数。

  • 返回值:

  • 指定区间内,带有score值(可选)的有序集成员的列表。

ZREVRANGEBYSCORE

  • ZREVRANGEBYSCORE key max min [WITHSCORES] [LIMIT offset count]


返回有序集key中,score值介于maxmin之间(默认包括等于maxmin)的所有的成员。有序集成员按score值递减(从大到小)的次序排列。

具有相同score值的成员按字典序的反序(reverse lexicographical order)排列。

除了成员按score值递减的次序排列这一点外,ZREVRANGEBYSCORE命令的其他方面和ZRANGEBYSCORE命令一样。

  • 时间复杂度:

  • O(log(N)+M),N为有序集的基数,M为结果集的基数。

  • 返回值:

  • 指定区间内,带有score值(可选)的有序集成员的列表。

ZRANK

  • ZRANK key member


返回有序集key中成员member的排名。其中有序集成员按score值递增(从小到大)顺序排列。

排名以0为底,也就是说,score值最小的成员排名为0

使用ZREVRANK命令可以获得成员按score值递减(从大到小)排列的排名。

  • 时间复杂度:

  • O(log(N))

  • 返回值:


  • 如果member是有序集key的成员,返回member的排名。

    如果member不是有序集key的成员,返回nil

ZREVRANK

  • ZREVRANK key member


返回有序集key中成员member的排名。其中有序集成员按score值递减(从大到小)排序。

排名以0为底,也就是说,score值最大的成员排名为0

使用ZRANK命令可以获得成员按score值递增(从小到大)排列的排名。

  • 时间复杂度:

  • O(log(N))

  • 返回值:


  • 如果member是有序集key的成员,返回member的排名。

    如果member不是有序集key的成员,返回nil

ZREMRANGEBYRANK

  • ZREMRANGEBYRANK key start stop


移除有序集key中,指定排名(rank)区间内的所有成员。

区间分别以下标参数startstop指出,包含startstop在内。


下标参数startstop都以0为底,也就是说,以0表示有序集第一个成员,以1表示有序集第二个成员,以此类推。

你也可以使用负数下标,以-1表示最后一个成员,-2表示倒数第二个成员,以此类推。

  • 时间复杂度:

  • O(log(N)+M),N为有序集的基数,而M为被移除成员的数量。

  • 返回值:

  • 被移除成员的数量。

ZREMRANGEBYSCORE

  • ZREMRANGEBYSCORE key min max


移除有序集key中,所有score值介于minmax之间(包括等于minmax)的成员。

自版本2.1.6开始,score值等于minmax的成员也可以不包括在内,详情请参见ZRANGEBYSCORE命令。

  • 时间复杂度:

  • O(log(N)+M),N为有序集的基数,而M为被移除成员的数量。

  • 返回值:

  • 被移除成员的数量。

ZINTERSTORE

  • ZINTERSTORE destination numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE SUM|MIN|MAX]


计算给定的一个或多个有序集的交集,其中给定key的数量必须以numkeys参数指定,并将该交集(结果集)储存到destination

默认情况下,结果集中某个成员的score值是所有给定集下该成员score值之

关于WEIGHTSAGGREGATE选项的描述,参见ZUNIONSTORE命令。

  • 时间复杂度:

  • O(N*K)+O(M*log(M)),N为给定key中基数最小的有序集,K为给定有序集的数量,M为结果集的基数。

  • 返回值:

  • 保存到destination的结果集的基数。

ZUNIONSTORE

  • ZUNIONSTORE destination numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE SUM|MIN|MAX]


计算给定的一个或多个有序集的并集,其中给定key的数量必须以numkeys参数指定,并将该并集(结果集)储存到destination

默认情况下,结果集中某个成员的score值是所有给定集下该成员score值之

WEIGHTS

使用WEIGHTS选项,你可以为每个给定有序集分别指定一个乘法因子(multiplication factor),每个给定有序集的所有成员的score值在传递给聚合函数(aggregation function)之前都要先乘以该有序集的因子。

如果没有指定WEIGHTS选项,乘法因子默认设置为1

AGGREGATE

使用AGGREGATE选项,你可以指定并集的结果集的聚合方式。

默认使用的参数SUM,可以将所有集合中某个成员的score值之作为结果集中该成员的score值;使用参数MIN,可以将所有集合中某个成员的最小score值作为结果集中该成员的score值;而参数MAX则是将所有集合中某个成员的最大score值作为结果集中该成员的score值。

  • 时间复杂度:

  • O(N)+O(M log(M)),N为给定有序集基数的总和,M为结果集的基数。

  • 返回值:

  • 保存到destination的结果集的基数。

发布/订阅(Pub/Sub)

PUBLISH

  • PUBLISH channel message


将信息 message 发送到指定的频道 channel

  • 时间复杂度:

  • O(N+M),其中 N 是频道 channel 的订阅者数量,而 M 则是使用模式订阅(subscribed patterns)的客户端的数量。

  • 返回值:

  • 接收到信息 message 的订阅者数量。

SUBSCRIBE

  • SUBSCRIBE channel [channel ...]


订阅给定频道的信息。

  • 时间复杂度:

  • O(N),其中 N 是订阅的频道的数量。

  • 返回值:

  • 接收到的信息(请参见下面的代码说明)。

PSUBSCRIBE

  • PSUBSCRIBE pattern [pattern ...]


订阅符合给定模式的频道。

每个模式以 * 作为匹配符,比如 huangz* 匹配所有以 huangz 开头的频道( huangzmsghuangz-bloghuangz.tweets 等等), news.* 匹配所有以 news. 开头的频道(news.itnews.global.today 等等),诸如此类。

  • 时间复杂度:

  • O(N), N 是订阅的模式的数量。

  • 返回值:

  • 接收到的信息(请参见下面的代码说明)。

UNSUBSCRIBE

警告:此命令在新版 Redis 中似乎已经被废弃?

PUNSUBSCRIBE

警告:此命令在新版 Redis 中似乎已经被废弃?

事务(Transaction)

WATCH

  • ATCH key [key ...]


监视一个(或多个) key ,如果在事务执行之前这个(或这些) key 被其他命令所改动,那么事务将被打断。

  • 时间复杂度:

  • O(1)。

  • 返回值:

  • 总是返回 OK

UNWATCH

UNWATCH

取消 WATCH 命令对所有 key 的监视。

如果在执行 WATCH 命令之后, EXEC 命令或 DISCARD 命令先被执行了的话,那么就不需要再执行 UNWATCH 了。

因为 EXEC 命令会执行事务,因此 WATCH 命令的效果已经产生了;而 DISCARD 命令在取消事务的同时也会取消所有对 key 的监视,因此这两个命令执行之后,就没有必要执行 UNWATCH 了。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 总是 OK

MULTI

MULTI

标记一个事务块的开始。

事务块内的多条命令会按照先后顺序被放进一个队列当中,最后由 EXEC 命令在一个原子时间内执行。

  • 时间复杂度:

  • O(1)。

  • 返回值:

  • 总是返回 OK

EXEC

EXEC

执行所有事务块内的命令。

假如某个(或某些) key 正处于 WATCH 命令的监视之下,且事务块中有和这个(或这些) key 相关的命令,那么 EXEC 命令只在这个(或这些) key 没有被其他命令所改动的情况下执行并生效,否则该事务被打断(abort)。

  • 时间复杂度:

  • 事务块内所有命令的时间复杂度的总和。

  • 返回值:


  • 事务块内所有命令的返回值,按命令执行的先后顺序排列。

    当操作被打断时,返回空值 nil

DISCARD

DISCARD

取消事务,放弃执行事务块内的所有命令。

如果正在使用 WATCH 命令监视某个(或某些) key ,那么取消所有监视,等同于执行命令 UNWATCH 。

  • 时间复杂度:

  • O(1)。

  • 返回值:

  • 总是返回 OK

连接(Connection)

AUTH

  • AUTH password


通过设置配置文件中 requirepass 项的值(使用命令 CONFIG SET requirepass password ),可以使用密码来保护 Redis 服务器。

如果开启了密码保护的话,在每次连接 Redis 服务器之后,就要使用 AUTH 命令解锁,解锁之后才能使用其他 Redis 命令。

如果 AUTH 命令给定的密码 password 和配置文件中的密码相符的话,服务器会返回 OK 并开始接受命令输入。

反之,如果密码不匹配的话,服务器将返回一个错误,并要求客户端需重新输入密码。


警告:因为 Redis 高性能的特点,在很短时间内尝试猜测非常多个密码是有可能的,因此请确保使用的密码足够复杂和足够长,以免遭受密码猜测攻击。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 密码匹配时返回 OK ,否则返回一个错误。

PING

PING

客户端向服务器发送一个 PING ,然后服务器返回客户端一个 PONG

通常用于测试与服务器的连接是否仍然生效,或者用于测量延迟值。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • PONG

SELECT

  • SELECT index


切换到指定的数据库,数据库索引号用数字值指定,以 0 作为起始索引值。

新的链接总是使用 0 号数据库。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • OK

ECHO

  • ECHO message


打印一个特定的信息 message ,测试时使用。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • message 自身。

QUIT

QUIT

请求服务器关闭与当前客户端的连接。

一旦所有等待中的回复(如果有的话)顺利写入到客户端,连接就会被关闭。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 总是返回 OK (但是不会被打印显示,因为当时 Redis-cli 已经退出)。

服务器(Server)

BGREWRITEAOF

BGREWRITEAOF

异步(Asynchronously)重写 AOF 文件以反应当前数据库的状态。

即使 BGREWRITEAOF 命令执行失败,旧 AOF 文件中的数据也不会因此丢失或改变。

  • 时间复杂度:

  • O(N), N 为要追加到 AOF 文件中的数据数量。

  • 返回值:

  • 反馈信息。

BGSAVE

在后台异步保存当前数据库的数据到磁盘。

BGSAVE 命令执行之后立即返回 OK ,然后 Redis fork出一个新子进程,原来的 Redis 进程(父进程)继续处理客户端请求,而子进程则负责将数据保存到磁盘,然后退出。

客户端可以通过 LASTSAVE 命令查看相关信息,判断 BGSAVE 命令是否执行成功。

  • 时间复杂度:

  • O(N), N 为要保存到数据库中的 key 的数量。

  • 返回值:

  • 反馈信息。

SAVE

SAVE

同步保存当前数据库的数据到磁盘。

  • 时间复杂度:

  • O(N), N 为要保存到数据库中的 key 的数量。

  • 返回值:

  • 总是返回 OK

LASTSAVE

LASTSAVE

返回最近一次 Redis 成功执行保存操作的时间点( SAVE 、 BGSAVE 等),以 UNIX 时间戳格式表示。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 一个 UNIX 时间戳。

DBSIZE

DBSIZE

返回当前数据库的 key 的数量。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 当前数据库的 key 的数量。

SLAVEOF

  • SLAVEOF host port


SLAVEOF 命令用于在 Redis 运行时动态地修改复制(replication)功能的行为。

通过执行 SLAVEOF host port 命令,可以将当前服务器转变为指定服务器的从属服务器(slave server)。

如果当前服务器已经是某个主服务器(master server)的从属服务器,那么执行 SLAVEOF host port 将使当前服务器停止对旧主服务器的同步,丢弃旧数据集,转而开始对新主服务器进行同步。

另外,对一个从属服务器执行命令 SLAVEOF NO ONE 将使得这个从属服务器关闭复制功能,并从从属服务器转变回主服务器,原来同步所得的数据集不会被丢弃。

利用“ SLAVEOF NO ONE 不会丢弃同步所得数据集”这个特性,可以在主服务器失败的时候,将从属服务器用作新的主服务器,从而实现无间断运行。

  • 时间复杂度:


  • SLAVEOF host port ,O(N), N 为要同步的数据数量。

    SLAVEOF NO ONE , O(1) 。

  • 返回值:

  • 总是返回 OK

FLUSHALL

FLUSHALL

清空整个 Redis 服务器的数据(删除所有数据库的所有 key)。

此命令从不失败。

  • 时间复杂度:

  • 尚未明确

  • 返回值:

  • 总是返回 OK

FLUSHDB

FLUSHDB

清空当前数据库中的所有 key 。

此命令从不失败。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 总是返回 OK

SHUTDOWN

SHUTDOWN

SHUTDOWN 命令执行以下操作:

  • 停止所有客户端

  • 如果有最少一个保存点在等待,执行 SAVE 命令

  • 如果 AOF 选项被打开,更新 AOF 文件

  • 服务器关闭

如果持久化被打开的话, SHUTDOWN 命令会保证服务器正常关闭而丢失任何数据。

假如只是单纯地执行 SAVE 命令,然后再执行 QUIT 命令,则没有这一保证 —— 因为在执行 SAVE 之后、执行 QUIT 之前的这段时间中间,其他客户端可能正在和服务器进行通讯,这时如果执行 QUIT 就会造成数据丢失。

  • 时间复杂度:

  • 不明确

  • 返回值:


  • 执行失败时返回错误。

    执行成功时不返回任何信息,服务器和客户端的连接断开,客户端自动退出。

SLOWLOG

  • SLOWLOG subcommand [argument]


什么是 SLOWLOG

Slow log 是 Redis 用来记录查询执行时间的日志系统。

查询执行时间指的是不包括像客户端响应(talking)、发送回复等 IO 操作,而单单是执行一个查询命令所耗费的时间。

另外,slow log 保存在内存里面,读写速度非常快,因此你可以放心地使用它,不必担心因为开启 slow log 而损害 Redis 的速度。

设置 SLOWLOG

Slow log 的行为由两个配置参数(configuration parameter)指定,可以通过改写 redis.conf 文件或者用 CONFIG GETCONFIG SET 命令对它们动态地进行修改。

第一个选项是 slowlog-log-slower-then ,它决定要对执行时间大于多少微秒(microsecond,1秒 = 1,000,000 微秒)的查询进行记录。

比如执行以下命令将让 slow log 记录所有查询时间大于等于 100 微秒的查询:

CONFIG SET slowlog-log-slower-then 100

而以下命令记录所有查询时间大于 1000 微秒的查询:

CONFIG SET slowlog-log-slower-then 1000

另一个选项是 slowlog-max-len ,它决定 slow log 最多能保存多少条日志, slow log 本身是一个 LIFO 队列,当队列大小超过 slowlog-max-len 时,最旧的一条日志将被删除,而最新的一条日志加入到 slow log ,以此类推。

以下命令让 slow log 最多保存 1000 条日志:

CONFIG SET slowlog-max-len 1000

使用 CONFIG GET 命令可以查询两个选项的当前值:

查看 slow log

要查看 slow log ,可以使用 SLOWLOG GET 或者 SLOWLOG GET number 命令,前者打印所有 slow log ,最大长度取决于 slowlog-max-len 选项的值,而 SLOWLOG GET number 则只打印指定数量的日志。

最新的日志会最先被打印:

日志的唯一 id 只有在 Redis 服务器重启的时候才会重置,这样可以避免对日志的重复处理(比如你可能会想在每次发现新的慢查询时发邮件通知你)。

查看当前日志的数量

使用命令 SLOWLOG LEN 可以查看当前日志的数量。

请注意这个值和 slower-max-len 的区别,它们一个是当前日志的数量,一个是允许记录的最大日志的数量。

清空日志

使用命令 SLOWLOG RESET 可以清空 slow log 。

时间复杂度:O(1)

返回值:取决于不同命令,返回不同的值。

INFO

INFO

返回关于 Redis 服务器的各种信息和统计值。

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 具体请参见下面的测试代码。

CONFIG GET

  • CONFIG GET parameter


CONFIG GET 命令用于取得运行中的 Redis 服务器的配置参数(configuration parameters),不过并非所有配置参数都被 CONFIG GET 命令所支持。

CONFIG GET 接受单个参数 parameter 作为搜索关键字,查找所有匹配的配置参数,其中参数和值以“键-值对”(key-value pairs)的方式排列。

比如执行 CONFIG GET s* 命令,服务器就会返回所有以 s 开头的配置参数及参数的值:

如果你只是寻找特定的某个参数的话,你当然也可以直接指定参数的名字:

使用命令 CONFIG GET * ,可以列出 CONFIG GET 命令支持的所有参数:

所有被 CONFIG SET 所支持的配置参数都可以在配置文件 redis.conf 中找到,不过 CONFIG GETCONFIG SET 使用的格式和 redis.conf 文件所使用的格式有以下两点不同:


  • 10kb2gb 这些在配置文件中所使用的储存单位缩写,不可以用在 CONFIG 命令中, CONFIG SET 的值只能通过数字值显式地设定。

    CONFIG SET xxx 1k 这样的命令是错误的,正确的格式是 CONFIG SET xxx 1000


  • save 选项在 redis.conf 中是用多行文字储存的,但在 CONFIG GET 命令中,它只打印一行文字。

    以下是 save 选项在 redis.conf 文件中的表示:

    save 900 1

    save 300 10

    save 60 10000

    但是 CONFIG GET 命令的输出只有一行:

    redis> CONFIG GET save

    1) "save"

    2) "900 1 300 10 60 10000"

    上面 save 参数的三个值表示:在 900 秒内最少有 1 个 key 被改动,或者 300 秒内最少有 10 个 key 被改动,又或者 60 秒内最少有 1000 个 key 被改动,以上三个条件随便满足一个,就触发一次保存操作。

  • 时间复杂度:

  • 不明确

  • 返回值:

  • 给定配置参数的值。

CONFIG SET

  • CONFIG SET parameter value


CONFIG SET 命令可以动态地调整 Redis 服务器的配置(configuration)而无须重启。

你可以使用它修改配置参数,或者改变 Redis 的持久化(Persistence)方式。

CONFIG SET 可以修改的配置参数可以使用命令 CONFIG GET * 来列出,所有被 CONFIG SET 修改的配置参数都会立即生效。

关于 CONFIG SET 命令的更多消息,请参见命令 CONFIG GET 的说明。

关于如何使用 CONFIG SET 命令修改 Redis 持久化方式,请参见 Redis Persistence 。

  • 时间复杂度:

  • 不明确

  • 返回值:

  • 当设置成功时返回 OK ,否则返回一个错误。

CONFIG RESETSTAT

  • CONFIG RESETSTAT


重置 INFO 命令中的某些统计数据,包括:

  • Keyspace hits (键空间命中次数)

  • Keyspace misses (键空间不命中次数)

  • Number of commands processed (执行命令的次数)

  • Number of connections received (连接服务器的次数)

  • Number of expired keys (过期key的数量)

  • 时间复杂度:

  • O(1)

  • 返回值:

  • 总是返回 OK

DEBUG OBJECT

  • DEBUG OBJECT key


返回给定 key 的调试信息。

  • 时间复杂度:

  • O(1)

  • 返回值:


  • key 存在时,返回有关信息。

    key 不存在时,返回一个错误。

DEBUG SEGFAULT

  • DEBUG SEGFAULT


令 Redis 服务器崩溃,调试用。

  • 时间复杂度:

  • 不明确

  • 返回值:

MONITOR

MONITOR

实时打印出 Redis 服务器接收到的命令,调试用。

  • 时间复杂度:

  • 不明确

  • 返回值:

  • 总是返回 OK

SYNC

YNC

用于复制功能(replication)的内部命令。

  • 时间复杂度:

  • 不明确

  • 返回值:

  • 不明确

相关标签: php redis 手册