summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/acl-load.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/acl-load.md')
-rw-r--r--iredis/data/commands/acl-load.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/iredis/data/commands/acl-load.md b/iredis/data/commands/acl-load.md
new file mode 100644
index 0000000..3892bb4
--- /dev/null
+++ b/iredis/data/commands/acl-load.md
@@ -0,0 +1,27 @@
+When Redis is configured to use an ACL file (with the `aclfile` configuration
+option), this command will reload the ACLs from the file, replacing all the
+current ACL rules with the ones defined in the file. The command makes sure to
+have an _all or nothing_ behavior, that is:
+
+- If every line in the file is valid, all the ACLs are loaded.
+- If one or more line in the file is not valid, nothing is loaded, and the old
+ ACL rules defined in the server memory continue to be used.
+
+@return
+
+@simple-string-reply: `OK` on success.
+
+The command may fail with an error for several reasons: if the file is not
+readable, if there is an error inside the file, and in such case the error will
+be reported to the user in the error. Finally the command will fail if the
+server is not configured to use an external ACL file.
+
+@examples
+
+```
+> ACL LOAD
++OK
+
+> ACL LOAD
+-ERR /tmp/foo:1: Unknown command or category name in ACL...
+```