replace #

Replaces the content of an existing document.

replace(index, collection, id, document, [options]);

Argument	Type	Description
`index`	string	Index name
`collection`	string	Collection name
`id`	string	Document ID
`document`	object	New content of the document to update
`options`	object	Query options

Options #

Additional query options

Options	Type (default)	Description
`queuable`	boolean (`true`)	If `true`, queues the request during downtime, until connected to Kuzzle again
`refresh`	string (`""`)	If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s)
`silent`	boolean (`false`)	If `true`, then Kuzzle will not generate notifications Available since 7.5.3
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolves #

Resolves to an object containing the the document update result.

Name	Type	Description
_id	string	ID of the newly created document
_version	number	Version of the document in the persistent data storage
_source	object	The updated document

Usage #

const doc = { color: 'yellow' };
try {
  await kuzzle.document.create('nyc-open-data', 'yellow-taxi', doc, 'some-id');
  const response = await kuzzle.document.replace(
    'nyc-open-data',
    'yellow-taxi',
    'some-id',
    { capacity: 4, category: 'sedan' }
  );
  console.log(response);
  /*
  { _id: 'some-id',
    _version: 2,
    _source:
    { capacity: 4,
      category: 'sedan',
      _kuzzle_info:
        { author: '-1',
          createdAt: 1538654776456,
          updatedAt: 1538654776456,
          updater: '-1' } } }
  */
  console.log('Success');
} catch (error) {
  console.error(error.message);
}

Edit this page on Github