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

Functions

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

Link to this section Types

Link to this type

insert_transaction_option()

View Source

Specs

insert_transaction_option() :: {:carbonite_prefix, prefix()} | {:params, map()}
Link to this type

override_mode_option()

View Source

Specs

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

Specs

params() :: map()

Specs

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

Link to this section Functions

Link to this function

insert_transaction(multi, params \\ %{}, opts \\ [])

View Source (since 0.2.0)

Specs

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

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

Options

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

override_mode(multi, opts \\ [])

View Source (since 0.2.0)

Specs

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.