From 5108680ce9b1740c4b1e82923255d62099239084 Mon Sep 17 00:00:00 2001 From: Izel Nakri Date: Thu, 1 Oct 2020 22:24:30 +0200 Subject: [PATCH] v0.9.0 flexible %PaperTrail.Version[:inserted_at] --- doc/.build | 25 ++-- doc/404.html | 34 +++-- doc/Mix.Tasks.Papertrail.Install.html | 43 +++--- doc/PaperTrail.Multi.html | 109 ++++++++------ doc/PaperTrail.RepoClient.html | 47 +++--- doc/PaperTrail.Version.html | 61 +++++--- doc/PaperTrail.VersionQueries.html | 139 +++++++++--------- doc/PaperTrail.html | 119 ++++++++------- doc/api-reference.html | 37 ++--- doc/dist/app-a225d03098e64fef431a.js | 89 ----------- doc/dist/app-aaa6eb1824b11a32f32d.js | 2 + doc/dist/elixir-0ab8a6a80ebaaa287431.css | 3 - doc/dist/elixir-9f91ebe876dc01d67920.css | 3 + doc/dist/erlang-bd206729da4d0d280293.css | 3 - ...706c8070.js => search_items-115f628dfc.js} | 2 +- doc/dist/sidebar_items-2880b88c56.js | 1 + doc/dist/sidebar_items-dcc8f77f52.js | 1 - doc/index.html | 5 +- doc/paper_trail.epub | Bin 0 -> 26513 bytes doc/search.html | 36 ++--- mix.exs | 8 +- mix.lock | 15 +- 22 files changed, 379 insertions(+), 403 deletions(-) delete mode 100644 doc/dist/app-a225d03098e64fef431a.js create mode 100644 doc/dist/app-aaa6eb1824b11a32f32d.js delete mode 100644 doc/dist/elixir-0ab8a6a80ebaaa287431.css create mode 100644 doc/dist/elixir-9f91ebe876dc01d67920.css delete mode 100644 doc/dist/erlang-bd206729da4d0d280293.css rename doc/dist/{search_items-dc706c8070.js => search_items-115f628dfc.js} (78%) create mode 100644 doc/dist/sidebar_items-2880b88c56.js delete mode 100644 doc/dist/sidebar_items-dcc8f77f52.js create mode 100644 doc/paper_trail.epub diff --git a/doc/.build b/doc/.build index c7d5ca2f..1938b5d7 100644 --- a/doc/.build +++ b/doc/.build @@ -1,19 +1,18 @@ -dist/search_items-dc706c8070.js -dist/app-a225d03098e64fef431a.js -dist/elixir-0ab8a6a80ebaaa287431.css -dist/erlang-bd206729da4d0d280293.css -dist/html/fonts/icomoon.eot -dist/html/fonts/icomoon.svg -dist/html/fonts/icomoon.ttf -dist/html/fonts/icomoon.woff -dist/sidebar_items-dcc8f77f52.js -api-reference.html -search.html 404.html -PaperTrail.html +Mix.Tasks.Papertrail.Install.html PaperTrail.Multi.html PaperTrail.RepoClient.html PaperTrail.Version.html PaperTrail.VersionQueries.html -Mix.Tasks.Papertrail.Install.html +PaperTrail.html +api-reference.html +dist/app-aaa6eb1824b11a32f32d.js +dist/elixir-9f91ebe876dc01d67920.css +dist/html/fonts/icomoon.eot +dist/html/fonts/icomoon.svg +dist/html/fonts/icomoon.ttf +dist/html/fonts/icomoon.woff +dist/search_items-115f628dfc.js +dist/sidebar_items-2880b88c56.js index.html +search.html diff --git a/doc/404.html b/doc/404.html index 8e5c9af3..d407e366 100644 --- a/doc/404.html +++ b/doc/404.html @@ -4,14 +4,14 @@ - - - 404 — paper_trail v0.8.8 - + + + 404 — paper_trail v0.9.0 + - + - + @@ -23,14 +23,14 @@ @@ -117,14 +118,16 @@

