`

jedis复杂类型操作

 
阅读更多

import java.util.List;

import java.util.Map;

import java.util.Set;

 

/**

 * Common interface for sharded and non-sharded Jedis

 */

public interface JedisCommands {

 

    /**

     * 存储数据到缓存中,若key已存在则覆盖 value的长度不能超过1073741824 bytes (1 GB)

     *

     * @param key

     * @param value

     * @return

     */

    String set(String key, String value);

 

    /**

     * 存储数据到缓存中,并制定过期时间和当Key存在时是否覆盖。

     *

     * @param key

     * @param value

     * @param nxxx 

     *            nxxx的值只能取NX或者XX,如果取NX,则只有当key不存在是才进行set,如果取XX,则只有当key已经存在时才进行set

     * 

     * @param expx expx的值只能取EX或者PX,代表数据过期时间的单位,EX代表秒,PX代表毫秒。

     * @param time 过期时间,单位是expx所代表的单位。

     * @return

     */

    String set(String key, String value, String nxxx, String expx, long time);

 

    /**

     * 从缓存中根据key取得其String类型的值,如果key不存在则返回null,如果key存在但value不是string类型的,

     * 则返回一个error。这个方法只能从缓存中取得value为string类型的值。

     *

     * @param key

     * @return

     */

    String get(String key);

 

    /**

     * 检查某个key是否在缓存中存在,如果存在返回true,否则返回false;需要注意的是,即使该key所对应的value是一个空字符串,

     * 也依然会返回true。

     *

     * @param key

     * @return

     */

    Boolean exists(String key);

 

    /**

     * 

     * 如果一个key设置了过期时间,则取消其过期时间,使其永久存在。

     *

     * @param key

     * @return 返回1或者0,1代表取消过期时间成功,0代表不成功(只有当key不存在时这种情况才会发生)

     */

    Long persist(String key);

 

    /**

     * 返回某个key所存储的数据类型,返回的数据类型有可能是"none", "string", "list", "set", "zset",

     * "hash". "none"代表key不存在。

     *

     * @param key

     * @return

     */

    String type(String key);

 

    /**

     * 为key设置一个特定的过期时间,单位为秒。过期时间一到,redis将会从缓存中删除掉该key。

     * 即使是有过期时间的key,redis也会在持久化时将其写到硬盘中,并把相对过期时间改为绝对的Unix过期时间。

     * 在一个有设置过期时间的key上重复设置过期时间将会覆盖原先设置的过期时间。

     *

     * @param key

     * @param seconds

     * @return 返回1表示成功设置过期时间,返回0表示key不存在。

     */

    Long expire(String key, int seconds);

 

    /**

     * 机制同{@link expire}一样,只是时间单位改为毫秒。

     *

     * @param key

     * @param milliseconds

     * @return 返回值同 {@link expire}一样。

     */

    Long pexpire(String key, long milliseconds);

 

    /**

     * 与{@link expire}不一样,expireAt设置的时间不是能存活多久,而是固定的UNIX时间(从1970年开始算起),单位为秒。

     *

     * @param key

     * @param unixTime

     * @return

     */

    Long expireAt(String key, long unixTime);

 

    /**

     * 同{@link expireAt}机制相同,但单位为毫秒。

     *

     * @param key

     * @param millisecondsTimestamp

     * @return

     */

    Long pexpireAt(String key, long millisecondsTimestamp);

 

    /**

     * 返回一个key还能活多久,单位为秒

     *

     * @param key

     * @return 如果该key本来并没有设置过期时间,则返回-1,如果该key不存在,则返回-2

     */

    Long ttl(String key);

 

    /**

     * 设置或者清除指定key的value上的某个位置的比特位,如果该key原先不存在,则新创建一个key,其value将会自动分配内存,

     * 直到可以放下指定位置的bit值。

     * 

     * @param key

     * @param offset

     * @param value true代表1,false代表0

     * @return 返回原来位置的bit值是否是1,如果是1,则返回true,否则返回false。

     */

    Boolean setbit(String key, long offset, boolean value);

 

    /**

     * 设置或者清除指定key的value上的某个位置的比特位,如果该key原先不存在,则新创建一个key,其value将会自动分配内存,

     * 直到可以放下指定位置的bit值。

     *

     * @param key

     * @param offset

     * @param value 只能是"1"或者"0"

     * @return 返回原来位置的bit值是否是1,如果是1,则返回true,否则返回false。

     */

    Boolean setbit(String key, long offset, String value);

 

    /**

     * 取得偏移量为offset的bit值。

     *

     * @param key

     * @param offset

     * @return true代表1,false代表0

     */

    Boolean getbit(String key, long offset);

 

    /**

     * 这个命令的作用是覆盖key对应的string的一部分,从指定的offset处开始,覆盖value的长度。

     * 如果offset比当前key对应string还要长,

     * 那这个string后面就补0以达到offset。不存在的keys被认为是空字符串,所以这个命令可以确保key有一个足够大的字符串

     * 能在offset处设置value。

     *

     * @param key

     * @param offset

     * @param value

     * @return 该命令修改后的字符串长度

     */

    Long setrange(String key, long offset, String value);

 

    /**

     * 获得start - end之间的子字符串,若偏移量为负数,代表从末尾开始计算,例如-1代表倒数第一个,-2代表倒数第二个

     *

     * @param key

     * @param startOffset

     * @param endOffset

     * @return

     */

    String getrange(String key, long startOffset, long endOffset);

 

    /**

     * 自动将key对应到value并且返回原来key对应的value。如果key存在但是对应的value不是字符串,就返回错误。

     * 

     * @param key

     * @param value

     * @return

     */

    String getSet(String key, String value);

 

    /**

     * 参考 {@link set(String key, String value, String nxxx, String expx, long

     * time)}

     *

     * @param key

     * @param value

     * @return

     */

    Long setnx(String key, String value);

 

    /**

     * 参考 {@link set(String key, String value, String nxxx, String expx, long

     * time)}

     *

     * @param key

     * @param seconds

     * @param value

     * @return

     */

    String setex(String key, int seconds, String value);

 

    /**

     * 将指定key的值减少某个值

     *

     * @param key

     * @param integer

     * @return 返回减少后的新值

     */

    Long decrBy(String key, long integer);

 

    /**

     * 将指定Key的值减少1

     *

     * @param key

     * @return 返回减少后的新值

     */

    Long decr(String key);

 

    /**

     * 将指定的key的值增加指定的值

     *

     * @param key

     * @param integer

     * @return 返回增加后的新值

     */

    Long incrBy(String key, long integer);

 

    /**

     * 将指定的key的值增加指定的值(浮点数)

     *

     * @param key

     * @param value

     * @return 返回增加后的新值

     */

    Double incrByFloat(String key, double value);

 

    /**

     * 将指定的key的值增加1

     *

     * @param key

     * @return 返回增加后的新值

     */

    Long incr(String key);

 

    /**

     * 若key存在,将value追加到原有字符串的末尾。若key不存在,则创建一个新的空字符串。

     *

     * @param key

     * @param value

     * @return 返回字符串的总长度

     */

    Long append(String key, String value);

 

    /**

     * 返回start - end 之间的子字符串(start 和 end处的字符也包括在内)

     *

     * @param key

     * @param start

     * @param end

     * @return 返回子字符串

     */

    String substr(String key, int start, int end);

 

    /**

     * 设置hash表里field字段的值为value。如果key不存在,则创建一个新的hash表

     * 

     * @param key

     * @param field

     * @param value

     * @return 如果该字段已经存在,那么将会更新该字段的值,返回0.如果字段不存在,则新创建一个并且返回1.

     */

    Long hset(String key, String field, String value);

 

    /**

     * 如果该key对应的值是一个Hash表,则返回对应字段的值。 如果不存在该字段,或者key不存在,则返回一个"nil"值。

     *

     * @param key

     * @param field

     * @return

     */

    String hget(String key, String field);

 

    /**

     * 当字段不存在时,才进行set。

     *

     * @param key

     * @param field

     * @param value

     * @return 如果该字段已经存在,则返回0.若字段不存在,则创建后set,返回1.

     */

    Long hsetnx(String key, String field, String value);

 

    /**

     * 设置多个字段和值,如果字段存在,则覆盖。

     *

     * @param key

     * @param hash

     * @return 设置成功返回OK,设置不成功则返回EXCEPTION

     */

    String hmset(String key, Map<String, String> hash);

 

    /**

     * 在hash中获取多个字段的值,若字段不存在,则其值为nil。

     *

     * @param key

     * @param fields

     * @return 按顺序返回多个字段的值。

     */

    List<String> hmget(String key, String... fields);

 

    /**

     * 对hash中指定字段的值增加指定的值

     *

     * @param key

     * @param field

     * @param value

     * @return 返回增加后的新值

     */

    Long hincrBy(String key, String field, long value);

 

    /**

     * 判断hash中指定字段是否存在

     *

     * @param key

     * @param field

     * @return 若存在返回1,若不存在返回0

     */

    Boolean hexists(String key, String field);

 

    /**

     * 删除hash中指定字段

     *

     * @param key

     * @param field

     * @return 删除成功返回1, 删除不成功返回0

     */

    Long hdel(String key, String... field);

 

    /**

     * 返回 key 指定的哈希集包含的字段的数量

     *

     * @param key

     * @return 哈希集中字段的数量,当 key 指定的哈希集不存在时返回 0

     */

    Long hlen(String key);

 

    /**

     * 返回 key 指定的哈希集中所有字段的名字。

     *

     * @param key

     * @return 哈希集中的字段列表,当 key 指定的哈希集不存在时返回空列表。

     */

    Set<String> hkeys(String key);

 

    /**

     * 返回 key 指定的哈希集中所有字段的值。

     *

     * @param key

     * @return 哈希集中的值的列表,当 key 指定的哈希集不存在时返回空列表。

     */

    List<String> hvals(String key);

 

    /**

     * 返回 key 指定的哈希集中所有的字段和值

     *

     * @param key

     * @return 返回 key 指定的哈希集中所有的字段和值,若key不存在返回空map。

     */

    Map<String, String> hgetAll(String key);

 

    /**

     * 向存于 key 的列表的尾部插入所有指定的值。如果 key 不存在,那么会创建一个空的列表然后再进行 push 操作。 当 key

     * 保存的不是一个列表,那么会返回一个错误。

     * 

     * 可以使用一个命令把多个元素打入队列,只需要在命令后面指定多个参数。元素是从左到右一个接一个从列表尾部插入。 比如命令 RPUSH mylist a

     * b c 会返回一个列表,其第一个元素是 a ,第二个元素是 b ,第三个元素是 c。

     *

     * @param key

     * @param string

     * @return 在 push 操作后的列表长度。

     */

    Long rpush(String key, String... string);

 

    /**

     * 将所有指定的值插入到存于 key 的列表的头部。如果 key 不存在,那么在进行 push 操作前会创建一个空列表。 如果 key

     * 对应的值不是一个 list 的话,那么会返回一个错误。

     * 

     * 可以使用一个命令把多个元素 push 进入列表,只需在命令末尾加上多个指定的参数。元素是从最左端的到最右端的、一个接一个被插入到 list

     * 的头部。 所以对于这个命令例子 LPUSH mylist a b c,返回的列表是 c 为第一个元素, b 为第二个元素, a 为第三个元素。

     *

     * @param key

     * @param string

     * @return 在 push 操作后的列表长度。

     */

    Long lpush(String key, String... string);

 

    /**

     * 返回存储在 key 里的list的长度。 如果 key 不存在,那么就被看作是空list,并且返回长度为 0。 当存储在 key

     * 里的值不是一个list的话,会返回error。

     *

     * @param key

     * @return key对应的list的长度。

     */

    Long llen(String key);

 

    /**

     * 返回存储在 key 的列表里指定范围内的元素。 start 和 end

     * 偏移量都是基于0的下标,即list的第一个元素下标是0(list的表头),第二个元素下标是1,以此类推。

     * 

     * 偏移量也可以是负数,表示偏移量是从list尾部开始计数。 例如, -1 表示列表的最后一个元素,-2 是倒数第二个,以此类推。

     *

     * @param key

     * @param start

     * @param end

     * @return 指定范围里的列表元素。

     */

    List<String> lrange(String key, long start, long end);

 

    /**

     * 修剪(trim)一个已存在的 list,这样 list 就会只包含指定范围的指定元素。start 和 stop 都是由0开始计数的, 这里的 0

     * 是列表里的第一个元素(表头),1 是第二个元素,以此类推。

     *

     * @param key

     * @param start

     * @param end

     * @return

     */

    String ltrim(String key, long start, long end);

 

    /**

     * 返回列表里的元素的索引 index 存储在 key 里面。 下标是从0开始索引的,所以 0 是表示第一个元素, 1 表示第二个元素,并以此类推。

     * 负数索引用于指定从列表尾部开始索引的元素。在这种方法下,-1 表示最后一个元素,-2 表示倒数第二个元素,并以此往前推。

     * 

     * 当 key 位置的值不是一个列表的时候,会返回一个error。

     *

     * @param key

     * @param index

     * @return 请求的对应元素,或者当 index 超过范围的时候返回 nil。

     */

    String lindex(String key, long index);

 

    /**

     * 设置 index 位置的list元素的值为 value。

     * 

     * 当index超出范围时会返回一个error。

     *

     * @param key

     * @param index

     * @param value

     * @return 状态恢复

     */

    String lset(String key, long index, String value);

 

    /**

     * 从存于 key 的列表里移除前 count 次出现的值为 value 的元素。 这个 count 参数通过下面几种方式影响这个操作:

     * 

     * count > 0: 从头往尾移除值为 value 的元素。 count < 0: 从尾往头移除值为 value 的元素。 count = 0:

     * 移除所有值为 value 的元素。

     * 

     * 比如, LREM list -2 "hello" 会从存于 list 的列表里移除最后两个出现的 "hello"。

     * 

     * 需要注意的是,如果list里没有存在key就会被当作空list处理,所以当 key 不存在的时候,这个命令会返回 0。

     *

     * @param key

     * @param count

     * @param value

     * @return 返回删除的个数

     */

    Long lrem(String key, long count, String value);

 

    /**

     * 移除并且返回 key 对应的 list 的第一个元素。

     *

     * @param key

     * @return 返回第一个元素的值,或者当 key 不存在时返回 nil。

     */

    String lpop(String key);

 

    /**

     * 移除并返回存于 key 的 list 的最后一个元素。

     *

     * @param key

     * @return 最后一个元素的值,或者当 key 不存在的时候返回 nil。

     */

    String rpop(String key);

 

    /**

     * 添加一个或多个指定的member元素到集合的 key中.指定的一个或者多个元素member 如果已经在集合key中存在则忽略.如果集合key

     * 不存在,则新建集合key,并添加member元素到集合key中.

     * 

     * 如果key 的类型不是集合则返回错误.

     *

     * @param key

     * @param member

     * @return 返回新成功添加到集合里元素的数量,不包括已经存在于集合中的元素.

     */

    Long sadd(String key, String... member);

 

    /**

     * 返回key集合所有的元素.

     * 

     * 该命令的作用与使用一个参数的SINTER 命令作用相同.

     *

     * @param key

     * @return 集合中的所有元素.

     */

    Set<String> smembers(String key);

 

    /**

     * 在key集合中移除指定的元素. 如果指定的元素不是key集合中的元素则忽略 如果key集合不存在则被视为一个空的集合,该命令返回0.

     * 

     * 如果key的类型不是一个集合,则返回错误.

     *

     * @param key

     * @param member

     * @return 从集合中移除元素的个数,不包括不存在的成员.

     */

    Long srem(String key, String... member);

 

    /**

     * 移除并返回一个集合中的随机元素

     * 

     * 该命令与 SRANDMEMBER相似,不同的是srandmember命令返回一个随机元素但是不移除.

     *

     * @param key

     * @return 被移除的元素, 当key不存在的时候返回 nil .

     */

    String spop(String key);

 

    /**

     * 移除并返回多个集合中的随机元素

     * 

     * @param key

     * @param count

     * @return 被移除的元素, 当key不存在的时候值为 nil .

     */

    Set<String> spop(String key, long count);

 

    /**

     * 返回集合存储的key的基数 (集合元素的数量).

     *

     * @param key

     * @return 集合的基数(元素的数量),如果key不存在,则返回 0.

     */

    Long scard(String key);

 

    /**

     * 返回成员 member 是否是存储的集合 key的成员.

     *

     * @param key

     * @param member

     * @return 如果member元素是集合key的成员,则返回1.如果member元素不是key的成员,或者集合key不存在,则返回0

     */

    Boolean sismember(String key, String member);

 

    /**

     * 仅提供key参数,那么随机返回key集合中的一个元素.该命令作用类似于SPOP命令, 不同的是SPOP命令会将被选择的随机元素从集合中移除,

     * 而SRANDMEMBER仅仅是返回该随记元素,而不做任何操作.

     *

     * @param key

     * @return 返回随机的元素,如果key不存在则返回nil

     */

    String srandmember(String key);

 

    /**

     * 如果count是整数且小于元素的个数,返回含有 count

     * 个不同的元素的数组,如果count是个整数且大于集合中元素的个数时,仅返回整个集合的所有元素

     * ,当count是负数,则会返回一个包含count的绝对值的个数元素的数组

     * ,如果count的绝对值大于元素的个数,则返回的结果集里会出现一个元素出现多次的情况.

     *

     * @param key

     * @param count

     * @return 返回一个随机的元素数组,如果key不存在则返回一个空的数组.

     */

    List<String> srandmember(String key, int count);

 

    /**

     * 返回key的string类型value的长度。如果key对应的非string类型,就返回错误。

     *

     * @param key

     * @return key对应的字符串value的长度,或者0(key不存在)

     */

    Long strlen(String key);

 

    /**

     * 该命令添加指定的成员到key对应的有序集合中,每个成员都有一个分数。你可以指定多个分数/成员组合。如果一个指定的成员已经在对应的有序集合中了,

     * 那么其分数就会被更新成最新的

     * ,并且该成员会重新调整到正确的位置,以确保集合有序。如果key不存在,就会创建一个含有这些成员的有序集合,就好像往一个空的集合中添加一样

     * 。如果key存在,但是它并不是一个有序集合,那么就返回一个错误。

     * 

     * 分数的值必须是一个表示数字的字符串,并且可以是double类型的浮点数。

     *

     * @param key

     * @param score

     * @param member

     * @return 返回添加到有序集合中元素的个数,不包括那种已经存在只是更新分数的元素。

     */

    Long zadd(String key, double score, String member);

 

    /**

     * 该命令添加指定的成员到key对应的有序集合中,每个成员都有一个分数。你可以指定多个分数/成员组合。如果一个指定的成员已经在对应的有序集合中了,

     * 那么其分数就会被更新成最新的

     * ,并且该成员会重新调整到正确的位置,以确保集合有序。如果key不存在,就会创建一个含有这些成员的有序集合,就好像往一个空的集合中添加一样

     * 。如果key存在,但是它并不是一个有序集合,那么就返回一个错误。

     * 

     * 分数的值必须是一个表示数字的字符串,并且可以是double类型的浮点数。

     *

     * @param key

     * @param scoreMembers

     * @return 返回添加到有序集合中元素的个数,不包括那种已经存在只是更新分数的元素。

     */

    Long zadd(String key, Map<String, Double> scoreMembers);

 

    /**

     * 返回有序集key中,指定区间内的成员。其中成员按score值递增(从小到大)来排序。具有相同score值的成员按字典序来排列。

     * 

     * 如果你需要成员按score值递减(score相等时按字典序递减)来排列,请使用ZREVRANGE命令。

     * 下标参数start和stop都以0为底,也就是说,以0表示有序集第一个成员,以1表示有序集第二个成员,以此类推。

     * 你也可以使用负数下标,以-1表示最后一个成员,-2表示倒数第二个成员,以此类推。

     * 

     * 超出范围的下标并不会引起错误。如果start的值比有序集的最大下标还要大,或是start >

     * stop时,ZRANGE命令只是简单地返回一个空列表。

     * 另一方面,假如stop参数的值比有序集的最大下标还要大,那么Redis将stop当作最大下标来处理。

     *

     * @param key

     * @param start

     * @param end

     * @return 指定范围的元素列表

     */

    Set<String> zrange(String key, long start, long end);

 

    /**

     * 从集合中删除指定member元素,当key存在,但是其不是有序集合类型,就返回一个错误。

     *

     * @param key

     * @param member

     * @return 返回的是从有序集合中删除的成员个数,不包括不存在的成员。

     */

    Long zrem(String key, String... member);

 

    /**

     * 为有序集key的成员member的score值加上增量increment。如果key中不存在member,就在key中添加一个member,

     * score是increment(就好像它之前的score是0.0)。如果key不存在,就创建一个只含有指定member成员的有序集合。

     * 

     * 当key不是有序集类型时,返回一个错误。

     * 

     * score值必须整数值或双精度浮点数。也有可能给一个负数来减少score的值。

     *

     * @param key

     * @param score

     * @param member

     * @return member成员的新score值.

     */

    Double zincrby(String key, double score, String member);

 

    /**

     * 返回有序集key中成员member的排名。其中有序集成员按score值递增(从小到大)顺序排列。排名以0为底,也就是说,

     * score值最小的成员排名为0。

     * 

     * 使用ZREVRANK命令可以获得成员按score值递减(从大到小)排列的排名。

     *

     * @param key

     * @param member

     * @return 如果member是有序集key的成员,返回member的排名的整数。 如果member不是有序集key的成员,返回 nil。

     */

    Long zrank(String key, String member);

 

    /**

     * 返回有序集key中成员member的排名,其中有序集成员按score值从大到小排列。排名以0为底,也就是说,score值最大的成员排名为0。

     * 

     * 使用ZRANK命令可以获得成员按score值递增(从小到大)排列的排名。

     *

     * @param key

     * @param member

     * @return 如果member是有序集key的成员,返回member的排名。整型数字。 如果member不是有序集key的成员,返回Bulk

     *         reply: nil.

     */

    Long zrevrank(String key, String member);

 

    /**

     * 返回有序集key中,指定区间内的成员。其中成员的位置按score值递减(从大到小)来排列。具有相同score值的成员按字典序的反序排列。

     * 除了成员按score值递减的次序排列这一点外,ZREVRANGE命令的其他方面和ZRANGE命令一样。

     *

     * @param key

     * @param start

     * @param end

     * @return 指定范围的元素列表(可选是否含有分数)。

     */

    Set<String> zrevrange(String key, long start, long end);

 

    /**

     * 返回有序集key中,指定区间内的成员。其中成员按score值递增(从小到大)来排序。具有相同score值的成员按字典序来排列。

     * 

     * 如果你需要成员按score值递减(score相等时按字典序递减)来排列,请使用ZREVRANGE命令。

     * 下标参数start和stop都以0为底,也就是说,以0表示有序集第一个成员,以1表示有序集第二个成员,以此类推。

     * 你也可以使用负数下标,以-1表示最后一个成员,-2表示倒数第二个成员,以此类推。

     * 

     * 超出范围的下标并不会引起错误。如果start的值比有序集的最大下标还要大,或是start >

     * stop时,ZRANGE命令只是简单地返回一个空列表。

     * 另一方面,假如stop参数的值比有序集的最大下标还要大,那么Redis将stop当作最大下标来处理。

     * 

     * 使用WITHSCORES选项,来让成员和它的score值一并返回,返回列表以value1,score1, ...,

     * valueN,scoreN的格式表示,而不是value1,...,valueN。客户端库可能会返回一些更复杂的数据类型,比如数组、元组等。

     *

     * @param key

     * @param start

     * @param end

     * @return 指定范围的元素列表(以元组集合的形式)。

     */

    Set<Tuple> zrangeWithScores(String key, long start, long end);

 

    /**

     * 返回有序集key中,指定区间内的成员。其中成员的位置按score值递减(从大到小)来排列。具有相同score值的成员按字典序的反序排列。

     * 除了成员按score值递减的次序排列这一点外,ZREVRANGE命令的其他方面和ZRANGE命令一样。

     *

     * @param key

     * @param start

     * @param end

     * @return 指定范围的元素列表(可选是否含有分数)。

     */

    Set<Tuple> zrevrangeWithScores(String key, long start, long end);

 

    /**

     * 返回key的有序集元素个数。

     *

     * @param key

     * @return key存在的时候,返回有序集的元素个数,否则返回0。

     */

    Long zcard(String key);

 

    /**

     * 返回有序集key中,成员member的score值。

     * 

     * 如果member元素不是有序集key的成员,或key不存在,返回nil。

     *

     * @param key

     * @param member

     * @return member成员的score值(double型浮点数)

     */

    Double zscore(String key, String member);

 

    /**

     * 对一个集合或者一个列表排序

     * 

     * 对集合,有序集合,或者列表的value进行排序。默认情况下排序只对数字排序,双精度浮点数。

     * 

     * @see #sort(String, String)

     * @see #sort(String, SortingParams)

     * @see #sort(String, SortingParams, String)

     * @param key

     * @return 假设集合或列表包含的是数字元素,那么返回的将会是从小到大排列的一个列表。

     */

    List<String> sort(String key);

 

    /**

     * 根据指定参数来对列表或集合进行排序.

     * <p>

     * <b>examples:</b>

     * <p>

     * 一下是一些例子列表或者key-value:

     * 

     * <pre>

     * x = [1, 2, 3]

     * y = [a, b, c]

     * 

     * k1 = z

     * k2 = y

     * k3 = x

     * 

     * w1 = 9

     * w2 = 8

     * w3 = 7

     * </pre>

     * 

     * 排序:

     * 

     * <pre>

     * sort(x) or sort(x, sp.asc())

     * -> [1, 2, 3]

     * 

     * sort(x, sp.desc())

     * -> [3, 2, 1]

     * 

     * sort(y)

     * -> [c, a, b]

     * 

     * sort(y, sp.alpha())

     * -> [a, b, c]

     * 

     * sort(y, sp.alpha().desc())

     * -> [c, b, a]

     * </pre>

     * 

     * Limit (e.g. for Pagination):

     * 

     * <pre>

     * sort(x, sp.limit(0, 2))

     * -> [1, 2]

     * 

     * sort(y, sp.alpha().desc().limit(1, 2))

     * -> [b, a]

     * </pre>

     * 

     * 使用外部键来排序:

     * 

     * <pre>

     * sort(x, sb.by(w*))

     * -> [3, 2, 1]

     * 

     * sort(x, sb.by(w*).desc())

     * -> [1, 2, 3]

     * </pre>

     * 

     * Getting external keys:

     * 

     * <pre>

     * sort(x, sp.by(w*).get(k*))

     * -> [x, y, z]

     * 

     * sort(x, sp.by(w*).get(#).get(k*))

     * -> [3, x, 2, y, 1, z]

     * </pre>

     * 

     * @see #sort(String)

     * @see #sort(String, SortingParams, String)

     * @param key

     * @param sortingParameters

     * @return a list of sorted elements.

     */

    List<String> sort(String key, SortingParams sortingParameters);

 

    /**

     * 返回有序集key中,score值在min和max之间(默认包括score值等于min或max)的成员。

     *

     * @param key

     * @param min

     * @param max

     * @return 指定分数范围的元素个数。

     */

    Long zcount(String key, double min, double max);

 

    /**

     * 返回有序集key中,score值在min和max之间(默认包括score值等于min或max)的成员。

     *

     * @param key

     * @param min

     * @param max

     * @return 指定分数范围的元素个数。

     */

    Long zcount(String key, String min, String max);

 

    /**

     * 返回key的有序集合中的分数在min和max之间的所有元素(包括分数等于max或者min的元素)。元素被认为是从低分到高分排序的。

     * 具有相同分数的元素按字典序排列

     *

     * @param key

     * @param min

     * @param max

     * @return 指定分数范围的元素列表

     */

    Set<String> zrangeByScore(String key, double min, double max);

 

    /**

     * 返回key的有序集合中的分数在min和max之间的所有元素(包括分数等于max或者min的元素)。元素被认为是从低分到高分排序的。

     * 具有相同分数的元素按字典序排列

     *

     * @param key

     * @param min

     * @param max

     * @return 指定分数范围的元素列表

     */

    Set<String> zrangeByScore(String key, String min, String max);

 

    /**

     * 返回key的有序集合中的分数在min和max之间的所有元素(包括分数等于max或者min的元素)。元素被认为是从低分到高分排序的。

     * 具有相同分数的元素按字典序排列, 指定返回结果的数量及区间。

     *

     * @param key

     * @param min

     * @param max

     * @param offset

     * @param count

     * @return 指定分数范围的元素列表

     */

    Set<String> zrangeByScore(String key, double min, double max, int offset, int count);

 

    /**

     * 返回key的有序集合中的分数在min和max之间的所有元素(包括分数等于max或者min的元素)。元素被认为是从低分到高分排序的。

     * 具有相同分数的元素按字典序排列, 指定返回结果的数量及区间。

     *

     * @param key

     * @param min

     * @param max

     * @param offset

     * @param count

     * @return 指定分数范围的元素列表

     */

    Set<String> zrangeByScore(String key, String min, String max, int offset, int count);

 

    /**

     * 返回key的有序集合中的分数在min和max之间的所有元素(包括分数等于max或者min的元素)。元素被认为是从低分到高分排序的。

     * 具有相同分数的元素按字典序排列。返回元素和其分数,而不只是元素。

     *

     * @param key

     * @param min

     * @param max

     * @return

     */

    Set<Tuple> zrangeByScoreWithScores(String key, double min, double max);

 

    /**

     * 返回key的有序集合中的分数在min和max之间的所有元素(包括分数等于max或者min的元素)。元素被认为是从低分到高分排序的。

     * 具有相同分数的元素按字典序排列, 指定返回结果的数量及区间。 返回元素和其分数,而不只是元素。

     *

     * @param key

     * @param min

     * @param max

     * @param offset

     * @param count

     * @return

     */

    Set<Tuple> zrangeByScoreWithScores(String key, double min, double max, int offset,

            int count);

 

    /**

     * 返回key的有序集合中的分数在min和max之间的所有元素(包括分数等于max或者min的元素)。元素被认为是从低分到高分排序的。

     * 具有相同分数的元素按字典序排列。返回元素和其分数,而不只是元素。

     *

     * @param key

     * @param min

     * @param max

     * @return

     */

    Set<Tuple> zrangeByScoreWithScores(String key, String min, String max);

 

    /**

     * 返回key的有序集合中的分数在min和max之间的所有元素(包括分数等于max或者min的元素)。元素被认为是从低分到高分排序的。

     * 具有相同分数的元素按字典序排列, 指定返回结果的数量及区间。 返回元素和其分数,而不只是元素。

     *

     * @param key

     * @param min

     * @param max

     * @param offset

     * @param count

     * @return

     */

    Set<Tuple> zrangeByScoreWithScores(String key, String min, String max, int offset,

            int count);

 

    /**

     * 机制与zrangeByScore一样,只是返回结果为降序排序。

     *

     * @param key

     * @param max

     * @param min

     * @return

     */

    Set<String> zrevrangeByScore(String key, double max, double min);

 

    /**

     * 机制与zrangeByScore一样,只是返回结果为降序排序。

     *

     * @param key

     * @param max

     * @param min

     * @return

     */

    Set<String> zrevrangeByScore(String key, String max, String min);

 

    /**

     * 机制与zrangeByScore一样,只是返回结果为降序排序。

     *

     * @param key

     * @param max

     * @param min

     * @param offset

     * @param count

     * @return

     */

    Set<String> zrevrangeByScore(String key, double max, double min, int offset, int count);

 

    /**

     * 机制与zrangeByScoreWithScores一样,只是返回结果为降序排序。

     *

     * @param key

     * @param max

     * @param min

     * @return

     */

    Set<Tuple> zrevrangeByScoreWithScores(String key, double max, double min);

 

    /**

     * 机制与zrangeByScore一样,只是返回结果为降序排序。

     *

     * @param key

     * @param max

     * @param min

     * @param offset

     * @param count

     * @return

     */

    Set<String> zrevrangeByScore(String key, String max, String min, int offset, int count);

 

    /**

     * 机制与zrangeByScoreWithScores一样,只是返回结果为降序排序。

     *

     * @param key

     * @param max

     * @param min

     * @return

     */

    Set<Tuple> zrevrangeByScoreWithScores(String key, String max, String min);

 

    /**

     * 机制与zrangeByScoreWithScores一样,只是返回结果为降序排序。

     *

     * @param key

     * @param max

     * @param min

     * @param offset

     * @param count

     * @return

     */

    Set<Tuple> zrevrangeByScoreWithScores(String key, double max, double min, int offset,

            int count);

 

    /**

     * 机制与zrangeByScoreWithScores一样,只是返回结果为降序排序。

     *

     * @param key

     * @param max

     * @param min

     * @param offset

     * @param count

     * @return

     */

    Set<Tuple> zrevrangeByScoreWithScores(String key, String max, String min, int offset,

            int count);

 

    /**

     * 移除有序集key中,指定排名(rank)区间内的所有成员。下标参数start和stop都以0为底,0处是分数最小的那个元素。这些索引也可是负数,

     * 表示位移从最高分处开始数。例如,-1是分数最高的元素,-2是分数第二高的,依次类推。

     *

     * @param key

     * @param start

     * @param end

     * @return 被移除成员的数量。

     */

    Long zremrangeByRank(String key, long start, long end);

 

    /**

     * 移除有序集key中,所有score值介于min和max之间(包括等于min或max)的成员。

     * 

     * 自版本2.1.6开始,score值等于min或max的成员也可以不包括在内,语法请参见ZRANGEBYSCORE命令。

     *

     * @param key

     * @param start

     * @param end

     * @return 删除的元素的个数

     */

    Long zremrangeByScore(String key, double start, double end);

 

    /**

     * 移除有序集key中,所有score值介于min和max之间(包括等于min或max)的成员。

     * 

     * 自版本2.1.6开始,score值等于min或max的成员也可以不包括在内,语法请参见ZRANGEBYSCORE命令。

     *

     * @param key

     * @param start

     * @param end

     * @return 删除的元素的个数

     */

    Long zremrangeByScore(String key, String start, String end);

 

    /**

     * 当插入到有序集合中的元素都具有相同的分数时,这个命令可以返回min和max指定范围内的元素的数量。

     *

     * @param key

     * @param min

     * @param max

     * @return

     */

    Long zlexcount(final String key, final String min, final String max);

 

    /**

     * 把 value 插入存于 key 的列表中在基准值 pivot 的前面或后面。

     * 

     * 当 key 不存在时,这个list会被看作是空list,任何操作都不会发生。

     * 

     * 当 key 存在,但保存的不是一个list的时候,会返回error。

     *

     * @param key

     * @param where

     * @param pivot 前或后

     * @param value

     * @return 在 insert 操作后的 list 长度。

     */

    Long linsert(String key, Client.LIST_POSITION where, String pivot, String value);

 

    /**

     * 只有当 key 已经存在并且存着一个 list 的时候,在这个 key 下面的 list 的头部插入 value。 与 LPUSH 相反,当

     * key 不存在的时候不会进行任何操作。

     *

     * @param key

     * @param string

     * @return 在 push 操作后的 list 长度。

     */

    Long lpushx(String key, String... string);

 

    /**

     * 将值 value 插入到列表 key 的表尾, 当且仅当 key 存在并且是一个列表。 和 RPUSH 命令相反, 当 key

     * 不存在时,RPUSHX 命令什么也不做。

     *

     * @param key

     * @param string

     * @return 在Push操作后List的长度

     */

    Long rpushx(String key, String... string);

 

    /**

     * @deprecated unusable command, this will be removed in 3.0.0.

     */

    @Deprecated

    List<String> blpop(String arg);

 

    /**

     * BLPOP 是阻塞式列表的弹出原语。 它是命令 LPOP 的阻塞版本,这是因为当给定列表内没有任何元素可供弹出的时候, 连接将被 BLPOP

     * 命令阻塞。 当给定多个 key 参数时,按参数 key 的先后顺序依次检查各个列表,弹出第一个非空列表的头元素。 {@link http

     * ://www.redis.cn/commands/blpop.html}

     * 

     * @param timeout

     * @param key

     * @return

     */

    List<String> blpop(int timeout, String key);

 

    /**

     * @deprecated unusable command, this will be removed in 3.0.0.

     */

    @Deprecated

    List<String> brpop(String arg);

 

    /**

     * BRPOP 是一个阻塞的列表弹出原语。 它是 RPOP 的阻塞版本,因为这个命令会在给定list无法弹出任何元素的时候阻塞连接。

     * 该命令会按照给出的 key 顺序查看 list,并在找到的第一个非空 list 的尾部弹出一个元素。

     * 

     * 请在 BLPOP 文档 中查看该命令的准确语义,因为 BRPOP 和 BLPOP

     * 基本是完全一样的,除了它们一个是从尾部弹出元素,而另一个是从头部弹出元素。 {@link http

     * ://www.redis.cn/commands/brpop.html}

     * 

     * 

     * @param timeout

     * @param key

     * @return

     */

    List<String> brpop(int timeout, String key);

 

    /**

     * 删除一个Key,如果删除的key不存在,则直接忽略。

     *

     * @param key

     * @return 被删除的keys的数量

     */

    Long del(String key);

 

    /**

     * 回显

     *

     * @param string

     * @return 回显输入的字符串

     */

    String echo(String string);

 

    /**

     * 将当前数据库的 key 移动到给定的数据库 db 当中。

     * 

     * 如果当前数据库(源数据库)和给定数据库(目标数据库)有相同名字的给定 key ,或者 key 不存在于当前数据库,那么 MOVE 没有任何效果。

     * 

     * 因此,也可以利用这一特性,将 MOVE 当作锁(locking)原语(primitive)。

     *

     * @param key

     * @param dbIndex

     * @return 移动成功返回 1 失败则返回 0

     */

    Long move(String key, int dbIndex);

 

    /**

     * 统计字符串的字节数

     *

     * @param key

     * @return 字节数

     */

    Long bitcount(final String key);

 

    /**

     * 统计字符串指定起始位置的字节数

     *

     * @param key

     * @param start

     * @param end

     * @return

     */

    Long bitcount(final String key, long start, long end);

 

    /**

     * 迭代hash里面的元素

     *

     * @param key

     * @param cursor

     * @return

     */

    ScanResult<Map.Entry<String, String>> hscan(final String key, final String cursor);

 

    /**

     * 迭代set里面的元素

     *

     * @param key

     * @param cursor

     * @return

     */

    ScanResult<String> sscan(final String key, final String cursor);

 

    /**

     * 迭代zset里面的元素

     *

     * @param key

     * @param cursor

     * @return

     */

    ScanResult<Tuple> zscan(final String key, final String cursor);

 

}

 

分享到:
评论

相关推荐

    Jedis操作5种数据类型

    除了基本操作外,Jedis还支持更复杂的操作,如事务(transactions)、管道(pipelining)和脚本(lua scripting)。例如,你可以使用multi()开始一个事务,然后执行一系列命令,最后用exec()提交事务。 在实际应用...

    jedis相关jar包

    使用这个版本的Jedis,开发者可以进行基本的数据操作,如设置和获取键值、操作集合类型(如列表、集合、有序集合)、事务处理、发布订阅等。 关于标签“Redis Jedis”,我们可以理解为这个压缩包是针对使用Java开发...

    jedis.rar(java操作redis依赖)2.9.0

    2. **字符串(Strings)操作**:字符串是Redis最基础的数据类型,Jedis支持`set`, `get`, `incr`, `decr`等命令,可以方便地设置和获取字符串,以及进行增量或减量操作。 3. **哈希(Hashes)操作**:哈希允许将多...

    jedis操作Redis

    4. 数据类型操作: - 字符串(Strings):支持简单的字符串操作,如增长、减少数字值。 - 哈希表(Hashes):存储键值对,适合存储对象。 - 列表(Lists):双向链表,支持两端插入和删除元素。 - 集合(Sets)...

    jedis-2.9.0.jar

    这对于需要原子性操作多个键的复杂逻辑非常有用。 6. **其他特性**:还包括pipeline(批量处理命令,减少网络延迟)、sentinel支持(监控和故障转移)、集群支持(JedisCluster)等。 **导入和使用Jedis-2.9.0.jar...

    英文 Jedis API 2.9.0

    基本数据类型操作 - **字符串(Strings)**:Jedis支持对Redis中的字符串进行CRUD操作,如`set`、`get`、`append`、`strlen`、`incr`、`decr`等。例如,`jedis.set("key", "value")`用于设置键值对,`jedis.get("key...

    java连接redis/jedis连接池/jedis相关工具/jedis对象存取

    对于大型项目,还可以考虑使用更高级的客户端,如Lettuce,它支持异步操作和更复杂的连接管理策略。 总结,Java通过Jedis连接Redis提供了高效的数据交互手段,Jedis连接池能优化资源利用,而对字符串和哈希的操作...

    jedis-2.9.0 最新版Redis客户端CSDN下载

    Jedis是Java语言中使用最广泛的Redis客户端库,它提供了丰富的API来操作Redis服务器。在这个"jedis-2.9.0"的最新版本中,我们包含了三个重要的文件: 1. `jedis-2.9.0.jar`:这是Jedis的二进制发行版,包含了所有...

    jedis(java连接redis)

    Jedis作为官方推荐的Java客户端,提供了丰富的API来支持各种Redis命令,包括字符串、哈希、列表、集合、有序集合等数据类型的操作。 ### Jedis的基本用法 1. **安装与依赖** 要在Java项目中使用Jedis,首先需要将...

    redis相关jar包(redis2.1.5、jedis2.9.0)

    这些数据结构使得Redis在处理复杂的数据操作时表现优秀,例如计数、发布订阅、事务处理等。同时,Redis支持主从复制、持久化机制(RDB和AOF),确保了数据的安全性。 Jedis是Java社区广泛使用的Redis客户端库,版本...

    jedis-2.9.0.jar及连接池分享

    Jedis支持多种数据类型操作,如字符串(String)、哈希(Hash)、列表(List)、集合(Set)和有序集合(Sorted Set)。此外,还支持发布/订阅、事务、脚本(Scripting)以及地理空间操作。 2. 连接池概念: 连接...

    jedis-2.9.0的驱动文件.rar

    5. 丰富的数据类型操作:Jedis支持Redis的所有基本数据类型,如字符串、列表、集合、哈希表以及有序集合,同时也支持更复杂的数据结构,如HyperLogLog、Geo、Stream等。 6. 支持Redis Sentinel和Cluster:Jedis不仅...

    jedis2.7版本

    Jedis 封装了 Redis 的大部分命令,包括字符串、哈希、列表、集合、有序集合等数据类型的常用操作。例如: - 字符串操作:`set(key, value)` 设置键值对,`get(key)` 获取键对应的值。 - 哈希操作:`hset(hashKey, ...

    jedis-2.0.o

    7. **Lua 脚本支持**:Jedis 允许通过 Lua 脚本来执行原子操作,这在处理复杂逻辑时非常有用。 **集成 Jedis** 要在 Java 项目中使用 Jedis,首先需要在项目中添加 Jedis 2.0.0 的依赖,通常是通过 Maven 或 ...

    jedis-3.0.0.jar(全)

    首先,`jedis-3.0.0.jar`是Jedis的核心库,它提供了与Redis服务器交互的各种操作,包括但不限于字符串、哈希表、列表、集合、有序集合、发布订阅、事务、地理位置等数据类型的操作,以及lua脚本执行等功能。Jedis的...

    jedis-2.4.2版本.rar

    1. **基本操作**:Jedis提供了诸如字符串(Strings)、哈希(Hashes)、列表(Lists)、集合(Sets)和有序集合(Sorted Sets)等Redis数据类型的基本操作。例如,你可以使用`set`方法设置键值对,`get`方法获取键...

    jedis-jar.rar

    Redis支持多种数据结构,如字符串、哈希、列表、集合、有序集合等,这些数据结构的设计使得Redis能高效地处理大量数据,并且提供了丰富的操作命令,便于进行复杂的数据操作。 **Jedis的安装与配置** 1. **添加依赖...

    jedis相关jar包和配置文件.zip

    5. **序列化支持**:Jedis允许用户自定义序列化和反序列化策略,以便在与Redis交互时处理复杂的数据类型。 6. **过期策略**:支持设置键的过期时间,便于实现临时缓存或者清理旧数据。 7. **兼容性**:Jedis与...

    jedis jar包

    2. **字符串操作**:提供对字符串类型的复杂操作,如增加数字(incr, decr),获取字符串长度(strlen)等。 3. **哈希表操作**:可以将一组字段值对存储在一个键中,方便管理对象。 4. **列表操作**:允许在列表两...

Global site tag (gtag.js) - Google Analytics