summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/hincrby.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/hincrby.md')
-rw-r--r--iredis/data/commands/hincrby.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/iredis/data/commands/hincrby.md b/iredis/data/commands/hincrby.md
new file mode 100644
index 0000000..71f53cb
--- /dev/null
+++ b/iredis/data/commands/hincrby.md
@@ -0,0 +1,22 @@
+Increments the number stored at `field` in the hash stored at `key` by
+`increment`. If `key` does not exist, a new key holding a hash is created. If
+`field` does not exist the value is set to `0` before the operation is
+performed.
+
+The range of values supported by `HINCRBY` is limited to 64 bit signed integers.
+
+@return
+
+@integer-reply: the value at `field` after the increment operation.
+
+@examples
+
+Since the `increment` argument is signed, both increment and decrement
+operations can be performed:
+
+```cli
+HSET myhash field 5
+HINCRBY myhash field 1
+HINCRBY myhash field -1
+HINCRBY myhash field -10
+```