com.hyd.ssdb

类 SsdbClient

java.lang.Object

com.hyd.ssdb.AbstractClient

com.hyd.ssdb.SsdbClient

public class SsdbClient
extends AbstractClient

包含连接池的客户端类，对于一个 SSDB 服务器只需要创建一个 SsdbClient 客户端。

应用关闭时，需要调用 AbstractClient.close() 方法释放资源。

作者:

Yiding

字段概要

从类继承的字段 com.hyd.ssdb.AbstractClient

DEFAULT_CHARSET

构造器概要

构造器

构造器和说明
SsdbClient(List<Server> servers)
SsdbClient(Server server)
SsdbClient(Sharding sharding)
SsdbClient(String host, int port) 构造方法
SsdbClient(String host, int port, int timeoutSeconds)
SsdbClient(String host, int port, int timeoutSeconds, int bufferSize)
SsdbClient(String host, int port, int timeoutSeconds, String pass)
SsdbClient(String host, int port, String pass)
SsdbClient(String host, int port, String pass, int timeoutSeconds, int poolMaxTotal)

方法概要

限定符和类型	方法和说明
int	bitcount(String key, long start, long end)
int	countbit(String key, long start, long end)
long	dbsize(Server server)
void	del(List<String> keys)
void	del(String... keys) 删除一个或多个 key，注意这个方法对 zlist 无效，zlist 需要调用 zclear(String) 方法
boolean	exists(String key)
int	expire(String key, int ttlSeconds)
static SsdbClient	fromClusters(List<Cluster> clusters)
static SsdbClient	fromSingleCluster(List<Server> servers)
String	get(String key)
int	getbit(String key, long offset)
byte[]	getBytes(String key) 获取字节内容。
String	getset(String key, Object value)
int	hclear(String key)
int	hdel(String key, String propName)
boolean	hexists(String key, String propName)
String	hget(String key, String propName)
List<KeyValue>	hgetall(String key)
Map<String,String>	hgetallmap(String key)
long	hincr(String key, String propName)
long	hincr(String key, String propName, long incr)
List<String>	hkeys(String key, String startExclude, String endInclude, int limit)
List<String>	hlist(String startExclude, String endInclude, int limit)
List<String>	hrlist(String startExclude, String endInclude, int limit)
List<KeyValue>	hrscan(String key, String startExclude, String endInclude, int limit)
List<KeyValue>	hscan(String key, String startExclude, String endInclude, int limit)
void	hset(String key, String propName, String propValue)
int	hsize(String key)
long	incr(String key)
long	incr(String key, long incr)
String	info(Server server)
List<String>	keys(String startExclude, String endInclude, int limit)
List<String>	multiGet(List<String> keys) 一次取多个 key。
List<String>	multiGet(String... keys)
List<byte[]>	multiGetBytes(List<String> keys) 一次取多个 key。
List<byte[]>	multiGetBytes(String... keys)
void	multiHdel(String key, String... propNames)
List<KeyValue>	multiHget(String key, List<String> propNames)
List<KeyValue>	multiHget(String key, String... propNames)
void	multiHset(String key, List<KeyValue> props)
void	multiHset(String key, String... props)
void	multiSet(List<KeyValue> keyValues)
void	multiSet(String... keyValues)
void	multiZdel(String key, List<String> ids)
List<IdScore>	multiZget(String key, List<String> ids)
List<IdScore>	multiZget(String key, String... ids)
long	multiZset(String key, IdScore... idScores)
long	multiZset(String key, List<IdScore> idScores)
String	qback(String key)
void	qclear(String key)
String	qfront(String key)
String	qget(String key, int index)
byte[]	qgetBytes(String key, int index)
List<String>	qlist(String startKeyExclude, String endKeyInclude, int limit) 列出指定区间的 queue/list 的 key 列表
void	qpopAllBack(String key, int batchSize, Processor<String> valueProcessor)
void	qpopAllFront(String key, int batchSize, Processor<String> valueProcessor)
List<String>	qpopBack(String key, int size)
List<String>	qpopFront(String key, int size)
int	qpushBack(String key, byte[] bytes)
int	qpushBack(String key, String... values)
int	qpushFront(String key, byte[] bytes)
int	qpushFront(String key, String... values)
List<String>	qrange(String key, int offset, int limit)
List<String>	qrlist(String startKeyExclude, String endKeyInclude, int limit)
void	qset(String key, int index, String value)
int	qsize(String key)
List<String>	qslice(String key, int startInclude, int endInclude)
int	qtrimBack(String key, int size)
int	qtrimFront(String key, int size)
List<String>	rkeys(String startExclude, String endInclude, int limit)
List<KeyValue>	rscan(String startExclude, String endInclude, int limit)
void	scan(String prefix, int batchSize, Processor<KeyValue> keyConsumer)
List<KeyValue>	scan(String startExclude, String endInclude, int limit)
void	set(String key, Object value)
int	setbit(String key, long offset)
int	setnx(String key, Object value)
void	setx(String key, Object value, int ttlSeconds)
int	strlen(String key)
String	substr(String key, int start)
String	substr(String key, int start, int size)
int	ttl(String key)
long	zavg(String key, int minScoreInclude, int maxScoreInclude)
int	zclear(String key)
int	zcount(String key, int minScoreInclude, int maxScoreInclude) 查询 score 在 minScoreInclude 与 maxScoreInclude 之间的 id 数量
void	zdel(String key, String id)
boolean	zexists(String key, String id)
Long	zget(String key, String id)
long	zincr(String key, String id, long incr)
List<String>	zkeys(String key, String keyStartExclude, Long scoreStartInclude, Long scoreEndInclude, int limit)
List<String>	zlist(String startExclude, String endInclude, int limit)
List<IdScore>	zpopBack(String key, int limit)
List<IdScore>	zpopFront(String key, int limit)
List<IdScore>	zrange(String key, int offset, int limit)
int	zrank(String key, String id) 获取 id 的排名，从小到大，0 表示第一位 注意，根据文档 http://www.ideawu.net/blog/archives/752.html ，该命令存在性能问题，请慎用
int	zremrangebyrank(String key, int minRankInclude, int maxRankInclude) 删除指定排名范围内的 id
int	zremrangebyscore(String key, int minScoreInclude, int maxScoreInclude)
List<IdScore>	zrrange(String key, int offset, int limit)
int	zrrank(String key, String id)
List<IdScore>	zrscan(String key, String keyStartExclude, Long scoreStartInclude, Long scoreEndInclude, int limit)
List<IdScore>	zscan(String key, String keyStartExclude, Long scoreStartInclude, Long scoreEndInclude, int limit) (这命令真别扭)
void	zset(String key, String id, long score)
int	zsize(String key)
Long	zsum(String key, int minScoreInclude, int maxScoreInclude)

