SSDB PHP 프로그램 API 문서

SSDB PHP 클라이언트 API 문서

• @Updated: 2014-11-05

SSDB는 zset 데이터 구조를 지원하는 고성능 NoSQL 데이터베이스로 Redis를 대체하는 데 사용됩니다. 공식 웹사이트는 http입니다. :/ /ssdb.io 이 문서에서는 SSDB의 PHP 클라이언트 API를 소개합니다.

참고: SSDB에서 사용하는 명사 "hashmap", "hash" 및 "map"은 동일한 의미를 갖습니다.

Class 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입니다.

Method

SimpleSSDB::__construct

Description

SimpleSSDB 인스턴스를 생성하고 SSDB 서버에 연결합니다. 서버에 연결할 수 없으면 예외가 발생합니다.

Parameters

• < code style="color: rgb(204, 0, 0);">host - SSDB 서버의 호스트 이름 또는 IP입니다.host - SSDB 服务器的主机名或者 IP.
• port - SSDB 服务器的端口号.
• timeout_ms
port - SSDB 서버의 포트 번호.

timeout_ms - 선택 사항, 연결 시간 초과 및 데이터 전송 및 수신 시간 초과(밀리초) 기본값은 2000ms입니다.

반환 값

SimpleSSDB 인스턴스

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

Since : 1.7 .0.0

Instructions

Parameter

• password -

返回值

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

示例

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

set

说明

设置指定 key 的值内容.

参数

• key -
• value -

返回值

出错则返回 false

오류가 발생한 경우 , < code style="color: rgb(204, 0, 0);">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');

ttl

$ssdb->del('key');

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

getset

说明

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

参数

• key -
• value -

返回值

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

키가 그렇지 않은 경우 그런 다음 null을 반환하고, 오류가 발생하면 false< /code>, 그렇지 않으면 키에 해당하는 값 콘텐츠를 반환합니다.

$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, 그 외 값은 정상을 의미하며, 반환값으로는 삭제된 키의 존재 여부를 판단할 수 없습니다. 🎜🎜🎜Example🎜🎜

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

incr

1.7.0.1부터 값을 정수로 변환할 수 없는 경우 🎜incr은 error.🎜🎜🎜🎜Description🎜🎜

key 사용 해당 값은 num 매개변수 num은 음수가 될 수 있습니다. 원래 값이 정수(문자열 형식의 정수)가 아닌 경우 먼저 정수로 변환됩니다.🎜🎜🎜 매개변수🎜🎜🎜🎜key -🎜num - 선택 사항, 부호 있는 정수여야 하며 기본값은 1입니다.🎜🎜반환 값🎜🎜

오류가 발생하면 false , 그렇지 않으면 새 값을 반환합니다.🎜

Example

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

exists

Description

지정된 키가 존재하는지 확인합니다.

Parameters

• key -key -

返回值

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

示例

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

getbit

说明

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

参数

• key -
• offset

반환 값

$ssdb->strlen('key');

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

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

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

계산 문자열의 하위 문자열에 포함된 비트 값이 1인 비트 수입니다. start가 음수인 경우 끝부터 계산합니다. size가 음수인 경우 해당 바이트 수를 무시하고 문자열 끝부터 계산한다는 의미입니다.# 🎜🎜## 🎜🎜##🎜🎜#Parameter#🎜🎜##🎜🎜##🎜🎜##🎜🎜#키 -#🎜🎜#시작 - 선택 사항, 하위 문자열의 바이트 오프셋#🎜🎜#< code style="color: rgb(204, 0, 0);">크기 - 선택 사항, 하위 문자열의 길이(바이트 수), 기본값은 문자열의 마지막 바이트입니다 #🎜🎜##🎜🎜#반환 값#🎜🎜##🎜🎜#

비트 값 1개를 반환합니다. false를 반환합니다.#🎜🎜# 오류

Example

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

substr

Explanation

start인 경우 문자열의 하위 문자열을 가져옵니다. size가 음수인 경우 문자열 끝부터 계산한다는 의미입니다. 문자열의 경우 멀티바이트(PHP의 substr()start 是负数, 则从字符串末尾算起. 若 size 是负数, 则表示从字符串末尾算起, 忽略掉那么多字节(类似 PHP 的 substr()).

参数

• key -
• start - 可选, int, 子串的字节偏移
• size와 유사)를 무시합니다.

parameters

• 키 -

返回值

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

示例

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

keys/rkeys

说明

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

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

参数

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

返回值

如果出错则返回 false

문자열의 길이를 반환하고, 키가 존재하지 않으면 0을 반환합니다.#🎜🎜##🎜🎜##🎜🎜#Example#🎜🎜##🎜🎜 #

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

