Simple way to Implement Soft Delete Active Record feature in Ruby on Rails
Total Blog Views: 130
Blog Status: publish
Created By: nandini Created at: 08-17-2021
Tags: ruby on rails soft delete ruby on rails rails Expert India
Ruby on Rails help do build amazing feature in simpler way. We can easily perform basic Creation and deletion processes in rails.Commonly required feature nowadays is to keep our database records backup.That means records can be deleted for the User interface but should be available in the database.In the future we can restore actual data as per requirement.
In general, soft delete can be handled by adding a deleted flag column and keep checking every time whenever there is a transaction in the table database.
This will be a disorganised way, if we need some customization in the soft delete process , we will have to write extra code.
While implementing this for the first time I found one of the best gem that was fulfilling my requirements. Paranoia gem allows to implement activerecord soft delete feature. Record marked as deleted_at timestamp.
It has a simple integration process.
Install gem: Add gem in Gemfile
gem "paranoia"
Use the gem version based on the rails version. Run bundle install
Add deleted_at to Model
Add deleted_at field in the model in which soft delete requires.
Ex: User model require soft delete add deleted_at column in User model
Migration:
rails generate migration AddDeletedAtToUsers deleted_at:datetime:index
Run the migration:
bundle exec rails db:migrate
Model changes:
Update model by adding acts_as_paranoid to the User model Ex:
class User < ApplicationRecord acts_as_paranoid end
Check Soft Delete:
When we destroy any User, the record will be soft deleted by updating deleted_at column of user model to current timestamp.
user = User.first user.destroy
Scopes provided by Paranoia
Paranoia gem provides some scopes to fetch the soft deleted records.
with_deleted : This scope can be used if we want to search through deleted records as well.
Ex: User.with_deleted.where(post_id: 1)
without_deleted: Scope can be used if we don’t require deleted active records to fetch while query execution.
User.without_deleted.where(post_id: 1)
There are some instance methods available
deleted? : Returns true/false if the record is deleted. restore(ids) : Accepts ids to be restored and marks deleted_at column nil.
Thanks For Reading, If Having Question and Suggestion Please Let me know In comments
Rate Blog :
Share on :
Do you have any blog suggestion? please click on the link