summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/hincrbyfloat.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2020-03-21 10:28:17 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-02-07 11:16:53 +0000
commit06cba6ccd165ca8b224797e37fccb9e63f026d77 (patch)
treee82f1bc439997ae296f2e74f8a64d84c5d95f140 /iredis/data/commands/hincrbyfloat.md
parentInitial commit. (diff)
downloadiredis-06cba6ccd165ca8b224797e37fccb9e63f026d77.tar.xz
iredis-06cba6ccd165ca8b224797e37fccb9e63f026d77.zip
Adding upstream version 1.9.1.upstream/1.9.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'iredis/data/commands/hincrbyfloat.md')
-rw-r--r--iredis/data/commands/hincrbyfloat.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/iredis/data/commands/hincrbyfloat.md b/iredis/data/commands/hincrbyfloat.md
new file mode 100644
index 0000000..fe58beb
--- /dev/null
+++ b/iredis/data/commands/hincrbyfloat.md
@@ -0,0 +1,33 @@
+Increment the specified `field` of a hash stored at `key`, and representing a
+floating point number, by the specified `increment`. If the increment value is
+negative, the result is to have the hash field value **decremented** instead of
+incremented. If the field does not exist, it is set to `0` before performing the
+operation. An error is returned if one of the following conditions occur:
+
+- The field contains a value of the wrong type (not a string).
+- The current field content or the specified increment are not parsable as a
+ double precision floating point number.
+
+The exact behavior of this command is identical to the one of the `INCRBYFLOAT`
+command, please refer to the documentation of `INCRBYFLOAT` for further
+information.
+
+@return
+
+@bulk-string-reply: the value of `field` after the increment.
+
+@examples
+
+```cli
+HSET mykey field 10.50
+HINCRBYFLOAT mykey field 0.1
+HINCRBYFLOAT mykey field -5
+HSET mykey field 5.0e3
+HINCRBYFLOAT mykey field 2.0e2
+```
+
+## Implementation details
+
+The command is always propagated in the replication link and the Append Only
+File as a `HSET` operation, so that differences in the underlying floating point
+math implementation will not be sources of inconsistency.