Redis学习记录之命令KEY(七)

忘是亡心i 2022-08-19 11:22 187阅读 0赞

**1、RENAME**  
RENAME key newkey

将 key 改名为 newkey 。

当 key 和 newkey 相同，或者 key 不存在时，返回一个错误。

当 newkey 已经存在时， RENAME 命令将覆盖旧值。

可用版本：  
1.0.0及以上

返回值：  
改名成功时提示 OK ，失败时候返回一个错误。  
**key 存在且 newkey 不存在**

redis> SET message “hello world”  
OK

redis> RENAME message greeting  
OK

redis> EXISTS message \# message 不复存在  
(integer) 0

redis> EXISTS greeting \# greeting 取而代之  
(integer) 1

**当 key 不存在时，返回错误**

redis> RENAME fake\_key never\_exists  
(error) ERR no such key

**newkey 已存在时， RENAME 会覆盖旧 newkey**

redis> SET pc “lenovo”  
OK

redis> SET personal\_computer “dell”  
OK

redis> RENAME pc personal\_computer  
OK

redis> GET pc  
(nil)

redis:1> GET personal\_computer \# 原来的值 dell 被覆盖了  
“lenovo”

**2、RENAMENX**  
RENAMENX key newkey

当且仅当 newkey 不存在时，将 key 改名为 newkey 。

当 key 不存在时，返回一个错误。

可用版本：  
1.0.0及以上

返回值：  
修改成功时，返回 1 。  
如果 newkey 已经存在，返回 0 。

**newkey 不存在，改名成功**

redis> SET player “MPlyaer”  
OK

redis> EXISTS best\_player  
(integer) 0

redis> RENAMENX player best\_player  
(integer) 1

**newkey存在时，失败**

redis> SET animal “bear”  
OK

redis> SET favorite\_animal “butterfly”  
OK

redis> RENAMENX animal favorite\_animal  
(integer) 0

redis> get animal  
“bear”

redis> get favorite\_animal  
“butterfly”

**3、RESTORE**

RESTORE key ttl serialized-value \[REPLACE\]

反序列化给定的序列化值，并将它和给定的 key 关联。

参数 ttl 以毫秒为单位为 key 设置生存时间；如果 ttl 为 0 ，那么不设置生存时间。

RESTORE 在执行反序列化之前会先对序列化值的 RDB 版本和数据校验和进行检查，如果 RDB 版本不相同或者数据不完整的话，那么 RESTORE 会拒绝进行反序列化，并返回一个错误。

如果键 key 已经存在， 并且给定了 REPLACE 选项， 那么使用反序列化得出的值来代替键 key 原有的值； 相反地， 如果键 key 已经存在， 但是没有给定 REPLACE 选项， 那么命令返回一个错误。

更多信息可以参考 DUMP 命令。

可用版本：  
2.6.0及以上

返回值：  
如果反序列化成功那么返回 OK ，否则返回一个错误。  
**创建一个键，作为 DUMP 命令的输入**

redis> SET greeting “hello, dumping world!”  
OK

redis> DUMP greeting  
“\\x00\\x15hello, dumping world!\\x06\\x00E\\xa0Z\\x82\\xd8r\\xc1\\xde”

**将序列化数据 RESTORE 到另一个键上面**

redis> RESTORE greeting-again 0 “\\x00\\x15hello, dumping world!\\x06\\x00E\\xa0Z\\x82\\xd8r\\xc1\\xde”  
OK

redis> GET greeting-again  
“hello, dumping world!”

**在没有给定 REPLACE 选项的情况下，再次尝试反序列化到同一个键，失败**

redis> RESTORE greeting-again 0 “\\x00\\x15hello, dumping world!\\x06\\x00E\\xa0Z\\x82\\xd8r\\xc1\\xde”  
(error) ERR Target key name is busy.

**给定 REPLACE 选项，对同一个键进行反序列化成功**

redis> RESTORE greeting-again 0 “\\x00\\x15hello, dumping world!\\x06\\x00E\\xa0Z\\x82\\xd8r\\xc1\\xde” REPLACE  
OK

**尝试使用无效的值进行反序列化，出错**

