Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carakan/soft_repo
ecto repo wrapper that support soft delete record's
https://github.com/carakan/soft_repo
ecto elixir soft-delete
Last synced: about 1 month ago
JSON representation
ecto repo wrapper that support soft delete record's
- Host: GitHub
- URL: https://github.com/carakan/soft_repo
- Owner: carakan
- License: mit
- Created: 2018-09-10T00:47:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-15T04:59:25.000Z (about 6 years ago)
- Last Synced: 2024-09-23T10:47:41.308Z (3 months ago)
- Topics: ecto, elixir, soft-delete
- Language: Elixir
- Homepage:
- Size: 60.5 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/carakan/soft_repo)
[](https://hex.pm/packages/soft_repo)
[](https://opensource.org/licenses/MIT)
# SoftRepo
Simple implementation of soft delete using repository pattern (Ecto Repo).
## Installation
- this package can be installed by adding `soft_repo` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:soft_repo, "~> 0.2.0"}
]
end
```
- Configure `soft_repo` to use your application repo in `config/config.exs`:
```elixir
config :soft_repo, repo: YourApplicationName.Repo
```
- **Migrations** for schemas to add support for soft deletion, add soft_repo_column() when creating/modifing a table
```elixir
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:
```elixir
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 `SoftRepo` gobally or alias to your `Repo`
```elixir
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 `Repo` injected pagination:
```elixir
SoftRepo.paginate(MyApp.User) # will exclude soft deleted records paginated
```
## Inspiration
- [Gist](https://gist.github.com/ahmadshah/83a695ac66d98a833d6d576815e6931d)
- [ecto_soft_delete](https://github.com/revelrylabs/ecto_soft_delete)
## TODO's
- [ ] Use Metaprogramming to change from set config Repo to inject into a module.
- [ ] Support associations, like `has_many(:whatevers, on_delete: :soft_delete)`