View Source PaperTrail.Multi (paper_trail v0.13.0)

Provide functions compatible with Ecto.Multi to insert, update and delete records on the database alongside their changes.

Summary

Types

changeset()

multi()

options()

queryable()

result()

struct_or_changeset()

updates()

Functions

add_prefix(changeset, prefix)

See PaperTrail.Serializer.add_prefix/2.

append(lhs, rhs)

See Ecto.Multi.append/2.

commit(multi, options \\ [])

delete(multi, struct_or_changeset, options \\ [])

error(multi, name, value)

See Ecto.Multi.error/3.

get_item_type(data)

See PaperTrail.Serializer.get_item_type/1.

get_model_id(model)

See PaperTrail.Serializer.get_model_id/1.

get_sequence_from_model(changeset, options \\ [])

See PaperTrail.Serializer.get_sequence_from_model/2.

get_sequence_id(table_name, options \\ [])

See PaperTrail.Serializer.get_sequence_id/2.

insert(multi, changeset, options \\ [])

make_version_struct(version, model, options)

See PaperTrail.Serializer.make_version_struct/3.

make_version_structs(version, queryable, changes, options)

See PaperTrail.Serializer.make_version_structs/4.

merge(multi, merge)

See Ecto.Multi.merge/2.

merge(multi, mod, fun, args)

See Ecto.Multi.merge/4.

new()

See Ecto.Multi.new/0.

prepend(lhs, rhs)

See Ecto.Multi.prepend/2.

run(multi, name, run)

See Ecto.Multi.run/3.

run(multi, name, mod, fun, args)

See Ecto.Multi.run/5.

serialize(data, options)

See PaperTrail.Serializer.serialize/2.

to_list(multi)

See Ecto.Multi.to_list/1.

update(multi, changeset, options \\ [])

update_all(multi, queryable, updates, options \\ [])

Types

changeset()

@type changeset() :: Ecto.Changeset.t()

multi()

@type multi() :: Ecto.Multi.t()

options()

@type options() :: PaperTrail.options()

queryable()

@type queryable() :: PaperTrail.queryable()

result()

@type result() ::
  {:ok, any()}
  | {:error, any()}
  | {:error, Ecto.Multi.name(), any(), %{required(Ecto.Multi.name()) => any()}}

struct_or_changeset()

@type struct_or_changeset() :: Ecto.Schema.t() | Ecto.Changeset.t()

updates()

@type updates() :: PaperTrail.updates()

Functions

add_prefix(changeset, prefix)

See PaperTrail.Serializer.add_prefix/2.

append(lhs, rhs)

See Ecto.Multi.append/2.

commit(multi, options \\ [])

@spec commit(multi(), options()) :: result()

delete(multi, struct_or_changeset, options \\ [])

@spec delete(multi(), struct_or_changeset(), options()) :: multi()

error(multi, name, value)

See Ecto.Multi.error/3.

get_item_type(data)

See PaperTrail.Serializer.get_item_type/1.

get_model_id(model)

See PaperTrail.Serializer.get_model_id/1.

get_sequence_from_model(changeset, options \\ [])

See PaperTrail.Serializer.get_sequence_from_model/2.

get_sequence_id(table_name, options \\ [])

See PaperTrail.Serializer.get_sequence_id/2.

insert(multi, changeset, options \\ [])

@spec insert(multi(), changeset(), options()) :: multi()

make_version_struct(version, model, options)

See PaperTrail.Serializer.make_version_struct/3.

make_version_structs(version, queryable, changes, options)

See PaperTrail.Serializer.make_version_structs/4.

merge(multi, merge)

See Ecto.Multi.merge/2.

merge(multi, mod, fun, args)

See Ecto.Multi.merge/4.

new()

See Ecto.Multi.new/0.

prepend(lhs, rhs)

See Ecto.Multi.prepend/2.

run(multi, name, run)

See Ecto.Multi.run/3.

run(multi, name, mod, fun, args)

See Ecto.Multi.run/5.

serialize(data, options)

See PaperTrail.Serializer.serialize/2.

to_list(multi)

See Ecto.Multi.to_list/1.

update(multi, changeset, options \\ [])

@spec update(multi(), changeset(), options()) :: multi()

update_all(multi, queryable, updates, options \\ [])

@spec update_all(multi(), queryable(), updates(), options()) :: multi()