SSDB PHP 客户端 API 文档.pdf

SSDB PHP 客户端 API ⽂档 SSDB 是⼀个⾼性能 NoSQL 数据库, ⽀持 zset 数据结构, ⽤于替代 Redis. 官⽅⽹站是 http://ssdb .io . 本⽂档介绍了 SSDB 的 PHP 客户端 API . 意: SSDB 所使⽤的名词 hashmap , hash , map 表⽰相同的意思. 类 SimpleSSDB 快速开始 ?php include_once(SSDB.php); try{ $ssdb = new Si pleSSDB(, 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 . port - SSDB 服务器的端⼜号. ti eout_ s - 可选, 连接超时时间, 和发送接收数据的超时时间, 单位毫秒. 默 认是 2000 ms. 返回值 SimpleSSDB 的实例. ⽰例 $ssdb = new Si pleSSDB(, 8888); auth Since: 1.7 .0 .0 说明 配置密码, 之后将⽤于向服务器校验. 这个校验不是⽴即进⾏的, ⽽是等你执⾏第⼀条 命令的时候才发给服务器. 注意, 密码是明⽂传输的 参数 password - 返回值 出错则返回 false, 否则返回 null. ⽰例 $ssdb-auth(very-strong-password); set 说明 设置指定 key 的值内容. 参数 key - value - 返回值 出错则返回 false, 其它值表⽰正常. ⽰例 $ssdb-set(key , value); setx 说明 设置指定 key 的值内容, 同时设置存活时间. 参数 key - value - ttl - 存活时间(秒 返回值 出错则返回 false, 其它值表⽰正常. ⽰例 $ssdb-setx(key , value, 60); setnx 说明 当 key 不存在时, 设置指定 key 的值内容. 如果已存在, 则不设置. 参数 key - value - 返回值 出错则返回 false, 1: value 已经设置, 0: key 已经存在, 不更新. ⽰例 $ssdb-setnx(key , value); expire 说明 设置 key(只针对 KV 类型 的存活时间. 参数 key - ttl - 存活时间(秒 返回值 出错则返回 false. 如果 key 存在并设置成功, 返回 1, 如果 key 不存在, 返回 0 . ⽰例 $ssdb-expire(key , 60); ttl 说明 返回 key(只针对 KV 类型 的存活时间. 参数 key - 返回值 出错则返回 false, 否则返回 key 的存活时间(秒 , -1 表⽰没有设置存活时间. ⽰例 $ssdb-ttl(key ); get 说明 获取指定 key 的值内容. 参数 key - 返回值 如果 key 不存在则返回 null, 如果出错则返回 false, 否则返回 key 对应的值内容. ⽰例 $ssdb-get(key );