ecto_gss v0.2.2 EctoGSS.Repo
Repository to use Google Spreadsheets as persistence layer for objects.
Link to this section Summary
Functions
Get several records
Returns a specification to start this module under a supervisor
Delete an existing record
Delete an existing record, raise in case of error
Get a record by row id, raise if not found
Get a record by row, raise if not found
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Add a new record
Add a new record, raise in case of error
Update an existing record, or insert a new one
Update an existing record, or insert a new one, raise in case of error
Update an existing record with a row id
Update an existing record, raise in case of error
Link to this section Types
ecto_object()
ecto_object() :: Ecto.Changeset.t() | Ecto.Schema.t()
ecto_object() :: Ecto.Changeset.t() | Ecto.Schema.t()
result()
result() :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
result() :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
state()
state() :: map()
state() :: map()
Link to this section Functions
all(schema, opts \\ [])
all(Ecto.Queryable.t(), Keyword.t()) :: [Ecto.Schema.t()] | no_return()
all(Ecto.Queryable.t(), Keyword.t()) :: [Ecto.Schema.t()] | no_return()
Get several records:
- by range of rows:
start_id
andend_id
options; - by exact list of rows:
rows
option.
child_spec(init_arg)
Returns a specification to start this module under a supervisor.
See Supervisor
.
delete(record)
delete(ecto_object()) :: result()
delete(ecto_object()) :: result()
Delete an existing record.
delete!(record)
delete!(ecto_object()) :: Ecto.Schema.t() | no_return()
delete!(ecto_object()) :: Ecto.Schema.t() | no_return()
Delete an existing record, raise in case of error.
get(schema, id)
get(Ecto.Queryable.t(), integer()) :: Ecto.Schema.t() | nil | no_return()
get(Ecto.Queryable.t(), integer()) :: Ecto.Schema.t() | nil | no_return()
Get a record by row id, raise if not found.
get!(schema, id)
get!(Ecto.Queryable.t(), integer() | nil) :: Ecto.Schema.t() | no_return()
get!(Ecto.Queryable.t(), integer() | nil) :: Ecto.Schema.t() | no_return()
Get a record by row, raise if not found.
init(state)
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
init_arg
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
,
except that it also sets a timeout. See the "Timeouts" section
in the module documentation for more information.
Returning {:ok, state, :hibernate}
is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
Returning :ignore
will cause start_link/3
to return :ignore
and
the process will exit normally without entering the loop or calling
c:terminate/2
. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer
. The remainder of the supervision tree will be started
and so the GenServer
should not be required by other processes.
It can be started later with Supervisor.restart_child/2
as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
insert(changeset)
insert(ecto_object()) :: result()
insert(ecto_object()) :: result()
Add a new record.
insert!(changeset)
insert!(ecto_object()) :: Ecto.Schema.t() | no_return()
insert!(ecto_object()) :: Ecto.Schema.t() | no_return()
Add a new record, raise in case of error.
insert_or_update(changeset)
insert_or_update(Ecto.Changeset.t()) :: result()
insert_or_update(Ecto.Changeset.t()) :: result()
Update an existing record, or insert a new one.
insert_or_update!(changeset)
insert_or_update!(Ecto.Changeset.t()) :: Ecto.Schema.t() | no_return()
insert_or_update!(Ecto.Changeset.t()) :: Ecto.Schema.t() | no_return()
Update an existing record, or insert a new one, raise in case of error.
start_link()
start_link() :: {:ok, pid()}
start_link() :: {:ok, pid()}
update(changeset)
update(ecto_object()) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
update(ecto_object()) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}
Update an existing record with a row id.
update!(changeset)
update!(Ecto.Changeset.t()) :: Ecto.Schema.t() | no_return()
update!(Ecto.Changeset.t()) :: Ecto.Schema.t() | no_return()
Update an existing record, raise in case of error.