redis> RESTORE fake-message 0 “hello moto moto blah blah”  
(error) ERR DUMP payload version or checksum are wrong

**4、SORT**

SORT key \[BY pattern\] \[LIMIT offset count\] \[GET pattern \[GET pattern …\]\] \[ASC | DESC\] \[ALPHA\] \[STORE destination\]

返回或保存给定列表、集合、有序集合 key 中经过排序的元素。

排序默认以数字作为对象，值被解释为双精度浮点数，然后进行比较。

一般 SORT 用法  
最简单的 SORT 使用方法是 SORT key 和 SORT key DESC ：

SORT key 返回键值从小到大排序的结果。  
SORT key DESC 返回键值从大到小排序的结果。  
假设 today\_cost 列表保存了今日的开销金额， 那么可以用 SORT 命令对它进行排序：

**开销金额列表**

redis> LPUSH today\_cost 30 1.5 10 8  
(integer) 4

**排序**

redis> SORT today\_cost  
1) “1.5”  
2) “8”  
3) “10”  
4) “30”

**逆序排序**

redis 127.0.0.1:6379> SORT today\_cost DESC  
1) “30”  
2) “10”  
3) “8”  
4) “1.5”  
使用 ALPHA 修饰符对字符串进行排序  
因为 SORT 命令默认排序对象为数字， 当需要对字符串进行排序时， 需要显式地在 SORT 命令之后添加 ALPHA 修饰符：

**网址**

redis> LPUSH website “www.reddit.com”  
(integer) 1

redis> LPUSH website “www.slashdot.com”  
(integer) 2

redis> LPUSH website “www.infoq.com”  
(integer) 3

**默认（按数字）排序**

redis> SORT website  
1) “www.infoq.com”  
2) “www.slashdot.com”  
3) “www.reddit.com”

**按字符排序**

redis> SORT website ALPHA  
1) “www.infoq.com”  
2) “www.reddit.com”  
3) “www.slashdot.com”  
如果系统正确地设置了 LC\_COLLATE 环境变量的话，Redis能识别 UTF-8 编码。

使用 LIMIT 修饰符限制返回结果  
排序之后返回元素的数量可以通过 LIMIT 修饰符进行限制， 修饰符接受 offset 和 count 两个参数：

offset 指定要跳过的元素数量。  
count 指定跳过 offset 个指定的元素之后，要返回多少个对象。  
以下例子返回排序结果的前 5 个对象( offset 为 0 表示没有元素被跳过)。

**添加测试数据，列表值为 1 指 10**

redis 127.0.0.1:6379> RPUSH rank 1 3 5 7 9  
(integer) 5

redis 127.0.0.1:6379> RPUSH rank 2 4 6 8 10  
(integer) 10

**返回列表中最小的 5 个值**

redis 127.0.0.1:6379> SORT rank LIMIT 0 5  
1) “1”  
2) “2”  
3) “3”  
4) “4”  
5) “5”  
可以组合使用多个修饰符。以下例子返回从大到小排序的前 5 个对象。

redis 127.0.0.1:6379> SORT rank LIMIT 0 5 DESC  
1) “10”  
2) “9”  
3) “8”  
4) “7”  
5) “6”  
使用外部 key 进行排序  
可以使用外部 key 的数据作为权重，代替默认的直接对比键值的方式来进行排序。

假设现在有用户数据如下：

uid user\_name\_\{uid\} user\_level\_\{uid\}  
1 admin 9999  
2 jack 10  
3 peter 25  
4 mary 70  
以下代码将数据输入到 Redis 中：

**admin**

redis 127.0.0.1:6379> LPUSH uid 1  
(integer) 1

redis 127.0.0.1:6379> SET user\_name\_1 admin  
OK

redis 127.0.0.1:6379> SET user\_level\_1 9999  
OK

**jack**

redis 127.0.0.1:6379> LPUSH uid 2  
(integer) 2

redis 127.0.0.1:6379> SET user\_name\_2 jack  
OK

redis 127.0.0.1:6379> SET user\_level\_2 10  
OK

peter

redis 127.0.0.1:6379> LPUSH uid 3  
(integer) 3