从类继承的方法 com.hyd.ssdb.AbstractClient

close, combineBlocks, combineKeyValues, getCharset, getSharding, prependCommand, prependCommand, prependCommand, prependCommand, prependCommandIdScore, prependCommandKeyValue, sendRequest, sendRequest, sendRequest, sendRequest, sendRequestToAll, sendRequestToAll, sendWriteRequest, setCharset, splitKeys, splitKeys, splitKeyValues, splitKeyValues

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SsdbClient

public SsdbClient(String host,
                  int port)
           throws SsdbException

构造方法

参数:

host - 服务器地址

port - 服务器端口

抛出:

SsdbException - 如果连接服务器失败

SsdbClient

public SsdbClient(String host,
                  int port,
                  int timeoutSeconds)
           throws SsdbException

抛出:

SsdbException

SsdbClient

public SsdbClient(String host,
                  int port,
                  int timeoutSeconds,
                  int bufferSize)
           throws SsdbException

抛出:

SsdbException

SsdbClient

public SsdbClient(String host,
                  int port,
                  int timeoutSeconds,
                  String pass)
           throws SsdbException

抛出:

SsdbException

SsdbClient

public SsdbClient(String host,
                  int port,
                  String pass)
           throws SsdbException

抛出:

SsdbException

SsdbClient

public SsdbClient(Server server)

SsdbClient

public SsdbClient(Sharding sharding)

SsdbClient

public SsdbClient(List<Server> servers)

SsdbClient

public SsdbClient(String host,
                  int port,
                  String pass,
                  int timeoutSeconds,
                  int poolMaxTotal)
           throws SsdbException

抛出:

SsdbException

方法详细资料

fromSingleCluster

public static SsdbClient fromSingleCluster(List<Server> servers)

fromClusters

public static SsdbClient fromClusters(List<Cluster> clusters)

dbsize

public long dbsize(Server server)

info

public String info(Server server)

get

public String get(String key)

getBytes

public byte[] getBytes(String key)

获取字节内容。注意，只有当 set 进去的内容为 byte[] 时，才应当使用 getBytes() 来取，否则得到的内容很可能是不完整的。

参数:

