PHP-redis api 中文說明

標籤：des   http   使用   資料   os   art   

來源 ： http://hi.baidu.com/gaolamp/item/1686aac07334bd0f0ad93a9f

 

PHP-redis api 中文說明

phpredis 是 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 查看串連狀態

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<0從尾到頭刪除|count|

個值為 value 的元素

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 <= end 的所有元素

zCount

$redis->zCount(key, star, end);

返回名稱為 key 的 zset 中 score >= star 且 score <= end 的所有元素的個數

zRemRangeByScore, zDeleteRangeByScore

$redis->zRemRangeByScore(‘key‘, star, end);

刪除名稱為 key 的 zset 中 score >= star 且 score <= end 的所有元素，返回刪除個數

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