SDK PHP v3.x

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]) #

Arguments Type Description
options JSON object Optional parameters
callback function Optional callback

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true
refresh string If 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 #

Copied to clipboard!
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
$dataCollection = $kuzzle->collection('collection', 'index');
// Deleting one document
try {
  $result = $dataCollection->deleteSpecifications();
catch (ErrorException $e) {

Callback response:

Copied to clipboard!
  "acknowledged": true