SDK
SDK Javascript v7.x
2

mCreate #

Creates multiple documents.


Copied to clipboard!
mCreate(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

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

Resolves #

Returns an object containing 2 arrays: successes and errors

Each created 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

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

Usage #

Copied to clipboard!
try {
  const documents = [
    {
      _id: 'some-id',
      body: { 'capacity': 4 }
    },
    {
      body: { this: 'document id is auto-computed' }
    }
  ];
  const response = await kuzzle.document.mCreate(
    'nyc-open-data',
    'yellow-taxi',
    documents
  );
  console.log(response);
  /*
  {
    "successes": [
      {
        "_id": "some-id",
        "_version": 1,
        "result": "created",
        "created": true,
        "status": 200,
        "_source": {
          "_kuzzle_info": {
            "author": "-1",
            "updater": null,
            "updatedAt": null,
            "createdAt": 1542036563677
          },
          "capacity": 4
        }
      },
      {
        "_id": "AWcIiqbeBiYFF8kkRLKg",
        "_version": 1,
        "result": "created",
        "created": true,
        "status": 200,
        "_source": {
          "_kuzzle_info": {
            "author": "-1",
            "updater": null,
            "updatedAt": null,
            "createdAt": 1542036563677
          },
          "this": "document id is auto-computed"
        }
      }
    ],
    "errors": []
  }
  */
  console.log(`Successfully created ${response.successes.length} documents`);
} catch (error) {
  console.error(error.message);
}