對象RedisList

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

用以操作Redis的List 對象，建立方法：

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

繼承關係

成員函數

push

將一個或多個值value 插入到清單的表頭

1
Integer RedisList.push(Array values);

呼叫參數:

• values: Array, 指定要插入的數據

回傳結果:

• Integer, 插入後，列表的長度

---

將一個或多個值value 插入到清單的表頭

1
Integer RedisList.push(...values);

呼叫參數:

• values: ..., 指定要插入的數據

回傳結果:

• Integer, 插入後，列表的長度

---

pop

移除並返回列表key 的頭元素

1
Buffer RedisList.pop();

回傳結果:

• Buffer, 清單的頭元素，如果清單為空則傳回null

---

rpush

將一個或多個值value 插入到清單的表尾(最右邊)

1
Integer RedisList.rpush(Array values);

呼叫參數:

• values: Array, 指定要插入的數據

回傳結果:

• Integer, 插入後，列表的長度

---

將一個或多個值value 插入到清單的表尾(最右邊)

1
Integer RedisList.rpush(...values);

呼叫參數:

• values: ..., 指定要插入的數據

回傳結果:

• Integer, 插入後，列表的長度

---

rpop

移除並傳回列表key 的表尾(最右邊)元素

1
Buffer RedisList.rpop();

回傳結果:

• Buffer, 清單的頭元素，如果清單為空則傳回null

---

set

將清單下標為index 的元素的值設為value

1
2
RedisList.set(Integer index,
    Buffer value);

呼叫參數:

• index: Integer, 指定要修改的下標
• value:Buffer, 指定要修改的數據

---

get

傳回清單中，下標為index 的元素

1
Buffer RedisList.get(Integer index);

呼叫參數:

• index: Integer, 指定要查詢的下標

回傳結果:

• Buffer, 清單中下標為index 的元素

---

insertBefore

將值value 插入到列表當中，位於值pivot 之前

1
2
Integer RedisList.insertBefore(Buffer pivot,
    Buffer value);

呼叫參數:

• pivot:Buffer, 指定插入時所尋找的數據
• value:Buffer, 指定要插入的數據

回傳結果:

• Integer, 插入後，列表的長度

---

insertAfter

將值value 插入到列表當中，位於值pivot 之後

1
2
Integer RedisList.insertAfter(Buffer pivot,
    Buffer value);

呼叫參數:

• pivot:Buffer, 指定插入時所尋找的數據
• value:Buffer, 指定要插入的數據

回傳結果:

• Integer, 插入後，列表的長度

---

remove

根據參數count 的值，移除列表中與參數value 相等的元素

1
2
Integer RedisList.remove(Integer count,
    Buffer value);

呼叫參數:

• count: Integer, 指定刪除的元素數量
• value:Buffer, 指定要刪除的數值

回傳結果:

• Integer, 被移除元素的數量

---

trim

將一個清單修剪(trim)，就是說，讓清單只保留指定區間內的元素，不在指定區間之內的元素都會被刪除

1
2
RedisList.trim(Integer start,
    Integer stop);

呼叫參數:

• start: Integer, 指定修剪的起始下標，0 表示第一個元素，-1 表示最後一個元素
• stop: Integer, 指定修剪的結束下標，0 表示第一個元素，-1 表示最後一個元素

---

len

返回列表的長度

1
Integer RedisList.len();

回傳結果:

• Integer, 返回列表的長度

---

range

傳回清單中指定區間內的元素，區間以偏移量start 和stop 指定，包含start 和stop 的元素

1
2
NArray RedisList.range(Integer start,
    Integer stop);

呼叫參數:

• start: Integer, 指定查詢的起始下標，0 表示第一個元素，-1 表示最後一個元素
• stop: Integer, 指定查詢的結束下標，0 表示第一個元素，-1 表示最後一個元素

回傳結果:

• NArray, 包含指定區間內的元素的陣列

---

toString

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

1
String RedisList.toString();

回傳結果:

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

---

toJSON

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

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

呼叫參數:

• key: String, 未使用

回傳結果:

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