SSDB PHP プログラム API ドキュメント

SSDB PHP Client API Document

• @更新日: 2014-11-05

SSDB は、zset データ構造をサポートし、Redis の置き換えに使用される高性能 NoSQL データベースです。公式 Web サイトは http です。 :/ /ssdb.io。このドキュメントでは、SSDB の PHP クライアント API を紹介します。

注: SSDB で使用される名詞「ハッシュマップ」、「ハッシュ」、「マップ」は同じ意味です。

クラス 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');

エラー処理

SimpleSSDB は、SSDB サーバーに接続できない場合に例外をスローし、 (いくつかの例外を除き) false を返すことでエラーを示します。強制等価 (===) を使用して戻り値を決定します。

ネットワークエラーが発生した場合、すべてのメソッドは SSDBException 例外をスローします

注: 実装上の理由により、すべてのパラメータの合計が 以上であることを確認してください。サイズは 10MB です。

メソッド

SimpleSSDB::__construct

説明

SimpleSSDBのインスタンスを作成し、SSDBサーバーに接続できない場合は、例外がスローされます。

パラメータ

• < code style="color: rgb(204, 0, 0);">host - SSDB サーバーのホスト名または IP。host - SSDB 服务器的主机名或者 IP.
• port - SSDB 服务器的端口号.
• timeout_ms
port - SSDB サーバーのポート番号。

timeout_ms - オプション、接続タイムアウト、およびデータの送受信 タイムアウト (ミリ秒単位) です。

戻り値

SimpleSSDB のインスタンス

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

1.7 .0.0

手順

パラメータ

• パスワード -

返回值

出错则返回 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 -

返回值

出错则返回 false値 -

戻り値

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

$ssdb->ttl('key');

$ssdb->get('key');

ttl

说明

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

参数

• key -

返回值

出错则返回 falsettl - 生存時間 (秒)

戻り値

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

説明

を返します。キーの生存時間 (KV タイプのみ) .

$ssdb->del('key');

getset

说明

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

参数

• key -
• value -

返回值

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

keyがそうでない場合存在する場合は null を返します。エラーが発生した場合は、false< /code>、それ以外の場合は、キーに対応する値コンテンツを返します

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

$ssdb->exists('key');

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

incr

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

说明

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

参数

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

返回值

如果出错则返回 false

エラーが発生した場合は、false、その他の値は正常を示します。戻り値によって削除されたキーが存在するかどうかを判断することはできません。🎜🎜🎜例🎜🎜

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

incr

1.7.0.1 以降、値を整数に変換できない場合、🎜incr はエラー。🎜🎜🎜🎜説明🎜🎜

key を使用します。対応する値は num を増加させます。 code> パラメータ num は、元の値が整数でない場合 (文字列形式の整数)、負の数にすることができます。最初に整数に変換されます。🎜🎜🎜 パラメータ🎜🎜🎜🎜key -🎜num - オプション。符号付き整数である必要があります。デフォルトは 1 です。🎜🎜戻り値🎜🎜

エラーが発生した場合は、false 、それ以外の場合は新しい値を返します。🎜

例

指定されたキーが存在するかどうかを判断します。

• key -

返回值

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

示例

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

getbit

说明

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

参数

• key -
• offset
戻り値

存在する場合は true を返し、それ以外の場合は を返しますstyle ="color: rgb(204, 0, 0);">false.

例

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

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

setbit

説明

文字列内の指定された位置にビット値(BIT)を設定すると、文字列の長さが自動的に拡張されます。

パラメータ

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

返回值

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

示例

$ssdb->strlen('key');

bitcount

说明

计算字符串的子串所包含的位值为 1 的个数. 若 start 是负数, 则从字符串末尾算起. 若 end offset - ビット オフセット、値の範囲 [0, 1073741824]val - 0 または 1< /ul>

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

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

$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;
}

ビット値 1 の数を返します。エラーの場合は false を返します。

例

