說明：
創建一個Redis客戶端
範例：
$redis = new Redis();
connect, open
說明：
實例連接到一個Redis.
參數：
Host：string，可以是一個host地址，也可以是一個unix socket
port: int
timeout: float 秒數，（可選參數，默認值爲0代表不限制）
返回值：
BOOL 成功返回：TRUE;失敗返回：FALSE
範例：
$redis->connect('127.0.0.1', 6379);
$redis->connect('127.0.0.1'); // port 6379 by default
$redis->connect('127.0.0.1', 6379, 2.5); // 2.5 sec timeout.
$redis->connect('/tmp/redis.sock'); // unix domain socket.
pconnect, popen
說明：
實例連接到一個Redis.，或者連接到一個已經通過pconnect/popen創建的連接上。
連接直到遇到close或者php進程結束纔會被關閉。
參數：
host: string
port: int
timeout: float
persistent_id: string 持久鏈接的身份驗證
返回值：
BOOL 成功返回：TRUE;失敗返回：FALSE
範例：
$redis->pconnect('127.0.0.1', 6379);
$redis->pconnect('127.0.0.1'); // port 6379 by default - same connection like before.
$redis->pconnect('127.0.0.1', 6379, 2.5); // 2.5 sec timeout and would be another connection than the two before.
$redis->pconnect('127.0.0.1', 6379, 2.5, 'x'); // x is sent as persistent_id and would be another connection the the three before.
$redis->pconnect('/tmp/redis.sock'); // unix domain socket - would be another connection than the four before.
close
說明：
斷開一個Redis實例連接，除非他是通過pconnect 鏈接的。
setOption
說明：
創建客戶端選項。
參數：
Name
Value
返回值：
BOOL 成功返回：TRUE;失敗返回：FALSE
範例：
$redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_NONE); // don't serialize data
$redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_PHP); // use built-in serialize/unserialize
$redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_IGBINARY); // use igBinary serialize/unserialize
$redis->setOption(Redis::OPT_PREFIX, 'myAppName:'); // use custom prefix on all keys
getOption
獲得客戶端選項
參數：
Name
返回值：
Value
範例：
$redis->getOption(Redis::OPT_SERIALIZER); // return Redis::SERIALIZER_NONE, Redis::SERIALIZER_PHP, or Redis::SERIALIZER_IGBINARY.
ping
說明：
檢查當前的連接狀態。
參數：
無
返回值：
STRING：PONG 失敗則會返回一個Redis拋出的連接異常。
get
說明：
獲得一個指定的key的值。
參數：
Key
返回值：
String or Bool: 如果值存在則返回值，否則返回false。
範例：
$redis->get('key');
set
說明：
創建一個值
參數：
Key
Value
Timeout （可選）可以在一定的timeout時間內讓SETEX 優先調用。
返回值：
成功返回true
範例：
$redis->set('key', 'value');
setex
說明：
創建一個有一定存活時間的值
參數：
Key TTL Value
返回值：
成功返回true
範例：
$redis->setex('key', 3600, 'value'); // sets key → value, with 1h TTL.
setnx
如果key的值不存在，則創建key的值爲value
參數：
Key
Value
返回值：
成功返回true 失敗返回false
範例：
$redis->setnx('key', 'value'); /* return TRUE */
$redis->setnx('key', 'value'); /* return FALSE */
del, delete
說明：
刪除一個指定的key的值
參數：
可以是一個數組，也可以是一個多個字符串。
返回值：
成功刪除的個數
範例：
$redis->set('key1', 'val1');
$redis->set('key2', 'val2');
$redis->set('key3', 'val3');
$redis->set('key4', 'val4');
$redis->delete('key1', 'key2'); /* return 2 */
$redis->delete(array('key3', 'key4')); /* return 2 */
multi, exec, discard.
說明：
進入或者退出事務模式
參數：
(可選)
Redis::MULTI或Redis::PIPELINE. 默認是 Redis::MULTI
Redis::MULTI：將多個操作當成一個事務執行
Redis::PIPELINE:讓（多條）執行命令簡單的，更加快速的發送給服務器，但是沒有任何原子性的保證
discard:刪除一個事務
返回值：
multi()，返回一個redis對象，並進入multi-mode模式，一旦進入multi-mode模式，以後調用的所有方法都會返回相同的對象，只到exec(）方法被調用。
範例：
$ret = $redis->multi()
->set('key1', 'val1')
->get('key1')
->set('key2', 'val2')
->get('key2')
->exec();
/*
$ret == array(
0 => TRUE,
1 => 'val1',
2 => TRUE,
3 => 'val2');
*/
watch, unwatch
說明：
監測一個key的值是否被其它的程序更改。如果這個key在watch 和 exec （方法）間被修改，這個 MULTI/EXEC 事務的執行將失敗（return false）
unwatch 取消被這個程序監測的所有key
參數：
Keys:一對key的列表
範例：
$redis->watch('x');
/* long code here during the execution of which other clients could well modify `x` */
$ret = $redis->multi()
->incr('x')
->exec();
/*
$ret = FALSE if x has been modified between the call to WATCH and the call to EXEC.
*/
subscribe
說明：
方法回調。注意，該方法可能在未來裏發生改變
參數：
channels: array
callback: 回調函數名
範例：
function f($redis, $chan, $msg) {
switch($chan) {
case 'chan-1':
...
break;
case 'chan-2':
...
break;
case 'chan-2':
...
break;
}
}
$redis->subscribe(array('chan-1', 'chan-2', 'chan-3'), 'f'); // subscribe to 3 chans
Publish
說明：
發表內容到某一個通道。注意，該方法可能在未來裏發生改變
參數：
Channel：
Messsage：string
範例：
$redis->publish('chan-1', 'hello, world!'); // send message.
exists
說明：
驗證指定的值是否存在
參數：
Key
返回值：
成功返回true 失敗返回false
範例：
$redis->set('key', 'value');
$redis->exists('key'); /* TRUE */
$redis->exists('NonExistingKey'); /* FALSE */
incr, incrBy
說明：
key中的值進行自增.如果第二個參數存在，它將被用來作爲整數值遞增
參數：
Key
Value
返回值：
返回新value
範例：
$redis->incr('key1'); /* key1 didn't exists, set to 0 before the increment */
/* and now has the value 1 */
$redis->incr('key1'); /* 2 */
$redis->incr('key1'); /* 3 */
$redis->incr('key1'); /* 4 */
$redis->incrBy('key1', 10); /* 14 */
decr, decrBy
說明：
刪掉key中的值，用法同incr
範例：
$redis->decr('key1'); /* key1 didn't exists, set to 0 before the increment */
/* and now has the value -1 */
$redis->decr('key1'); /* -2 */
$redis->decr('key1'); /* -3 */
$redis->decrBy('key1', 10); /* -13 */
getMultiple
說明：
返回一組數據的值，如果這個數組中的key值不存在，則返回false
參數：
Array
返回值：
Array
範例：
$redis->set('key1', 'value1');
$redis->set('key2', 'value2');
$redis->set('key3', 'value3');
$redis->getMultiple(array('key1', 'key2', 'key3')); /* array('value1', 'value2', 'value3');
$redis->getMultiple(array('key0', 'key1', 'key5')); /* array(`FALSE`, 'value2', `FALSE`);
lPush
說明：
在名稱爲key的list左邊（頭）添加一個值爲value的 元素，如果這個key值不存在則創建一個。如果key值存在並且不是一個list，則返回false
參數：
Key
Value
返回值：
返回key值得長度。
範例：
$redis->delete('key1');
$redis->lPush('key1', 'C'); // returns 1
$redis->lPush('key1', 'B'); // returns 2
$redis->lPush('key1', 'A'); // returns 3
/* key1 now points to the following list: [ 'A', 'B', 'C' ] */
rPush
說明：
在名稱爲key的list右邊（尾）添加一個值爲value的 元素，如果這個key值不存在則創建一個。如果key值存在並且不是一個list，則返回false
參數：
Key
Value
返回值：
返回key值得長度。
範例：
$redis->delete('key1');
$redis->rPush('key1', 'A'); // returns 1
$redis->rPush('key1', 'B'); // returns 2
$redis->rPush('key1', 'C'); // returns 3
/* key1 now points to the following list: [ 'A', 'B', 'C' ] */
lPushx
說明：
在名稱爲key的list左邊（頭）添加一個值爲value的 元素，如果這個value存在則不添加。
參數：
Key
Value
返回值：
返回key值得長度。
範例：
$redis->delete('key1');
$redis->lPushx('key1', 'A'); // returns 0
$redis->lPush('key1', 'A'); // returns 1
$redis->lPushx('key1', 'B'); // returns 2
$redis->lPushx('key1', 'C'); // returns 3
/* key1 now points to the following list: [ 'A', 'B', 'C' ] */
rPushx
說明：
在名稱爲key的list右邊（尾）添加一個值爲value的 元素，如果這個value存在則不添加。
參數：
Key
Value
返回值：
返回key值得長度。
範例：
$redis->delete('key1');
$redis->rPushx('key1', 'A'); // returns 0
$redis->rPush('key1', 'A'); // returns 1
$redis->rPushx('key1', 'B'); // returns 2
$redis->rPushx('key1', 'C'); // returns 3
/* key1 now points to the following list: [ 'A', 'B', 'C' ] */
lPop
說明：
輸出名稱爲key的list左(頭)起起的第一個元素，刪除該元素
參數：
Key
返回值：
失敗返回false
範例：
$redis->rPush('key1', 'A');
$redis->rPush('key1', 'B');
$redis->rPush('key1', 'C'); /* key1 => [ 'A', 'B', 'C' ] */
$redis->lPop('key1'); /* key1 => [ 'B', 'C' ] */
rPop
說明：
輸出名稱爲key的list右(尾)起起的第一個元素，刪除該元素
參數：
Key
返回值：
失敗返回false
範例：
$redis->rPush('key1', 'A');
$redis->rPush('key1', 'B');
$redis->rPush('key1', 'C'); /* key1 => [ 'A', 'B', 'C' ] */
$redis->rPop('key1'); /* key1 => [ 'A', 'B' ] */
blPop, brPop
說明：
lpop命令的block版本。即當timeout爲0時，若遇到名稱爲key 的list不存在或該list爲空，則命令結束。如果timeout>0，則遇到上述情況時，等待timeout秒，如果問題沒有解決，則對key+1開始的list執行pop操作
參數：
Key
Timeout
返回值：
Array array('listName', 'element')
範例：
/* Non blocking feature */
$redis->lPush('key1', 'A');
$redis->delete('key2');
$redis->blPop('key1', 'key2', 10); /* array('key1', 'A') */
/* OR */
$redis->blPop(array('key1', 'key2'), 10); /* array('key1', 'A') */
$redis->brPop('key1', 'key2', 10); /* array('key1', 'A') */
/* OR */
$redis->brPop(array('key1', 'key2'), 10); /* array('key1', 'A') */
/* Blocking feature */
/* process 1 */
$redis->delete('key1');
$redis->blPop('key1', 10);
/* blocking for 10 seconds */
/* process 2 */
$redis->lPush('key1', 'A');
/* process 1 */
/* array('key1', 'A') is returned*/
lSize
說明：
返回這個key值list的個數，如果這個list不存在或爲空，則返回0，如果這個值得類型並不是一個list則返回false。
參數：
Key
返回值：
Long or bool
範例：
$redis->rPush('key1', 'A');
$redis->rPush('key1', 'B');
$redis->rPush('key1', 'C'); /* key1 => [ 'A', 'B', 'C' ] */
$redis->lSize('key1');/* 3 */
$redis->rPop('key1');
$redis->lSize('key1');/* 2 */
lIndex, lGet
說明：
返回名稱爲key的list中index位置的元素，0代表第一個，1代表第二個，-1代表最後一個，-2代表倒數第二個，當這個key值不存在於list中時，返回false。
參數：
key index
返回值：
String or false
範例：
$redis->rPush('key1', 'A');
$redis->rPush('key1', 'B');
$redis->rPush('key1', 'C'); /* key1 => [ 'A', 'B', 'C' ] */
$redis->lGet('key1', 0); /* 'A' */
$redis->lGet('key1', -1); /* 'C' */
$redis->lGet('key1', 10); /* `FALSE` */
lSet
說明：
設置名稱爲key的list中index位置的元素賦值爲value
參數：
Key
Index
Value
返回值：
Bool 成功返回true 失敗返回false
範例：
$redis->rPush('key1', 'A');
$redis->rPush('key1', 'B');
$redis->rPush('key1', 'C'); /* key1 => [ 'A', 'B', 'C' ] */
$redis->lGet('key1', 0); /* 'A' */
$redis->lSet('key1', 0, 'X');
$redis->lGet('key1', 0); /* 'X' */
lRange, lGetRange
說明：
返回名稱爲key的list中start至end之間的元素（end爲 -1 ，返回所有）
參數：
Key
Start
End
返回值：
Array
範例：
$redis->rPush('key1', 'A');
$redis->rPush('key1', 'B');
$redis->rPush('key1', 'C');
$redis->lRange('key1', 0, -1); /* array('A', 'B', 'C') */
lTrim, listTrim
說明：
截取名稱爲key的list，保留start至end之間的元素
參數：
Key
Start
Stop
返回值：
Array
範例：
$redis->rPush('key1', 'A');
$redis->rPush('key1', 'B');
$redis->rPush('key1', 'C');
$redis->lRange('key1', 0, -1); /* array('A', 'B', 'C') */
$redis->lTrim('key1', 0, 1);
$redis->lRange('key1', 0, -1); /* array('A', 'B') */
lRem, lRemove
說明：
從列表中從頭部開始移除count個匹配的值。如果count爲零，所有匹配的元素都被刪除。如果count是負數，內容從尾部開始刪除。
參數：
key
value
count
返回值：
LONG or bool
範例：
$redis->lPush('key1', 'A');
$redis->lPush('key1', 'B');
$redis->lPush('key1', 'C');
$redis->lPush('key1', 'A');
$redis->lPush('key1', 'A');
$redis->lRange('key1', 0, -1); /* array('A', 'A', 'C', 'B', 'A') */
$redis->lRem('key1', 'A', 2); /* 2 */
$redis->lRange('key1', 0, -1); /* array('C', 'B', 'A') */
lInsert
說明：
在名稱爲key的list中，找到值爲pivot 的value，並根據參數Redis::BEFORE | Redis::AFTER，來確定，newvalue 是放在 pivot 的前面，或者後面。如果key不存在，不會插入，如果 pivot不存在，return -1
參數：
key position Redis::BEFORE | Redis::AFTER pivot value
返回值：
返回這個list的長度
如果pivot 不存在 返回-1
範例：
$redis->delete('key1');
$redis->lInsert('key1', Redis::AFTER, 'A', 'X'); /* 0 */
$redis->lPush('key1', 'A');
$redis->lPush('key1', 'B');
$redis->lPush('key1', 'C');
$redis->lInsert('key1', Redis::BEFORE, 'C', 'X'); /* 4 */
$redis->lRange('key1', 0, -1); /* array('A', 'B', 'X', 'C') */
$redis->lInsert('key1', Redis::AFTER, 'C', 'Y'); /* 5 */
$redis->lRange('key1', 0, -1); /* array('A', 'B', 'X', 'C', 'Y') */
$redis->lInsert('key1', Redis::AFTER, 'W', 'value'); /* -1 */
sAdd
說明：
向名稱爲key的set中添加元素value,如果value存在，不寫入，return false
參數：
key
value
返回值：
Bool 成功返回true 失敗或已存在value值則返回false
範例：
$redis->sAdd('key1' , 'set1'); /* TRUE, 'key1' => {'set1'} */
$redis->sAdd('key1' , 'set2'); /* TRUE, 'key1' => {'set1', 'set2'}*/
$redis->sAdd('key1' , 'set2'); /* FALSE, 'key1' => {'set1', 'set2'}*/
sRem, sRemove
刪除名稱爲key的set中的元素value
參數：
key
member
返回值：
Bool
範例：
$redis->sAdd('key1' , 'set1');
$redis->sAdd('key1' , 'set2');
$redis->sAdd('key1' , 'set3'); /* 'key1' => {'set1', 'set2', 'set3'}*/
$redis->sRem('key1', 'set2'); /* 'key1' => {'set1', 'set3'} */
sMove
說明：
將value元素從名稱爲srckey的集合移到名稱爲dstkey的集合
參數：
srcKey
dstKey
member
返回值：
Bool 成功返回true 失敗返回false
範例：
$redis->sAdd('key1' , 'set11');
$redis->sAdd('key1' , 'set12');
$redis->sAdd('key1' , 'set13'); /* 'key1' => {'set11', 'set12', 'set13'}*/
$redis->sAdd('key2' , 'set21');
$redis->sAdd('key2' , 'set22'); /* 'key2' => {'set21', 'set22'}*/
$redis->sMove('key1', 'key2', 'set13'); /* 'key1' => {'set11', 'set12'} */
/* 'key2' => {'set21', 'set22', 'set13'} */
sIsMember, sContains
說明：
名稱爲key的集合中查找是否有value元素
參數：
key
value
返回值：
Bool 存在返回true 不存在返回false
範例：
$redis->sAdd('key1' , 'set1');
$redis->sAdd('key1' , 'set2');
$redis->sAdd('key1' , 'set3'); /* 'key1' => {'set1', 'set2', 'set3'}*/
$redis->sIsMember('key1', 'set1'); /* TRUE */
$redis->sIsMember('key1', 'setX'); /* FALSE */
sCard, sSize
說明：
返回名稱爲key的set的元素個數
參數：
Key
返回值：
Long 元素個數，不存在則返回0
範例：
$redis->sAdd('key1' , 'set1');
$redis->sAdd('key1' , 'set2');
$redis->sAdd('key1' , 'set3'); /* 'key1' => {'set1', 'set2', 'set3'}*/
$redis->sCard('key1'); /* 3 */
$redis->sCard('keyX'); /* 0 */
sPop
說明：
隨機返回並刪除名稱爲key的set中一個元素
參數：
key
返回值：
返回被隨機取得的值，如果失敗返回false
範例：
$redis->sAdd('key1' , 'set1');
$redis->sAdd('key1' , 'set2');
$redis->sAdd('key1' , 'set3'); /* 'key1' => {'set3', 'set1', 'set2'}*/
$redis->sPop('key1'); /* 'set1', 'key1' => {'set3', 'set2'} */
$redis->sPop('key1'); /* 'set3', 'key1' => {'set2'} */
sRandMember
說明：
隨機返回名稱爲key的set中一個元素
參數：
Key
返回值：
返回的value的值，失敗返回false
範例：
$redis->sAdd('key1' , 'set1');
$redis->sAdd('key1' , 'set2');
$redis->sAdd('key1' , 'set3'); /* 'key1' => {'set3', 'set1', 'set2'}*/
$redis->sRandMember('key1'); /* 'set1', 'key1' => {'set3', 'set1', 'set2'} */
$redis->sRandMember('key1'); /* 'set3', 'key1' => {'set3', 'set1', 'set2'} */
sInter
說明：
求交集
參數：
Key1，key2….keyN
返回值：
Array 返回交集的數組，如果交集爲空，則返回一個空數組
範例：
$redis->sAdd('key1', 'val1');
$redis->sAdd('key1', 'val2');
$redis->sAdd('key1', 'val3');
$redis->sAdd('key1', 'val4');
$redis->sAdd('key2', 'val3');
$redis->sAdd('key2', 'val4');
$redis->sAdd('key3', 'val3');
$redis->sAdd('key3', 'val4');
var_dump($redis->sInter('key1', 'key2', 'key3'));
Output:
array(2) {
[0]=>
string(4) "val4"
[1]=>
string(4) "val3"
}
sInterStore
說明：
執行sInter命令並把結果儲存到新建的變量中。
參數：
Key
Key2:key1,key2…keyN
返回值：
範例：
$redis->sAdd('key1', 'val1');
$redis->sAdd('key1', 'val2');
$redis->sAdd('key1', 'val3');
$redis->sAdd('key1', 'val4');
$redis->sAdd('key2', 'val3');
$redis->sAdd('key2', 'val4');
$redis->sAdd('key3', 'val3');
$redis->sAdd('key3', 'val4');
var_dump($redis->sInterStore('output', 'key1', 'key2', 'key3'));
var_dump($redis->sMembers('output'));
Output:
int(2)
array(2) {
[0]=>
string(4) "val4"
[1]=>
string(4) "val3"
}
sUnion
說明：
合併多個key值
參數：
Keys：key1，key2…..keyN
返回值：
這些key生成的合集
範例：
$redis->delete('s0', 's1', 's2');
$redis->sAdd('s0', '1');
$redis->sAdd('s0', '2');
$redis->sAdd('s1', '3');
$redis->sAdd('s1', '1');
$redis->sAdd('s2', '3');
$redis->sAdd('s2', '4');
var_dump($redis->sUnion('s0', 's1', 's2'));
Return value: all elements that are either in s0 or in s1 or in s2.
array(4) {
[0]=>
string(1) "3"
[1]=>
string(1) "4"
[2]=>
string(1) "1"
[3]=>
string(1) "2"
}
sUnionStore
說明：
執行sUnion命令並把結果儲存到新建的變量中。
參數：
Key:
Keys:
返回值：
範例：
$redis->delete('s0', 's1', 's2');
$redis->sAdd('s0', '1');
$redis->sAdd('s0', '2');
$redis->sAdd('s1', '3');
$redis->sAdd('s1', '1');
$redis->sAdd('s2', '3');
$redis->sAdd('s2', '4');
var_dump($redis->sUnionStore('dst', 's0', 's1', 's2'));
var_dump($redis->sMembers('dst'));
Return value: the number of elements that are either in s0 or in s1 or in s2.
int(4)
array(4) {
[0]=>
string(1) "3"
[1]=>
string(1) "4"
[2]=>
string(1) "1"
[3]=>
string(1) "2"
}
sDiff
說明：
求差集
參數：
Keys
返回值：
Array
範例：
$redis->delete('s0', 's1', 's2');
$redis->sAdd('s0', '1');
$redis->sAdd('s0', '2');
$redis->sAdd('s0', '3');
$redis->sAdd('s0', '4');
$redis->sAdd('s1', '1');
$redis->sAdd('s2', '3');
var_dump($redis->sDiff('s0', 's1', 's2'));
Return value: all elements of s0 that are neither in s1 nor in s2.
array(2) {
[0]=>
string(1) "4"
[1]=>
string(1) "2"
}
sDiffStore
說明：
求差集並把結果儲存到新建的變量中。
參數：
Key
Keys
返回值：
範例：
$redis->delete('s0', 's1', 's2');
$redis->sAdd('s0', '1');
$redis->sAdd('s0', '2');
$redis->sAdd('s0', '3');
$redis->sAdd('s0', '4');
$redis->sAdd('s1', '1');
$redis->sAdd('s2', '3');
var_dump($redis->sDiffStore('dst', 's0', 's1', 's2'));
var_dump($redis->sMembers('dst'));
Return value: the number of elements of s0 that are neither in s1 nor in s2.
int(2)
array(2) {
[0]=>
string(1) "4"
[1]=>
string(1) "2"
}
sMembers, sGetMembers
說明：
返回名稱爲key的set的所有元素
參數：
Key
返回值：
array
範例：
$redis->delete('s');
$redis->sAdd('s', 'a');
$redis->sAdd('s', 'b');
$redis->sAdd('s', 'a');
$redis->sAdd('s', 'c');
var_dump($redis->sMembers('s'));
Output:
array(3) {
[0]=>
string(1) "c"
[1]=>
string(1) "a"
[2]=>
string(1) "b"
}
getSet
說明：
返回原來key中的值，並將value寫入key
參數：
Key
Value
返回值：
這個key的前一個值
範例：
$redis->set('x', '42');
$exValue = $redis->getSet('x', 'lol'); // return '42', replaces x by 'lol'
$newValue = $redis->get('x')' // return 'lol'
randomKey
說明：
隨機返回key空間的一個key
參數：
無
返回值：
在redis中隨機存在的一個key
範例：
$key = $redis->randomKey();
$surprise = $redis->get($key); // who knows what's in there.
select
說明：
選擇一個數據庫
參數：
Dbindex
返回值：
Bool
範例：
$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
move
說明：
轉移一個key到另外一個數據庫
參數：
Key
返回值：
Bool
範例：
$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
參數：
Srckey
dstkey
返回值：
Bool
範例：
$redis->set('x', '42');
$redis->rename('x', 'y');
$redis->get('y'); // → 42
$redis->get('x'); // → `FALSE`
renameNx
與remane類似，但是，如果重新命名的名字已經存在，不會替換成功
setTimeout, expire
說明：
設定一個key的活動時間（s）
參數：
Key
返回值：
Bool
範例：
$redis->set('x', '42');
$redis->setTimeout('x', 3); // x will disappear in 3 seconds.
sleep(5); // wait 5 seconds
$redis->get('x'); // will return `FALSE`, as 'x' has expired.
expireAt
說明：
key存活到一個unix時間戳時間
參數：
Key
Unix timestamp
返回值：
Bool
範例：
$redis->set('x', '42');
$now = time(NULL); // current timestamp
$redis->expireAt('x', $now + 3); // x will disappear in 3 seconds.
sleep(5); // wait 5 seconds
$redis->get('x'); // will return `FALSE`, as 'x' has expired.
keys, getKeys
說明：
返回滿足給定pattern的所有key
參數：
Pattern (可帶*)
返回值：
Array
範例：
$allKeys = $redis->keys('*'); // all keys will match this.
$keyWithUserPrefix = $redis->keys('user*');
dbSize
說明：
查看現在數據庫有多少key
參數：
無
返回值：
DB size,
範例：
$count = $redis->dbSize();
echo "Redis has $count keys\n";
auth
說明：
密碼驗證
參數：
password
返回值：
BOOL
範例：
$redis->auth('foobared');
bgrewriteaof
說明：
使用aof來進行數據庫持久化
參數：
無
返回值：
Bool
範例：
$redis->bgrewriteaof();
slaveof
說明：
選擇從服務器
參數：
host (string) and port
返回值：
BOOL
範例：
$redis->slaveof('10.0.1.7', 6379);
/* ... */
$redis->slaveof();
object
說明：
獲得key對象的詳細內容
參數：
"encoding"
"refcount"
"idletime"
返回值：
STRING for "encoding",
LONG for "refcount" and "idletime",
FALSE if the key doesn't exist.
範例：
$redis->object("encoding", "l"); // → ziplist
$redis->object("refcount", "l"); // → 1
$redis->object("idletime", "l"); // → 400 (in seconds, with a precision of 10 seconds).
save
說明：
將數據同步保存到磁盤
參數：
無
返回值：
Bool
範例：
$redis->save();
bgsave
說明：
將數據異步保存到磁盤
參數：
無
返回值：
Bool
範例：
$redis->bgSave();
lastSave
說明：
返回上次成功將數據保存到磁盤的Unix時間戳
參數：
無
返回值：
timestamp
範例：
$redis->lastSave();
type
說明：
返回key的類型值
參數：
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
範例：
$redis->type('key');
append
說明：
在指定的一個key值後面追加一個值
參數：
Key
Value
返回值：
追加完之後這個key值得長度。
範例：
$redis->set('key', 'value1');
$redis->append('key', 'value2'); /* 12 */
$redis->get('key'); /* 'value1value2' */
getRange (方法不存在)
說明：
返回名稱爲key的string中start至end之間的字符
參數：
key
start
end
返回值：
截取之後的值
範例：
$redis->set('key', 'string value');
$redis->getRange('key', 0, 5); /* 'string' */
$redis->getRange('key', -5, -1); /* 'value' */
setRange
說明：
改變key的string中start至end之間的字符爲value
參數：
key
offset
value
返回值：
修改後字符的長度
範例：
$redis->set('key', 'Hello world');
$redis->setRange('key', 6, "redis"); /* returns 11 */
$redis->get('key'); /* "Hello redis" */
strlen
說明：
獲得一個指定key的長度
參數：
key
返回值：
長度
範例：
$redis->set('key', 'value');
$redis->strlen('key'); /* 5 */
getBit
說明：
返回一個指定key的二進制信息
參數：
key
offset
返回值：
LONG
範例：
$redis->set('key', "\x7f"); // this is 0111 1111
$redis->getBit('key', 0); /* 0 */
$redis->getBit('key', 1); /* 1 */
setBit
說明：
給一個指定key的值得第offset位 賦值爲value。
參數：
key
offset
value: bool or int (1 or 0)
返回值：
LONG: 0 or 1
範例：
$redis->set('key', "*"); // ord("*") = 42 = 0x2f = "0010 1010"
$redis->setBit('key', 5, 1); /* returns 0 */
$redis->setBit('key', 7, 1); /* returns 0 */
$redis->get('key'); /* chr(0x2f) = "/" = b("0010 1111") */
flushDB
說明：
清空當前數據庫
參數：
無
返回值：
Bool:永遠都返回true
範例：
$redis->flushDB();
flushAll
說明：
清空所有數據庫
參數：
無
返回值：
Bool:永遠都返回true
範例：
$redis->flushAll();
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'
返回值：
Array
範例：
$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
info
說明：
返回redis的版本信息等詳情
參數：
無
返回值：
範例：
$redis->info();
resetStat
說明：
重新統計輸出INFO 命令的結果
參數：
無
返回值：
BOOL
範例：
$redis->resetStat();
ttl
說明：
得到一個key的生存時間，如果這個key值不存在則返回false
參數：
Key
返回值：
Long or bool
範例：
$redis->ttl('key');
persist
說明：
移除生存時間到期的key
參數：
Key
返回值：
Bool 如果移除成功了返回true ，如果值不存在或是還在生存時間內則返回false
範例：
$redis->persist('key');
mset, msetnx
說明：
同時給多個key賦值 ，MSETNX 只有當給所有的值都創建成功的時候纔會返回true
參數：
array(key => value, ...)
返回值：
Bool
範例：
$redis->mset(array('key0' => 'value0', 'key1' => 'value1'));
var_dump($redis->get('key0'));
var_dump($redis->get('key1'));
Output:
string(6) "value0"
string(6) "value1"
rpoplpush （redis版本1.1以上纔可以）
說明：
返回並刪除名稱爲srckey的list的尾元素，並將該元素添加到名稱爲dstkey的list的頭部
參數：
Key: srckey
Key: dstkey
返回值：
Bool
範例：
$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));
Output:
string(3) "abc"
array(1) {
[0]=>
string(3) "def"
}
array(3) {
[0]=>
string(3) "abc"
[1]=>
string(3) "456"
[2]=>
string(3) "123"
}
brpoplpush
說明：
Rpoplpush命令的block版本。
參數：
Key: srckey
Key: dstkey
Long: timeout
返回值：
Bool
範例：
zAdd
說明：
向名稱爲key的zset中添加元素member，score用於排序。如果該元素已經存在，則根據score更新該元素的順序。
參數：
key
score : double
value: string
返回值：
Long 元素被成功添加了返回1 否則返回0
範例：
$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的zset（元素已按score從小到大排序）中的index從start到end的所有元素
參數：
key
start: long
end: long
withscores: bool = false
返回值：
Array
範例：
$redis->zAdd('key1', 0, 'val0');
$redis->zAdd('key1', 2, 'val2');
$redis->zAdd('key1', 10, 'val10');
$redis->zRange('key1', 0, -1); /* array('val0', 'val2', 'val10') */
// with scores
$redis->zRange('key1', 0, -1, true); /* array('val0' => 0, 'val2' => 2, 'val10' => 10) */
zDelete, zRem
說明：
刪除名稱爲key的zset中的元素member
參數：
key
member
返回值：
LONG 成功返回1 失敗返回0
範例：
$redis->zAdd('key', 0, 'val0');
$redis->zAdd('key', 2, 'val2');
$redis->zAdd('key', 10, 'val10');
$redis->zDelete('key', 'val2');
$redis->zRange('key', 0, -1); /* array('val0', 'val10') */
zRevRange
說明：
返回名稱爲key的zset（元素已按score從大到小排序）中的index從start到end的所有元素.withscores: 是否輸出socre的值，默認false，不輸出
參數：
key
start: long
end: long
withscores: bool = false
返回值：
Array
範例：
$redis->zAdd('key', 0, 'val0');
$redis->zAdd('key', 2, 'val2');
$redis->zAdd('key', 10, 'val10');
$redis->zRevRange('key', 0, -1); /* array('val10', 'val2', 'val0') */
// with scores
$redis->zRevRange('key', 0, -1, true); /* array('val10' => 10, 'val2' => 2, 'val0' => 0) */
zRangeByScore, zRevRangeByScore
說明：
返回名稱爲key值中score >= star且score <= end的所有元素
參數：
key
start: string
end: string
options: array
返回值：
Array
範例：
$redis->zAdd('key', 0, 'val0');
$redis->zAdd('key', 2, 'val2');
$redis->zAdd('key', 10, 'val10');
$redis->zRangeByScore('key', 0, 3); /* array('val0', 'val2') */
$redis->zRangeByScore('key', 0, 3, array('withscores' => TRUE); /* array('val0' => 0, 'val2' => 2) */
$redis->zRangeByScore('key', 0, 3, array('limit' => array(1, 1)); /* array('val2' => 2) */
$redis->zRangeByScore('key', 0, 3, array('limit' => array(1, 1)); /* array('val2') */
$redis->zRangeByScore('key', 0, 3, array('withscores' => TRUE, 'limit' => array(1, 1)); /* array('val2' => 2) */
zCount
說明：
返回名稱爲key值中score >= star且score <= end的所有元素的個數
參數：
key
start: string
end: string
返回值：
LONG 返回相應結果的長度
範例：
$redis->zAdd('key', 0, 'val0');
$redis->zAdd('key', 2, 'val2');
$redis->zAdd('key', 10, 'val10');
$redis->zCount('key', 0, 3); /* 2, corresponding to array('val0', 'val2') */
zRemRangeByScore, zDeleteRangeByScore
說明：
刪除名稱爲key的值中score >= star且score <= end的所有元素，返回刪除個數
參數：
key
start: double or "+inf" or "-inf" string
end: double or "+inf" or "-inf" string
返回值：
LONG 刪除的個數
範例：
$redis->zAdd('key', 0, 'val0');
$redis->zAdd('key', 2, 'val2');
$redis->zAdd('key', 10, 'val10');
$redis->zRemRangeByScore('key', 0, 3); /* 2 */
zRemRangeByRank, zDeleteRangeByRank
說明：
移除有序集key中，指定排名(rank)區間內的所有成員。
區間分別以下標參數start和stop指出，包含start和stop在內。
參數：
key
start: LONG
end: LONG
返回值：
LONG
範例：
$redis->zAdd('key', 1, 'one');
$redis->zAdd('key', 2, 'two');
$redis->zAdd('key', 3, 'three');
$redis->zRemRangeByRank('key', 0, 1); /* 2 */
$redis->zRange('key', 0, -1, array('withscores' => TRUE)); /* array('three' => 3) */
zSize, zCard
說明：
返回名稱爲key的值的所有元素的個數
參數：
key
返回值：
Long
範例：
$redis->zAdd('key', 0, 'val0');
$redis->zAdd('key', 2, 'val2');
$redis->zAdd('key', 10, 'val10');
$redis->zSize('key'); /* 3 */
zScore
說明：
返回名稱爲key的值中元素member的score
參數：
key
member
返回值：
Double
範例：
$redis->zAdd('key', 2.5, 'val2');
$redis->zScore('key', 'val2'); /* 2.5 */
zRank, zRevRank
說明：
返回名稱爲key的值（元素已按score從小到大排序）中member 元素的rank（即index，從0開始），若沒有member 元素，返回“null”。zRevRank 是從大到小排序
參數：
key
member
返回值：
範例：
$redis->delete('z');
$redis->zAdd('key', 1, 'one');
$redis->zAdd('key', 2, 'two');
$redis->zRank('key', 'one'); /* 0 */
$redis->zRank('key', 'two'); /* 1 */
$redis->zRevRank('key', 'one'); /* 1 */
$redis->zRevRank('key', 'two'); /* 0 */
zIncrBy
說明：
如果在名稱爲key的值中已經存在元素member，則該元素的score增加increment；否則向集合中添加該元素，其score的值爲increment
參數：
key
value: (double) value that will be added to the member's score
member
返回值：
DOUBLE
範例：
$redis->delete('key');
$redis->zIncrBy('key', 2.5, 'member1'); /* key or member1 didn't exist, so member1's score is to 0 before the increment */
/* and now has the value 2.5 */
$redis->zIncrBy('key', 1, 'member1'); /* 3.5 */
zUnion
說明：
對N個ZSetKeys求並集，並將最後的集合保存在dstkeyN中。對於集合中每一個元素的score，在進行AGGREGATE運算前，都要乘以對於的WEIGHT參數。如果沒有提供WEIGHT，默認爲1。默認的AGGREGATE是SUM，即結果集合中元素的score是所有集合對應元素進行SUM運算的值，而MIN和MAX是指，結果集合中元素的score是所有集合對應元素中最小值和最大值。
參數：
keyOutput
arrayZSetKeys
arrayWeights
aggregateFunction Either "SUM", "MIN", or "MAX": defines the behaviour to use on duplicate entries during the zUnion.
返回值：
LONG
範例：
$redis->delete('k1');
$redis->delete('k2');
$redis->delete('k3');
$redis->delete('ko1');
$redis->delete('ko2');
$redis->delete('ko3');
$redis->zAdd('k1', 0, 'val0');
$redis->zAdd('k1', 1, 'val1');
$redis->zAdd('k2', 2, 'val2');
$redis->zAdd('k2', 3, 'val3');
$redis->zUnion('ko1', array('k1', 'k2')); /* 4, 'ko1' => array('val0', 'val1', 'val2', 'val3') */
/* Weighted zUnion */
$redis->zUnion('ko2', array('k1', 'k2'), array(1, 1)); /* 4, 'ko1' => array('val0', 'val1', 'val2', 'val3') */
$redis->zUnion('ko3', array('k1', 'k2'), array(5, 1)); /* 4, 'ko1' => array('val0', 'val2', 'val3', 'val1') */
zInter
說明：
對N個ZSetKeys求交集，並將最後的集合保存在dstkeyN中。對於集合中每一個元素的score，在進行AGGREGATE運算前，都要乘以對於的WEIGHT參數。如果沒有提供WEIGHT，默認爲1。默認的AGGREGATE是SUM，即結果集合中元素的score是所有集合對應元素進行SUM運算的值，而MIN和MAX是指，結果集合中元素的score是所有集合對應元素中最小值和最大值。
參數：
keyOutput
arrayZSetKeys
arrayWeights
aggregateFunction Either "SUM", "MIN", or "MAX": defines the behaviour to use on duplicate entries during the zUnion.
返回值：
LONG
範例：
$redis->delete('k1');
$redis->delete('k2');
$redis->delete('k3');
$redis->delete('ko1');
$redis->delete('ko2');
$redis->delete('ko3');
$redis->zAdd('k1', 0, 'val0');
$redis->zAdd('k1', 1, 'val1');
$redis->zAdd('k2', 2, 'val2');
$redis->zAdd('k2', 3, 'val3');
$redis->zUnion('ko1', array('k1', 'k2')); /* 4, 'ko1' => array('val0', 'val1', 'val2', 'val3') */
/* Weighted zUnion */
$redis->zUnion('ko2', array('k1', 'k2'), array(1, 1)); /* 4, 'ko1' => array('val0', 'val1', 'val2', 'val3') */
$redis->zUnion('ko3', array('k1', 'k2'), array(5, 1)); /* 4, 'ko1' => array('val0', 'val2', 'val3', 'val1') */
hSet
說明：
向名稱爲key的hash中添加元素hashKey—> value
參數：
key
hashKey
value
返回值：
Long:如果這個值不存在並且被添加成功返回1，如果這個值存在並且被替代返回0，錯誤返回false
範例：
$redis->delete('h')
$redis->hSet('h', 'key1', 'hello'); /* 1, 'key1' => 'hello' in the hash at "h" */
$redis->hGet('h', 'key1'); /* returns "hello" */
$redis->hSet('h', 'key1', 'plop'); /* 0, value was replaced. */
$redis->hGet('h', 'key1'); /* returns "plop" */
hSetNx
說明：
向名稱爲key的hash中添加元素hashKey—> value ，只當這個值不存在的時候生效。
參數：
key
hashKey
value
返回值：
Bool
範例：
$redis->delete('h')
$redis->hSetNx('h', 'key1', 'hello'); /* TRUE, 'key1' => 'hello' in the hash at "h" */
$redis->hSetNx('h', 'key1', 'world'); /* FALSE, 'key1' => 'hello' in the hash at "h". No change since the field wasn't replaced.
hGet
說明：
返回指定名稱爲key 的hash中hashKey對應的值
參數：
key
hashKey
返回值：
成功取到這個值則返回這個值，否則返回false
範例：
hLen
說明：
返回名稱爲key 的hash中元素個數
參數：
key
返回值：
LONG 成功則返回hase中元素的個數，失敗則返回false
範例：
$redis->delete('h')
$redis->hSet('h', 'key1', 'hello');
$redis->hSet('h', 'key2', 'plop');
$redis->hLen('h'); /* returns 2 */
hDel
說明：
刪除名稱爲key的hash中鍵爲hashKey的域
參數：
key
hashKey
返回值：
bool
範例：
hKeys
說明：
返回名稱爲key的hash中所有鍵值
參數：
key
返回值：
Array 類似於php中的array_keys函數
範例：
$redis->delete('h');
$redis->hSet('h', 'a', 'x');
$redis->hSet('h', 'b', 'y');
$redis->hSet('h', 'c', 'z');
$redis->hSet('h', 'd', 't');
var_dump($redis->hKeys('h'));
Output:
array(4) {
[0]=>
string(1) "a"
[1]=>
string(1) "b"
[2]=>
string(1) "c"
[3]=>
string(1) "d"
}
hVals
說明：
返回名稱爲key的hash中所有值
參數：
Key
返回值：
Array
範例：
$redis->delete('h');
$redis->hSet('h', 'a', 'x');
$redis->hSet('h', 'b', 'y');
$redis->hSet('h', 'c', 'z');
$redis->hSet('h', 'd', 't');
var_dump($redis->hVals('h'));
Output:
array(4) {
[0]=>
string(1) "x"
[1]=>
string(1) "y"
[2]=>
string(1) "z"
[3]=>
string(1) "t"
}
hGetAll
說明：
返回一個完整的hash
參數：
Key
返回值：
array
範例：
$redis->delete('h');
$redis->hSet('h', 'a', 'x');
$redis->hSet('h', 'b', 'y');
$redis->hSet('h', 'c', 'z');
$redis->hSet('h', 'd', 't');
var_dump($redis->hGetAll('h'));
Output:
array(4) {
["a"]=>
string(1) "x"
["b"]=>
string(1) "y"
["c"]=>
string(1) "z"
["d"]=>
string(1) "t"
}
hExists
說明：
名稱爲key的hash中是否存在鍵名字爲memberKey 的域
參數：
key
memberKey
返回值：
BOOL
範例：
$redis->hSet('h', 'a', 'x');
$redis->hExists('h', 'a'); /* TRUE */
$redis->hExists('h', 'NonExistingKey'); /* FALSE */
hIncrBy
說明：
將名稱爲key的hash中member的值增加value
參數：
key
member
value: (integer) value that will be added to the member's value
返回值：
LONG 返回這個新值
範例：
$redis->delete('h');
$redis->hIncrBy('h', 'x', 2); /* returns 2: h[x] = 2 now. */
$redis->hIncrBy('h', 'x', 1); /* h[x] ← 2 + 1. Returns 3 */
hMset
說明：
向名稱爲key的hash中批量添加元素
參數：
Key
members: key → value array
返回值：
BOOL
範例：
$redis->delete('user:1');
$redis->hMset('user:1', array('name' => 'Joe', 'salary' => 2000));
$redis->hIncrBy('user:1', 'salary', 100); // Joe earns 100 more now.
hMGet
說明：
返回名稱爲key的hash中member 數組中的值所對應的在hash中的value
參數：
key
member:Keys Array
返回值：
array
範例：
$redis->delete('h');
$redis->hSet('h', 'field1', 'value1');
$redis->hSet('h', 'field2', 'value2');
$redis->hmGet('h', array('field1', 'field2')); /* returns array('field1' => 'value1', 'field2' => 'value2') */
轉載自：http://www.cnblogs.com/youxu/archive/2011/12/12/2284437.html