PHP-redis中文文件

PHP-redis中文文件

phpredis是php的一個擴充套件，效率是相當高有連結串列排序功能，對建立記憶體級的模組業務關係

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

下載地址如下：

（支援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 檢視連線狀態

get 得到某個key的值（string值）
如果該key不存在，return false

set 寫入key 和 value（string值）
如果寫入成功，return ture

setex 帶生存時間的寫入值
$redis->setex('key', 3600, 'value'); // sets key → value, with 1h TTL.

setnx 判斷是否重複的，寫入值
$redis->setnx('key', 'value');
$redis->setnx('key', 'value');

delete  刪除指定key的值
返回已經刪除key的個數（長整數）
$redis->delete('key1', 'key2');
$redis->delete(array('key3', 'key4', 'key5'));

ttl
得到一個key的生存時間

persist
移除生存時間到期的key
如果key到期 true 如果不到期 false

mset （redis版本1.1以上才可以用）
同時給多個key賦值
$redis->mset(array('key0' => 'value0', 'key1' => 'value1'));



multi, exec, discard
進入或者退出事務模式
引數可選Redis::MULTI或Redis::PIPELINE. 預設是 Redis::MULTI
Redis::MULTI：將多個操作當成一個事務執行
Redis::PIPELINE:讓（多條）執行命令簡單的，更加快速的傳送給伺服器，但是沒有任何原子性的保證
discard:刪除一個事務
返回值
multi()，返回一個redis物件，並進入multi-mode模式，一旦進入multi-mode模式，以後呼叫的所有方法都會返回相同的物件，只到exec(）方法被呼叫。

watch, unwatch （程式碼測試後，不能達到所說的效果）
監測一個key的值是否被其它的程式更改。如果這個key在watch 和 exec （方法）間被修改，這個 MULTI/EXEC 事務的執行將失敗（return false）
unwatch  取消被這個程式監測的所有key
引數，一對key的列表
$redis->watch('x');

$ret = $redis->multi() ->incr('x') ->exec();


subscribe *
方法回撥。注意，該方法可能在未來裡發生改變

publish *
發表內容到某一個通道。注意，該方法可能在未來裡發生改變

exists
判斷key是否存在。存在 true 不在 false

incr, incrBy
key中的值進行自增1，如果填寫了第二個引數，者自增第二個引數所填的值
$redis->incr('key1');
$redis->incrBy('key1', 10);

decr, decrBy
做減法，使用方法同incr

getMultiple
傳參
由key組成的陣列
返回引數
如果key存在返回value，不存在返回false
$redis->set('key1', 'value1'); $redis->set('key2', 'value2'); $redis->set('key3', 'value3'); $redis->getMultiple(array('key1', 'key2', 'key3'));
$redis->lRem('key1', 'A', 2);
$redis->lRange('key1', 0, -1);

list相關操作
lPush
$redis->lPush(key, value);
在名稱為key的list左邊（頭）新增一個值為value的 元素

rPush
$redis->rPush(key, value);
在名稱為key的list右邊（尾）新增一個值為value的 元素

lPushx/rPushx
$redis->lPushx(key, value);
在名稱為key的list左邊(頭)/右邊（尾）新增一個值為value的元素,如果value已經存在，則不新增

lPop/rPop
$redis->lPop('key');
輸出名稱為key的list左(頭)起/右（尾）起的第一個元素，刪除該元素

blPop/brPop
$redis->blPop('key1', 'key2', 10);
lpop命令的block版本。即當timeout為0時，若遇到名稱為key i的list不存在或該list為空，則命令結束。如果timeout>0，則遇到上述情況時，等待timeout秒，如果問題沒有解決，則對keyi+1開始的list執行pop操作

lSize
$redis->lSize('key');
返回名稱為key的list有多少個元素

lIndex, lGet
$redis->lGet('key', 0);
返回名稱為key的list中index位置的元素

lSet
$redis->lSet('key', 0, 'X');
給名稱為key的list中index位置的元素賦值為value

lRange, lGetRange
$redis->lRange('key1', 0, -1);
返回名稱為key的list中start至end之間的元素（end為 -1 ，返回所有）

lTrim, listTrim
$redis->lTrim('key', start, end);
擷取名稱為key的list，保留start至end之間的元素

lRem, lRemove
$redis->lRem('key', 'A', 2);
刪除count個名稱為key的list中值為value的元素。count為0，刪除所有值為value的元素，count>0從頭至尾刪除count個值為value的元素，count
lInsert
在名稱為為key的list中，找到值為pivot 的value，並根據引數Redis::BEFORE | Redis::AFTER，來確定，newvalue 是放在 pivot 的前面，或者後面。如果key不存在，不會插入，如果 pivot不存在，return -1
$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');
$redis->lRange('key1', 0, -1);
$redis->lInsert('key1', Redis::AFTER, 'C', 'Y');
$redis->lRange('key1', 0, -1);
$redis->lInsert('key1', Redis::AFTER, 'W', 'value');

rpoplpush
返回並刪除名稱為srckey的list的尾元素，並將該元素新增到名稱為dstkey的list的頭部
$redis->delete('x', 'y');
$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'));
var_dump($redis->lRange('x', 0, -1));
var_dump($redis->lRange('y', 0, -1));

string(3) "abc"
array(1) { [0]=> string(3) "def" }
array(3) { [0]=> string(3) "abc" [1]=> string(3) "456" [2]=> string(3) "123" }

SET操作相關
sAdd
向名稱為key的set中新增元素value,如果value存在，不寫入，return false
$redis->sAdd(key , value);

sRem, sRemove
刪除名稱為key的set中的元素value
$redis->sAdd('key1' , 'set1');
$redis->sAdd('key1' , 'set2');
$redis->sAdd('key1' , 'set3');
$redis->sRem('key1', 'set2');

sMove
將value元素從名稱為srckey的集合移到名稱為dstkey的集合
$redis->sMove(seckey, dstkey, value);

sIsMember, sContains
名稱為key的集合中查詢是否有value元素，有ture 沒有 false
$redis->sIsMember(key, value);

sCard, sSize
返回名稱為key的set的元素個數

sPop
隨機返回並刪除名稱為key的set中一個元素

sRandMember
隨機返回名稱為key的set中一個元素，不刪除

sInter
求交集

sInterStore
求交集並將交集儲存到output的集合
$redis->sInterStore('output', 'key1', 'key2', 'key3')

sUnion
求並集
$redis->sUnion('s0', 's1', 's2');
s0,s1,s2 同時求並集

sUnionStore
求並集並將並集儲存到output的集合
$redis->sUnionStore('output', 'key1', 'key2', 'key3')；

sDiff
求差集

sDiffStore
求差集並將差集儲存到output的集合

sMembers, sGetMembers
返回名稱為key的set的所有元素

sort
排序，分頁等
引數
'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'
例子
$redis->delete('s'); $redis->sadd('s', 5); $redis->sadd('s', 4); $redis->sadd('s', 2); $redis->sadd('s', 1); $redis->sadd('s', 3);
var_dump($redis->sort('s')); // 1,2,3,4,5
var_dump($redis->sort('s', array('sort' => 'desc'))); // 5,4,3,2,1
var_dump($redis->sort('s', array('sort' => 'desc', 'store' => 'out'))); // (int)5
 
string命令
getSet
返回原來key中的值，並將value寫入key
$redis->set('x', '42');
$exValue = $redis->getSet('x', 'lol'); // return '42', replaces x by 'lol'
$newValue = $redis->get('x')' // return 'lol'

append
string，名稱為key的string的值在後面加上value
$redis->set('key', 'value1');
$redis->append('key', 'value2');
$redis->get('key');

getRange （方法不存在）
返回名稱為key的string中start至end之間的字元
$redis->set('key', 'string value');
$redis->getRange('key', 0, 5);
$redis->getRange('key', -5, -1);

setRange （方法不存在）
改變key的string中start至end之間的字元為value
$redis->set('key', 'Hello world');
$redis->setRange('key', 6, "redis");
$redis->get('key');

strlen
得到key的string的長度
$redis->strlen('key');

getBit/setBit
返回2進位制資訊

zset（sorted set）操作相關
zAdd(key, score, member)：向名稱為key的zset中新增元素member，score用於排序。如果該元素已經存在，則根據score更新該元素的順序。
$redis->zAdd('key', 1, 'val1');
$redis->zAdd('key', 0, 'val0');
$redis->zAdd('key', 5, 'val5');
$redis->zRange('key', 0, -1); // array(val0, val1, val5)

zRange(key, start, end,withscores)：返回名稱為key的zset（元素已按score從小到大排序）中的index從start到end的所有元素
$redis->zAdd('key1', 0, 'val0');
$redis->zAdd('key1', 2, 'val2');
$redis->zAdd('key1', 10, 'val10');
$redis->zRange('key1', 0, -1); // with scores $redis->zRange('key1', 0, -1, true);

zDelete, zRem
zRem(key, member) ：刪除名稱為key的zset中的元素member
$redis->zAdd('key', 0, 'val0');
$redis->zAdd('key', 2, 'val2');
$redis->zAdd('key', 10, 'val10');
$redis->zDelete('key', 'val2');
$redis->zRange('key', 0, -1);

zRevRange(key, start, end,withscores)：返回名稱為key的zset（元素已按score從大到小排序）中的index從start到end的所有元素.withscores: 是否輸出socre的值，預設false，不輸出
$redis->zAdd('key', 0, 'val0');
$redis->zAdd('key', 2, 'val2');
$redis->zAdd('key', 10, 'val10');
$redis->zRevRange('key', 0, -1); // with scores $redis->zRevRange('key', 0, -1, true);

zRangeByScore, zRevRangeByScore
$redis->zRangeByScore(key, star, end, array(withscores， limit ));
返回名稱為key的zset中score >= star且score
zCount
$redis->zCount(key, star, end);
返回名稱為key的zset中score >= star且score
zRemRangeByScore, zDeleteRangeByScore
$redis->zRemRangeByScore('key', star, end);
刪除名稱為key的zset中score >= star且score
zSize, zCard
返回名稱為key的zset的所有元素的個數

zScore
$redis->zScore(key, val2);
返回名稱為key的zset中元素val2的score

zRank, zRevRank
$redis->zRevRank(key, val);
返回名稱為key的zset（元素已按score從小到大排序）中val元素的rank（即index，從0開始），若沒有val元素，返回“null”。zRevRank 是從大到小排序

zIncrBy
$redis->zIncrBy('key', increment, 'member');
如果在名稱為key的zset中已經存在元素member，則該元素的score增加increment；否則向集合中新增該元素，其score的值為increment

zUnion/zInter
引數
keyOutput
arrayZSetKeys
arrayWeights
aggregateFunction Either "SUM", "MIN", or "MAX": defines the behaviour to use on duplicate entries during the zUnion.
對N個zset求並集和交集，並將最後的集合儲存在dstkeyN中。對於集合中每一個元素的score，在進行AGGREGATE運算前，都要乘以對於的WEIGHT引數。如果沒有提供WEIGHT，預設為1。預設的AGGREGATE是SUM，即結果集合中元素的score是所有集合對應元素進行SUM運算的值，而MIN和MAX是指，結果集合中元素的score是所有集合對應元素中最小值和最大值。

Hash操作
hSet
$redis->hSet('h', 'key1', 'hello');
向名稱為h的hash中新增元素key1—>hello

hGet
$redis->hGet('h', 'key1');
返回名稱為h的hash中key1對應的value（hello）

hLen
$redis->hLen('h');
返回名稱為h的hash中元素個數

hDel
$redis->hDel('h', 'key1');
刪除名稱為h的hash中鍵為key1的域

hKeys
$redis->hKeys('h');
返回名稱為key的hash中所有鍵

hVals
$redis->hVals('h')
返回名稱為h的hash中所有鍵對應的value

hGetAll
$redis->hGetAll('h');
返回名稱為h的hash中所有的鍵（field）及其對應的value

hExists
$redis->hExists('h', 'a');
名稱為h的hash中是否存在鍵名字為a的域

hIncrBy
$redis->hIncrBy('h', 'x', 2);
將名稱為h的hash中x的value增加2

hMset
$redis->hMset('user:1', array('name' => 'Joe', 'salary' => 2000));
向名稱為key的hash中批次新增元素

hMGet
$redis->hmGet('h', array('field1', 'field2'));
返回名稱為h的hash中field1,field2對應的value

redis 操作相關
flushDB
清空當前資料庫

flushAll
清空所有資料庫

randomKey
隨機返回key空間的一個key
$key = $redis->randomKey();

select
選擇一個資料庫
move
轉移一個key到另外一個資料庫
$redis->select(0); // switch to DB 0
$redis->set('x', '42'); // write 42 to x
$redis->move('x', 1); // move to DB 1
$redis->select(1); // switch to DB 1
$redis->get('x'); // will return 42

rename, renameKey
給key重新命名
$redis->set('x', '42');
$redis->rename('x', 'y');
$redis->get('y'); // → 42
$redis->get('x'); // → `FALSE`

renameNx
與remane類似，但是，如果重新命名的名字已經存在，不會替換成功

setTimeout, expire
設定一個key的活動時間（s）
$redis->setTimeout('x', 3);

expireAt
key存活到一個unix時間戳時間
$redis->expireAt('x', time() + 3);

keys, getKeys
返回滿足給定pattern的所有key
$keyWithUserPrefix = $redis->keys('user*');

dbSize
檢視現在資料庫有多少key
$count = $redis->dbSize();

auth
密碼認證
$redis->auth('foobared');

bgrewriteaof
使用aof來進行資料庫持久化
$redis->bgrewriteaof();

slaveof
選擇從伺服器
$redis->slaveof('10.0.1.7', 6379);

save
將資料同步儲存到磁碟

bgsave
將資料非同步儲存到磁碟

lastSave
返回上次成功將資料儲存到磁碟的Unix時戳

info
返回redis的版本資訊等詳情



type
返回key的型別值
string: Redis::REDIS_STRING
set: Redis::REDIS_SET
list: Redis::REDIS_LIST
zset: Redis::REDIS_ZSET
hash: Redis::REDIS_HASH
other: Redis::REDIS_NOT_FOUND