Simple implementation of soft delete using repository pattern (Ecto Repo).
- this package can be installed by adding
soft_repoto your list of dependencies inmix.exs:
def deps do
[
{:soft_repo, "~> 0.2.0"}
]
end- Configure
soft_repoto use your application repo inconfig/config.exs:
config :soft_repo, repo: YourApplicationName.Repo- Migrations for schemas to add support for soft deletion, add soft_repo_column() when creating/modifing a table
defmodule MyApp.Repo.Migrations.CreateWhatever do
use Ecto.Migration
def change do
create table(:whatever) do
add(:my_field, :string)
add(:my_other_field, :string)
timestamps()
SoftRepo.Migration.soft_repo_column()
end
end
end- Schema
Import SoftRepo.Schema into your module, then add soft_repo_schema() to your schema block:
defmodule Whatever do
use Ecto.Schema
import SoftRepo.Schema
schema "users" do
field(:email, :string)
soft_repo_schema()
end
end- Queries Now you can call
SoftRepogobally or alias to yourRepo
SoftRepo.get(MyApp.User, 1) # will return nil if record is in soft delete state
SoftRepo.get(MyApp.User, 1, with_thrash: true) # will return the soft deleted record
SoftRepo.all(MyApp.User) # will exclude soft deleted records
SoftRepo.all(MyApp.User, with_thrash: true) # will include soft deleted records
SoftRepo.delete(user) # will update the deleted_at column
SoftRepo.delete(user, force: true) # will permanently delete the record
SoftRepo.delete_all(MyApp.User) # will updated the deleted_at columns
SoftRepo.delete_all(MyApp.User, force: true) # will permanently delete all records
SoftRepo.restore(MyApp.User, 1) # will restore back the soft deleted record- Pagination, to do pagination (using scrivener) I added a function to use in your
Repoinjected pagination:
SoftRepo.paginate(MyApp.User) # will exclude soft deleted records paginated- Use Metaprogramming to change from set config Repo to inject into a module.
- Support associations, like
has_many(:whatevers, on_delete: :soft_delete)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent