Documentation de l'API du programme PHP SSDB

Document API client PHP SSDB

• @Mise à jour : 05/11/2014

SSDB est une base de données NoSQL hautes performances qui prend en charge la structure de données zset et est utilisée pour remplacer Redis. Le site officiel est http. :/ /ssdb.io Ce document présente l'API client PHP de SSDB.

Remarque : Les noms "hashmap", "hash" et "map" utilisés par SSDB ont la même signification.

Class SimpleSSDB

Démarrage rapide

<?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');

Gestion des erreurs

SimpleSSDB lèvera une exception s'il ne peut pas se connecter au serveur SSDB. La plupart des méthodes (à quelques exceptions près) indiquent une erreur en renvoyant false So à. Utilisez des égalités forcées (===) pour déterminer la valeur de retour

Si une erreur réseau se produit, toutes les méthodes lanceront une exception SSDBException

Remarque : pour des raisons de mise en œuvre, veuillez vous assurer que tous les paramètres totalisent plus de. Taille de 10 Mo.

Méthode

SimpleSSDB::__construct

Description

Créez une instance de SimpleSSDB et connectez-vous au serveur SSDB. Si vous ne parvenez pas à vous connecter au serveur, une exception sera levée.

Paramètres.

• < code style="color: rgb(204, 0, 0);">host - Le nom d'hôte ou l'adresse IP du serveur SSDB.host - SSDB 服务器的主机名或者 IP.
• port - SSDB 服务器的端口号.
• timeout_ms
port - Le numéro de port du serveur SSDB.

timeout_ms - Facultatif, connexion délai d'attente, et envoi et réception de données Le délai d'attente, en millisecondes. La valeur par défaut est de 2000 ms. Depuis : 1.7 .0.0

Instructions

Configurez le mot de passe, qui sera utilisé pour vérifier auprès du serveur ultérieurement. Cette vérification n'est pas effectuée immédiatement, mais est envoyée au serveur lorsque vous exécutez la première commande Notez que le mot de passe est. transmis en texte clair

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

set

说明

设置指定 key 的值内容.

参数

• key -
• value -

返回值

出错则返回 false

Si une erreur se produit , < code style="color: rgb(204, 0, 0);">false, sinon renvoie null .

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

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

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

setnx

说明

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

参数

• key -
• value -

返回值

出错则返回 falsevaleur -

Valeur de retour

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

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

ttl

说明

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

参数

• key -

返回值

出错则返回 falsettl - temps de survie (secondes)

Valeur de retour

$ssdb->ttl('key');

Paramètre

$ssdb->get('key');

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

getset

说明

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

参数

• key -
• value -

返回值

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

si la clé ne fonctionne pas existe Puis retournez null, si une erreur se produit, retournez false< /code>, sinon renvoie le contenu de la valeur correspondant à la clé

$ssdb->del('key');

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

$ssdb->exists('key');

incr

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

说明

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

参数

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

返回值

如果出错则返回 false

Si une erreur se produit, retournez false, les autres valeurs indiquent normal. Vous ne pouvez pas juger si la clé supprimée existe grâce à la valeur de retour. 🎜🎜🎜Exemple🎜🎜

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

incr

À partir de la version 1.7.0.1, si la valeur ne peut pas être convertie en entier, 🎜incr renverra un error.🎜🎜🎜🎜Description🎜🎜

Utilisez key La valeur correspondante augmente num. Les paramètres num peuvent être un nombre négatif si la valeur d'origine n'est pas un entier (un entier sous forme de chaîne). sera d'abord converti en nombre entier.🎜🎜🎜 Paramètres🎜🎜🎜🎜key -🎜num - facultatif, doit être un entier signé, la valeur par défaut est 1.🎜🎜valeur de retour🎜🎜

Si une erreur se produit, retournez false , sinon renvoie la nouvelle valeur.🎜

Exemple

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

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

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

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

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

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

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

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

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

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

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

$ssdb->hsize('h');

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

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

$ssdb->hgetall('h');

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

hget

说明

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

参数

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

返回值

如果 key 不存在则返回 null, 如果出错则返回 falsekey - clé dans hashmap.

Si une erreur se produit, false sera renvoyé, les autres valeurs​​signifient normales. 🎜🎜 🎜Exemple🎜🎜

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

Obtenir la valeur contenu de la clé spécifiée dans le hashmap.🎜🎜🎜Paramètres 🎜🎜🎜🎜name - le nom du hashmap.🎜key - saisissez le hashmap.🎜🎜valeur de retour🎜🎜

Si la clé n'existe pas, renvoie null, si une erreur survient Puis renvoie false, sinon renvoie la valeur contenu correspondant à la clé.🎜

Exemple

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

hdel

Explication

Obtenez la clé spécifiée dans le hashmap.

Paramètres

• name - le nom de la hashmap.
name - hashmap 的名字.
• key - hashmap 中的 key.

返回值

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

示例

$ssdb->hclear('h');

hincr

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

说明

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

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

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

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

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

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

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

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

$ssdb->zsize('z');

name - le nom de la hashmap.🎜key_start - la clé de démarrage renvoyée (non incluse), une chaîne vide signifie -inf.🎜key_end - la clé de fin renvoyée (incluse), représentation de chaîne vide +inf.🎜limit - Renvoie au plus ce nombre d'éléments.< /li> 🎜🎜Valeur de retour🎜🎜🎜Si une erreur se produit, renvoie false, sinon renvoie un tableau associatif contenant clé-valeur.🎜🎜🎜Exemple🎜 🎜

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

🎜Hash Traverse :🎜

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

hrscan

Explication

Répertoriez la liste clé-valeur dans l'intervalle (key_start, key_end] dans le hashmap, dans l'ordre inverse.

("", ""] représente l'intervalle entier.

Paramètres

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

返回值

如果出错则返回 falsekey_start - La clé de démarrage renvoyée (non incluse), une chaîne vide représente +inf.

limit - Renvoie au maximum ce nombre d'éléments.Valeur de retour

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

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

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

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

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

$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->qsize('q');

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

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

zscan

Explication

Listez la liste des scores clés dans l'intervalle (key_start+score_start, score_end] dans zset. Si key_start est vide, alors la valeur de poids correspondante est supérieure supérieur ou égal à La clé de score_start sera renvoyée. Si key_start n'est pas vide, alors la clé avec la valeur de poids correspondante supérieure à score_start, ou la clé avec la valeur de poids correspondante supérieure à key_start et la valeur de poids correspondante égale à score_start sera renvoyée. être renvoyé.

En d'autres termes, la clé renvoyée est dans (key.score == score_start && key > key_start || key.score > ; score_start), et key.score <= score_end interval . Déterminez d'abord score_start, score_end, puis déterminez 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

parameter

• name - Le nom de zset.
• key_start - La clé correspondant à score_start.
• < code style="color: rgb(204, 0, 0);">score_start - Renvoie la valeur de poids minimale de la clé (peut ne pas être incluse, dépend de key_start), la chaîne vide signifie -inf.
< li>score_end - Renvoie la valeur de poids maximum de la clé (inclus), une chaîne vide signifie +inf.
• limit - Renvoie au maximum ce nombre d'éléments.

$ssdb->qclear('q');

$ssdb->qfront('q');

zrscan

说明

列出 zset 中的 key-score 列表, 反向顺序. Utilisez zkeys() zkeys().

参数

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

返回值

如果出错则返回 false.

参数

• name - 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->qback('q');

Example

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

Paramètres

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

返回值

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

示例

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

zclear

说明

删除 zset 中的所有 key.

参数

• name - zset 的名字.

返回值

如果出错则返回 falseoffset - un entier positif, à partir de cet index. À partir de 0.

Valeur de retour

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

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

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

zsum

说明

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

参数

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

返回值

如果出错则返回 falsescore_start - la valeur de poids minimale de la clé (incluse), la chaîne vide signifie -inf.

Si une erreur se produit, renvoie false , sinon renvoie le nombre de clés correspondantes. 🎜🎜🎜Exemple🎜🎜

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

zsum

Renvoie la somme des scores de la clé dans l'intervalle [début, fin].🎜🎜🎜Paramètres🎜🎜🎜🎜name - le nom du zset.🎜score_start - la valeur de poids minimum de la clé (inclus), une chaîne vide représente -inf.🎜score_end - le valeur de poids maximum de la clé (incluse), une chaîne vide représente +inf.🎜🎜Valeur de retour🎜🎜

Si une erreur se produit, retournez false, sinon retournez la somme des scores qui remplissent les conditions.🎜

Exemple

$ssdb->qpop_front('q');

zavg

Explication

Renvoie le score moyen de la clé dans l'intervalle [début, fin].

Paramètres

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

返回值

如果出错则返回 falsescore_start - key La valeur de poids minimale (incluse), la chaîne vide représente -inf.

Valeur de retour

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

$ssdb->info();

rrreeeDéfinissez zset par lots key-score.

multi_zdel

说明

批量删除 zset 中的 key.

参数

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

返回值

出错则返回 falsekeys - un tableau contenant des clés.

Valeur de retour

rrreee< a style = "couleur : rgb(0, 0, 0) ; famille de polices : tahoma, arial ; taille de police : 13 px ; hauteur de ligne : normale ;" name="m-multi_zdel">

multi_zdel

Paramètres

• nom -

返回值

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

示例

qlist, qrlist

说明

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

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

参数

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

返回值

出错则返回 false

Renvoi d'erreur false, sinon un entier est renvoyé, 0 signifie que la file d'attente n'existe pas (ou est vide). 🎜🎜🎜Exemple🎜🎜rrreee

qlist, qrlist

Liste la file d'attente/liste dont les noms sont dans la plage (name_start, name_end).🎜

