首页 > 代码库 > PHP-redis中文文档
PHP-redis中文文档
1 phpredis是php的一个扩展,效率是相当高有链表排序功能,对创建内存级的模块业务关系 2 3 很有用;以下是redis官方提供的命令使用技巧: 4 5 下载地址如下: 6 7 https://github.com/owlient/phpredis(支持redis 2.0.4) 8 9 10 Redis::__construct构造函数 11 $redis = new Redis(); 12 13 connect, open 链接redis服务 14 参数 15 host: string,服务地址 16 port: int,端口号 17 timeout: float,链接时长 (可选, 默认为 0 ,不限链接时间) 18 注: 在redis.conf中也有时间,默认为300 19 20 pconnect, popen 不会主动关闭的链接 21 参考上面 22 23 setOption 设置redis模式 24 25 getOption 查看redis设置的模式 26 27 ping 查看连接状态 28 29 get 得到某个key的值(string值) 30 如果该key不存在,return false 31 32 set 写入key 和 value(string值) 33 如果写入成功,return ture 34 35 setex 带生存时间的写入值 36 $redis->setex(‘key‘, 3600, ‘value‘); // sets key → value, with 1h TTL. 37 38 setnx 判断是否重复的,写入值 39 $redis->setnx(‘key‘, ‘value‘); 40 $redis->setnx(‘key‘, ‘value‘); 41 42 delete 删除指定key的值 43 返回已经删除key的个数(长整数) 44 $redis->delete(‘key1‘, ‘key2‘); 45 $redis->delete(array(‘key3‘, ‘key4‘, ‘key5‘)); 46 47 ttl 48 得到一个key的生存时间 49 50 persist 51 移除生存时间到期的key 52 如果key到期 true 如果不到期 false 53 54 mset (redis版本1.1以上才可以用) 55 同时给多个key赋值 56 $redis->mset(array(‘key0‘ => ‘value0‘, ‘key1‘ => ‘value1‘)); 57 58 59 60 multi, exec, discard 61 进入或者退出事务模式 62 参数可选Redis::MULTI或Redis::PIPELINE. 默认是 Redis::MULTI 63 Redis::MULTI:将多个操作当成一个事务执行 64 Redis::PIPELINE:让(多条)执行命令简单的,更加快速的发送给服务器,但是没有任何原子性的保证 65 discard:删除一个事务 66 返回值 67 multi(),返回一个redis对象,并进入multi-mode模式,一旦进入multi-mode模式,以后调用的所有方法都会返回相同的对象,只到exec()方法被调用。 68 69 watch, unwatch (代码测试后,不能达到所说的效果) 70 监测一个key的值是否被其它的程序更改。如果这个key在watch 和 exec (方法)间被修改,这个 MULTI/EXEC 事务的执行将失败(return false) 71 unwatch 取消被这个程序监测的所有key 72 参数,一对key的列表 73 $redis->watch(‘x‘); 74 75 $ret = $redis->multi() ->incr(‘x‘) ->exec(); 76 77 78 subscribe * 79 方法回调。注意,该方法可能在未来里发生改变 80 81 publish * 82 发表内容到某一个通道。注意,该方法可能在未来里发生改变 83 84 exists 85 判断key是否存在。存在 true 不在 false 86 87 incr, incrBy 88 key中的值进行自增1,如果填写了第二个参数,者自增第二个参数所填的值 89 $redis->incr(‘key1‘); 90 $redis->incrBy(‘key1‘, 10); 91 92 decr, decrBy 93 做减法,使用方法同incr 94 95 getMultiple 96 传参 97 由key组成的数组 98 返回参数 99 如果key存在返回value,不存在返回false100 $redis->set(‘key1‘, ‘value1‘); $redis->set(‘key2‘, ‘value2‘); $redis->set(‘key3‘, ‘value3‘); $redis->getMultiple(array(‘key1‘, ‘key2‘, ‘key3‘));101 $redis->lRem(‘key1‘, ‘A‘, 2);102 $redis->lRange(‘key1‘, 0, -1);103 104 list相关操作105 lPush106 $redis->lPush(key, value);107 在名称为key的list左边(头)添加一个值为value的 元素108 109 rPush110 $redis->rPush(key, value);111 在名称为key的list右边(尾)添加一个值为value的 元素112 113 lPushx/rPushx114 $redis->lPushx(key, value);115 在名称为key的list左边(头)/右边(尾)添加一个值为value的元素,如果value已经存在,则不添加116 117 lPop/rPop118 $redis->lPop(‘key‘);119 输出名称为key的list左(头)起/右(尾)起的第一个元素,删除该元素120 121 blPop/brPop122 $redis->blPop(‘key1‘, ‘key2‘, 10);123 lpop命令的block版本。即当timeout为0时,若遇到名称为key i的list不存在或该list为空,则命令结束。如果timeout>0,则遇到上述情况时,等待timeout秒,如果问题没有解决,则对keyi+1开始的list执行pop操作124 125 lSize126 $redis->lSize(‘key‘);127 返回名称为key的list有多少个元素128 129 lIndex, lGet130 $redis->lGet(‘key‘, 0);131 返回名称为key的list中index位置的元素132 133 lSet134 $redis->lSet(‘key‘, 0, ‘X‘);135 给名称为key的list中index位置的元素赋值为value136 137 lRange, lGetRange138 $redis->lRange(‘key1‘, 0, -1);139 返回名称为key的list中start至end之间的元素(end为 -1 ,返回所有)140 141 lTrim, listTrim142 $redis->lTrim(‘key‘, start, end);143 截取名称为key的list,保留start至end之间的元素144 145 lRem, lRemove146 $redis->lRem(‘key‘, ‘A‘, 2);147 删除count个名称为key的list中值为value的元素。count为0,删除所有值为value的元素,count>0从头至尾删除count个值为value的元素,count<0从尾到头删除|count|个值为value的元素148 149 lInsert150 在名称为为key的list中,找到值为pivot 的value,并根据参数Redis::BEFORE | Redis::AFTER,来确定,newvalue 是放在 pivot 的前面,或者后面。如果key不存在,不会插入,如果 pivot不存在,return -1151 $redis->delete(‘key1‘); $redis->lInsert(‘key1‘, Redis::AFTER, ‘A‘, ‘X‘); $redis->lPush(‘key1‘, ‘A‘); $redis->lPush(‘key1‘, ‘B‘); $redis->lPush(‘key1‘, ‘C‘); $redis->lInsert(‘key1‘, Redis::BEFORE, ‘C‘, ‘X‘);152 $redis->lRange(‘key1‘, 0, -1);153 $redis->lInsert(‘key1‘, Redis::AFTER, ‘C‘, ‘Y‘);154 $redis->lRange(‘key1‘, 0, -1);155 $redis->lInsert(‘key1‘, Redis::AFTER, ‘W‘, ‘value‘);156 157 rpoplpush158 返回并删除名称为srckey的list的尾元素,并将该元素添加到名称为dstkey的list的头部159 $redis->delete(‘x‘, ‘y‘);160 $redis->lPush(‘x‘, ‘abc‘); $redis->lPush(‘x‘, ‘def‘); $redis->lPush(‘y‘, ‘123‘); $redis->lPush(‘y‘, ‘456‘); // move the last of x to the front of y. var_dump($redis->rpoplpush(‘x‘, ‘y‘));161 var_dump($redis->lRange(‘x‘, 0, -1));162 var_dump($redis->lRange(‘y‘, 0, -1)); 163 164 string(3) "abc" 165 array(1) { [0]=> string(3) "def" } 166 array(3) { [0]=> string(3) "abc" [1]=> string(3) "456" [2]=> string(3) "123" }167 168 SET操作相关169 sAdd170 向名称为key的set中添加元素value,如果value存在,不写入,return false171 $redis->sAdd(key , value);172 173 sRem, sRemove174 删除名称为key的set中的元素value175 $redis->sAdd(‘key1‘ , ‘set1‘);176 $redis->sAdd(‘key1‘ , ‘set2‘);177 $redis->sAdd(‘key1‘ , ‘set3‘);178 $redis->sRem(‘key1‘, ‘set2‘);179 180 sMove181 将value元素从名称为srckey的集合移到名称为dstkey的集合182 $redis->sMove(seckey, dstkey, value);183 184 sIsMember, sContains185 名称为key的集合中查找是否有value元素,有ture 没有 false186 $redis->sIsMember(key, value);187 188 sCard, sSize189 返回名称为key的set的元素个数190 191 sPop192 随机返回并删除名称为key的set中一个元素193 194 sRandMember195 随机返回名称为key的set中一个元素,不删除196 197 sInter198 求交集199 200 sInterStore201 求交集并将交集保存到output的集合202 $redis->sInterStore(‘output‘, ‘key1‘, ‘key2‘, ‘key3‘)203 204 sUnion205 求并集206 $redis->sUnion(‘s0‘, ‘s1‘, ‘s2‘);207 s0,s1,s2 同时求并集208 209 sUnionStore210 求并集并将并集保存到output的集合211 $redis->sUnionStore(‘output‘, ‘key1‘, ‘key2‘, ‘key3‘);212 213 sDiff214 求差集215 216 sDiffStore217 求差集并将差集保存到output的集合218 219 sMembers, sGetMembers220 返回名称为key的set的所有元素221 222 sort223 排序,分页等224 参数225 ‘by‘ => ‘some_pattern_*‘,226 ‘limit‘ => array(0, 1),227 ‘get‘ => ‘some_other_pattern_*‘ or an array of patterns,228 ‘sort‘ => ‘asc‘ or ‘desc‘,229 ‘alpha‘ => TRUE,230 ‘store‘ => ‘external-key‘231 例子232 $redis->delete(‘s‘); $redis->sadd(‘s‘, 5); $redis->sadd(‘s‘, 4); $redis->sadd(‘s‘, 2); $redis->sadd(‘s‘, 1); $redis->sadd(‘s‘, 3);233 var_dump($redis->sort(‘s‘)); // 1,2,3,4,5234 var_dump($redis->sort(‘s‘, array(‘sort‘ => ‘desc‘))); // 5,4,3,2,1235 var_dump($redis->sort(‘s‘, array(‘sort‘ => ‘desc‘, ‘store‘ => ‘out‘))); // (int)5236 237 string命令238 getSet239 返回原来key中的值,并将value写入key240 $redis->set(‘x‘, ‘42‘);241 $exValue = $redis->getSet(‘x‘, ‘lol‘); // return ‘42‘, replaces x by ‘lol‘242 $newValue = $redis->get(‘x‘)‘ // return ‘lol‘243 244 append245 string,名称为key的string的值在后面加上value246 $redis->set(‘key‘, ‘value1‘);247 $redis->append(‘key‘, ‘value2‘);248 $redis->get(‘key‘);249 250 getRange (方法不存在)251 返回名称为key的string中start至end之间的字符252 $redis->set(‘key‘, ‘string value‘);253 $redis->getRange(‘key‘, 0, 5);254 $redis->getRange(‘key‘, -5, -1);255 256 setRange (方法不存在)257 改变key的string中start至end之间的字符为value258 $redis->set(‘key‘, ‘Hello world‘);259 $redis->setRange(‘key‘, 6, "redis");260 $redis->get(‘key‘);261 262 strlen263 得到key的string的长度264 $redis->strlen(‘key‘);265 266 getBit/setBit267 返回2进制信息268 269 zset(sorted set)操作相关270 zAdd(key, score, member):向名称为key的zset中添加元素member,score用于排序。如果该元素已经存在,则根据score更新该元素的顺序。271 $redis->zAdd(‘key‘, 1, ‘val1‘);272 $redis->zAdd(‘key‘, 0, ‘val0‘);273 $redis->zAdd(‘key‘, 5, ‘val5‘);274 $redis->zRange(‘key‘, 0, -1); // array(val0, val1, val5)275 276 zRange(key, start, end,withscores):返回名称为key的zset(元素已按score从小到大排序)中的index从start到end的所有元素277 $redis->zAdd(‘key1‘, 0, ‘val0‘);278 $redis->zAdd(‘key1‘, 2, ‘val2‘);279 $redis->zAdd(‘key1‘, 10, ‘val10‘);280 $redis->zRange(‘key1‘, 0, -1); // with scores $redis->zRange(‘key1‘, 0, -1, true);281 282 zDelete, zRem283 zRem(key, member) :删除名称为key的zset中的元素member284 $redis->zAdd(‘key‘, 0, ‘val0‘);285 $redis->zAdd(‘key‘, 2, ‘val2‘);286 $redis->zAdd(‘key‘, 10, ‘val10‘);287 $redis->zDelete(‘key‘, ‘val2‘);288 $redis->zRange(‘key‘, 0, -1); 289 290 zRevRange(key, start, end,withscores):返回名称为key的zset(元素已按score从大到小排序)中的index从start到end的所有元素.withscores: 是否输出socre的值,默认false,不输出291 $redis->zAdd(‘key‘, 0, ‘val0‘);292 $redis->zAdd(‘key‘, 2, ‘val2‘);293 $redis->zAdd(‘key‘, 10, ‘val10‘);294 $redis->zRevRange(‘key‘, 0, -1); // with scores $redis->zRevRange(‘key‘, 0, -1, true);295 296 zRangeByScore, zRevRangeByScore297 $redis->zRangeByScore(key, star, end, array(withscores, limit ));298 返回名称为key的zset中score >= star且score <= end的所有元素299 300 zCount301 $redis->zCount(key, star, end);302 返回名称为key的zset中score >= star且score <= end的所有元素的个数303 304 zRemRangeByScore, zDeleteRangeByScore305 $redis->zRemRangeByScore(‘key‘, star, end);306 删除名称为key的zset中score >= star且score <= end的所有元素,返回删除个数307 308 zSize, zCard309 返回名称为key的zset的所有元素的个数310 311 zScore312 $redis->zScore(key, val2);313 返回名称为key的zset中元素val2的score314 315 zRank, zRevRank316 $redis->zRevRank(key, val);317 返回名称为key的zset(元素已按score从小到大排序)中val元素的rank(即index,从0开始),若没有val元素,返回“null”。zRevRank 是从大到小排序318 319 zIncrBy320 $redis->zIncrBy(‘key‘, increment, ‘member‘);321 如果在名称为key的zset中已经存在元素member,则该元素的score增加increment;否则向集合中添加该元素,其score的值为increment322 323 zUnion/zInter324 参数325 keyOutput326 arrayZSetKeys327 arrayWeights328 aggregateFunction Either "SUM", "MIN", or "MAX": defines the behaviour to use on duplicate entries during the zUnion.329 对N个zset求并集和交集,并将最后的集合保存在dstkeyN中。对于集合中每一个元素的score,在进行AGGREGATE运算前,都要乘以对于的WEIGHT参数。如果没有提供WEIGHT,默认为1。默认的AGGREGATE是SUM,即结果集合中元素的score是所有集合对应元素进行SUM运算的值,而MIN和MAX是指,结果集合中元素的score是所有集合对应元素中最小值和最大值。330 331 Hash操作332 hSet333 $redis->hSet(‘h‘, ‘key1‘, ‘hello‘);334 向名称为h的hash中添加元素key1—>hello335 336 hGet337 $redis->hGet(‘h‘, ‘key1‘);338 返回名称为h的hash中key1对应的value(hello)339 340 hLen341 $redis->hLen(‘h‘);342 返回名称为h的hash中元素个数343 344 hDel345 $redis->hDel(‘h‘, ‘key1‘);346 删除名称为h的hash中键为key1的域347 348 hKeys349 $redis->hKeys(‘h‘);350 返回名称为key的hash中所有键351 352 hVals353 $redis->hVals(‘h‘)354 返回名称为h的hash中所有键对应的value355 356 hGetAll357 $redis->hGetAll(‘h‘);358 返回名称为h的hash中所有的键(field)及其对应的value359 360 hExists361 $redis->hExists(‘h‘, ‘a‘);362 名称为h的hash中是否存在键名字为a的域363 364 hIncrBy365 $redis->hIncrBy(‘h‘, ‘x‘, 2);366 将名称为h的hash中x的value增加2367 368 hMset369 $redis->hMset(‘user:1‘, array(‘name‘ => ‘Joe‘, ‘salary‘ => 2000));370 向名称为key的hash中批量添加元素371 372 hMGet373 $redis->hmGet(‘h‘, array(‘field1‘, ‘field2‘));374 返回名称为h的hash中field1,field2对应的value375 376 redis 操作相关377 flushDB378 清空当前数据库379 380 flushAll381 清空所有数据库382 383 randomKey384 随机返回key空间的一个key385 $key = $redis->randomKey();386 387 select388 选择一个数据库389 move390 转移一个key到另外一个数据库391 $redis->select(0); // switch to DB 0392 $redis->set(‘x‘, ‘42‘); // write 42 to x393 $redis->move(‘x‘, 1); // move to DB 1394 $redis->select(1); // switch to DB 1395 $redis->get(‘x‘); // will return 42396 397 rename, renameKey398 给key重命名399 $redis->set(‘x‘, ‘42‘);400 $redis->rename(‘x‘, ‘y‘);401 $redis->get(‘y‘); // → 42402 $redis->get(‘x‘); // → `FALSE`403 404 renameNx405 与remane类似,但是,如果重新命名的名字已经存在,不会替换成功406 407 setTimeout, expire408 设定一个key的活动时间(s)409 $redis->setTimeout(‘x‘, 3);410 411 expireAt412 key存活到一个unix时间戳时间413 $redis->expireAt(‘x‘, time() + 3);414 415 keys, getKeys416 返回满足给定pattern的所有key417 $keyWithUserPrefix = $redis->keys(‘user*‘);418 419 dbSize420 查看现在数据库有多少key421 $count = $redis->dbSize();422 423 auth424 密码认证425 $redis->auth(‘foobared‘);426 427 bgrewriteaof428 使用aof来进行数据库持久化429 $redis->bgrewriteaof();430 431 slaveof432 选择从服务器433 $redis->slaveof(‘10.0.1.7‘, 6379);434 435 save436 将数据同步保存到磁盘437 438 bgsave439 将数据异步保存到磁盘440 441 lastSave442 返回上次成功将数据保存到磁盘的Unix时戳443 444 info445 返回redis的版本信息等详情446 447 type448 返回key的类型值449 string: Redis::REDIS_STRING450 set: Redis::REDIS_SET451 list: Redis::REDIS_LIST452 zset: Redis::REDIS_ZSET453 hash: Redis::REDIS_HASH454 other: Redis::REDIS_NOT_FOUND
PHP-redis中文文档
声明:以上内容来自用户投稿及互联网公开渠道收集整理发布,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任,若内容有误或涉及侵权可进行投诉: 投诉/举报 工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。