SSDB PHP程序api文档

SSDB PHP 客户端 API 文档

• @更新: 2014-11-05

SSDB 是一个高性能 NoSQL 数据库, 支持 zset 数据结构, 用于替代 Redis. 官方网站是 http://ssdb.io. 本文档介绍了 SSDB 的 PHP 客户端 API.

注意: SSDB 所使用的名词 "hashmap", "hash", "map" 表示相同的意思.

类 SimpleSSDB

快速开始

<?php
include_once('SSDB.php');
try{
    $ssdb = new SimpleSSDB('127.0.0.1', 8888);
}catch(SSDBException $e){
    die(LINE . ' ' . $e->getMessage());
}
$ret = $ssdb->set('key', 'value');
if($ret === false){
    // error!
}
echo $ssdb->get('key');

错误处理

如果无法连接到 SSDB 服务器, SimpleSSDB 将抛出异常. 大多数的方法(除了少数几个例外)通过返回 false 来标明出错. 所以要使用强制等于(===)来判断返回值.

如果出现网络错误, 所有的方法将会抛出 SSDBException 异常.

注意: 因为实现的原因, 请保证所有的参数加起来不超过 10MB 大小.

方法

SimpleSSDB::__construct

说明

创建 SimpleSSDB 的实例, 并连接到 SSDB 服务器. 如果无法连接到服务器, 将抛出异常.

参数

• host - SSDB 服务器的主机名或者 IP.host - SSDB 服务器的主机名或者 IP.
• port - SSDB 服务器的端口号.
• timeout_ms
port - SSDB 服务器的端口号.

timeout_ms - 可选, 连接超时时间, 和发送接收数据的超时时间, 单位毫秒. 默认是 2000 ms.

返回值

SimpleSSDB 的实例.

$ssdb = new SimpleSSDB('127.0.0.1', 8888);

Since: 1.7.0.0

说明

参数

• password -

返回值

出错则返回 false, 否则返回 null.

示例

$ssdb->auth('very-strong-password');

set

说明

设置指定 key 的值内容.

参数

• key -
• value -

返回值

出错则返回 false

出错则返回 false, 否则返回 null.

$ssdb->set('key', 'value');

$ssdb->setx('key', 'value', 60);

$ssdb->setnx('key', 'value');

setnx

说明

当 key 不存在时, 设置指定 key 的值内容. 如果已存在, 则不设置.

参数

• key -
• value -

返回值

出错则返回 falsevalue -

返回值

$ssdb->expire('key', 60);

$ssdb->ttl('key');

$ssdb->get('key');

ttl

说明

返回 key(只针对 KV 类型) 的存活时间.

参数

• key -

返回值

出错则返回 falsettl - 存活时间(秒)

返回值

$ssdb->getset('key', 'value');

ttl

$ssdb->del('key');

$ssdb->incr('key', 1);

getset

说明

更新 key 对应的 value, 并返回更新前的旧的 value.

参数

• key -
• value -

返回值

如果 key 不存在则返回 null, 如果出错则返回 false

如果 key 不存在则返回 null, 如果出错则返回 false, 否则返回 key 对应的值内容.

$ssdb->exists('key');

$ssdb->getbit('key', 9);

$ssdb->setbit('key', 9, 1);

incr

从 1.7.0.1 起, 如果 value 不能转换成整数, incr 会返回错误.

说明

使 key 对应的值增加 num. 参数 num 可以为负数. 如果原来的值不是整数(字符串形式的整数), 它会被先转换成整数.

参数

• key -
• num - 可选, 必须是有符号整数, 默认是 1.

返回值

如果出错则返回 false

如果出错则返回 false, 其它值表示正常. 你无法通过返回值来判断被删除的 key 是否存在.🎜🎜🎜示例🎜🎜

$ssdb->bitcount('key', 2, 10);

incr

从 1.7.0.1 起, 如果 value 不能转换成整数, 🎜incr 会返回错误.🎜🎜🎜🎜说明🎜🎜