key - 键

返回:

值

set

public void set(String key,
                Object value)

getset

public String getset(String key,
                     Object value)

setx

public void setx(String key,
                 Object value,
                 int ttlSeconds)

setnx

public int setnx(String key,
                 Object value)

expire

public int expire(String key,
                  int ttlSeconds)

ttl

public int ttl(String key)

del

public void del(String... keys)

删除一个或多个 key，注意这个方法对 zlist 无效，zlist 需要调用 zclear(String) 方法

参数:

keys - 要删除的 key

del

public void del(List<String> keys)

incr

public long incr(String key)

incr

public long incr(String key,
                 long incr)

exists

public boolean exists(String key)

getbit

public int getbit(String key,
                  long offset)

setbit

public int setbit(String key,
                  long offset)

bitcount

public int bitcount(String key,
                    long start,
                    long end)

countbit

public int countbit(String key,
                    long start,
                    long end)

substr

public String substr(String key,
                     int start,
                     int size)

substr

public String substr(String key,
                     int start)

strlen

public int strlen(String key)

keys

public List<String> keys(String startExclude,
                         String endInclude,
                         int limit)

rkeys

public List<String> rkeys(String startExclude,
                          String endInclude,
                          int limit)

scan

public List<KeyValue> scan(String startExclude,
                           String endInclude,
                           int limit)

scan

public void scan(String prefix,
                 int batchSize,
                 Processor<KeyValue> keyConsumer)

rscan

public List<KeyValue> rscan(String startExclude,
                            String endInclude,
                            int limit)

multiGet

public List<String> multiGet(String... keys)

multiGetBytes

public List<byte[]> multiGetBytes(String... keys)

multiGet

public List<String> multiGet(List<String> keys)

一次取多个 key。注意如果 Sharding 中包含一个以上的 Cluster，那么实际上是对每个 key 执行 get 查询。

参数:

keys - key 列表

返回:

value 列表

multiGetBytes

public List<byte[]> multiGetBytes(List<String> keys)

一次取多个 key。注意如果 Sharding 中包含一个以上的 Cluster，那么实际上是对每个 key 执行 get 查询。

参数:

keys - key 列表

返回:

value 列表

multiSet

public void multiSet(String... keyValues)

multiSet

public void multiSet(List<KeyValue> keyValues)

hset

public void hset(String key,
                 String propName,
                 String propValue)

hget

public String hget(String key,
                   String propName)

hdel

public int hdel(String key,
                String propName)

hincr

public long hincr(String key,
                  String propName)

hincr

public long hincr(String key,
                  String propName,
                  long incr)

hexists

public boolean hexists(String key,
                       String propName)

hsize

public int hsize(String key)

hlist

public List<String> hlist(String startExclude,
                          String endInclude,
                          int limit)

hrlist

public List<String> hrlist(String startExclude,
                           String endInclude,
                           int limit)

hkeys

public List<String> hkeys(String key,
                          String startExclude,
                          String endInclude,
                          int limit)

hgetall

public List<KeyValue> hgetall(String key)

hgetallmap

public Map<String,String> hgetallmap(String key)

hscan

public List<KeyValue> hscan(String key,
                            String startExclude,
                            String endInclude,
                            int limit)

hrscan

public List<KeyValue> hrscan(String key,
                             String startExclude,
                             String endInclude,
                             int limit)

hclear

public int hclear(String key)

multiHset

public void multiHset(String key,
                      String... props)

multiHset

public void multiHset(String key,
                      List<KeyValue> props)

multiHget

public List<KeyValue> multiHget(String key,
                                String... propNames)

multiHget

public List<KeyValue> multiHget(String key,
                                List<String> propNames)

multiHdel

public void multiHdel(String key,
                      String... propNames)

zset

public void zset(String key,
                 String id,
                 long score)

zget

public Long zget(String key,
                 String id)

zdel

public void zdel(String key,
                 String id)

zexists

public boolean zexists(String key,
                       String id)

zincr

public long zincr(String key,
                  String id,
                  long incr)

zsize

public int zsize(String key)

zclear

public int zclear(String key)

zlist

public List<String> zlist(String startExclude,
                          String endInclude,
                          int limit)

zkeys

public List<String> zkeys(String key,
                          String keyStartExclude,
                          Long scoreStartInclude,
                          Long scoreEndInclude,
                          int limit)

zscan

public List<IdScore> zscan(String key,
                           String keyStartExclude,
                           Long scoreStartInclude,
                           Long scoreEndInclude,
                           int limit)