키/rkeys< /h3># 🎜🎜##🎜🎜#Description#🎜🎜##🎜🎜#

간격(key_start, key_end].#🎜🎜#

("", ""]는 전체 간격을 나타냅니다.#🎜🎜##🎜🎜##🎜🎜#Parameter#🎜🎜##🎜🎜##🎜🎜# #🎜🎜#< code style="color: rgb(204, 0, 0);">key_start - 반환된 시작 키(포함되지 않음), 빈 문자열은 -inf를 의미합니다.#🎜 🎜#key_end - 반환된 끝 키(포함), 빈 문자열은 +inf를 나타냅니다.#🎜🎜#< code style=" color: rgb(204, 0, 0);">limit - 최대 이 개수의 요소를 반환합니다.#🎜🎜##🎜🎜#Return value#🎜 🎜##🎜 🎜#

오류가 발생하면 반환 false, 그렇지 않으면 키가 포함된 배열을 반환합니다.#🎜🎜#

Example

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

scan

Explanation

List 간격(key_start, key_end].

("", ""]은 전체 간격을 나타냅니다.

매개변수

• key_start - 반환된 시작 키(포함되지 않음), 빈 문자열은 -inf를 의미합니다.
key_start - 返回的起始 key(不包含), 空字符串表示 -inf.
• key_end - 返回的结束 key(包含), 空字符串表示 +inf.
• limit - 最多返回这么多个元素.

返回值

如果出错则返回 falsekey_end - 반환된 끝 키(포함), 빈 문자열은 +inf를 나타냅니다.

반환 값

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

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

rscan

Parameters

• key_start - 반환된 시작 키(포함되지 않음), 빈 문자열은 +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 - 반환된 끝 키(포함), 빈 문자열은 -inf를 나타냅니다.

Return value

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

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

$ssdb->hgetall('h');

multi_del

说明

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

参数

• keys - 包含 key 的数组 .

返回值

出错则返回 false

오류가 발생하면 false를 반환하고, 그렇지 않으면 키-값이 포함된 연관 배열을 반환합니다. 반환된 배열에는 표시되지 않습니다.

$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, 如果出错则返回 false키 - 해시맵의 키.

오류가 발생하면 false가 반환되고, 그 외의 값은 ​​​​정상을 의미합니다. 🎜🎜 🎜예🎜🎜

$ssdb->hclear('h');

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

hdel

Explanation

해시맵에서 지정된 키를 가져옵니다.

Parameters

• name - 해시맵의 이름.
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 - 해시맵의 키.

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

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

hexists

说明

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

参数

• name - hashmap 的名字.
• key -

返回值

如果存在, 返回 true, 否则返回 false키 -

반환값

$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은 해시맵이 없음(비어 있음)을 의미합니다.#🎜🎜##🎜🎜##🎜🎜#Example#🎜🎜##🎜🎜#

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

hlist, hrlist

이름이 해당 간격에 있는 해시맵을 나열합니다. (name_start, name_end] .#🎜🎜#

(" ", ""] 전체 간격을 나타냅니다.#🎜🎜##🎜🎜##🎜🎜#Parameter#🎜🎜##🎜🎜##🎜🎜##🎜🎜#name_start - 반환된 시작 이름(포함되지 않음), 빈 문자열은 -inf를 의미합니다.#🎜🎜# name_end - 반환된 끝 이름(포함), 빈 문자열은 +inf를 나타냅니다.#🎜🎜#limit code> - 최대 이 개수의 요소를 반환합니다.#🎜🎜##🎜🎜#Return value#🎜🎜##🎜🎜#

오류가 발생하면 false , 이름이 포함된 배열을 반환합니다.#🎜🎜#예시 🎜 #Description

(key_start, key_end] 간격으로 해시맵에 키 목록을 나열합니다.

$ssdb->zsize('z');

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

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

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

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

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

$ssdb->zclear('z');

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

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

Return if an < code style="color: rgb(204, 0, 0);">false 오류가 발생하면, 그 외의 값은 정상임을 나타내는 반환값으로는 삭제된 키의 존재 여부를 판단할 수 없습니다.

Example

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

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

zincr

说明

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

Parameter

• 이름 - zset 이름.
name - zset 的名字.
• key -
• num - 必须是有符号整数.

返回值

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

示例

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

zexists

说明

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

参数

• name - zset 的名字.
• key -

返回值

如果存在, 返回 true, 否则返回 false키 -

Return value

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

zexists

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

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

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

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

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

$ssdb->qclear('q');

$ssdb->qfront('q');

$ssdb->qback('q');

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

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

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

$ssdb->info();