redis 127.0.0.1:6379> SET user\_name\_3 peter  
OK

redis 127.0.0.1:6379> SET user\_level\_3 25  
OK

**mary**

redis 127.0.0.1:6379> LPUSH uid 4  
(integer) 4

redis 127.0.0.1:6379> SET user\_name\_4 mary  
OK

redis 127.0.0.1:6379> SET user\_level\_4 70  
OK  
BY 选项

默认情况下， SORT uid 直接按 uid 中的值排序：

redis 127.0.0.1:6379> SORT uid  
1) “1” \# admin  
2) “2” \# jack  
3) “3” \# peter  
4) “4” \# mary  
通过使用 BY 选项，可以让 uid 按其他键的元素来排序。

比如说， 以下代码让 uid 键按照 user\_level\_\{uid\} 的大小来排序：

redis 127.0.0.1:6379> SORT uid BY user\_level\_\*  
1) “2” \# jack , level = 10  
2) “3” \# peter, level = 25  
3) “4” \# mary, level = 70  
4) “1” \# admin, level = 9999  
user\_level\_\* 是一个占位符， 它先取出 uid 中的值， 然后再用这个值来查找相应的键。

比如在对 uid 列表进行排序时， 程序就会先取出 uid 的值 1 、 2 、 3 、 4 ， 然后使用 user\_level\_1 、 user\_level\_2 、 user\_level\_3 和 user\_level\_4 的值作为排序 uid 的权重。

GET 选项

使用 GET 选项， 可以根据排序的结果来取出相应的键值。

比如说， 以下代码先排序 uid ， 再取出键 user\_name\_\{uid\} 的值：

redis 127.0.0.1:6379> SORT uid GET user\_name\_\*  
1) “admin”  
2) “jack”  
3) “peter”  
4) “mary”  
组合使用 BY 和 GET

通过组合使用 BY 和 GET ， 可以让排序结果以更直观的方式显示出来。

比如说， 以下代码先按 user\_level\_\{uid\} 来排序 uid 列表， 再取出相应的 user\_name\_\{uid\} 的值：

redis 127.0.0.1:6379> SORT uid BY user\_level\_\* GET user\_name\_\*  
1) “jack” \# level = 10  
2) “peter” \# level = 25  
3) “mary” \# level = 70  
4) “admin” \# level = 9999  
现在的排序结果要比只使用 SORT uid BY user\_level\_\* 要直观得多。

获取多个外部键

可以同时使用多个 GET 选项， 获取多个外部键的值。

以下代码就按 uid 分别获取 user\_level\_\{uid\} 和 user\_name\_\{uid\} ：

redis 127.0.0.1:6379> SORT uid GET user\_level\_\* GET user\_name\_\*  
1) “9999” \# level  
2) “admin” \# name  
3) “10”  
4) “jack”  
5) “25”  
6) “peter”  
7) “70”  
8) “mary”  
GET 有一个额外的参数规则，那就是 —— 可以用 \# 获取被排序键的值。

以下代码就将 uid 的值、及其相应的 user\_level\_\* 和 user\_name\_\* 都返回为结果：

redis 127.0.0.1:6379> SORT uid GET \# GET user\_level\_\* GET user\_name\_\*  
1) “1” \# uid  
2) “9999” \# level  
3) “admin” \# name  
4) “2”  
5) “10”  
6) “jack”  
7) “3”  
8) “25”  
9) “peter”  
10) “4”  
11) “70”  
12) “mary”  
获取外部键，但不进行排序

通过将一个不存在的键作为参数传给 BY 选项， 可以让 SORT 跳过排序操作， 直接返回结果：

redis 127.0.0.1:6379> SORT uid BY not-exists-key  
1) “4”  
2) “3”  
3) “2”  
4) “1”  
这种用法在单独使用时，没什么实际用处。

不过，通过将这种用法和 GET 选项配合， 就可以在不排序的情况下， 获取多个外部键， 相当于执行一个整合的获取操作（类似于 SQL 数据库的 join 关键字）。

以下代码演示了，如何在不引起排序的情况下，使用 SORT 、 BY 和 GET 获取多个外部键：

