truncate( )
Removes all items from a collection.
Description
The truncate()
function returns a Promise that resolves
after all items have been removed from the specified collection.
truncate()
runs when at least one of the following is true:
- The current user is the site owner.
- The request is performed in backend code with a
suppressAuth
options value oftrue
.
Calling the truncate()
function does not trigger any hooks.
Note:
truncate()
also clears multiple-item reference fields in collections referenced by the specified collection. For example, suppose you have a Movies collection with an Actors field that contains multiple references to items in a People collection. Truncating the Movies collection also clears the data in the corresponding multiple-item reference field in the People collection.
Syntax
function truncate(collectionId: string, [options: WixDataOptions]): Promise<null>
truncate Parameters
NAME
TYPE
DESCRIPTION
The ID of the collection to remove items from.
To find your collectionId
, select the Databases tab in the Velo Sidebar.
Hover over your collection, click the three dots, and select Edit Settings.
An object containing options you can use when calling this function.
Returns
Fulfilled - When the items have been removed. Rejected - The error that caused the rejection.
Return Type:
Was this helpful?
1import wixData from 'wix-data';23// ...45wixData.truncate("myCollection")6 .then(() => {7 console.log("All items removed");8 })9 .catch((err) => {10 console.log(err);11 });
1import wixData from 'wix-data';23// ...45let options = {6 "suppressAuth": true7};89wixData.truncate("myCollection", options)10 .then(() => {11 console.log("All items removed");12 })13 .catch((err) => {14 console.log(err);15 });