Redis list类型键相关命令整理

女爷i 2022-04-24 15:22 181阅读 0赞

1.LPUSH  
`LPUSH key value [value ...]`  
在列表key的表头依次插入值，可以依次插入多个，例如LPUSH sam-list a b c，得到的列表值为c,b,a。  
如果 key 不存在，一个空列表会被创建并执行LPUSH 操作。  
当 key 存在但不是列表类型时，返回一个错误。  
执行LPUSH 命令后，返回列表的长度。

2.LPUSHX  
`LPUSHX key value`  
当key是列表时，将value插入到该列表表头；如果key不存在，则不做任何操作。  
LPUSHX 命令执行之后，返回表的长度。

3.RPUSH  
`RPUSH key value [value ...]`  
在列表key的末尾插入值，可以依次插入多个，类似LPUSH。  
如果 key 不存在，一个空列表会被创建并执行RPUSH 操作。  
当 key 存在但不是列表类型时，返回一个错误。  
执行RPUSH 操作后，返回表的长度。

4.RPUSHX  
`RPUSHX key value`  
当key是列表时，将value插入到该列表末尾；如果key不存在，则不做任何操作。  
RPUSHX 命令执行之后，返回表的长度。

5.LPOP  
`LPOP key`  
移除并返回列表key的头元素。  
当 key 不存在时，返回 nil 。

6.RPOP  
`RPOP key`  
移除并返回列表 key 的尾元素。  
当 key 不存在时，返回 nil 。

7.BLPOP  
`BLPOP key [key ...] timeout`  
是LPOP 命令的阻塞版本，当给定列表内没有任何元素可供弹出的时候，连接将被BLPOP 命令阻塞，直到等待超时或发现可弹出元素为止。  
当给定多个 key 参数时，按参数 key 的先后顺序依次检查各个列表，弹出第一个非空列表的头元素。  
当BLPOP 被调用时，如果给定 key 内至少有一个非空列表，那么弹出遇到的第一个非空列表的头元素，并和被弹出元素所属的列表的名字一起，组成结果返回给调用者。  
当存在多个给定 key 时，BLPOP 按给定 key 参数排列的先后顺序，依次检查各个列表。  
如果所有给定 key 都不存在或包含空列表，那么BLPOP 命令将阻塞连接，直到等待超时，或有另一个客户端对给定 key 的任意一个执行LPUSH 或RPUSH 命令为止。  
超时参数 timeout 接受一个以秒为单位的数字作为值。超时参数设为 0 表示阻塞时间可以无限期延长。

8.BRPOP  
`BRPOP key [key ...] timeout`  
参考BLPOP，只是操作的元素位置是列表末尾。

9.RPOPLPUSH  
`RPOPLPUSH source destination`  
命令RPOPLPUSH 在一个原子时间内，执行以下两个动作：  
• 将列表 source 中的最后一个元素 (尾元素) 弹出，并返回给客户端。  
• 将 source 弹出的元素插入到列表 destination ，作为 destination 列表的的头元素。  
如果 source 不存在，值 nil 被返回，并且不执行其他动作。  
如果 source 和 destination 相同，则列表中的表尾元素被移动到表头，并返回该元素，可以把这种特殊情况视作列表的旋转 (rotation) 操作

10.BRPOPLPUSH  
`BRPOPLPUSH source destination timeout`  
RPOPLPUSH的阻塞版本，当source为空时，将阻塞连接，直到等到超时或另一个客户端对列表source插入值。  
超时参数 timeout 接受一个以秒为单位的数字作为值。超时参数设为 0 表示阻塞时间可以无限期延长。  
假如在指定时间内没有任何元素被弹出，则返回一个 nil 和等待时长。  
反之，返回一个含有两个元素的列表，第一个元素是被弹出元素的值，第二个元素是等待时长。

11.LINDEX  
`LINDEX key index`  
返回列表key下标为index的元素，表头下标为0，往后依次递增；也可以从末尾往前，末尾下标为-1，倒数第二个为-2，依次递减。  
如果 key 不是列表类型，返回一个错误。  
如果 index 参数的值不在列表的区间范围内 (out of range)，返回 nil 。

12.LINSERT  
`LINSERT key BEFORE|AFTER pivot value`  
将value插入列表key，位置是在pivot之前或之后。  
当 pivot 不存在于列表 key 时，不执行任何操作。  
当 key 不存在时，key 被视为空列表，不执行任何操作。  
如果 key 不是列表类型，返回一个错误。  
如果命令执行成功，返回插入操作完成之后，列表的长度。  
如果没有找到 pivot ，返回 -1 。  
如果 key 不存在或为空列表，返回 0 。

13.LRANGE  
`LRANGE key start stop`  
返回列表key中偏移量为start到stop区间的元素，包括start和stop的元素，表头为0，第二个为1，末尾为-1，倒数第二个为-1。  
如果 start 下标比列表的最大下标 end ( LLEN list 减去 1 ) 还要大，或者 start > stop ，LRANGE 返回一个空列表。  
如果 stop 下标比 end 下标还要大，Redis 将 stop 的值设置为 end 。

14.LREM  
`LREM key count value`  
移除列表key中count个等于value的元素，  
count 的值可以是以下几种：  
• count > 0 : 从表头开始向表尾搜索，移除与 value 相等的元素，数量为 count 。  
• count < 0 : 从表尾开始向表头搜索，移除与 value 相等的元素，数量为 count 的绝对值。  
• count = 0 : 移除表中所有与 value 相等的值。  
返回移除元素的数量，因为不存在的 key 被视作空表 (empty list)，所以当 key 不存在时，LREM 命令总是返回 0 。

15.LSET  
`LSET key index value`  
将列表 key 下标为 index 的元素的值设置为 value 。  
当 index 参数超出范围，或对一个空列表 ( key 不存在) 进行LSET 时，返回一个错误。  
操作成功返回 ok ，否则返回错误信息。

16.LTRIM  
`LTRIM key start stop`  
对列表key进行裁剪，只保留区间start-stop的元素，包括start和stop。  
当 key 不是列表类型时，返回一个错误。  
超出范围的下标值不会引起错误。  
如果 start 下标比列表的最大下标 end ( LLEN list 减去 1 ) 还要大，或者 start > stop ，LTRIM 返回  
一个空列表 (因为LTRIM 已经将整个列表清空)。  
如果 stop 下标比 end 下标还要大，Redis 将 stop 的值设置为 end 。