使 key 对应的值增加 num. 参数 num 可以为负数. 如果原来的值不是整数(字符串形式的整数), 它会被先转换成整数.🎜🎜🎜参数🎜🎜🎜🎜key -🎜num - 可选, 必须是有符号整数, 默认是 1.🎜🎜返回值🎜🎜

如果出错则返回 false, 否则返回新的值.🎜

示例

$ssdb->countbit('key', 2, 10);

exists

说明

判断指定的 key 是否存在.

参数

• key -key -

返回值

如果存在, 返回 true, 否则返回 false.

示例

$ssdb->substr('key', 2, 10);

getbit

说明

获取字符串内指定位置的位值(BIT).

参数

• key -
• offset

返回值

$ssdb->strlen('key');

$ssdb->keys('a', 'z', 10);

setbit

说明

设置字符串内指定位置的位值(BIT), 字符串的长度会自动扩展.

参数

• key -
key -
• offset - 位偏移, 取值范围 [0, 1073741824]
• val - 0 或 1

返回值

返回原来的位值. 如果 val 不是 0 或者 1, 返回 false.

示例

$ssdb->scan('a', 'z', 10);

bitcount

说明

计算字符串的子串所包含的位值为 1 的个数. 若 start 是负数, 则从字符串末尾算起. 若 endoffset - 位偏移, 取值范围 [0, 1073741824]val - 0 或 1

$start = ''; 
$limit = 1000;
while(1){
    $kvs = $ssdb->scan($start, '', $limit);
    if(!$kvs){
        break;
    }
    // do something on key-value pairs...
    $keys = array_keys(array_slice($kvs, -1, 1, true));
    $max_key = $keys[0];
    $start = $max_key;
}

$ssdb->rscan('a', 'z', 10);

countbit

说明

计算字符串的子串所包含的位值为 1 的个数. 若 start 是负数, 则从字符串末尾算起. 若 size 是负数, 则表示从字符串末尾算起, 忽略掉那么多字节.

参数

• key -
• start - 可选, 子串的字节偏移
• size - 可选, 子串的长度(字节数), 默认为到字符串最后一个字节

返回值

返回位值为 1 的个数. 出错返回 falsestart - 可选, 子串的字节偏移

返回位值为 1 的个数. 出错返回 false.🎜🎜🎜示例🎜🎜

$ssdb->multi_set(array(
    'a' => 1,
    'b' => 2,
));

countbit

计算字符串的子串所包含的位值为 1 的个数. 若 start 是负数, 则从字符串末尾算起. 若 size 是负数, 则表示从字符串末尾算起, 忽略掉那么多字节.🎜🎜🎜参数🎜🎜🎜🎜key -🎜start - 可选, 子串的字节偏移🎜size - 可选, 子串的长度(字节数), 默认为到字符串最后一个字节🎜🎜返回值🎜🎜

返回位值为 1 的个数. 出错返回 false.🎜

示例

$ssdb->multi_get(array('k1', 'k2'));

substr

说明

获取字符串的子串. 若 start 是负数, 则从字符串末尾算起. 若 size 是负数, 则表示从字符串末尾算起, 忽略掉那么多字节(类似 PHP 的 substr()start 是负数, 则从字符串末尾算起. 若 size 是负数, 则表示从字符串末尾算起, 忽略掉那么多字节(类似 PHP 的 substr()).

参数

• key -
• start - 可选, int, 子串的字节偏移
• size).

参数

• key -

返回值

返回字符串的长度, key 不存在则返回 0.

示例

$ssdb->hset('h', 'key', 'value');

keys/rkeys

说明

列出处于区间 (key_start, key_end] 的 key 列表.

("", ""] 表示整个区间.

参数

• key_start - 返回的起始 key(不包含), 空字符串表示 -inf.
• key_end - 返回的结束 key(包含), 空字符串表示 +inf.
• limit - 最多返回这么多个元素.

返回值

如果出错则返回 false

返回字符串的长度, key 不存在则返回 0.🎜🎜🎜示例🎜🎜

$ssdb->hget('h', 'key');

keys/rkeys

列出处于区间 (key_start, key_end] 的 key 列表.🎜

