diff --git a/documentation/dsls/DSL:-AshCubDB.DataLayer.cheatmd b/documentation/dsls/DSL:-AshCubDB.DataLayer.cheatmd index 767abb8..cd36c37 100644 --- a/documentation/dsls/DSL:-AshCubDB.DataLayer.cheatmd +++ b/documentation/dsls/DSL:-AshCubDB.DataLayer.cheatmd @@ -1,3 +1,6 @@ + # DSL: AshCubDB.DataLayer A CubDB data layer for Ash. @@ -83,13 +86,137 @@ end ### Options -| Name | Type | Default | Docs | -| --- | --- | --- | --- | -| `directory` | `nil \| String.t` | | The directory within which to store the CubDB data. If none is supplied, then one will be automatically generated in the `priv` directory of the parent OTP application. | -| `otp_app` | `atom` | | The OTP application in whose `priv` directory data should be stored. Only used if `directory` is not supplied. When not provided `Application.get_application/1` will be called for the resource. | -| `auto_compact?` | `boolean` | `true` | Whether or not to automatically compact the CubDB database. See [the CubDB documentation](https://hexdocs.pm/cubdb/faq.html#what-is-compaction) for more information. | -| `auto_file_sync?` | `boolean` | `true` | Whether or not to automatically flush the buffer to disk on write. See [the CubDB documentation](https://hexdocs.pm/cubdb/faq.html#what-does-file-sync-mean) | -| `name` | `atom` | | The name of the CubDB database. By default this is the name of the resource module, however in some (rare) circumstances you may wish to specifically name the database. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDocs
+ + + directory + + + + + nil | String.t + + + + The directory within which to store the CubDB data. + +If none is supplied, then one will be automatically generated in the +`priv` directory of the parent OTP application. + +
+ + + otp_app + + + + + atom + + + + The OTP application in whose `priv` directory data should be stored. + +Only used if `directory` is not supplied. When not provided +`Application.get_application/1` will be called for the resource. + +
+ + + auto_compact? + + + + + boolean + + true + + Whether or not to automatically compact the CubDB database. + +See [the CubDB documentation](https://hexdocs.pm/cubdb/faq.html#what-is-compaction) for more information. + +
+ + + auto_file_sync? + + + + + boolean + + true + + Whether or not to automatically flush the buffer to disk on write. + +See [the CubDB documentation](https://hexdocs.pm/cubdb/faq.html#what-does-file-sync-mean) + +
+ + + name + + + + + atom + + + + The name of the CubDB database. + +By default this is the name of the resource module, however in some +(rare) circumstances you may wish to specifically name the database. + +
diff --git a/mix.lock b/mix.lock index b29835e..90a4408 100644 --- a/mix.lock +++ b/mix.lock @@ -8,7 +8,7 @@ "dialyxir": {:hex, :dialyxir, "1.4.1", "a22ed1e7bd3a3e3f197b68d806ef66acb61ee8f57b3ac85fc5d57354c5482a93", [:mix], [{:erlex, ">= 0.2.6", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "84b795d6d7796297cca5a3118444b80c7d94f7ce247d49886e7c291e1ae49801"}, "doctor": {:hex, :doctor, "0.21.0", "20ef89355c67778e206225fe74913e96141c4d001cb04efdeba1a2a9704f1ab5", [:mix], [{:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}], "hexpm", "a227831daa79784eb24cdeedfa403c46a4cb7d0eab0e31232ec654314447e4e0"}, "earmark": {:hex, :earmark, "1.4.45", "25f0a0fb2a8279a8acfb0a62c45f1d3046e4b35018e728fe6bd15c78f428d7bc", [:mix], [], "hexpm", "3be30a7afe33db742e4682608b90d03c07e944610459394bc75dd617c4f27894"}, - "earmark_parser": {:hex, :earmark_parser, "1.4.36", "487ea8ef9bdc659f085e6e654f3c3feea1d36ac3943edf9d2ef6c98de9174c13", [], [], "hexpm", "a524e395634bdcf60a616efe77fd79561bec2e930d8b82745df06ab4e844400a"}, + "earmark_parser": {:hex, :earmark_parser, "1.4.36", "487ea8ef9bdc659f085e6e654f3c3feea1d36ac3943edf9d2ef6c98de9174c13", [:mix], [], "hexpm", "a524e395634bdcf60a616efe77fd79561bec2e930d8b82745df06ab4e844400a"}, "ecto": {:hex, :ecto, "3.10.3", "eb2ae2eecd210b4eb8bece1217b297ad4ff824b4384c0e3fdd28aaf96edd6135", [:mix], [{:decimal, "~> 1.6 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "44bec74e2364d491d70f7e42cd0d690922659d329f6465e89feb8a34e8cd3433"}, "elixir_make": {:hex, :elixir_make, "0.7.7", "7128c60c2476019ed978210c245badf08b03dbec4f24d05790ef791da11aa17c", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}], "hexpm", "5bc19fff950fad52bbe5f211b12db9ec82c6b34a9647da0c2224b8b8464c7e6c"}, "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},