replaceDocument

Replace an existing document and return the updated version as a Document object.


replaceDocument(documentId, content, [options], [callback])

Arguments Type Description
documentId string Unique document identifier
content JSON Object Content of the document to create
options JSON Object Optional parameters
callback function Optional callback

Options

Option Type Description Default
volatile JSON Object Additional information passed to notifications to other users null
queuable boolean Make this request queuable or not true
refresh string If set to wait_for, Kuzzle will wait for the persistence layer to finish indexing (available with Elasticsearch 5.x and above) undefined

Return Value

Returns the Collection object to allow chaining.


Callback Response

Returns an updated Document object.

Usage

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
kuzzle
  .collection('collection', 'index')
  .replaceDocument('documentId', {title: 'foo', content: 'bar'}, function (error, result) {
    // result is a Document object
  });

// Using promises (NodeJS)
kuzzle
  .collection('collection', 'index')
  .replaceDocumentPromise('documentId', {title: 'foo', content: 'bar'})
  .then(result => {
    // result is a Document object
  });