SDK
SDK Javascript v6.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.

truncate #

Removes all documents from a collection, while keeping the associated mapping.


Copied to clipboard!
truncate(index, collection, [options]);

Arguments Type Description
index
string
Index name
collection
string
Collection name
options
object
Query options

options #

Additional query options

Property Type
(default)
Description
queuable
boolean

(true)
If true, queues the request during downtime, until connected to Kuzzle again

Resolves #

Resolves when the collection is successfully truncated.

Usage #

Copied to clipboard!
try {
  await kuzzle.collection.truncate('nyc-open-data', 'yellow-taxi');
  console.log('Success');
} catch (error) {
  console.error(error.message);
}