ecto_mnesia

Deps Status Hex.pm Downloads Latest Version License Build Status Coverage Status Ebert

Ecto 2.X adapter for Mnesia Erlang Term database. In most cases it can be used as drop-in replacement for other adapters.

Supported features:

  • Compatible Ecto.Repo API.
  • Automatically converts Ecto.Query structs to Erlang match_spec. Also adapter emulates query.select and query.order_bys behaviors, even trough Mnesia itself does not support them.
  • Auto-generated (via sequence table) :id primary keys.
  • Migrations and database setup via Ecto.Migrations.
  • Transactions in dirty context.

Planned features:

  • Secondary indexes.
  • Native primary key and unique index constraints.
  • Custom primary keys.
  • Other transactional contexts.

Not supported features (create issue and vote if you need them):

  • Type casting. Mnesia can store any data in any field, including strings, numbers, atoms, tuples, floats or even PID’s. All types in your migrations will be silently ignored.
  • Mnesia clustering and auto-clustering.

Why Mnesia?

We have production task that needs low read-latency database and our data fits in RAM, so Mnesia is a best choice: it’s part of OTP, shares same space as our app does, work fast in RAM and supports transactions (it’s critical for fintech projects).

Why do we need adapter? We don’t want to lock us to any specific database, since requirements can change. Ecto allows to switch databases by simply modifying config, and we might want to go back to Postres or another DB.

Clustering

We don’t recommend to use distributed Mnesia, because it’s neither AP, nor CP database. (And there are no such thing as AC DB.) Mnesia requires you to handle network partitions (split brains) manually.

So clustering should be an option only when you absolutely sure how you will recover from split-brains. In general, if you don’t sure what is network splits, dont use it. ### Mnesia configuration fromconfig.exsconfig :ecto_mnesia, host: {:system, :atom, "MNESIA_HOST", Kernel.node()}, dir: {:system, "MNESIA_DATA_DIR", "priv/data/mnesia"}, storage_type: {:system, :atom, "MNESIA_STORAGE_TYPE", :disc_copies} Notice that{:system, [TYPE], ENV_NAME, default_value}tuples can be replaced with any raw values. They tell adapter to read configuration from environment in run-time, so you will be able to setMNESIA_HOST,MNESIA_DATA_DIR,MNESIA_STORAGE_TYPEenvironment variables, which is very useful when you releasing app in production and don't want to rebuild all code on each config change. If you want to know more how this tool works take look at [Confex](https://github.com/Nebo15/confex) package. #### Storage Types -:disc_copies- store data in both RAM and on dics. Recommended value for most cases. -:ram_copies- store data only in RAM. Data will be lost on node restart. Useful when working with large datasets that don't need to be persisted. -:disc_only_copies- store data only on dics. This will limit database size to 2GB and affect adapter performance. ## Installation It is [available in Hex](https://hexdocs.pm/ecto_mnesia), the package can be installed as: 1. Addecto_mnesiato your list of dependencies inmix.exs: ```elixir def deps do [{:ecto_mnesia, "~> 0.5.0"}] end ``` 2. Ensureecto_mnesia` is started before your application: elixir def application do [applications: [:ecto_mnesia]] end The docs can be found at https://hexdocs.pm/ecto_mnesia. ## Thanks We want to thank meh for his Amnesia package that helped a loot in initial Mnesia investigations. Some pieces of code was copied from hes repo. Also big thanks to josevalim for Elixir, Ecto and active help while this adapter was developed.