BeetleX.Redis有序集全

Redis 有序集合和集合一样也是元素的集合,且不允许重复的成员。

不同的是 有序集合 每个元素都会关联一个double类型的分数。redis正是通过分数来为集合中的成员进行从小到大的排序。 有序集合的成员是唯一的,但分数(score)却可以重复。 组件通过 Sequence 来封装相关有序集合的操作方法，在操作前需要创建相关对象

DB.CreateSequence("seq2")

ZADD

将一个或多个 member 元素及其 score 值加入到有序集 key 当中。

如果某个 member 已经是有序集的成员，那么更新这个 member 的 score 值，并通过重新插入这个 member 元素，来保证该 member 在正确的位置上。

score 值可以是整数值或双精度浮点数。

如果 key 不存在，则创建一个空的有序集并执行 ZADD 操作。

当 key 存在但不是有序集类型时，返回一个错误。

await DB.Del("seq2");
var sequeue = DB.CreateSequence("seq2");
var count = await sequeue.ZAdd((1, Guid.NewGuid().ToString("N")), (2, Guid.NewGuid().ToString("N")));
Assert.Equal<long>(count, 2);

ZCARD

返回有序集 key 的基数。

await DB.Del("seq2");
string member = "ken";
var sequeue = DB.CreateSequence("seq2");
await sequeue.ZAdd((4.14, member));
var count = await sequeue.ZCard();
Assert.Equal<long>(count, 1);
await sequeue.ZAdd((4.14, "ken1"));
count = await sequeue.ZCard();
Assert.Equal<long>(count, 2);

ZCOUNT

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

await DB.Del("seq2");
var sequeue = DB.CreateSequence("seq2");
await sequeue.ZAdd((100, "A1"), (200, "A2"), (300, "A3"), (400, "A4"));
var count = await sequeue.ZCount(200, 300);
Assert.Equal<long>(count, 2);

ZINCRBY

为有序集 key 的成员 member 的 score 值加上增量 increment 。

可以通过传递一个负数值 increment ，让 score 减去相应的值，比如 ZINCRBY key -5 member ，就是让 member 的 score 值减去 5 。

当 key 不存在，或 member 不是 key 的成员时， ZINCRBY key increment member 等同于 ZADD key increment member 。

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

score 值可以是整数值或双精度浮点数。

await DB.Del("seq2");
string member = "ken";
var sequeue = DB.CreateSequence("seq2");
var count = await sequeue.ZAdd((4.14, member));
var value = await sequeue.ZScore(member);
Assert.Equal<double>(value, 4.14);
await sequeue.ZIncrby(5, member);
value = await sequeue.ZScore(member);
Assert.Equal<double>(value, 9.14);

ZINTERSTORE

计算给定的一个或多个有序集的交集，其中给定 key 的数量必须以 numkeys 参数指定，并将该交集(结果集)储存到 destination 。

默认情况下，结果集中某个成员的 score 值是所有给定集下该成员 score 值之和.

await DB.Del("seq2", "seq3", "seq4");
var seq2 = DB.CreateSequence("seq2");
await seq2.ZAdd((70, "Li Lei"), (70, "Han Meimei"), (99.5, "Tom"));

var seq3 = DB.CreateSequence("seq3");
await seq3.ZAdd((88, "Li Lei"), (75, "Han Meimei"), (99.5, "Tom"));

var seq4 = DB.CreateSequence("seq4");
await seq4.ZInterStore("seq2", "seq3");

var items = await seq4.ZRange(0, -1, true);

Assert.Equal<double>(145, items[0].Score);
Assert.Equal<double>(158, items[1].Score);
Assert.Equal<double>(199, items[2].Score);

ZRANGE

返回有序集 key 中，指定区间内的成员。

其中成员的位置按 score 值递增(从小到大)来排序。

具有相同 score 值的成员按字典序(lexicographical order )来排列。

如果你需要成员按 score 值递减(从大到小)来排列，请使用 ZREVRANGE key start stop [WITHSCORES] 命令。

下标参数 start 和 stop 都以 0 为底，也就是说，以 0 表示有序集第一个成员，以 1 表示有序集第二个成员，以此类推。你也可以使用负数下标，以 -1 表示最后一个成员， -2 表示倒数第二个成员，以此类推。

超出范围的下标并不会引起错误。比如说，当 start 的值比有序集的最大下标还要大，或是 start > stop 时， ZRANGE 命令只是简单地返回一个空列表。另一方面，假如 stop 参数的值比有序集的最大下标还要大，那么 Redis 将 stop 当作最大下标来处理。

可以通过使用 WITHSCORES 选项，来让成员和它的 score 值一并返回，返回列表以 value1,score1, ..., valueN,scoreN 的格式表示。客户端库可能会返回一些更复杂的数据类型，比如数组、元组等。

await DB.Del("seq2");
var sequeue = DB.CreateSequence("seq2");
await sequeue.ZAdd((100, "A1"), (200, "A2"), (300, "A3"), (400, "A4"));
var items = await sequeue.ZRange(0, -1, true);
Assert.Equal<int>(items.Count, 4);
Assert.Equal<string>(items[0].Member, "A1");
Assert.Equal<string>(items[1].Member, "A2");
Assert.Equal<string>(items[2].Member, "A3");
Assert.Equal<string>(items[3].Member, "A4");

