对象 RedisSet
Redis 数据库客户端 Set 对象,此对象为包含指定 key 的客户端,只有调用其方法才会操作数据库
用以操作 Redis 的 Set 对象,创建方法:
1
2
3var db = require("db");
var rdb = new db.openRedis("redis-server");
var set = rdb.getSet("test");
继承关系
成员函数
add
将一个或多个 member 元素加入到集合 key 当中,已经存在于集合的 member 元素将被忽略
1Integer RedisSet.add(Array members);
调用参数:
- members: Array, 指定要添加的元素数组
返回结果:
- Integer, 被添加到集合中的新元素的数量,不包括被忽略的元素
同时将多个 field-value (域-值)对设置到哈希表中,此命令会覆盖哈希表中已存在的域
1Integer RedisSet.add(...members);
调用参数:
- members: ..., 指定要添加的元素列表
返回结果:
- Integer, 被添加到集合中的新元素的数量,不包括被忽略的元素
remove
移除集合中的一个或多个 member 元素
1Integer RedisSet.remove(Array members);
调用参数:
- members: Array, 指定要移除的元素数组
返回结果:
- Integer, 被成功移除的元素的数量,不包括被忽略的元素
移除集合中的一个或多个 member 元素
1Integer RedisSet.remove(...members);
调用参数:
- members: ..., 指定要移除的元素列表
返回结果:
- Integer, 被成功移除的元素的数量,不包括被忽略的元素
len
返回集合中元素的数量
1Integer RedisSet.len();
返回结果:
- Integer, 返回集合的长度
exists
判断 member 元素是否集合的成员
1Boolean RedisSet.exists(Buffer member);
调用参数:
- member: Buffer, 指定检查的 member
返回结果:
- Boolean, 如果 member 元素是集合的成员,返回 true
members
返回集合中的所有成员
1NArray RedisSet.members();
返回结果:
- NArray, 集合中所有成员的列表
pop
移除并返回集合中的一个随机元素
1Buffer RedisSet.pop();
返回结果:
- Buffer, 被移除的随机元素。当集合是空集时,返回 null
randMember
从集合中获取随机的一个元素
1Value RedisSet.randMember();
返回结果:
- Value, 返回一个元素;如果集合为空,返回 null
从集合中获取随机的若干元素
1Value RedisSet.randMember(Integer count);
调用参数:
- count: Integer, 指定返回的元素个数。正数,返回一个包含 count 个元素的数组;负数,返回一个数组,数组中的元素可能会重复出现多次,而数组的长度为 count 的绝对值
返回结果:
- Value, 返回一个列表;如果集合为空,返回空列表
toString
返回对象的字符串表示,一般返回 "[Native Object]",对象可以根据自己的特性重新实现
1String RedisSet.toString();
返回结果:
- String, 返回对象的字符串表示
toJSON
返回对象的 JSON 格式表示,一般返回对象定义的可读属性集合
1Value RedisSet.toJSON(String key = "");
调用参数:
- key: String, 未使用
返回结果:
- Value, 返回包含可 JSON 序列化的值