summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/script-kill.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/script-kill.md')
-rw-r--r--iredis/data/commands/script-kill.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/iredis/data/commands/script-kill.md b/iredis/data/commands/script-kill.md
new file mode 100644
index 0000000..225798b
--- /dev/null
+++ b/iredis/data/commands/script-kill.md
@@ -0,0 +1,19 @@
+Kills the currently executing Lua script, assuming no write operation was yet
+performed by the script.
+
+This command is mainly useful to kill a script that is running for too much
+time(for instance because it entered an infinite loop because of a bug). The
+script will be killed and the client currently blocked into EVAL will see the
+command returning with an error.
+
+If the script already performed write operations it can not be killed in this
+way because it would violate Lua script atomicity contract. In such a case only
+`SHUTDOWN NOSAVE` is able to kill the script, killing the Redis process in an
+hard way preventing it to persist with half-written information.
+
+Please refer to the `EVAL` documentation for detailed information about Redis
+Lua scripting.
+
+@return
+
+@simple-string-reply