redis 127.0.0.1:6379> SORT uid BY not-exists-key GET \# GET user\_level\_\* GET user\_name\_\*  
1) “4” \# id  
2) “70” \# level  
3) “mary” \# name  
4) “3”  
5) “25”  
6) “peter”  
7) “2”  
8) “10”  
9) “jack”  
10) “1”  
11) “9999”  
12) “admin”  
将哈希表作为 GET 或 BY 的参数

除了可以将字符串键之外， 哈希表也可以作为 GET 或 BY 选项的参数来使用。

比如说，对于前面给出的用户信息表：

uid user\_name\_\{uid\} user\_level\_\{uid\}  
1 admin 9999  
2 jack 10  
3 peter 25  
4 mary 70  
我们可以不将用户的名字和级别保存在 user\_name\_\{uid\} 和 user\_level\_\{uid\} 两个字符串键中， 而是用一个带有 name 域和 level 域的哈希表 user\_info\_\{uid\} 来保存用户的名字和级别信息：

redis 127.0.0.1:6379> HMSET user\_info\_1 name admin level 9999  
OK

redis 127.0.0.1:6379> HMSET user\_info\_2 name jack level 10  
OK

redis 127.0.0.1:6379> HMSET user\_info\_3 name peter level 25  
OK

redis 127.0.0.1:6379> HMSET user\_info\_4 name mary level 70  
OK  
之后， BY 和 GET 选项都可以用 key->field 的格式来获取哈希表中的域的值， 其中 key 表示哈希表键， 而 field 则表示哈希表的域：

redis 127.0.0.1:6379> SORT uid BY user\_info\_\*->level  
1) “2”  
2) “3”  
3) “4”  
4) “1”

redis 127.0.0.1:6379> SORT uid BY user\_info\_\*->level GET user\_info\_\*->name  
1) “jack”  
2) “peter”  
3) “mary”  
4) “admin”  
保存排序结果  
默认情况下， SORT 操作只是简单地返回排序结果，并不进行任何保存操作。

通过给 STORE 选项指定一个 key 参数，可以将排序结果保存到给定的键上。

如果被指定的 key 已存在，那么原有的值将被排序结果覆盖。

**测试数据**

redis 127.0.0.1:6379> RPUSH numbers 1 3 5 7 9  
(integer) 5

redis 127.0.0.1:6379> RPUSH numbers 2 4 6 8 10  
(integer) 10

redis 127.0.0.1:6379> LRANGE numbers 0 -1  
1) “1”  
2) “3”  
3) “5”  
4) “7”  
5) “9”  
6) “2”  
7) “4”  
8) “6”  
9) “8”  
10) “10”

redis 127.0.0.1:6379> SORT numbers STORE sorted-numbers  
(integer) 10

**排序后的结果**

redis 127.0.0.1:6379> LRANGE sorted-numbers 0 -1  
1) “1”  
2) “2”  
3) “3”  
4) “4”  
5) “5”  
6) “6”  
7) “7”  
8) “8”  
9) “9”  
10) “10”  
可以通过将 SORT 命令的执行结果保存，并用 EXPIRE 为结果设置生存时间，以此来产生一个 SORT 操作的结果缓存。

这样就可以避免对 SORT 操作的频繁调用：只有当结果集过期时，才需要再调用一次 SORT 操作。

另外，为了正确实现这一用法，你可能需要加锁以避免多个客户端同时进行缓存重建(也就是多个客户端，同一时间进行 SORT 操作，并保存为结果集)，具体参见 SETNX 命令。

可用版本：  
1.0.0及以上

返回值：  
没有使用 STORE 参数，返回列表形式的排序结果。  
使用 STORE 参数，返回排序结果的元素数量。

**5、TTL**  
TTL key

以秒为单位，返回给定 key 的剩余生存时间(TTL, time to live)。

可用版本：  
1.0.0及以上

返回值：  
当 key 不存在时，返回 -2 。  
当 key 存在但没有设置剩余生存时间时，返回 -1 。  
否则，以秒为单位，返回 key 的剩余生存时间。  
在 Redis 2.8 以前，当 key 不存在，或者 key 没有设置剩余生存时间时，命令都返回 -1 。  
**不存在的 key**