If start の部分文字列を取得します。負の数値の場合は、文字列の末尾から数えることを意味します。size が負の数値の場合、文字列の末尾から数えることを意味します。文字列の末尾を無視し、マルチバイト (PHP の substr()

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

参数

• key -
• start - 可选, int, 子串的字节偏移
• size
パラメータ

• key -
• start - オプション、部分文字列の int バイト オフセット
• < code style="color : rgb(204, 0, 0);">size - オプション、int、部分文字列の長さ (バイト数)、デフォルトは文字列の最後のバイトです

戻り値

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

パラメータ

• キー -

返回值

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

示例

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

keys/rkeys

说明

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

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

参数

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

返回值

如果出错则返回 false

キーが存在しない場合は、0 を返します。 🎜🎜🎜例 🎜🎜

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

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

scan

説明

間隔(key_start, key_end]内のキーと値のリストをリストします。

("", ""]は間隔全体を表します。

) パラメータ

• key_start - 返される開始キー (含まれていません)、空の文字列は -inf を意味します。
key_start - 返回的起始 key(不包含), 空字符串表示 -inf.
• key_end - 返回的结束 key(包含), 空字符串表示 +inf.
• limit - 最多返回这么多个元素.

返回值

如果出错则返回 falsekey_end - 返される終了キー (両端を含む)。空の文字列は +inf を表します。

戻り値

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

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

rscan

パラメータ

• key_start - 返された開始キー (含まれていません)。空の文字列は +inf を意味します。key_start - 返回的起始 key(不包含), 空字符串表示 +inf.
• key_end - 返回的结束 key(包含), 空字符串表示 -inf.
• limit - 最多返回这么多个元素.

返回值

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

示例

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

multi_set

说明

批量设置一批 key-value.

参数

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

返回值

出错则返回 falsekey_end - 返された終了キー (両端を含む)、空の文字列は -inf を表します。

戻り値

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

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

$ssdb->hsize('h');

multi_del

说明

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

参数

• keys - 包含 key 的数组 .

返回值

出错则返回 false

エラーが発生した場合は false を返します。それ以外の場合は、キーが存在しない場合はキーと値を含む連想配列を返します。返される配列には表示されません

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

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

hget

说明

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

参数

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

返回值

如果 key 不存在则返回 null, 如果出错则返回 falsekey - ハッシュマップ内のキー。

エラーが発生した場合は、false が返され、その他の値は正常を意味します。 🎜🎜 🎜例🎜🎜

$ssdb->hgetall('h');

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

hdel

説明

ハッシュマップ内の指定されたキーを取得します。

パラメータ

• name - ハッシュマップの名前。
name - hashmap 的名字.
• key - hashmap 中的 key.

返回值

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

示例

$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];}

hincr

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

说明

使 hashmap 中的 key 对应的值增加 num. 参数 numkey - ハッシュマップ内のキー。

パラメータ

• name - ハッシュマップの名前。
name - hashmap 的名字.
• key -
• num - 可选, 必须是有符号整数, 默认是 1.

返回值

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

示例

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

hexists

说明

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

参数

• name - hashmap 的名字.
• key -

返回值

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

戻り値

$ssdb->hclear('h');

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

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

hlist, hrlist

说明

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

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

参数

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

返回值

出错则返回 false

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

hlist, hrlist

名前が範囲 (name_start、name_end) に含まれるハッシュマップをリストします。 ].🎜

("", ""] は間隔全体。🎜🎜🎜parameter🎜🎜 🎜🎜name_start - 返された開始名 (含まれていません)、空の文字列は -inf を意味します.🎜name_end - 返される終了名 (両端を含む)。空の文字列は +inf を表します。🎜 limit - 最大でこの数の要素を返します。🎜🎜戻り値🎜🎜

エラーが発生した場合は、false、Return は名前を含む配列を返します。🎜R 例 re Rreeeee

HashMap の区間 (key_start, key_end] のキーリストのリスト。 Parameters

name - ハッシュマップの名前。

key_end - 終了キー (これを含む)、空の文字列は +inf を意味します.

戻り値

エラーが発生した場合はfalseを返し、それ以外の場合はキーを含む配列を返します。
• name - hashmap 的名字.
• key_start - 起始 key(不包含), 空字符串表示 -inf.
• key_end - 结束 key(包含), 空字符串表示 +inf.
• limit - 最多返回这么多个元素.