("", ""] 表示整个区间.🎜🎜🎜参数🎜🎜🎜🎜key_start - 返回的起始 key(不包含), 空字符串表示 -inf.🎜key_end - 返回的结束 key(包含), 空字符串表示 +inf.🎜limit - 最多返回这么多个元素.🎜🎜返回值🎜🎜

如果出错则返回 false, 否则返回包含 key 的数组.🎜

示例

$ssdb->hdel('h', 'key');

scan

说明

列出处于区间 (key_start, key_end] 的 key-value 列表.

("", ""] 表示整个区间.

参数

• key_start - 返回的起始 key(不包含), 空字符串表示 -inf.
key_start - 返回的起始 key(不包含), 空字符串表示 -inf.
• key_end - 返回的结束 key(包含), 空字符串表示 +inf.
• limit - 最多返回这么多个元素.

返回值

如果出错则返回 falsekey_end - 返回的结束 key(包含), 空字符串表示 +inf.

返回值

$ssdb->hincr('h', 'key', 1);

$ssdb->hexists('h', 'key');

rscan

参数

• key_start - 返回的起始 key(不包含), 空字符串表示 +inf.
key_start - 返回的起始 key(不包含), 空字符串表示 +inf.
• key_end - 返回的结束 key(包含), 空字符串表示 -inf.
• limit - 最多返回这么多个元素.

返回值

如果出错则返回 false, 否则返回包含 key-value 的数关联组.

示例

$ssdb->hsize('h');

multi_set

说明

批量设置一批 key-value.

参数

• kvs - 包含 key-value 的关联数组 .

返回值

出错则返回 falsekey_end - 返回的结束 key(包含), 空字符串表示 -inf.

返回值

$ssdb->hlist('a', 'z', 10);

$ssdb->hkeys('h', 'a', 'z', 10);

$ssdb->hgetall('h');

multi_del

说明

批量删除一批 key 和其对应的值内容.

参数

• keys - 包含 key 的数组 .

返回值

出错则返回 false

如果出错则返回 false, 否则返回包含 key-value 的关联数组, 如果某个 key 不存在, 则它不会出现在返回数组中.

$ssdb->hscan('h', 'a', 'z', 10);