run(args)

Built using - ExDoc (v0.21.3), + ExDoc (v0.22.6) for the + Elixir programming language. - designed by + Designed by Friedel Ziegelmayer.

+ API Reference diff --git a/doc/PaperTrail.Multi.html b/doc/PaperTrail.Multi.html index 40448b56..bf53628d 100644 --- a/doc/PaperTrail.Multi.html +++ b/doc/PaperTrail.Multi.html @@ -4,14 +4,14 @@ - - - PaperTrail.Multi — paper_trail v0.8.8 - + + + PaperTrail.Multi — paper_trail v0.9.0 + - + - + @@ -23,14 +23,14 @@

@@ -187,7 +188,9 @@

append(lhs, rhs)

commit(multi)

+
+
@@ -199,7 +202,9 @@

commit(multi)

delete(multi, struct, options \\ [origin: nil, meta: nil, originator: nil, prefix: nil])

+
+
@@ -210,9 +215,10 @@

delete(multi, struct, options \\ [origin: nil, meta: nil,

error(multi, name, value)

+
-

See Ecto.Multi.error/3.

-
+ +

See Ecto.Multi.error/3.

@@ -223,7 +229,9 @@

error(multi, name, value)

insert(multi, changeset, options \\ [origin: nil, meta: nil, originator: nil, prefix: nil, model_key: :model, version_key: :version, ecto_options: []])

+
+
@@ -234,9 +242,10 @@

insert(multi, changeset, options \\ [origin: nil, meta: ni

merge(multi, merge)

+
-

See Ecto.Multi.merge/2.

-
+ +

See Ecto.Multi.merge/2.

@@ -246,9 +255,10 @@

merge(multi, merge)

merge(multi, mod, fun, args)

+
-

See Ecto.Multi.merge/4.

-
+ +

See Ecto.Multi.merge/4.

@@ -258,9 +268,10 @@

merge(multi, mod, fun, args)

new()

+
-

See Ecto.Multi.new/0.

-
+ +

See Ecto.Multi.new/0.

@@ -270,9 +281,10 @@

new()

prepend(lhs, rhs)

+
-

See Ecto.Multi.prepend/2.

-
+ +

See Ecto.Multi.prepend/2.

@@ -282,9 +294,10 @@

prepend(lhs, rhs)

run(multi, name, run)

+
-

See Ecto.Multi.run/3.

-
+ +

See Ecto.Multi.run/3.

@@ -294,9 +307,10 @@

run(multi, name, run)

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

+
-

See Ecto.Multi.run/5.

-
+ +

See Ecto.Multi.run/5.

@@ -306,9 +320,10 @@

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

to_list(multi)

+
-

See Ecto.Multi.to_list/1.

-
+ +

See Ecto.Multi.to_list/1.

@@ -319,7 +334,9 @@

to_list(multi)

update(multi, changeset, options \\ [origin: nil, meta: nil, originator: nil, prefix: nil])

+
+
@@ -328,14 +345,16 @@

update(multi, changeset, options \\ [origin: nil, meta: ni

Built using - ExDoc (v0.21.3), + ExDoc (v0.22.6) for the + Elixir programming language. - designed by + Designed by Friedel Ziegelmayer.

+ API Reference diff --git a/doc/PaperTrail.RepoClient.html b/doc/PaperTrail.RepoClient.html index eda05c50..fb60d03e 100644 --- a/doc/PaperTrail.RepoClient.html +++ b/doc/PaperTrail.RepoClient.html @@ -4,14 +4,14 @@ - - - PaperTrail.RepoClient — paper_trail v0.8.8 - + + + PaperTrail.RepoClient — paper_trail v0.9.0 + - + - + @@ -23,14 +23,14 @@

@@ -128,9 +130,10 @@

originator()

repo()

+
-

Gets the configured repo module or defaults to Repo if none configured

-
+ +

Gets the configured repo module or defaults to Repo if none configured

@@ -140,7 +143,9 @@

repo()

strict_mode()

+
+
@@ -149,14 +154,16 @@

strict_mode()

Built using - ExDoc (v0.21.3), + ExDoc (v0.22.6) for the + Elixir programming language. - designed by + Designed by Friedel Ziegelmayer.

+ API Reference diff --git a/doc/PaperTrail.Version.html b/doc/PaperTrail.Version.html index d80d791c..28307604 100644 --- a/doc/PaperTrail.Version.html +++ b/doc/PaperTrail.Version.html @@ -4,14 +4,14 @@ - - - PaperTrail.Version — paper_trail v0.8.8 - + + + PaperTrail.Version — paper_trail v0.9.0 + - + - + @@ -23,14 +23,14 @@

@@ -151,9 +153,10 @@

changeset(model, params \\ :empty)

count()

+
-

Returns the count of all version records in the database

-
+ +

Returns the count of all version records in the database

@@ -163,7 +166,9 @@

count()

count(options)

+
+
@@ -174,9 +179,10 @@

count(options)

first()

+
-

Returns the first version record in the database by :inserted_at

-
+ +

Returns the first version record in the database by :inserted_at

@@ -186,7 +192,9 @@

first()

first(options)

+
+
@@ -197,9 +205,10 @@

first(options)

last()

+
-

Returns the last version record in the database by :inserted_at

-
+ +

Returns the last version record in the database by :inserted_at

@@ -209,7 +218,9 @@

last()

last(options)

+
+
@@ -218,14 +229,16 @@

last(options)

Built using - ExDoc (v0.21.3), + ExDoc (v0.22.6) for the + Elixir programming language. - designed by + Designed by Friedel Ziegelmayer.

+ API Reference diff --git a/doc/PaperTrail.VersionQueries.html b/doc/PaperTrail.VersionQueries.html index 5931c11b..ce73e83b 100644 --- a/doc/PaperTrail.VersionQueries.html +++ b/doc/PaperTrail.VersionQueries.html @@ -4,14 +4,14 @@ - - - PaperTrail.VersionQueries — paper_trail v0.8.8 - + + + PaperTrail.VersionQueries — paper_trail v0.9.0 + - + - + @@ -23,14 +23,14 @@

@@ -154,13 +155,15 @@

get_current_model(version)

Link to this function

get_version(record)

-
-
get_version(record :: Ecto.Schema.t()) :: Ecto.Query.t()
-
+
-

Gets the last version of a record.

-
+

Specs

+
+
get_version(record :: Ecto.Schema.t()) :: Ecto.Query.t()
+
+ +

Gets the last version of a record.

@@ -169,18 +172,17 @@

get_version(record)

Link to this function

get_version(model, id)

-
-
get_version(model :: module(), id :: pos_integer()) :: Ecto.Query.t()
-
get_version(record :: Ecto.Schema.t(), options :: []) :: Ecto.Query.t()
-
+
-

Gets the last version of a record.

-

A list of options is optional, so you can set for example the :prefix of the query, -wich allows you to change between different tenants.

-

Usage example:

-

iex(1)> PaperTrail.VersionQueries.get_version(record, [prefix: "tenant_id"])

-
+

Specs

+
+
get_version(model :: module(), id :: pos_integer()) :: Ecto.Query.t()
+
get_version(record :: Ecto.Schema.t(), options :: []) :: Ecto.Query.t()
+
+ +

Gets the last version of a record.

A list of options is optional, so you can set for example the :prefix of the query, +wich allows you to change between different tenants.

Usage example:

iex(1)> PaperTrail.VersionQueries.get_version(record, [prefix: "tenant_id"])

@@ -189,18 +191,17 @@

Usage example:

Link to this function

get_version(model, id, options)

+
+ +
+

Specs

get_version(model :: module(), id :: pos_integer(), options :: []) ::
-  Ecto.Query.t()
+ Ecto.Query.t()
- -
-

Gets the last version of a record given its module reference and its id.

-

A list of options is optional, so you can set for example the :prefix of the query, -wich allows you to change between different tenants.

-

Usage example:

-

iex(1)> PaperTrail.VersionQueries.get_version(ModelName, id, [prefix: "tenant_id"])

-
+ +

Gets the last version of a record given its module reference and its id.

A list of options is optional, so you can set for example the :prefix of the query, +wich allows you to change between different tenants.

Usage example:

iex(1)> PaperTrail.VersionQueries.get_version(ModelName, id, [prefix: "tenant_id"])

@@ -209,13 +210,15 @@

Usage example:

Link to this function

get_versions(record)

-
-
get_versions(record :: Ecto.Schema.t()) :: Ecto.Query.t()
-
+
-

Gets all the versions of a record.

-
+

Specs

+
+
get_versions(record :: Ecto.Schema.t()) :: Ecto.Query.t()
+
+ +

Gets all the versions of a record.

@@ -224,18 +227,17 @@

get_versions(record)

Link to this function

get_versions(model, id)

-
-
get_versions(model :: module(), id :: pos_integer()) :: Ecto.Query.t()
-
get_versions(record :: Ecto.Schema.t(), options :: []) :: Ecto.Query.t()
-
+
-

Gets all the versions of a record.

-

A list of options is optional, so you can set for example the :prefix of the query, -wich allows you to change between different tenants.

-

Usage example:

-

iex(1)> PaperTrail.VersionQueries.get_versions(record, [prefix: "tenant_id"])

-
+

Specs

+
+
get_versions(model :: module(), id :: pos_integer()) :: Ecto.Query.t()
+
get_versions(record :: Ecto.Schema.t(), options :: []) :: Ecto.Query.t()
+
+ +

Gets all the versions of a record.

A list of options is optional, so you can set for example the :prefix of the query, +wich allows you to change between different tenants.

Usage example:

iex(1)> PaperTrail.VersionQueries.get_versions(record, [prefix: "tenant_id"])

@@ -244,18 +246,17 @@

Usage example:

Link to this function

get_versions(model, id, options)

+
+ +
+

Specs

get_versions(model :: module(), id :: pos_integer(), options :: []) ::
-  Ecto.Query.t()
+ Ecto.Query.t()
- -
-

Gets all the versions of a record given a module and its id.

-

A list of options is optional, so you can set for example the :prefix of the query, -wich allows you to change between different tenants.

-

Usage example:

-

iex(1)> PaperTrail.VersionQueries.get_versions(ModelName, id, [prefix: "tenant_id"])

-
+ +

Gets all the versions of a record given a module and its id.

A list of options is optional, so you can set for example the :prefix of the query, +wich allows you to change between different tenants.

Usage example:

iex(1)> PaperTrail.VersionQueries.get_versions(ModelName, id, [prefix: "tenant_id"])

@@ -263,14 +264,16 @@

Usage example:

Built using - ExDoc (v0.21.3), + ExDoc (v0.22.6) for the + Elixir programming language. - designed by + Designed by Friedel Ziegelmayer.

+ API Reference diff --git a/doc/PaperTrail.html b/doc/PaperTrail.html index f6a9a27a..595a51c6 100644 --- a/doc/PaperTrail.html +++ b/doc/PaperTrail.html @@ -4,14 +4,14 @@ - - - PaperTrail — paper_trail v0.8.8 - + + + PaperTrail — paper_trail v0.9.0 + - + - + @@ -23,14 +23,14 @@

@@ -198,9 +199,10 @@

delete(struct, options \\ [origin: nil, meta: nil, origina

delete!(struct, options \\ [origin: nil, meta: nil, originator: nil, prefix: nil])

+
-

Same as delete/2 but returns only the model struct or raises if the changeset is invalid.

-
+ +

Same as delete/2 but returns only the model struct or raises if the changeset is invalid.

@@ -210,9 +212,10 @@

delete!(struct, options \\ [origin: nil, meta: nil, origin

get_current_model(version)

+
-

See PaperTrail.VersionQueries.get_current_model/1.

-
+ +

See PaperTrail.VersionQueries.get_current_model/1.

@@ -222,7 +225,9 @@

get_current_model(version)

get_model_id(model)

+
+
@@ -233,9 +238,10 @@

get_model_id(model)

get_version(record)

+
-

See PaperTrail.VersionQueries.get_version/1.

-
+ +

See PaperTrail.VersionQueries.get_version/1.

@@ -245,9 +251,10 @@

get_version(record)

get_version(model_or_record, id_or_options)

+
-

See PaperTrail.VersionQueries.get_version/2.

-
+ +

See PaperTrail.VersionQueries.get_version/2.

@@ -257,9 +264,10 @@

get_version(model_or_record, id_or_options)

get_version(model, id, options)

+
-

See PaperTrail.VersionQueries.get_version/3.

-
+ +

See PaperTrail.VersionQueries.get_version/3.

@@ -269,9 +277,10 @@

get_version(model, id, options)

get_versions(record)

+
-

See PaperTrail.VersionQueries.get_versions/1.

-
+ +

See PaperTrail.VersionQueries.get_versions/1.

@@ -281,9 +290,10 @@

get_versions(record)

get_versions(model_or_record, id_or_options)

+
-

See PaperTrail.VersionQueries.get_versions/2.

-
+ +

See PaperTrail.VersionQueries.get_versions/2.

@@ -293,9 +303,10 @@

get_versions(model_or_record, id_or_options)

get_versions(model, id, options)

+
-

See PaperTrail.VersionQueries.get_versions/3.

-
+ +

See PaperTrail.VersionQueries.get_versions/3.

@@ -306,9 +317,10 @@

get_versions(model, id, options)

insert(changeset, options \\ [origin: nil, meta: nil, originator: nil, prefix: nil, model_key: :model, version_key: :version, ecto_options: []])

+
-

Inserts a record to the database with a related version insertion in one transaction

-
+ +

Inserts a record to the database with a related version insertion in one transaction

@@ -319,9 +331,10 @@

insert(changeset, options \\ [origin: nil, meta: nil, orig

insert!(changeset, options \\ [origin: nil, meta: nil, originator: nil, prefix: nil, model_key: :model, version_key: :version, ecto_options: []])

+
-

Same as insert/2 but returns only the model struct or raises if the changeset is invalid.

-
+ +

Same as insert/2 but returns only the model struct or raises if the changeset is invalid.

@@ -332,9 +345,10 @@

insert!(changeset, options \\ [origin: nil, meta: nil, ori

update(changeset, options \\ [origin: nil, meta: nil, originator: nil, prefix: nil])

+
-

Updates a record from the database with a related version insertion in one transaction

-
+ +

Updates a record from the database with a related version insertion in one transaction

@@ -345,9 +359,10 @@

update(changeset, options \\ [origin: nil, meta: nil, orig

update!(changeset, options \\ [origin: nil, meta: nil, originator: nil, prefix: nil])

+
-

Same as update/2 but returns only the model struct or raises if the changeset is invalid.

-
+ +

Same as update/2 but returns only the model struct or raises if the changeset is invalid.

@@ -355,14 +370,16 @@

update!(changeset, options \\ [origin: nil, meta: nil, ori

Built using - ExDoc (v0.21.3), + ExDoc (v0.22.6) for the + Elixir programming language. - designed by + Designed by Friedel Ziegelmayer.

+ API Reference diff --git a/doc/api-reference.html b/doc/api-reference.html index f86c4aca..c6b64e2b 100644 --- a/doc/api-reference.html +++ b/doc/api-reference.html @@ -4,14 +4,14 @@ - - - API Reference — paper_trail v0.8.8 - + + + API Reference — paper_trail v0.9.0 + - + - + @@ -23,14 +23,14 @@