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.

updateSpecifications #

Update parts of a specification, by replacing some fields or adding new ones.
Note that you cannot remove fields this way: missing fields will simply be left unchanged.

updateSpecifications(content, [options], [callback]) #

Arguments Type Description
content JSON object Content of the specification to update
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 the persistence layer to finish indexing (available with Elasticsearch 5.x and above) undefined
retryOnConflict int Number of retries to attempt before rejecting this update because of a cluster sync conflict 0

Return Value #

Returns the Collection object to allow chaining.

Usage #

Copied to clipboard!
use \Kuzzle\Kuzzle;
$specifications = [
  'strict' => true,
  'fields' => [
    'foo' => [
      'mandatory' => true,
      'type' => 'string',
      'defaultValue' => 'bar'
$kuzzle = new Kuzzle('localhost');
$dataCollection = $kuzzle->collection('collection', 'index');
try {
  // result is an array
  $res = $dataCollection->updateSpecifications($specifications);
catch (ErrorException $e) {

Callback response

Copied to clipboard!
  "index": {
    "collection": {
      "strict": "true",
      "fields": {
        "foo": {
          "mandatory": "true",
          "type": "string",
          "defaultValue": "bar"