redis> FLUSHDB  
OK

redis> TTL key  
(integer) -2

**key 存在，但没有设置剩余生存时间**

redis> SET key value  
OK

redis> TTL key  
(integer) -1

**有剩余生存时间的 key**

redis> EXPIRE key 10086  
(integer) 1

redis> TTL key  
(integer) 10084

**6、TYPE**

TYPE key

返回 key 所储存的值的类型。

可用版本：  
1.0.0及以上

返回值：  
none (key不存在)  
string (字符串)  
list (列表)  
set (集合)  
zset (有序集)  
hash (哈希表)  
**字符串**

redis> SET weather “sunny”  
OK

redis> TYPE weather  
string

**列表**

redis> LPUSH book\_list “programming in scala”  
(integer) 1

redis> TYPE book\_list  
list

**集合**

redis> SADD pat “dog”  
(integer) 1

redis> TYPE pat  
set

**7、SCAN**  
SCAN cursor \[MATCH pattern\] \[COUNT count\]

SCAN 命令及其相关的 SSCAN 命令、 HSCAN 命令和 ZSCAN 命令都用于增量地迭代（incrementally iterate）一集元素（a collection of elements）：

SCAN 命令用于迭代当前数据库中的数据库键。  
SSCAN 命令用于迭代集合键中的元素。  
HSCAN 命令用于迭代哈希键中的键值对。  
ZSCAN 命令用于迭代有序集合中的元素（包括元素成员和元素分值）。  
以上列出的四个命令都支持增量式迭代， 它们每次执行都只会返回少量元素， 所以这些命令可以用于生产环境， 而不会出现像 KEYS 命令、 SMEMBERS 命令带来的问题 —— 当 KEYS 命令被用于处理一个大的数据库时， 又或者 SMEMBERS 命令被用于处理一个大的集合键时， 它们可能会阻塞服务器达数秒之久。

不过， 增量式迭代命令也不是没有缺点的： 举个例子， 使用 SMEMBERS 命令可以返回集合键当前包含的所有元素， 但是对于 SCAN 这类增量式迭代命令来说， 因为在对键进行增量式迭代的过程中， 键可能会被修改， 所以增量式迭代命令只能对被返回的元素提供有限的保证 （offer limited guarantees about the returned elements）。

因为 SCAN 、 SSCAN 、 HSCAN 和 ZSCAN 四个命令的工作方式都非常相似， 所以这个文档会一并介绍这四个命令， 但是要记住：

SSCAN 命令、 HSCAN 命令和 ZSCAN 命令的第一个参数总是一个数据库键。  
而 SCAN 命令则不需要在第一个参数提供任何数据库键 —— 因为它迭代的是当前数据库中的所有数据库键。  
SCAN 命令的基本用法  
SCAN 命令是一个基于游标的迭代器（cursor based iterator）： SCAN 命令每次被调用之后， 都会向用户返回一个新的游标， 用户在下次迭代时需要使用这个新游标作为 SCAN 命令的游标参数， 以此来延续之前的迭代过程。

当 SCAN 命令的游标参数被设置为 0 时， 服务器将开始一次新的迭代， 而当服务器向用户返回值为 0 的游标时， 表示迭代已结束。

以下是一个 SCAN 命令的迭代过程示例：

redis 127.0.0.1:6379> scan 0  
1) “17”  
2) 1) “key:12”  
2) “key:8”  
3) “key:4”  
4) “key:14”  
5) “key:16”  
6) “key:17”  
7) “key:15”  
8) “key:10”  
9) “key:3”  
10) “key:7”  
11) “key:1”

redis 127.0.0.1:6379> scan 17  
1) “0”  
2) 1) “key:5”  
2) “key:18”  
3) “key:0”  
4) “key:2”  
5) “key:19”  
6) “key:13”  
7) “key:6”  
8) “key:9”  
9) “key:11”  
在上面这个例子中， 第一次迭代使用 0 作为游标， 表示开始一次新的迭代。