("", ""] représente l'intervalle entier.🎜🎜🎜 paramètre🎜🎜🎜🎜< code style="color: rgb(204, 0, 0);">name_start - Le nom de départ renvoyé (non inclus), une chaîne vide signifie -inf.🎜 name_end - Le nom de fin renvoyé (inclus), la chaîne vide représente +inf.🎜limit - Renvoie au maximum autant d'éléments.🎜🎜Valeur de retour🎜🎜

Si une erreur se produit, retournez false, return Renvoie un tableau contenant des noms.🎜

Exemple

qclear

Description

Effacer une file d'attente.

Paramètres

• nom -

返回值

出错返回 false.

示例

qfront

说明

返回队列的第一个元素.

参数

• name -

返回值

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

qback

Description

Renvoyer le dernier élément de la file d'attente.

Paramètres

• nom -

返回值

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

示例

qget

说明

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

参数

• name -
• index - 可传负数.

返回值

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

Mettre à jour les éléments situés dans la position d'index S'il dépasse la plage d'éléments existante, il renverra des erreurs.

nom - index - Des nombres négatifs peuvent être transmis.

• Return La valeur name -
• index - 可传负数.
• val -

返回值

出错则返回 false

renvoie false s'il y a une erreur, d'autres valeurs indiquent normal.

qrange

Paramètres

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

返回值

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

示例

qslice

说明

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

参数

• name -
• begin -
• end -

返回值

出错返回 falseoffset - un entier, à partir de cet index. À partir de 0. Il peut s'agir d'un nombre négatif, indiquant le comptage à partir de la fin.

Si une erreur se produit, retournez false, sinon renvoie un tableau.🎜🎜🎜Exemple🎜🎜rrreee

qslice

Renvoie l'élément dont l'indice est dans la zone [begin, end]. le début et la fin peuvent être des nombres négatifs🎜🎜🎜paramètres🎜🎜🎜🎜< code style="color: rgb(204, 0, 0 );">nom -🎜begin -🎜fin -🎜🎜valeur de retour🎜🎜

Retour false en cas d'erreur, sinon renvoie l'élément contenant Array of .🎜

Exemple

qpush

Explication

Cette fonction est un alias de qpush_back() qpush_back() 的别名.

qpush_front

说明

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

参数

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

返回值

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

qpush_front

Ajoutez un ou plusieurs éléments en tête de file d'attente

Paramètres

• nom -
• item - Chaîne ou tableau de chaînes.

Paramètres

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

返回值

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

示例

qpop

说明

本函数是 qpop_front()item - Chaîne ou tableau de chaînes.

Exemplerrreeeqpop_front().

qpop_back

说明

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

参数

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

返回值

出错返回 false. 当 size 未指定或者小于等于 1 时, 队列不存在(或者为空)则返回 null, 否则删除并返回一个元素. 当 sizetaille - facultatif, jusqu'à ce nombre d'éléments peuvent être extraits de la file d'attente

Erreur renvoyée false Lorsque size n'est pas précisé ou est inférieur ou égal à 1, et que la file d'attente n'existe pas (ou est vide), puis null, sinon supprimez et renvoyez un élément lorsque size est supérieur ou égal à 2 , renvoie un tableau contenant les éléments sautés 🎜🎜🎜Example🎜🎜rrreee

qpop_back

Popez un ou plusieurs éléments de la fin de la file d'attente.🎜🎜🎜Paramètres🎜🎜🎜🎜nom - 🎜taille - facultatif, jusqu'à ce nombre les éléments peuvent être extraits de la file d'attente🎜🎜 Valeur de retour🎜🎜

Erreur renvoyée false. Lorsque taille n'est pas précisée ou est inférieure ou égale à 1, Si la file d'attente n'existe pas (ou est vide), null est renvoyé, sinon un élément est supprimé et renvoyé Lorsque Lorsque la taille est supérieure ou égale à 2, renvoie un tableau contenant les éléments sautés.🎜

Exemple

qtrim_front

Description

Supprimer plusieurs éléments de la tête de la file d'attente.

Paramètres

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

返回值

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

示例

qtrim_back

说明

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

参数

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

返回值

出错返回 falsesize - supprime au plus ce nombre d'éléments de la file d'attente< /li >

batch, exec

Explication

Exécuter un lot de commandes par lots peut réduire le délai d'interaction entre le client et le serveur et améliorer les performances et la vitesse de réponse.

Cette fonctionnalité est implémentée côté client. ssdb-server ne prend pas en charge les commandes batch, mais est exécutée une par une en tant que commande indépendante. La taille de toutes les commandes et paramètres doit être inférieure à 10 Mo.

Paramètres.

Valeur de retour

if exec() 出错则返回 false, sinon renvoie un tableau contenant les résultats correspondant à chaque commande.

Exemple

dbsize

Explication

Renvoie le estimation de la base de données Taille, en octets Si la compression est activée sur le serveur, renvoie la taille compressée.

Paramètres

Valeur de retour

L'erreur renvoie false Renvoie la taille de la base de données.false. 返回数据库大小.

示例

info

说明

返回服务器的信息.

参数

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

返回值

出错返回 false

Exemple. rrreee

Description