Assert.Equal<double>(items[0].Score, 100);
Assert.Equal<double>(items[1].Score, 200);
Assert.Equal<double>(items[2].Score, 300);
Assert.Equal<double>(items[3].Score, 400);

ZRANGEBYLEX

当有序集合的所有成员都具有相同的分值时， 有序集合的元素会根据成员的字典序（lexicographical ordering）来进行排序， 而这个命令则可以返回给定的有序集合键 key 中， 值介于 min 和 max 之间的成员。

如果有序集合里面的成员带有不同的分值， 那么命令返回的结果是未指定的（unspecified）。

命令会使用 C 语言的 memcmp() 函数， 对集合中的每个成员进行逐个字节的对比（byte-by-byte compare）， 并按照从低到高的顺序， 返回 排序 后的集合成员。如果两个字符串有一部分内容是相同的话， 那么命令会认为较长的字符串比较短的字符串要大。

可选的 LIMIT offset count 参数用于获取指定范围内的匹配元素 （就像 SQL 中的 SELECT LIMIT offset count 语句）。需要注意的一点是， 如果 offset 参数的值非常大的话， 那么命令在返回结果之前， 需要先遍历至 offset 所指定的位置， 这个操作会为命令加上最多 O(N) 复杂度。

await DB.Del("seq2");
var sequeue = DB.CreateSequence("seq2");
await sequeue.ZAdd((100, "A1"), (200, "A2"), (300, "A3"), (400, "A4"));
var count = await sequeue.ZCard();
Assert.Equal<long>(count, 4);
var items = await sequeue.ZRangeByLex("[A2", null);
Assert.Equal<int>(items.Count, 2);

ZRANGEBYSCORE

返回有序集 key 中，所有 score 值介于 min 和 max 之间(包括等于 min 或 max )的成员。有序集成员按 score 值递增(从小到大)次序排列。

具有相同 score 值的成员按字典序(lexicographical order)来排列(该属性是有序集提供的，不需要额外的计算)。

可选的 LIMIT 参数指定返回结果的数量及区间(就像SQL中的 SELECT LIMIT offset, count )，注意当 offset 很大时，定位 offset 的操作可能需要遍历整个有序集，此过程最坏复杂度为 O(N) 时间。

可选的 WITHSCORES 参数决定结果集是单单返回有序集的成员，还是将有序集成员及其 score 值一起返回。该选项自 Redis 2.0 版本起可用。

await DB.Del("seq2");
var seq = DB.CreateSequence("seq2");
await seq.ZAdd((100, "A1"), (200, "A2"), (300, "A3"), (400, "A4"));
var items = await seq.ZRangeByScore("200", "300", true);
Assert.Equal<int>(items.Count, 2);
Assert.Equal<string>(items[0].Member, "A2");
Assert.Equal<double>(items[0].Score, 200);

ZRANK

返回有序集 key 中成员 member 的排名。其中有序集成员按 score 值递增(从小到大)顺序排列。

排名以 0 为底，也就是说， score 值最小的成员排名为 0 。

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

await DB.Del("seq2");
var sequeue = DB.CreateSequence("seq2");
await sequeue.ZAdd((100, "A1"), (200, "A2"), (300, "A3"), (400, "A4"));
var value = await sequeue.ZRank("A4");
Assert.Equal<long>(value, 3);

ZREM

移除有序集 key 中的一个或多个成员，不存在的成员将被忽略。

当 key 存在但不是有序集类型时，返回一个错误。

await DB.Del("seq2");
var sequeue = DB.CreateSequence("seq2");
await sequeue.ZAdd((100, "A1"), (200, "A2"), (300, "A3"), (400, "A4"));
var count = await sequeue.ZCard();
Assert.Equal<long>(count, 4);
await sequeue.ZRem("A1", "A2");
count = await sequeue.ZCard();
Assert.Equal<long>(count, 2);

ZREMRANGEBYRANK

移除有序集 key 中，指定排名(rank)区间内的所有成员。

区间分别以下标参数 start 和 stop 指出，包含 start 和 stop 在内。

下标参数 start 和 stop 都以 0 为底，也就是说，以 0 表示有序集第一个成员，以 1 表示有序集第二个成员，以此类推。你也可以使用负数下标，以 -1 表示最后一个成员， -2 表示倒数第二个成员，以此类推。

await DB.Del("seq2");
var sequeue = DB.CreateSequence("seq2");
await sequeue.ZAdd((100, "A1"), (200, "A2"), (300, "A3"), (400, "A4"));
var count = await sequeue.ZCard();
Assert.Equal<long>(count, 4);
await sequeue.ZRemRangeByRank(0, 1);
count = await sequeue.ZCard();
Assert.Equal<long>(count, 2);

ZREMRANGEBYSCORE

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

自版本2.1.6开始， score 值等于 min 或 max 的成员也可以不包括在内，详情请参见 ZRANGEBYSCORE key min max [WITHSCORES] [LIMIT offset count] 命令。