(这命令真别扭)

参数:

key - zset 的 key

keyStartExclude - （可选）key 的开始值

scoreStartInclude - （可选）score 的最小值，为空表示无限小(-inf)

scoreEndInclude - （可选）score 的最大值，为空表示无限大(+inf)

limit - 最多返回记录数

返回:

查询结果

zrscan

public List<IdScore> zrscan(String key,
                            String keyStartExclude,
                            Long scoreStartInclude,
                            Long scoreEndInclude,
                            int limit)

zrank

public int zrank(String key,
                 String id)

获取 id 的排名，从小到大，0 表示第一位

注意，根据文档 http://www.ideawu.net/blog/archives/752.html ，该命令存在性能问题，请慎用

参数:

key - id 所处的 zset 的 key

id - id

返回:

排名，如果 id 不在 key 当中则返回 -1

zrrank

public int zrrank(String key,
                  String id)

zrange

public List<IdScore> zrange(String key,
                            int offset,
                            int limit)

zrrange

public List<IdScore> zrrange(String key,
                             int offset,
                             int limit)

zcount

public int zcount(String key,
                  int minScoreInclude,
                  int maxScoreInclude)

查询 score 在 minScoreInclude 与 maxScoreInclude 之间的 id 数量

参数:

key - zset 的 key

minScoreInclude - score 最小值（含），Integer.MIN_VALUE 表示无最小值

maxScoreInclude - score 最大值（含），Integer.MAX_VALUE 表示无最大值

返回:

score 在 minScoreInclude 与 maxScoreInclude 之间的 id 数量

zsum

public Long zsum(String key,
                 int minScoreInclude,
                 int maxScoreInclude)

zavg

public long zavg(String key,
                 int minScoreInclude,
                 int maxScoreInclude)

zremrangebyrank

public int zremrangebyrank(String key,
                           int minRankInclude,
                           int maxRankInclude)

删除指定排名范围内的 id

参数:

key - zset 的 key

minRankInclude - 最小排名（含），最小值为 0

maxRankInclude - 最大排名（含），最大值为 zset 的大小

返回:

被删除的 id 的数量

zremrangebyscore

public int zremrangebyscore(String key,
                            int minScoreInclude,
                            int maxScoreInclude)

zpopFront

public List<IdScore> zpopFront(String key,
                               int limit)

zpopBack

public List<IdScore> zpopBack(String key,
                              int limit)

multiZset

public long multiZset(String key,
                      IdScore... idScores)

multiZset

public long multiZset(String key,
                      List<IdScore> idScores)

multiZget

public List<IdScore> multiZget(String key,
                               List<String> ids)

multiZget

public List<IdScore> multiZget(String key,
                               String... ids)

multiZdel

public void multiZdel(String key,
                      List<String> ids)

qpushFront

public int qpushFront(String key,
                      String... values)

qpushFront

public int qpushFront(String key,
                      byte[] bytes)

qpushBack

public int qpushBack(String key,
                     String... values)

qpushBack

public int qpushBack(String key,
                     byte[] bytes)

qpopFront

public List<String> qpopFront(String key,
                              int size)

qpopBack

public List<String> qpopBack(String key,
                             int size)

qpopAllFront

public void qpopAllFront(String key,
                         int batchSize,
                         Processor<String> valueProcessor)

qpopAllBack

public void qpopAllBack(String key,
                        int batchSize,
                        Processor<String> valueProcessor)

qfront

public String qfront(String key)

qback

public String qback(String key)

qsize

public int qsize(String key)

qclear

public void qclear(String key)

qget

public String qget(String key,
                   int index)

qgetBytes

public byte[] qgetBytes(String key,
                        int index)

qset

public void qset(String key,
                 int index,
                 String value)

qrange

public List<String> qrange(String key,
                           int offset,
                           int limit)

qslice

public List<String> qslice(String key,
                           int startInclude,
                           int endInclude)

qtrimFront

public int qtrimFront(String key,
                      int size)

qtrimBack

public int qtrimBack(String key,
                     int size)

qlist

public List<String> qlist(String startKeyExclude,
                          String endKeyInclude,
                          int limit)

列出指定区间的 queue/list 的 key 列表

参数:

startKeyExclude - 起始名字（不含，可选）

endKeyInclude - 结束名字（含，可选）

limit - 最多返回记录数

返回:

指定区间的 queue/list 的 key 列表

qrlist

public List<String> qrlist(String startKeyExclude,
                           String endKeyInclude,
                           int limit)