Carbonite.Multi (Carbonite v0.2.0) View Source

This module provides functions for dealing with audit trails in the context of Ecto.Multi.

Link to this section Summary

params()

prefix()

Adds an insert operation for a Carbonite.Transaction to an Ecto.Multi.

Sets the current transaction to "override mode" for all tables in a translation log.

insert_transaction_option() :: {:carbonite_prefix, prefix()} | {:params, map()}

override_mode_option() :: {:carbonite_prefix, prefix()}

params() :: map()

prefix() :: binary() | atom()

(since 0.2.0)

insert_transaction(Ecto.Multi.t(), params(), [insert_transaction_option()]) ::
  Ecto.Multi.t()

Adds an insert operation for a Carbonite.Transaction to an Ecto.Multi.

carbonite_prefix defines the audit trail's schema, defaults to "carbonite_default"
params map of params for the Carbonite.Transaction (e.g., :meta)

(since 0.2.0)

override_mode(Ecto.Multi.t(), [override_mode_option()]) :: Ecto.Multi.t()

Sets the current transaction to "override mode" for all tables in a translation log.