replace #

Replaces the content of an existing document.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/<index>/<collection>/<documentId>/_replace[?refresh=wait_for][&silent]
Method: PUT
Body:

{
  // new document content
}

Other protocols #

{
  "index": "<index>",
  "collection": "<collection>",
  "controller": "document",
  "action": "replace",
  "_id": "<documentId>",
  "refresh": "wait_for",
  "body": {
    // new document content
  }
}

Kourou #

kourou document:replace <index> <collection> <id> <body>
kourou document:replace <index> <collection> <id> <body> -a silent=true

Arguments #

collection: collection name
_id: unique ID of the document to replace
index: index name

Optional: #

refresh: if set to wait_for, Kuzzle will not respond until the new document content is indexed
silent: if set, then Kuzzle will not generate notifications
Available since 2.9.2

Body properties #

New document content.

Response #

Returns an object containing updated document information, with the following properties:

_id: document unique identifier
_source: new document content
_version: updated document version number

{
  "status": 200,
  "error": null,
  "index": "<index>",
  "collection": "<collection>",
  "controller": "document",
  "action": "replace",
  "requestId": "<unique request identifier>",
  "result": {
    "_id": "<documentId>",
    "_source": {
      // new document content
    },
    "_version": 13
  }
}

Edit this page on Github