| code | type | title | description |
|---|---|---|---|
true |
page |
update |
Update a document |
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.
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 |
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 |
silent |
boolean ( false) |
If true, then Kuzzle will not generate notifications |
source |
boolean ( false) |
If true, returns the updated document inside the response |
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 |
Resolves to an object containing the document update result.
<<< ./snippets/update.js