mWrite #

Available since 1.8.0

Create or replace multiple documents directly into the storage engine.

This is a low level route intended to bypass Kuzzle actions on document creation, notably:

check document validity,
add kuzzle metadata,
trigger realtime notifications (unless asked otherwise)

Query Syntax #

HTTP #

URL: http://kuzzle:7512/<index>/<collection>/_mWrite[?refresh=wait_for][&notify]
Method: POST
Body:

{
  "documents": [
    {
      "_id": "<documentId>",
      "body": {
        // document content
      }
    },
    {
      "_id": "<anotherDocumentId>",
      "body": {
        // document content
      }
    }
  ]
}

Other protocols #

{
  "index": "<index>",
  "collection": "<collection>",
  "controller": "bulk",
  "action": "mWrite",

  "notify": "<boolean>",
  "body": {
    "documents": [
      {
        "_id": "<documentId>",
        "body": {
          // document content
        }
      },
      {
        "_id": "<anotherDocumentId>",
        "body": {
          // document content
        }
      }
    ]
  }
}

Arguments #

collection: data collection
index: data index

Optional: #

notify: if set to true, Kuzzle will trigger realtime notifications
refresh: if set to wait_for, Kuzzle will not respond until the created/replaced documents are indexed

Body properties #

documents: an array of object. Each object describes a document to create or replace, by exposing the following properties:
- _id: document unique identifier
- body: document content

Response #

Returns a hits array, containing the list of created documents, in the same order than the one provided in the query.

Each created document is an object with the following properties:

_id: created document unique identifier
_source: document content
_version: version number of the document
created: a boolean telling whether a document is created

If one or more document creations fail, the response status is set to 206, and the error object contains a partial error error.

Example #

{
  "status": 200,
  "error": null,
  "index": "<index>",
  "collection": "<collection>",
  "action": "mWrite",
  "controller": "bulk",
  "requestId": "<unique request identifier>",
  "result": {
    "hits": [
      {
        "_id": "<documentId>",
        "_source": {
          // document content
        },
        "_version": 2,
        "created": false
      },
      {
        "_id": "<anotherDocumentId>",
        "_source": {
          // document content
        },
        "_version": 1,
        "created": true
      }
    ],
    "total": 2
  }
}

Edit this page on Github