chiya/lib/chiya/notes.ex

132 lines
2.1 KiB
Elixir

defmodule Chiya.Notes do
@moduledoc """
The Notes context.
"""
import Ecto.Query, warn: false
alias Chiya.Repo
alias Chiya.Notes.Note
@preloads [:channels]
@doc """
Returns the list of notes.
## Examples
iex> list_notes()
[%Note{}, ...]
"""
def list_notes do
Repo.all(Note) |> Repo.preload(@preloads)
end
@doc """
Preloads a note
## Examples
iex> preload_note(note)
%Note{}
"""
def preload_note(note), do: Repo.preload(note, @preloads)
@doc """
Gets a single note.
Raises `Ecto.NoResultsError` if the Note does not exist.
## Examples
iex> get_note!(123)
%Note{}
iex> get_note!(456)
** (Ecto.NoResultsError)
"""
def get_note!(id), do: Repo.get!(Note, id)
@doc """
Gets a single note and preloads it.
Raises `Ecto.NoResultsError` if the Note does not exist.
## Examples
iex> get_note_preloaded!(123)
%Note{}
iex> get_note_preloaded!(456)
** (Ecto.NoResultsError)
"""
def get_note_preloaded!(id), do: Repo.get!(Note, id) |> preload_note()
@doc """
Creates a note.
## Examples
iex> create_note(%{field: value})
{:ok, %Note{}}
iex> create_note(%{field: bad_value})
{:error, %Ecto.Changeset{}}
"""
def create_note(attrs \\ %{}) do
%Note{}
|> Note.changeset(attrs)
|> Repo.insert()
end
@doc """
Updates a note.
## Examples
iex> update_note(note, %{field: new_value})
{:ok, %Note{}}
iex> update_note(note, %{field: bad_value})
{:error, %Ecto.Changeset{}}
"""
def update_note(%Note{} = note, attrs) do
note
|> Note.changeset(attrs)
|> Repo.update()
end
@doc """
Deletes a note.
## Examples
iex> delete_note(note)
{:ok, %Note{}}
iex> delete_note(note)
{:error, %Ecto.Changeset{}}
"""
def delete_note(%Note{} = note) do
Repo.delete(note)
end
@doc """
Returns an `%Ecto.Changeset{}` for tracking note changes.
## Examples
iex> change_note(note)
%Ecto.Changeset{data: %Note{}}
"""
def change_note(%Note{} = note, attrs \\ %{}) do
Note.changeset(note, attrs)
end
end