Unknown SDK


Replace the provided Documents.

mReplaceDocument(documents, [options], [callback])

Arguments Type Description
documents Document[] Array of Document to replace
options JSON Object Optional parameters
callback function Optional callback


Option Type Description Default
queuable boolean Make this request queuable or not true

Return Value

Returns the Collection object to allow chaining.

Callback Response

Returns a JSON object containing the raw Kuzzle response. Can return a 206 partial error in cases where documents could not be replaced.


Copied to clipboard!
use \Kuzzle\Kuzzle;
use \Kuzzle\Document;
$kuzzle = new Kuzzle('localhost');
$dataCollection = $kuzzle->collection('collection', 'index');
$firstDocument = new Document($dataCollection, 'doc1', ['title' => 'foo', 'content' => 'bar']);
$secondDocument = new Document($dataCollection, 'doc2', ['title' => 'foo', 'content' => 'bar']);
try {
  $result = $dataCollection->mReplaceDocument([$firstDocument, $secondDocument]);
catch (ErrorException $e) {

Callback response:

Copied to clipboard!
  "hits": [{ "first": "document" }, { "second": "document" }],
  "total": 2