summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/script-debug.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/script-debug.md')
-rw-r--r--iredis/data/commands/script-debug.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/iredis/data/commands/script-debug.md b/iredis/data/commands/script-debug.md
new file mode 100644
index 0000000..67502b2
--- /dev/null
+++ b/iredis/data/commands/script-debug.md
@@ -0,0 +1,26 @@
+Set the debug mode for subsequent scripts executed with `EVAL`. Redis includes a
+complete Lua debugger, codename LDB, that can be used to make the task of
+writing complex scripts much simpler. In debug mode Redis acts as a remote
+debugging server and a client, such as `redis-cli`, can execute scripts step by
+step, set breakpoints, inspect variables and more - for additional information
+about LDB refer to the [Redis Lua debugger](/topics/ldb) page.
+
+**Important note:** avoid debugging Lua scripts using your Redis production
+server. Use a development server instead.
+
+LDB can be enabled in one of two modes: asynchronous or synchronous. In
+asynchronous mode the server creates a forked debugging session that does not
+block and all changes to the data are **rolled back** after the session
+finishes, so debugging can be restarted using the same initial state. The
+alternative synchronous debug mode blocks the server while the debugging session
+is active and retains all changes to the data set once it ends.
+
+- `YES`. Enable non-blocking asynchronous debugging of Lua scripts (changes are
+ discarded).
+- `SYNC`. Enable blocking synchronous debugging of Lua scripts (saves changes to
+ data).
+- `NO`. Disables scripts debug mode.
+
+@return
+
+@simple-string-reply: `OK`.