await DB.Del("seq2");
var sequeue = DB.CreateSequence("seq2");
await sequeue.ZAdd((100, "A1"), (200, "A2"), (300, "A3"), (400, "A4"));
var count = await sequeue.ZCard();
Assert.Equal<long>(count, 4);
await sequeue.ZRemRangeByScore(200, 400);
count = await sequeue.ZCard();
Assert.Equal<long>(count, 1);

ZREVRANGE

返回有序集 key 中，指定区间内的成员。

其中成员的位置按 score 值递减(从大到小)来排列。具有相同 score 值的成员按字典序的逆序(reverse lexicographical order)排列。

除了成员按 score 值递减的次序排列这一点外， ZREVRANGE 命令的其他方面和 ZRANGE key start stop [WITHSCORES] 命令一样。

await DB.Del("seq2");
var sequeue = DB.CreateSequence("seq2");
await sequeue.ZAdd((100, "A1"), (200, "A2"), (300, "A3"), (400, "A4"));
var items = await sequeue.ZRevRange(0, -1, true);
Assert.Equal<int>(items.Count, 4);
Assert.Equal<string>(items[0].Member, "A4");
Assert.Equal<string>(items[1].Member, "A3");
Assert.Equal<string>(items[2].Member, "A2");
Assert.Equal<string>(items[3].Member, "A1");

Assert.Equal<double>(items[0].Score, 400);
Assert.Equal<double>(items[1].Score, 300);
Assert.Equal<double>(items[2].Score, 200);
Assert.Equal<double>(items[3].Score, 100);

ZREVRANK

返回有序集 key 中成员 member 的排名。其中有序集成员按 score 值递减(从大到小)排序。

排名以 0 为底，也就是说， score 值最大的成员排名为 0 。

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

await DB.Del("seq2");
var sequeue = DB.CreateSequence("seq2");
await sequeue.ZAdd((100, "A1"), (200, "A2"), (300, "A3"), (400, "A4"));
var value = await sequeue.ZRevRank("A4");
Assert.Equal<long>(value, 0);

ZREVRANGEBYSCORE

返回有序集 key 中， score 值介于 max 和 min 之间(默认包括等于 max 或 min )的所有的成员。有序集成员按 score 值递减(从大到小)的次序排列。

具有相同 score 值的成员按字典序的逆序(reverse lexicographical order )排列。

除了成员按 score 值递减的次序排列这一点外， ZREVRANGEBYSCORE 命令的其他方面和 ZRANGEBYSCORE key min max [WITHSCORES] [LIMIT offset count] 命令一样。

await DB.Del("seq2");
var sequeue = DB.CreateSequence("seq2");
await sequeue.ZAdd((100, "A1"), (200, "A2"), (300, "A3"), (400, "A4"));
var items = await sequeue.ZRevRangeByScore("300", "200", true);
Assert.Equal<int>(items.Count, 2);
Assert.Equal<string>(items[0].Member, "A3");
Assert.Equal<double>(items[0].Score, 300);
Assert.Equal<string>(items[1].Member, "A2");
Assert.Equal<double>(items[1].Score, 200);

ZSCORE

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

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

await DB.Del("seq2");
var sequeue = DB.CreateSequence("seq2");
var count = await sequeue.ZAdd((4.14, "bca"));
var value = await sequeue.ZScore("bca");
Assert.Equal<double>(value, 4.14);

ZUNIONSTORE

计算给定的一个或多个有序集的并集，其中给定 key 的数量必须以 numkeys 参数指定，并将该并集(结果集)储存到 destination 。

默认情况下，结果集中某个成员的 score 值是所有给定集下该成员 score 值之 和 。

WEIGHTS 使用 WEIGHTS 选项，你可以为 每个 给定有序集 分别 指定一个乘法因子(multiplication factor)，每个给定有序集的所有成员的 score 值在传递给聚合函数(aggregation function)之前都要先乘以该有序集的因子。

如果没有指定 WEIGHTS 选项，乘法因子默认设置为 1 。

AGGREGATE 使用 AGGREGATE 选项，你可以指定并集的结果集的聚合方式。

默认使用的参数 SUM ，可以将所有集合中某个成员的 score 值之 和 作为结果集中该成员的 score 值；使用参数 MIN ，可以将所有集合中某个成员的 最小 score 值作为结果集中该成员的 score 值；而参数 MAX 则是将所有集合中某个成员的 最大 score 值作为结果集中该成员的 score 值。

await DB.Del("seq2", "seq3", "seq4");
var seq2 = DB.CreateSequence("seq2");
await seq2.ZAdd((100, "A1"), (200, "A2"), (300, "A3"), (400, "A4"));

var seq3 = DB.CreateSequence("seq2");
await seq3.ZAdd((500, "B1"), (600, "B2"), (700, "B3"), (800, "B4"));

var seq4 = DB.CreateSequence("seq4");
await seq4.ZUnionsStore("seq2", "seq3");

var count = await seq4.ZCard();
Assert.Equal<long>(count, 8);