Redis脚本

Redis脚本

Redis脚本使用Lua解释器来执行脚本。Redis 2.6版本通过通过内嵌支持Lua环境。执行脚本的常用命令为EVAL。

---

eval script numkeys key [key…] arg [arg….]

描述:EVAL命令使用Lua解释器执行脚本

参数说明:

script:参数是一段Lua 5.1脚本程序，脚本不必(也不应该)定义为一个Lua函数

numkeys:用于指定键名参数的个数

key[key…]:从EVAL的第三个参数开始算起,表示在脚本中所用到的那些Redis键(key)，这些键名参数可以在Lua中通过全局变量Keys数组,用1为基址的形式访问（keys[1], keys[2], keys[3]，以此类推）

arg[arg …]：附加参数,在Lua中通过全局变量ARGV数组访问，访问的形式和keys变量类似(ARGV[1],ARGV[2],诸如此类)

127.0.0.1:6379> eval "return {KEYS[1], KEYS[2], ARGV[1], ARGV[2]}" 2 key1 key2  first second
1) "key1"
2) "key2"
3) "first"
4) "second"

---

evalsha sha1 numkeys key[key…] arg[arg…]

描述:Evalsha命令根据给定的sha1校验码,执行缓存在服务器中的脚本，将脚本缓存到服务器的操作可以通过script load命令进行

参数说明:

sha1:通过script load生产的sha1校验码

numkeys:用于指定键名参数的个数

key [key…]:从EVAL的第三个参数开始算起,表示在脚本中所用到的那些Redis键(key)，这些键名参数可以在Lua中通过全局变量Keys数组,用1为基址的形式访问（keys[1], keys[2], keys[3]，以此类推

arg[arg …]：附加参数,在Lua中通过全局变量ARGV数组访问，访问的形式和keys变量类似(ARGV[1],ARGV[2],诸如此类)

127.0.0.1:6379> script load "return 'hello moto'"
"232fd51614574cf0867b83d384a5e898cfd24e5a"
127.0.0.1:6379> evalsha "232fd51614574cf0867b83d384a5e898cfd24e5a" 0
"hello moto"

---

script exists script [script …]

描述:查看指定的脚本是否已经被保存在缓存当中

返回值:一个列表,包含0和1,前者表示脚本不存于缓存,后者表示脚本已经在缓存之中

# 载入一个脚本
127.0.0.1:6379> script load "return 'hello world'"
"5332031c6b470dc5a0dd9b4bf2030dea6d65de91"
127.0.0.1:6379> script exists 5332031c6b470dc5a0dd9b4bf2030dea6d65de91
1) (integer) 1
# 清空缓存
127.0.0.1:6379> script flush
OK
127.0.0.1:6379> script exists 5332031c6b470dc5a0dd9b4bf2030dea6d65de91
1) (integer) 0

---

script flush

描述:用于清除所有Lua脚本缓存

返回值:总是返回OK

127.0.0.1:6379> script flush
OK

---

script kill

描述:用于杀死当前正在运行的Lua脚本,当且仅当这个脚本没有执行过任何写操作，这个命令才生效。这个命令主要用于终止运行时间过长的脚本，比如一个因为bug而发生无限循环的脚本。script kill执行之后，当前运行的脚本会被杀死，执行这个脚本的客户端会从eval命令阻塞当中退出，并收到一个错误作为返回值.

返回值:总是返回OK

127.0.0.1:6379> SCRIPT KILL
OK

---

script load script

描述:用于将脚本script添加到脚本缓存中，但并不立即执行这个脚本。eval命令也会将脚本添加脚本缓存中，但是它会立即对输入的脚本进行求值。如果给定的脚本已经在缓存里面了，那么不执行任何操作。在脚本被加入到缓存之后，通过evalsha命令，可以使用脚本的sha1校验和来调用这个脚本。脚本可以在缓存中保留无限长的时间，直到执行script flush为止

返回值:给定脚本的sha1校验和

127.0.0.1:6379> script load "return 1"
"e0e1f9fabfc9d4800c877a703b823ac0578ff8db"
127.0.0.1:6379> evalsha "e0e1f9fabfc9d4800c877a703b823ac0578ff8db" 0
(integer) 1