Ecto

v3.0.8

Ecto

Ecto v3.0.8 Ecto.Adapter.Transaction behaviour View Source

Specifies the adapter transactions API.

Link to this section Summary

Types

adapter_meta()

Callbacks

in_transaction?(adapter_meta)

Returns true if the given process is inside a transaction

rollback(adapter_meta, value)

Rolls back the current transaction

transaction(adapter_meta, options, function)

Runs the given function inside a transaction

Link to this section Types

Link to this section Callbacks

Link to this callback in_transaction?(adapter_meta) View Source 
in_transaction?(adapter_meta()) :: boolean()

Returns true if the given process is inside a transaction.

Link to this callback rollback(adapter_meta, value) View Source 
rollback(adapter_meta(), value :: any()) :: no_return()

Rolls back the current transaction.

The transaction will return the value given as {:error, value}.

See Ecto.Repo.rollback/1.

Link to this callback transaction(adapter_meta, options, function) View Source 
transaction(adapter_meta(), options :: Keyword.t(), function :: (... -> any())) ::
  {:ok, any()} | {:error, any()}

Runs the given function inside a transaction.

Returns {:ok, value} if the transaction was successful where value is the value return by the function or {:error, value} if the transaction was rolled back where value is the value given to rollback/1.