SDK
SDK Javascript v6.x
1

update #

Updates a document content.

Conflicts may occur if the same document gets updated multiple times within a short timespan, in a database cluster. You can set the retryOnConflict optional argument (with a retry count), to tell Kuzzle to retry the failing updates the specified amount of times before rejecting the request with an error.


Copied to clipboard!
update(index, collection, id, document, [options]);
Argument Type Description
index
string
Index name
collection
string
Collection name
id
string
Document ID
document
object
Partial 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)
retryOnConflict
int

(0)
The number of times the database layer should retry in case of version conflict

Resolves #

Resolves to an object containing the the document update result.

Usage #

Copied to clipboard!
try {
  await kuzzle.document.create(
    'nyc-open-data',
    'yellow-taxi',
    { capacity: 4 },
    'some-id'
  );
  const response = await kuzzle.document.update(
    'nyc-open-data',
    'yellow-taxi',
    'some-id',
    { category: 'suv' }
  );
  console.log(response);
  /*
  { _index: 'nyc-open-data',
    _type: 'yellow-taxi',
    _id: 'some-id',
    _version: 2,
    result: 'updated',
    _shards: { total: 2, successful: 1, failed: 0 } }
  */
} catch (error) {
  console.error(error.message);
}