第二次迭代使用的是第一次迭代时返回的游标， 也即是命令回复第一个元素的值 —— 17 。

从上面的示例可以看到， SCAN 命令的回复是一个包含两个元素的数组， 第一个数组元素是用于进行下一次迭代的新游标， 而第二个数组元素则是一个数组， 这个数组中包含了所有被迭代的元素。

在第二次调用 SCAN 命令时， 命令返回了游标 0 ， 这表示迭代已经结束， 整个数据集（collection）已经被完整遍历过了。

以 0 作为游标开始一次新的迭代， 一直调用 SCAN 命令， 直到命令返回游标 0 ， 我们称这个过程为一次完整遍历（full iteration）。

SCAN 命令的保证（guarantees）  
SCAN 命令， 以及其他增量式迭代命令， 在进行完整遍历的情况下可以为用户带来以下保证： 从完整遍历开始直到完整遍历结束期间， 一直存在于数据集内的所有元素都会被完整遍历返回； 这意味着， 如果有一个元素， 它从遍历开始直到遍历结束期间都存在于被遍历的数据集当中， 那么 SCAN 命令总会在某次迭代中将这个元素返回给用户。

然而因为增量式命令仅仅使用游标来记录迭代状态， 所以这些命令带有以下缺点：

同一个元素可能会被返回多次。 处理重复元素的工作交由应用程序负责， 比如说， 可以考虑将迭代返回的元素仅仅用于可以安全地重复执行多次的操作上。  
如果一个元素是在迭代过程中被添加到数据集的， 又或者是在迭代过程中从数据集中被删除的， 那么这个元素可能会被返回， 也可能不会， 这是未定义的（undefined）。  
SCAN 命令每次执行返回的元素数量  
增量式迭代命令并不保证每次执行都返回某个给定数量的元素。

增量式命令甚至可能会返回零个元素， 但只要命令返回的游标不是 0 ， 应用程序就不应该将迭代视作结束。

不过命令返回的元素数量总是符合一定规则的， 在实际中：

对于一个大数据集来说， 增量式迭代命令每次最多可能会返回数十个元素；  
而对于一个足够小的数据集来说， 如果这个数据集的底层表示为编码数据结构（encoded data structure，适用于是小集合键、小哈希键和小有序集合键）， 那么增量迭代命令将在一次调用中返回数据集中的所有元素。  
最后， 用户可以通过增量式迭代命令提供的 COUNT 选项来指定每次迭代返回元素的最大值。

COUNT 选项  
虽然增量式迭代命令不保证每次迭代所返回的元素数量， 但我们可以使用 COUNT 选项， 对命令的行为进行一定程度上的调整。

基本上， COUNT 选项的作用就是让用户告知迭代命令， 在每次迭代中应该从数据集里返回多少元素。

虽然 COUNT 选项只是对增量式迭代命令的一种提示（hint）， 但是在大多数情况下， 这种提示都是有效的。

COUNT 参数的默认值为 10 。  
在迭代一个足够大的、由哈希表实现的数据库、集合键、哈希键或者有序集合键时， 如果用户没有使用 MATCH 选项， 那么命令返回的元素数量通常和 COUNT 选项指定的一样， 或者比 COUNT 选项指定的数量稍多一些。  
在迭代一个编码为整数集合（intset，一个只由整数值构成的小集合）、 或者编码为压缩列表（ziplist，由不同值构成的一个小哈希或者一个小有序集合）时， 增量式迭代命令通常会无视 COUNT 选项指定的值， 在第一次迭代就将数据集包含的所有元素都返回给用户。  
并非每次迭代都要使用相同的 COUNT 值。  
用户可以在每次迭代中按自己的需要随意改变 COUNT 值， 只要记得将上次迭代返回的游标用到下次迭代里面就可以了。

MATCH 选项  
和 KEYS 命令一样， 增量式迭代命令也可以通过提供一个 glob 风格的模式参数， 让命令只返回和给定模式相匹配的元素， 这一点可以通过在执行增量式迭代命令时， 通过给定 MATCH pattern 参数来实现。

以下是一个使用 MATCH 选项进行迭代的示例：

