Railsでparanoiaを使って論理削除を実装する

はじめに

はじめまして！エンジニアの こぼり と申します。今回はRailsでparanoiaを使った論理削除の実装について説明します！
paranoiaのGitHubを参照して書きました！

物理削除と論理削除

物理削除とはDB上からデータを削除すること指し、一方で論理削除とは表面上データを削除したようにみせるが、DB上ではデータを残しておくことをいいます。

paranoia の導入

gemのインストール

Gemfileに以下のように記述し、

 gem 'paranoia'

bundleコマンドでgemをインストールします。

 $ bundle install

カラムの追加

以下のコマンドを実行すると…

 $ rails g migration AddDeletedAtToUsers deleted_at:datetime:index

マイグレーションファイルが生成されます。
今回はUserモデルを例に説明を進めていきます。

 class AddDeletedAtToUsers < ActiveRecord::Migration[6.0]
def change
add_column :users, :deleted_at, :datetime
add_index :users, :deleted_at
end
end

マイグレーションを実行します。

 $ rails db:migrate

acts_as_paranoidの記述

論理削除を適用したいテーブルのモデルファイルにacts_as_paranoidを記述します。

 class User < ApplicationRecord
acts_as_paranoid
end

これで準備はOKです！

paranoia の使い方

基本的な動き

railsコンソールに入ってみましょう！

 $ rails c

ユーザを2人作成し確認します。

> User.create(name: "test1")
> User.create(name: "test2")
> User.all

ユーザが2人作成されました。

 => User id: 1, name: "test1", created_at: "2019-09-04 08:25:06", updated_at: "2019-09-04 08:35:53", deleted_at: nil
User id: 2, name: "test2", created_at: "2019-09-04 08:36:10", updated_at: "2019-09-04 08:36:10", deleted_at: nil

ID が1 のユーザデータを取得して削除を実行します。

 > user = User.find(1)
> user.destroy
> User.all

再びユーザを取得してみるとID：1 のユーザが削除されていることがわかります。

 => User id: 2, name: "test2", created_at: "2019-09-04 08:36:10", updated_at: "2019-09-04 08:36:10", deleted_at: nil

実際のDBを見てみるとDB上はデータが残ってます。この状態を「論理削除」といいます。
さきほどdeleteを実行したid：1のユーザのレコードを見てましょう。今回新しく追加した「deleted_at カラム」にdeleteを実行した日時が入っています。paranoiaはこのカラムを元に削除の判定をしていることがわかります。

元に戻したい

クラスとインスタンスそれぞれから論理削除したデータを元に戻すことができます。
コンソールから下記コマンドを実行するとdelete_at カラムがnullで更新され、対象データが元に戻ります！

 > user.restore

クラスから実行する場合にはIDを指定して実行します。

 > User.restore(1)

削除分も含めたデータ取得

以下のコマンドで論理削除されたデータも含めたデータ検索をすることができます。

 > User.with_deleted

削除したデータのみ取得

論理削除されたデータのみを取得することもできます。
たとえば、「削除済み一覧」を作りたい場合に活用できそうです。

 > User.only_deleted

削除したデータを除いて取得

下記コマンドでは、論理削除されたデータを除いて取得することができ、
User.allと同じ結果が得られます。

 > User.without_deleted

物理削除したい！

下記コマンドでDB上から完全に削除することができます。
元に戻すことができないため使う際には十分に注意が必要です。

 > user.really_destroy!

まとめ

論理削除を実装するgem、paranoia の使い方を見てきました。
データを削除したいけどリストアできる状態にしておきたい時に最適なgemです！
使い方は簡単だと思いますので、ぜひ使ってみてください！