Object 內建對象

物件RedisSortedSet

Redis資料庫客戶端SortedSet 對象,此物件為包含指定key 的客戶端,只有呼叫其方法才會操作資料庫

用以操作Redis的SortedSet 對象,建立方法:

1 2 3
var db = require("db"); var rdb = new db.openRedis("redis-server"); var set = rdb.getSortedSet("test");

繼承關係

成員函數

add

將一個或多個member 元素及其score 值加入到有序集當中

1
Integer RedisSortedSet.add(Object sms);

呼叫參數:

  • sms: Object, 指定要新增的member/score 對象

回傳結果:

  • Integer, 被成功加入的新成員的數量,不包括那些被更新的、已經存在的成員

將一個或多個member 元素及其score 值加入到有序集當中

1
Integer RedisSortedSet.add(...sms);

呼叫參數:

  • sms: ..., 指定要新增的member/score 列表

回傳結果:

  • Integer, 被成功加入的新成員的數量,不包括那些被更新的、已經存在的成員

score

傳回有序集中,成員member 的score 值

1
Buffer RedisSortedSet.score(Buffer member);

呼叫參數:

  • member:Buffer, 指定要查詢的member

回傳結果:

  • Buffer, member 成員的score 值,以字串形式表示

incr

為有序集的成員member 的score 值加上增量num

1 2
Buffer RedisSortedSet.incr(Buffer member, Long num = 1);

呼叫參數:

  • member:Buffer, 指定要修改的member
  • num: Long, 指定要加上的數值

回傳結果:

  • Buffer, member 成員的新score 值,以字串形式表示

remove

移除有序集中的一個或多個member 元素

1
Integer RedisSortedSet.remove(Array members);

呼叫參數:

  • members: Array, 指定要移除的元素數組

回傳結果:

  • Integer, 被成功移除的元素的數量,不包括被忽略的元素

移除有序集中的一個或多個member 元素

1
Integer RedisSortedSet.remove(...members);

呼叫參數:

  • members: ..., 指定要移除的元素列表

回傳結果:

  • Integer, 被成功移除的元素的數量,不包括被忽略的元素

len

傳回有序集中元素的數量

1
Integer RedisSortedSet.len();

回傳結果:

  • Integer, 傳回有序集的長度

count

傳回有序集中, score 值在min 和max 之間(預設包括score 值等於min 或max )的成員的數量

1 2
Integer RedisSortedSet.count(Integer min, Integer max);

呼叫參數:

  • min: Integer, 指定統計的最小score
  • max: Integer, 指定統計的最大score

回傳結果:

  • Integer, score 值在min 和max 之間的成員的數量

range

傳回有序集中,指定區間內的成員,成員的位置依score 值遞增(從小到大)來排序

1 2 3
NArray RedisSortedSet.range(Integer start, Integer stop, Boolean withScores = false);

呼叫參數:

  • start: Integer, 指定查詢的起始下標,0 表示第一個元素,-1 表示最後一個元素
  • stop: Integer, 指定查詢的結束下標,0 表示第一個元素,-1 表示最後一個元素
  • withScores: Boolean, 指定是否在結果中包含score

回傳結果:

  • NArray, 指定區間內,帶有score 值(可選)的有序集成員的列表

rangeRev

傳回有序集中,指定區間內的成員,成員的位置依score 值遞減(從大到小)來排序

1 2 3
NArray RedisSortedSet.rangeRev(Integer start, Integer stop, Boolean withScores = false);

呼叫參數:

  • start: Integer, 指定查詢的起始下標,0 表示第一個元素,-1 表示最後一個元素
  • stop: Integer, 指定查詢的結束下標,0 表示第一個元素,-1 表示最後一個元素
  • withScores: Boolean, 指定是否在結果中包含score

回傳結果:

  • NArray, 指定區間內,帶有score 值(可選)的有序集成員的列表

rank

有序集中成員member 的排名。其中有序集成員依score 值遞增(從小到大)順序排列

1
Integer RedisSortedSet.rank(Buffer member);

呼叫參數:

  • member:Buffer, 指定要查詢的member

回傳結果:

  • Integer, member 如果member 是有序集key 的成員,回傳member 的排名。如果member 不是有序集key 的成員,則回傳nil

rankRev

有序集中成員member 的排名。其中有序集成員依score 值遞減(由大到小)順序排列

1
Integer RedisSortedSet.rankRev(Buffer member);

呼叫參數:

  • member:Buffer, 指定要查詢的member

回傳結果:

  • Integer, member 如果member 是有序集key 的成員,回傳member 的排名。如果member 不是有序集key 的成員,則回傳nil

toString

傳回物件的字串表示,一般回傳"[Native Object]",物件可以根據自己的特性重新實現

1
String RedisSortedSet.toString();

回傳結果:

  • String, 傳回物件的字串表示

toJSON

傳回物件的JSON 格式表示,一般傳回物件定義的可讀屬性集合

1
Value RedisSortedSet.toJSON(String key = "");

呼叫參數:

  • key: String, 未使用

回傳結果:

  • Value, 傳回包含可JSON 序列化的值