code | type | title | description |
---|---|---|---|
true |
page |
mCreateOrReplace |
Create or replace documents |
Creates or replaces multiple documents.
mCreateOrReplace(index, collection, documents, [options]);
Argument | Type | Description |
---|---|---|
index |
string |
Index name |
collection |
string |
Collection name |
documents |
object[] |
Array of documents to create |
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) |
silent |
boolean ( false ) |
If true , then Kuzzle will not generate notifications |
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 |
Returns an object containing 2 arrays: successes
and errors
Each created or replaced document is an object of the successes
array with the following properties:
Name | Type | Description |
---|---|---|
_id |
string |
Document ID |
_version |
number |
Version of the document in the persistent data storage |
_source |
object |
Document content |
created |
boolean |
True if the document was created |
Each errored document is an object of the errors
array with the following properties:
Name | Type | Description |
---|---|---|
document |
object |
Document that cause the error |
status |
number |
HTTP error status |
reason |
string |
Human readable reason |
<<< ./snippets/m-create-or-replace.js