https://github.com/eldomagan/sails-hook-soft-delete

Add soft delete to sails Waterline ORM
https://github.com/eldomagan/sails-hook-soft-delete

Last synced: 6 months ago
JSON representation

Add soft delete to sails Waterline ORM

• Host: GitHub
• URL: https://github.com/eldomagan/sails-hook-soft-delete
• Owner: eldomagan
• Created: 2019-10-22T07:07:49.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-12T16:10:12.000Z (over 4 years ago)
• Last Synced: 2025-10-05T13:08:08.589Z (9 months ago)
• Language: JavaScript
• Size: 174 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Sails hook soft delete

This hook add soft delete functionality to Waterline ORM

## Installation

```shell

npm install --save sails-hook-soft-delete

```

```shell

# For yarn users

yarn add sails-hook-soft-delete

```

## Usage

### Deleting record

Now the `Model.destroyOne()` method will mark the record as soft-deleted. It set the deletedAt attribute to current date.

If you want to completely remove a record, use the `Model.forceDestroyOne()`method.

You can also use `Model.destroy()` and `Model.forceDestroy()` to soft-delete/delete many record.

### Restoring record

Once a record is soft-deleted, you can restore it using `Model.restoreOne()` /  `Method.restore()` method.

### Quering records

`Model.find()` / `Model.findOne()` will now find record which are not soft-deleted.

If you want to include soft-deleted record, use `Model.findWithTrashed()` method

To get only soft-deleted record, use `Model.findTrashed()` method