redis 127.0.0.1:6379> sadd myset 1 2 3 foo foobar feelsgood  
(integer) 6

redis 127.0.0.1:6379> sscan myset 0 match f\*  
1) “0”  
2) 1) “foo”  
2) “feelsgood”  
3) “foobar”  
需要注意的是， 对元素的模式匹配工作是在命令从数据集中取出元素之后， 向客户端返回元素之前的这段时间内进行的， 所以如果被迭代的数据集中只有少量元素和模式相匹配， 那么迭代命令或许会在多次执行中都不返回任何元素。

以下是这种情况的一个例子：

redis 127.0.0.1:6379> scan 0 MATCH *11*  
1) “288”  
2) 1) “key:911”

redis 127.0.0.1:6379> scan 288 MATCH *11*  
1) “224”  
2) (empty list or set)

redis 127.0.0.1:6379> scan 224 MATCH *11*  
1) “80”  
2) (empty list or set)

redis 127.0.0.1:6379> scan 80 MATCH *11*  
1) “176”  
2) (empty list or set)

redis 127.0.0.1:6379> scan 176 MATCH *11* COUNT 1000  
1) “0”  
2) 1) “key:611”  
2) “key:711”  
3) “key:118”  
4) “key:117”  
5) “key:311”  
6) “key:112”  
7) “key:111”  
8) “key:110”  
9) “key:113”  
10) “key:211”  
11) “key:411”  
12) “key:115”  
13) “key:116”  
14) “key:114”  
15) “key:119”  
16) “key:811”  
17) “key:511”  
18) “key:11”  
如你所见， 以上的大部分迭代都不返回任何元素。

在最后一次迭代， 我们通过将 COUNT 选项的参数设置为 1000 ， 强制命令为本次迭代扫描更多元素， 从而使得命令返回的元素也变多了。

并发执行多个迭代  
在同一时间， 可以有任意多个客户端对同一数据集进行迭代， 客户端每次执行迭代都需要传入一个游标， 并在迭代执行之后获得一个新的游标， 而这个游标就包含了迭代的所有状态， 因此， 服务器无须为迭代记录任何状态。

中途停止迭代  
因为迭代的所有状态都保存在游标里面， 而服务器无须为迭代保存任何状态， 所以客户端可以在中途停止一个迭代， 而无须对服务器进行任何通知。

即使有任意数量的迭代在中途停止， 也不会产生任何问题。

使用错误的游标进行增量式迭代  
使用间断的（broken）、负数、超出范围或者其他非正常的游标来执行增量式迭代并不会造成服务器崩溃， 但可能会让命令产生未定义的行为。

未定义行为指的是， 增量式命令对返回值所做的保证可能会不再为真。

只有两种游标是合法的：

在开始一个新的迭代时， 游标必须为 0 。  
增量式迭代命令在执行之后返回的， 用于延续（continue）迭代过程的游标。  
迭代终结的保证  
增量式迭代命令所使用的算法只保证在数据集的大小有界（bounded）的情况下， 迭代才会停止， 换句话说， 如果被迭代数据集的大小不断地增长的话， 增量式迭代命令可能永远也无法完成一次完整迭代。

从直觉上可以看出， 当一个数据集不断地变大时， 想要访问这个数据集中的所有元素就需要做越来越多的工作， 能否结束一个迭代取决于用户执行迭代的速度是否比数据集增长的速度更快。

可用版本：

2.8.0及以上

返回值：

SCAN 命令、 SSCAN 命令、 HSCAN 命令和 ZSCAN 命令都返回一个包含两个元素的 multi-bulk 回复： 回复的第一个元素是字符串表示的无符号 64 位整数（游标）， 回复的第二个元素是另一个 multi-bulk 回复， 这个 multi-bulk 回复包含了本次被迭代的元素。

SCAN 命令返回的每个元素都是一个数据库键。

SSCAN 命令返回的每个元素都是一个集合成员。

HSCAN 命令返回的每个元素都是一个键值对，一个键值对由一个键和一个值组成。

ZSCAN 命令返回的每个元素都是一个有序集合元素，一个有序集合元素由一个成员（member）和一个分值（score）组成