Core
API v1.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

hincrbyfloat #

Increments the number stored in a hash field by the provided float value.

[Redis documentation]


Query Syntax #

HTTP #

Copied to clipboard!
URL: http://kuzzle:7512/ms/_hincrbyfloat/<_id>
Method: POST
Body:
Copied to clipboard!
{
  "field": "field name",
  "value": <increment float value>
}

Other protocols #

Copied to clipboard!
{
  "controller": "ms",
  "action": "hincrbyfloat",
  "_id": "<key>",
  "body": {
    "field": "field name",
    "value": <increment float value>
  }
}

Arguments #

  • _id: hash key identifier

Body properties #

  • field: the hash field to increment
  • value: the float to add to the field value

Response #

Returns the updated value for the incremented hash field.

Copied to clipboard!
{
  "requestId": "<unique request identifier>",
  "status": 200,
  "error": null,
  "controller": "ms",
  "action": "hincrbyfloat",
  "collection": null,
  "index": null,
  "result": "3.14159"
}

Increments the number stored in a hash field by the provided float value.

[Redis documentation]