Core
Framework v2.x
2

update() #

Updates parts of a document's content.

Arguments #

Copied to clipboard!
update(document: JSONObject, options?: JSONObject): Promise<JSONObject>;

Arguments Type Description
document
JSONObject
Parts of the document to update. The provided object must contain a _id property, which is the document unique identifier
options
JSONObject
Optional arguments

options #

The options argument accepts the following parameters:

Options Type Description
refresh
string
If set with the wait_for string value, then the function will respond only after the document has been indexed

Return #

The update function returns a promise , resolving to the document update result.

Example #

Copied to clipboard!
const content = {
  _id: '<unique id>',
  someField: 'some content',
  anotherField: 'another content'
};

const result = await repository.update(content);
/*
  * { _index: '%<plugin name>',
  *   _type: '<collection>',
  *   _id: '<a unique id>',
  *   _version: 1,
  *   result: 'updated',
  *   _shards: { total: 2, successful: 1, failed: 0 },
  *   _source: {
  *     someField: 'some content',
  *     anotherField: 'another content'
  *   }
  * }
  */