View Source Bonfire.Common.Repo.Delete (Bonfire v0.9.11-social-beta.6)

Helpers for deleting Ecto data

Summary

Functions

deletion_result(other)

deletion_result!(arg)

hard_delete(it)

Actually deletes an entry from the database.

hard_delete!(it)

Actually deletes an entry from the database, or throws an error.

schema(it)

soft_delete(it)

Marks an entry as deleted in the database.

soft_delete!(it)

Marks an entry as deleted in the database or throws an error.

soft_delete_changeset(it, column \\ :deleted_at, value \\ DateTime.utc_now(), error \\ "was already deleted")

Creates a changeset for marking an entity as deleted.

undelete(it)

Marks an entry as not deleted.

Functions

deletion_result(other)

deletion_result!(arg)

hard_delete(it)

@spec hard_delete(any()) :: {:ok, any()} | {:error, :deletion_error}

Actually deletes an entry from the database.

Examples

iex> hard_delete(some_entry)
{:ok, some_entry}

iex> hard_delete(non_existent_entry)
{:error, :deletion_error}

hard_delete!(it)

@spec hard_delete!(any()) :: any()

Actually deletes an entry from the database, or throws an error.

Examples

iex> hard_delete!(some_entry)
some_entry

iex> hard_delete!(non_existent_entry)
** (RuntimeError) :deletion_error

schema(it)

soft_delete(it)

@spec soft_delete(any()) :: {:ok, any()} | {:error, :deletion_error}

Marks an entry as deleted in the database.

Examples

iex> soft_delete(some_entry)
{:ok, some_entry}

iex> soft_delete(non_existent_entry)
{:error, :deletion_error}

soft_delete!(it)

@spec soft_delete!(any()) :: any()

Marks an entry as deleted in the database or throws an error.

Examples

iex> soft_delete!(some_entry)
some_entry

iex> soft_delete!(non_existent_entry)
** (RuntimeError) :deletion_error

soft_delete_changeset(it, column \\ :deleted_at, value \\ DateTime.utc_now(), error \\ "was already deleted")

Creates a changeset for marking an entity as deleted.

Examples

iex> soft_delete_changeset(some_entry)
%Ecto.Changeset{...}

iex> soft_delete_changeset({SomeSchema, some_entry}, :deleted_at, nil, "was already deleted")
%Ecto.Changeset{...}

undelete(it)

Marks an entry as not deleted.

Examples

iex> undelete(some_entry)
{:ok, some_entry}

iex> undelete(non_existent_entry)
{:error, :deletion_error}