updateSpecifications #

Creates or updates the validation specifications for a collection.

When the validation specification is not formatted correctly, a detailed error message is returned to help you to debug.

updateSpecifications(index, collection, specifications, [options]);

Arguments	Type	Description
`index`	string	Index name
`collection`	string	Collection name
`specifications`	object	Specifications to update
`options`	object	Query options

specifications #

An object representing the specifications.

This object must follow the Specification Structure:

{
  strict: <boolean>,
  fields: {
    // ... specification for each field
  }
}

options #

Additional query options

Property	Type (default)	Description
`queuable`	boolean (`true`)	If `true`, queues the request during downtime, until connected to Kuzzle again
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolves #

Resolve to an object containing the specifications.

Usage #

const specifications = {
  strict: false,
  fields: {
    license: {
      mandatory: true,
      type: 'string'
    }
  }
};
try {
  const result = await kuzzle.collection.updateSpecifications('nyc-open-data', 'yellow-taxi', specifications);
  console.log(result);
  /*
    { strict: false,
      fields: {
        license: {
          mandatory: true,
          type: 'string' } } }
  */
  console.log('Success');
} catch (error) {
  console.error(error.message);
}

Edit this page on Github