delete #

Deletes fields of an existing document.

The optional parameter refresh can be used with the value wait_for in order to wait for the document to be indexed (and to no longer be available in search).

Copied to clipboard!

deleteFields (index, collection, id, fields, [options]);

Argument	Type	Description
index	string	Index name
collection	string	Collection name
id	string	Document ID
fields	string[]	Path of fields to delete
options	object	Query options

Options #

Additional query options

Options	Type (default)	Description
queuable	boolean (true)	If true, queues the request during downtime, until connected to Kuzzle again
refresh	string ("")	If set to wait_for, waits for the change to be reflected for search (up to 1s)
silent	boolean (false)	If true, then Kuzzle will not generate notifications Available since 7.5.3
source	boolean (false)	If true, then the response will contain the updated document
timeout	number	Time (in ms) during which a request will still be waited to be resolved. Set it -1 if you want to wait indefinitely

Resolves #

Resolves to updated document.

Usage #

Copied to clipboard!

try {
  const response = await kuzzle.document.deleteFields('nyc-open-data', 'yellow-taxi', 'some-id', ['bar'], {source: true});
  console.log(response._source);
} catch (error) {
  console.error(error.message);
}