一、Redis连接与认证
//连接参数:ip、端口、连接超时时间,连接成功返回true,否则返回false $ret = $redis->connect('127.0.0.1', 6379, 30); //密码认证:成功返回true,否则返回false $ret = $redis->auth('123456');
二、String操作
//设置键值:成功返回true,否则返回false $redis->set('mystr', 'Welcome!'); //获取键值:成功返回String类型键值,若key不存在或不是String类型则返回false $ret = $redis->get('mystr'); //从某个key所存储的字符串的指定偏移量开始,替换为另一指定字符串,成功返回替换后新字符串的长度。 $ret = $redis->setRange('mystr', 7, ' to Beijing!'); //获取存储在指定key中字符串的子字符串。 $ret = $redis->getRange('mystr', 0, 6); //设置新值,返回旧值:若key不存在则设置值,返回false $ret = $redis->getSet('mystr', 'hi man'); //一次设置多个键值对:成功返回true。 $ret = $redis->mset(['name' => 'jet', 'age' => 18]); //一次获取多个key的值:返回一个键值对数组,其中不存在的key值为false。 $ret = $redis->mget(['name', 'age']); //设置指定key的值及其过期时间,单位:秒。 //参数:键名,过期时间,键值。成功返回true。 $ret = $redis->setex('name', 10, 'jetwu'); //以毫秒为单位设置指定key的值和过期时间。成功返回true。 $ret = $redis->psetex('name', 10, 'jetwu'); //key的值不存在时,才为其设置值。key不存在且设置成功返回true,否则返回false。 $ret = $redis->setnx('name', 'boby'); //setnx命令的批量操作。只有在给定所有key都不存在的时候才能设置成功,只要其中一个key存在,所有key都无法设置成功。 $ret = $redis->msetnx(['country' => 'China', 'city' => 'Shenzhen']); //获取指定key存储的字符串的长度,key不存在返回0,不为字符串返回false。 $ret = $redis->strlen('name'); //将指定key存储的数字值增加1。若key不存在会先初始化为0再增加1,若key存储的不是整数值则返回false。成功返回key新值。 $ret = $redis->incr('age'); //给指定key存储的数字值增加指定增量值。 $ret = $redis->incrBy('age', 10); //给指定key存储的数字值增加指定浮点数增量。 $ret = $redis->incrByFloat('age', 1.5); //将指定key存储的数字值减一。 $ret = $redis->decr('age'); //将指定key存储的数字值减去指定减量值。 $ret = $redis->decrBy('age', 10); //为指定key追加值到原值末尾,若key不存在则相对于set()函数。 $ret = $redis->append('mystr', 'haha');
三、Hash操作
//为hash表中的字段赋值。成功返回1,失败返回0。若hash表不存在会先创建表再赋值,若字段已存在会覆盖旧值。 $ret = $redis->hSet('user', 'realname', 'jetwu'); //获取hash表中指定字段的值。若hash表不存在则返回false。 $ret = $redis->hGet('user', 'realname'); //查看hash表的某个字段是否存在,存在返回true,否则返回false。 $ret = $redis->hExists('user', 'realname'); //删除hash表的一个字段,不支持删除多个字段。成功返回1,否则返回0。 $ret = $redis->hDel('user', 'realname'); //同时设置某个hash表的多个字段值。成功返回true。 $ret = $redis->hMset('user', ['name' => 'jet', 'age' => 18]); //同时获取某个hash表的多个字段值。其中不存在的字段值为false。 $ret = $redis->hMget('user', ['name', 'age']); //获取某个hash表所有的字段和值。 $ret = $redis->hGetAll('user'); //获取某个hash表所有字段名。hash表不存在时返回空数组,key不为hash表时返回false。 $ret = $redis->hKeys('user'); //获取某个hash表所有字段值。 $ret = $redis->hVals('user'); //为hash表中不存在的字段赋值。若hash表不存在则先创建,若字段已存在则不做任何操作。设置成功返回true,否则返回false。 $ret = $redis->hSetNx('user', 'realname', 'jetwu'); //获取某个hash表的字段数量。若hash表不存在返回0,若key不为hash表则返回false。 $ret = $redis->hLen('user'); //为hash表中的指定字段加上指定增量值,若增量值为负数则相当于减法操作。若hash表不存在则先创建,若字段不存在则先初始化值为0再进行操作,若字段值为字符串则返回false。设置成功返回字段新值。 $ret = $redis->hIncrBy('user', 'age', 10); //为hash表中的指定字段加上指定浮点数增量值。 $ret = $redis->hIncrBy('user', 'age', 1.5);
四、List操作
//从list头部插入一个值。 $ret = $redis->lPush('city', 'guangzhou'); //从list尾部插入一个值。 $ret = $redis->rPush('city', 'guangzhou'); //获取列表指定区间中的元素。0表示列表第一个元素,-1表示最后一个元素,-2表示倒数第二个元素。 $ret = $redis->lrange('city', 0, -1);//查看队列所有元素 //将一个插入已存在的列表头部,列表不存在时操作无效。 $ret = $redis->lPushx('city', 'hangzhou'); //将一个或多个值插入已存在的列表尾部,列表不存在时操作无效。 $ret = $redis->rPushx('city', 'hangzhou'); //移除并返回列表的第一个元素,若key不存在或不是列表则返回false。 $ret = $redis->lPop('city'); //移除并返回列表的最后一个元素,若key不存在或不是列表则返回false。 $ret = $redis->rPop('city'); //移除并获取列表的第一个元素。如果列表没有元素则会阻塞列表直到等待超时或发现可弹出元素为止。 //参数:key,超时时间(单位:秒) //返回值:[0=>key,1=>value],超时返回[] $ret = $redis->blPop('city', 10); //移除并获取列表的最后一个元素。如果列表没有元素则会阻塞列表直到等待超时或发现可弹出元素为止。 //参数:key,超时时间(单位:秒) //返回值:[0=>key,1=>value],超时返回[] $ret = $redis->brPop('city', 10); //移除列表中最后一个元素,将其插入另一个列表头部,并返回这个元素。若源列表没有元素则返回false。 $ret = $redis->rpoplpush('city', 'city2'); //移除列表中最后一个元素,将其插入另一个列表头部,并返回这个元素。如果列表没有元素则会阻塞列表直到等待超时或发现可弹出元素为止。 //参数:源列表,目标列表,超时时间(单位:秒) //超时返回false $ret = $redis->brpoplpush('city', 'city2', 10); //返回列表长度。 $ret = $redis->lLen('city'); //通过索引获取列表中的元素。若索引超出列表范围则返回false。 $ret = $redis->lindex('city', 0); //通过索引设置列表中元素的值。若是索引超出范围,或对一个空列表进行lset操作,则返回false。 $ret = $redis->lSet('city', 2, 'changsha'); //在列表中指定元素前或后面插入元素。若指定元素不在列表中,或列表不存在时,不执行任何操作。 //参数:列表key,Redis::AFTER或Redis::BEFORE,基准元素,插入元素 //返回值:插入成功返回插入后列表元素个数,若基准元素不存在返回-1,若key不存在返回0,若key不是列表返回false。 $ret = $redis->lInsert('city', Redis::AFTER, 'changsha', 'nanjing'); //根据第三个参数count的值,移除列表中与参数value相等的元素。 //count > 0 : 从表头开始向表尾搜索,移除与value相等的元素,数量为count。 //count < 0 : 从表尾开始向表头搜索,移除与value相等的元素,数量为count的绝对值。 //count = 0 : 移除表中所有与value相等的值。 //返回实际删除元素个数 $ret = $redis->lrem('city', 'guangzhou', -2); //对一个列表进行修剪,只保留指定区间的元素,其他元素都删除。成功返回true。 $ret = $redis->ltrim('city', 1, 4);
五、Set操作