truncate #
Removes all documents from a collection, while keeping the associated mapping.
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 #
try {
await kuzzle.collection.truncate('nyc-open-data', 'yellow-taxi');
console.log('Success');
} catch (error) {
console.error(error.message);
}
Edit this page on Github(opens new window)