SDK
SDK PHP v3.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

deleteSpecifications #

Delete specifications linked to the collection object.


deleteSpecifications([options], [callback]) #

ArgumentsTypeDescription
optionsJSON objectOptional parameters
callbackfunctionOptional callback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue
refreshstringIf set to wait_for, Kuzzle will wait for the persistence layer indexation to return (available with Elasticsearch 5.x and above)undefined

Return Value #

Returns the Collection object to allow chaining.

Usage #

<?php
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
$dataCollection = $kuzzle->collection('collection', 'index');
// Deleting one document
try {
  $result = $dataCollection->deleteSpecifications();
}
catch (ErrorException $e) {
}

Callback response:

{
  "acknowledged": true
}