返回值

如果出错则返回 false

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

ハッシュマップ全体を返します。

パラメータ

• name - ハッシュマップの名前。

返回值

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

示例

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

hscan

说明

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

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

参数

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

返回值

如果出错则返回 false

エラーが発生した場合は、false が返され、それ以外の場合は、キーと値を含む連想配列が返されます

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

name - ハッシュマップの名前。🎜key_start - 返された開始キー (含まれていません)、空の文字列は -inf を意味します。🎜key_end -返される終了キー (含まれる)、空の文字列表現 +inf。🎜limit - 最大でこの数の要素を返します。< /li> 🎜🎜戻り値🎜🎜🎜エラーが発生した場合はfalseを返し、それ以外の場合は次の内容を含む連想配列を返します。 key-value.🎜🎜🎜例🎜 🎜

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

🎜トラバースハッシュ:🎜

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

hrscan

説明

ハッシュマップ内の間隔 (key_start, key_end] 内のキーと値のリストを逆順にリストします。

("", ""] は間隔全体を表します。

パラメータ

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

返回值

如果出错则返回 falsekey_start - 返された開始キー (含まれていません)。空の文字列は +inf を表します。

limit - 最大でこの数の要素を返します。戻り値

$ssdb->zsize('z');

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

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

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

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

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

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

$ssdb->zclear('z');

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

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

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

zexists

说明

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

参数

• name - zset 的名字.
• key -

返回值

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

戻り値

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

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

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

zlist, zrlist

说明

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

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

参数

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

返回值

出错则返回 false

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

名前が範囲 (name_start, name_end] 内にある zset をリストします) .🎜

("", ""] は全体を表しますInterval.🎜🎜🎜parameter🎜🎜 🎜🎜name_start - 返された開始名 (含まれていません)。空の文字列は -inf を意味します。 🎜name_end - 返される終了名 (両端を含む)。空の文字列は +inf を表します。🎜< code style="color: rgb (204, 0, 0);">limit - 最大でこの数の要素を返します。🎜🎜戻り値🎜🎜

エラーが発生した場合は、false、それ以外の場合は名前を含む配列を返します。🎜

例

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

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->multi_zget('z', array('k1', 'k2'));

zscan

説明

zsetの間隔(key_start+score_start,score_end]内のキースコアリストをリストします。key_startが空の場合、対応する重み値はより大きくなります)スコア_スタート以上のキーが返されます。 key_start が空でない場合は、対応する重み値がスコア_スタートより大きいキー、または対応する重み値がキー_スタートより大きく、対応する重み値がスコア_スタートに等しいキーが返されます。

つまり、返されるキーは (key.score == core_start && key > key_start || key.score >) にあります。 ;score_start)、key.score <=score_endinterval 。まず、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

パラメータ

• <コードスタイル="color: rgb(204, 0, 0);">name - zset の名前。
• key_start -score_start に対応するキー。
• < code style="color: rgb(204, 0, 0);">score_start - 最小重み値を返します。キー (key_start に応じて含まれない場合があります)、空の文字列は -inf を意味します。
< li>score_end - キーの最大重み値 (両端を含む) を返します。空の文字列は +inf を意味します。
• limit - 最大でこの数の要素を返します。

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

$ssdb->qsize('q');

zrscan

说明

列出zset中のkey-score列表、逆顺序。 参照 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、そうでない場合は、キースコアを含む关联数组が返されます。 说明

注意! この方法では非常に遅い可能性があります! 请在离線環境内で使用します。

zset内の指定されたキーのソート位置(ランキング)を返します。ランキングは0から始まります。zrrankは逆のランキングを取得します。

パラメータ

• name - zset の名前。
name - zset 的名字.
• key -

返回值

$ssdb->qclear('q');

$ssdb->qfront('q');

$ssdb->qback('q');

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

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

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

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

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

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

$ssdb->qpop_front('q');

$ssdb->qpop_back('q');

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

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

$ssdb->dbsize();