$start = '';
while(1){
    $kvs = $ssdb->hscan($name, $start, '', 10);
    if(!$kvs){
        break;
    }
    // do sth on kvs here$keys = array_keys($kvs);$start = $keys[count($keys) - 1];}

$ssdb->hrscan('h', 'a', 'z', 10);

hget

说明

获取 hashmap 中指定 key 的值内容.

参数

• name - hashmap 的名字.
• key - hashmap 中的 key.

返回值

如果 key 不存在则返回 null, 如果出错则返回 falsekey - hashmap 中的 key.

出错则返回 false, 其它值表示正常.🎜🎜🎜示例🎜🎜

$ssdb->hclear('h');

hget

获取 hashmap 中指定 key 的值内容.🎜🎜🎜参数🎜🎜🎜🎜name - hashmap 的名字.🎜key - hashmap 中的 key.🎜🎜返回值🎜🎜

如果 key 不存在则返回 null, 如果出错则返回 false, 否则返回 key 对应的值内容.🎜

示例

$ssdb->multi_hset('h', array(
    'a' => 1,
    'b' => 2,
));

hdel

说明

获取 hashmap 中的指定 key.

参数

• name - hashmap 的名字.
name - hashmap 的名字.
• key - hashmap 中的 key.

返回值

如果出错则返回 false, 其它值表示正常. 你无法通过返回值来判断被删除的 key 是否存在.

示例

$ssdb->multi_hget('h', array('k1', 'k2'));

hincr

从 1.7.0.1 起, 如果 value 不能转换成整数, incr 会返回错误.

说明

使 hashmap 中的 key 对应的值增加 num. 参数 numkey - hashmap 中的 key.

$ssdb->multi_hdel('h', array('k1', 'k2'));

$ssdb->zset('z', 'key', 100);

hexists

说明

判断指定的 key 是否存在于 hashmap 中.

参数

• name - hashmap 的名字.
• key -

返回值

如果存在, 返回 true, 否则返回 falsekey -

返回值

$ssdb->zget('z', 'key');

$ssdb->zdel('hz, 'key');

$ssdb->zincr('z', 'key', 1);

hlist, hrlist

说明

列出名字处于区间 (name_start, name_end] 的 hashmap.

("", ""] 表示整个区间.

参数

• name_start - 返回的起始名字(不包含), 空字符串表示 -inf.
• name_end - 返回的结束名字(包含), 空字符串表示 +inf.
• limit - 最多返回这么多个元素.

返回值

出错则返回 false

出错则返回 false, 否则返回元素的个数, 0 表示不存在 hashmap(空).🎜🎜🎜示例🎜🎜

$ssdb->zexists('z', 'key');

hlist, hrlist

列出名字处于区间 (name_start, name_end] 的 hashmap.🎜

("", ""] 表示整个区间.🎜🎜🎜参数🎜🎜🎜🎜name_start - 返回的起始名字(不包含), 空字符串表示 -inf.🎜name_end - 返回的结束名字(包含), 空字符串表示 +inf.🎜limit - 最多返回这么多个元素.🎜🎜返回值🎜🎜

出错则返回 false, 返回返回包含名字的数组.🎜

示例

$ssdb->zsize('z');

hkeys

说明

列出 hashmap 中处于区间 (key_start, key_end] 的 key 列表.

("", ""] 表示整个区间.

参数

• name - hashmap 的名字.
name - hashmap 的名字.
• key_start - 起始 key(不包含), 空字符串表示 -inf.
• key_end - 结束 key(包含), 空字符串表示 +inf.
• limit - 最多返回这么多个元素.

返回值

如果出错则返回 falsekey_start - 起始 key(不包含), 空字符串表示 -inf.

limit - 最多返回这么多个元素.返回值

示例

$ssdb->zlist('a', 'z', 10);

参数

• name - hashmap 的名字.

返回值

如果出错则返回 false, 否则返回包含 key-value 的关联数组.

示例

$ssdb->zkeys('z', '', 1, 100, 10);

hscan

说明

列出 hashmap 中处于区间 (key_start, key_end] 的 key-value 列表.

("", ""] 表示整个区间.

参数

• name - hashmap 的名字.
• key_start - 返回的起始 key(不包含), 空字符串表示 -inf.
• key_end - 返回的结束 key(包含), 空字符串表示 +inf.
• limit - 最多返回这么多个元素.

返回值

如果出错则返回 false

如果出错则返回 false, 否则返回包含 key-value 的关联数组.

$ssdb->zscan('z', '', 1, 100, 10);

hscan

$key_start = ''; 
$score_start = ''; 
while(1){
    $items = $ssdb->zscan($zname, $key_start, $score_start, '', 10);
    if(!$items){
        break;
    }
    foreach($items as $key=>$score){
        // process($key, $score)...    // 记住最大的元素和它的权重
    $key_start = $key;
    $score_start = $score;
}   
}

$ssdb->zrscan('z', '', 100, 1, 10);

hrscan

说明

列出 hashmap 中处于区间 (key_start, key_end] 的 key-value 列表, 反向顺序.

("", ""] 表示整个区间.

参数

• name - hashmap 的名字.
name - hashmap 的名字.
• key_start - 返回的起始 key(不包含), 空字符串表示 +inf.
• key_end - 返回的结束 key(包含), 空字符串表示 -inf.
• limit - 最多返回这么多个元素.

返回值

如果出错则返回 falsekey_start - 返回的起始 key(不包含), 空字符串表示 +inf.

limit - 最多返回这么多个元素.返回值

示例

$ssdb->zrank('z', 'k1');

参数

• name - hashmap 的名字.

返回值

如果出错则返回 false, 否则返回删除的 key 的数量.

示例

$ssdb->zrange('z', 0, 10);

multi_hset

说明

批量设置 hashmap 中的 key-value.

参数

• name - hashmap 的名字.
• kvs - 包含 key-value 的关联数组 .

返回值

出错则返回 false

如果出错则返回 false, 否则返回删除的 key 的数量.

$ssdb->zclear('z');

$ssdb->zcount('z', 0, 100);

$ssdb->zsum('z', 0, 100);

multi_hdel

说明

批量删除 hashmap 中的 key.

参数

• name - hashmap 的名字.
• keys - 包含 key 的数组 .

返回值

出错则返回 falsekeys - 包含 key 的数组 .

返回值

$ssdb->zavg('z', 0, 100);

multi_hdel

$ssdb->zremrangebyrank('z', 1, 2);

$ssdb->zremrangebyscore('z', 1, 2);

zget

说明

获取 zset 中指定 key 的权重值.

参数

• name - zset 的名字.
• key - zset 中的 key.

返回值

如果 key 不存在则返回 null, 如果出错则返回 falsekey - zset 中的 key.

出错则返回 false, 其它值表示正常.🎜🎜🎜示例🎜🎜

$ssdb->zpop_front('z', 3);

zget

获取 zset 中指定 key 的权重值.🎜🎜🎜参数🎜🎜🎜🎜name - zset 的名字.🎜key - zset 中的 key.🎜🎜返回值🎜🎜

如果 key 不存在则返回 null, 如果出错则返回 false, 否则返回 key 对应的权重值.🎜

示例

$ssdb->zpop_back('z', 3);

zdel

说明

获取 zset 中的指定 key.

参数

• name - zset 的名字.
name - zset 的名字.
• key - zset 中的 key.

返回值

如果出错则返回 false, 其它值表示正常. 你无法通过返回值来判断被删除的 key 是否存在.

示例

$ssdb->multi_zset('z', array(
    'a' => 1,
    'b' => 2,
));

zincr

说明

使 zset 中的 key 对应的值增加 num. 参数 numkey - zset 中的 key.

$ssdb->multi_zget('z', array('k1', 'k2'));

$ssdb->multi_zdel('z', array('k1', 'k2'));

zexists

说明

判断指定的 key 是否存在于 zset 中.

参数

• name - zset 的名字.
• key -

返回值

如果存在, 返回 true, 否则返回 falsekey -

返回值

$ssdb->qsize('q');

$ssdb->qlist('a', 'z', 10);

$ssdb->qclear('q');

zlist, zrlist

说明

列出名字处于区间 (name_start, name_end] 的 zset.

("", ""] 表示整个区间.

参数

• name_start - 返回的起始名字(不包含), 空字符串表示 -inf.
• name_end - 返回的结束名字(包含), 空字符串表示 +inf.
• limit - 最多返回这么多个元素.

返回值

出错则返回 false

出错则返回 false, 否则返回元素的个数, 0 表示不存在 zset(空).🎜🎜🎜示例🎜🎜

$ssdb->qfront('q');

zlist, zrlist

列出名字处于区间 (name_start, name_end] 的 zset.🎜

("", ""] 表示整个区间.🎜🎜🎜参数🎜🎜🎜🎜name_start - 返回的起始名字(不包含), 空字符串表示 -inf.🎜name_end - 返回的结束名字(包含), 空字符串表示 +inf.🎜limit - 最多返回这么多个元素.🎜🎜返回值🎜🎜

出错则返回 false, 否则返回包含名字的数组.🎜

示例

$ssdb->qback('q');

zkeys

说明

导入zset中的密钥列表。 参见 zscan() zscan().

参数

• name - zset 的名字.
• key_start - 参见 zscan().
• score_start - 参见 zscan().
• score_end - 参见 zscan().
• limit - 最多返回这么多个元素.

返回值

如果出错则返回 false.

• 名称 - zset 的名字。
• key_start - 参见zscan()🎜。
• score_start - 参见zscan()🎜 .
• score_end - 参见zscan()🎜。
• < code style="color: rgb(204, 0, 0);">limit - 最多返回这么多元素。

$ssdb->qget('q', -2);

zscan

说明

列出 zset 中处于区间 (key_start+score_start, score_end] 的 key-score 列表. 如果 key_start 为空, 那么对应权重值大于或者等于 score_start 的 key 将被返回. 如果 key_start 不为空, 那么对应权重值大于 score_start 的 key, 或者大于 key_start 且对应权重值等于 score_start 的 key 将被返回.

也就是说, 返回的 key 在 (key.score == score_start && key > key_start || key.score > score_start), 并且 key.score <= score_end 区间. 先判断 score_start, score_end, 然后判断 key_start.(key.score == score_start && key > key_start || key.score > score_start), 并且 key.score <= score_end 区间. 先判断 score_start, score_end, 然后判断 key_start.

("", ""] 表示整个区间.

参数

• name - zset 的名字.
• key_start - score_start 对应的 key.
• score_start - 返回 key 的最小权重值(可能不包含, 依赖 key_start), 空字符串表示 -inf.
• score_end - 返回 key 的最大权重值(包含), 空字符串表示 +inf.
• limit - 最多返回这么多个元素.

返回值

如果出错则返回 false

参数

• name - zset 的名字.
• key_start - score_start 对应的 key.
• score_start - 返回 key 的最小权重值(可能不包含, 依赖 key_start), 空字符串表示 -inf.
• score_end - 返回 key 的最大权重值(包含), 空字符串表示 +inf.
• limit - 最多返回这么多个元素.

$ssdb->qset('q', 0, 'new val');

$ssdb->qrange('q', 0, 10);

zrscan

说明

列出 zset 中的关键分数列表，反向顺序。 参见 zkeys() zkeys().

参数

• name - zset 的名字.
• key_start - 参见 zkeys().
• score_start - 参见 zkeys().
• score_end - 参见 zkeys().
• limit - 最多返回这么多个元素.

返回值

如果出错则返回 false.

参数

• 名称 - zset 的名字。
• key_start - 参见zkeys()。
• score_start - 参见zkeys() .
• score_end - 参见zkeys()。
• < code style="color: rgb(204, 0, 0);">limit - 最多返回这么多元素。

返回值

如果出错则返回 < code style="color: rgb(204, 0, 0);">false,否则返回包含 key-score 的关联数据库。

示例

$ssdb->qslice('q', 0, -1);

示例

$ssdb->qpush_front('q', 'a');

参数

• name - zset 的名字.
name - zset 的名字.
• offset - 正整数, 从此下标处开始返回. 从 0 开始.
• limit - 正整数, 最多返回这么多个 key-score 对.

返回值

如果出错则返回 false, 否则返回包含 key-score 的关联数组.

示例

$ssdb->qpush_back('q', 'a');

zclear

说明

删除 zset 中的所有 key.

参数

• name - zset 的名字.

返回值

如果出错则返回 falseoffset - 正整数, 从此下标处开始返回. 从 0 开始.

返回值

$ssdb->qpop_front('q');

$ssdb->qpop_back('q');

$ssdb->qtrim_front('q', 3);

zsum

说明

返回 key 处于区间 [start,end] 的 score 的和.

参数

• name - zset 的名字.
• score_start - key 的最小权重值(包含), 空字符串表示 -inf.
• score_end - key 的最大权重值(包含), 空字符串表示 +inf.

返回值

如果出错则返回 falsescore_start - key 的最小权重值(包含), 空字符串表示 -inf.

如果出错则返回 false, 否则返回符合条件的 key 的数量.🎜🎜🎜示例🎜🎜

$ssdb->qtrim_back('q', 3);

zsum

返回 key 处于区间 [start,end] 的 score 的和.🎜🎜🎜参数🎜🎜🎜🎜name - zset 的名字.🎜score_start - key 的最小权重值(包含), 空字符串表示 -inf.🎜score_end - key 的最大权重值(包含), 空字符串表示 +inf.🎜🎜返回值🎜🎜

如果出错则返回 false, 否则返回符合条件的 score 的求和.🎜

示例

$ret = $ssdb->batch()
    ->set('a', 1)
    ->get('a')
    ->exec();
// 或者
$ssdb->batch();
$ssdb->set('a', 1);
$ssdb->get('a');
$ret = $ssdb->exec();

zavg

说明

返回 key 处于区间 [start,end] 的 score 的平均值.

参数

• name - zset 的名字.
name - zset 的名字.
• score_start - key 的最小权重值(包含), 空字符串表示 -inf.
• score_end - key 的最大权重值(包含), 空字符串表示 +inf.

返回值

如果出错则返回 falsescore_start - key 的最小权重值(包含), 空字符串表示 -inf.

返回值

$ssdb->dbsize();

zremrangebyrank

参数

• name - zset 的名字.
name - zset 的名字.
• start - (包含).
• end -(包含).

返回值

出错则返回 false, 否则返回被删除的元素个数.

示例

$ssdb->info();

zremrangebyscore

说明

删除权重处于区间 [start,end] 的元素.

参数

• name - zset 的名字.
• start - (包含).
• end -(包含).

返回值

出错则返回 falsestart - (包含).

出错则返回 false, 否则返回被删除的元素个数.🎜🎜🎜示例🎜🎜rrreee

zremrangebyscore

删除权重处于区间 [start,end] 的元素.🎜🎜🎜参数🎜🎜🎜🎜name - zset 的名字.🎜start - (包含).🎜end -(包含).🎜🎜返回值🎜🎜

出错则返回 false, 否则返回被删除的元素个数.🎜

示例

zpop_front

说明

从 zset 首部删除并返回 limit 个元素.limit 个元素.

参数

• name - zset 的名字.
• limit - 正整数, 最多要删除并返回这么多个 key-score 对.

返回值

如果出错则返回 false, 否则返回包含 key-score 的关联数组.

示例

zpop_back

说明

从 zset 尾部删除并返回 limit

• name - zset 的名字.
• limit - 正整数, 最多要删除并返回这么多个 key-score 对.

multi_zset

说明

批量设置 zset 中的 key-score.

参数

• name - zset 的名字.
• kvs - 包含 key-score 的关联数组 .

返回值

出错则返回 falselimit - 正整数, 最多要删除并返回这么多个 key-score 对.

返回值

rrreee

multi_zset

multi_zdel

说明

批量删除 zset 中的 key.

参数

• name - zset 的名字.
• keys - 包含 key 的数组 .

返回值

出错则返回 falsekeys - 包含 key 的数组 .

返回值

rrreee

multi_zdel

qlist, qrlist

说明

列出名字处于区间 (name_start, name_end] 的 queue/list.

("", ""] 表示整个区间.

参数

• name_start - 返回的起始名字(不包含), 空字符串表示 -inf.
• name_end - 返回的结束名字(包含), 空字符串表示 +inf.
• limit - 最多返回这么多个元素.

返回值

出错则返回 false

出错返回 false, 否则返回一个整数, 0 表示队列不存在(或者为空).🎜🎜🎜示例🎜🎜rrreee

qlist, qrlist

列出名字处于区间 (name_start, name_end] 的 queue/list.🎜

("", ""] 表示整个区间.🎜🎜🎜参数🎜🎜🎜🎜name_start - 返回的起始名字(不包含), 空字符串表示 -inf.🎜name_end - 返回的结束名字(包含), 空字符串表示 +inf.🎜limit - 最多返回这么多个元素.🎜🎜返回值🎜🎜

出错则返回 false, 返回返回包含名字的数组.🎜

示例

qclear

说明

清空一个队列.

参数

• name -

返回值

出错返回 false.

示例

qfront

说明

返回队列的第一个元素.

参数

• name -

返回值

出错返回 false, 队列不存在(或者为空)则返回 null

qback

说明

返回队列的最后一个元素.

参数

• name -

返回值

出错返回 false, 队列不存在(或者为空)则返回 null, 否则返回一个元素.

示例

qget

说明

返回指定位置的元素. 0 表示第一个元素, 1 是第二个 ... -1 是最后一个.

参数

• name -
• index - 可传负数.

返回值

出错返回 false, 如果指定位置不存在一个元素, 则返回 null

qset

Since: 1.7.0.0

说明

更新位于 index 位置的元素. 如果超过现有的元素范围, 会返回错误.

参数

• name -
name -
• index - 可传负数.
• val -

返回值

出错则返回 falseindex - 可传负数.

返回值

qrange

参数

• name - queue 的名字.
name - queue 的名字.
• offset - 整数, 从此下标处开始返回. 从 0 开始. 可以是负数, 表示从末尾算起.
• limit - 正整数, 最多返回这么多个元素.

返回值

如果出错则返回 false, 否则返回数组.

示例

qslice

说明

返回下标处于区域 [begin, end] 的元素. begin 和 end 可以是负数

参数

• name -
• begin -
• end -

返回值

出错返回 falseoffset - 整数, 从此下标处开始返回. 从 0 开始. 可以是负数, 表示从末尾算起.

如果出错则返回 false, 否则返回数组.🎜🎜🎜示例🎜🎜rrreee

qslice

返回下标处于区域 [begin, end] 的元素. begin 和 end 可以是负数🎜🎜🎜参数🎜🎜🎜🎜name -🎜begin -🎜end -🎜🎜返回值🎜🎜

出错返回 false, 否则返回包含元素的数组.🎜

示例

qpush

说明

本函数是 qpush_back() 的别名.qpush_back() 的别名.

qpush_front

说明

往队列的首部添加一个或者多个元素

参数

• name -
• item - 字符串或是字符串数组.

返回值

添加元素之后, 队列的长度, 出错返回 false

qpush_front

往队列的首部添加一个或者多个元素

参数

• name -
• item - 字符串或是字符串数组.

参数

• name -
name -
• item - 字符串或是字符串数组.

返回值

添加元素之后, 队列的长度, 出错返回 false.

示例

qpop

说明

本函数是 qpop_front()item - 字符串或是字符串数组.

示例rrreee

qpop_back

说明

从队列尾部弹出一个或者多个元素.

参数

• name -
• size - 可选, 最多从队列弹出这么多个元素

返回值

出错返回 false. 当 size 未指定或者小于等于 1 时, 队列不存在(或者为空)则返回 null, 否则删除并返回一个元素. 当 sizesize - 可选, 最多从队列弹出这么多个元素

出错返回 false. 当 size 未指定或者小于等于 1 时, 队列不存在(或者为空)则返回 null, 否则删除并返回一个元素. 当 size 大于等于 2 时, 返回一个数组包含弹出的元素.🎜🎜🎜示例🎜🎜rrreee

qpop_back

从队列尾部弹出一个或者多个元素.🎜🎜🎜参数🎜🎜🎜🎜name -🎜size - 可选, 最多从队列弹出这么多个元素🎜🎜返回值🎜🎜

出错返回 false. 当 size 未指定或者小于等于 1 时, 队列不存在(或者为空)则返回 null, 否则删除并返回一个元素. 当 size 大于等于 2 时, 返回一个数组包含弹出的元素.🎜

示例

qtrim_front

说明

从队列头部删除多个元素.

参数

• name -
name -
• size - 最多从队列删除这么多个元素

返回值

出错返回 false. 返回被删除的元素数量.

示例

qtrim_back

说明

从队列头部删除多个元素.

参数

• name -
• size - 最多从队列删除这么多个元素

返回值

出错返回 falsesize - 最多从队列删除这么多个元素

batch, exec

说明

批量执行一批命令. 批量命令可以减少客户端和服务器之间的交互延时, 能提高性能和响应速度.

这个特性是在客户端实现的, ssdb-server 不支持批量命令, 而是当作独立的一个命令一个命令地执行. 所有命令和参数的大小应小于 10MB.

参数

返回值

如果 exec() 出错则返回 false, 否则返回一个数组包含对应每一条命令的结果.

示例

dbsize

说明

返回数据库的估计大小, 以字节为单位. 如果服务器开启了压缩, 返回压缩后的大小.

参数

返回值

出错返回 false. 返回数据库大小.false. 返回数据库大小.

示例

info

说明

返回服务器的信息.

参数

• opt - 可选, 可以是 cmd, leveldb

返回值

出错返回 false

示例rrreee

info