Mnemonix

v0.2.0

Mnemonix v0.2.0 Mnemonix.Mnesia.Store

A Mnemonix.Store adapter that uses a Mnesia table to store state.

Before using, you must have started Mnesia:

iex> :mnesia.create_schema([node])
iex> :mnesia.start()
:ok
iex> {:ok, store} = Mnemonix.Mnesia.Store.start_link
iex> Mnemonix.put(store, :foo, "bar")
iex> Mnemonix.get(store, :foo)
"bar"
iex> Mnemonix.delete(store, :foo)
iex> Mnemonix.get(store, :foo)
nil

Summary

Functions

delete(store, key)

Callback implementation for Mnemonix.Store.Behaviour.delete/2

fetch(store, key)

Callback implementation for Mnemonix.Store.Behaviour.fetch/2

init(opts)

Creates a Mnesia table to store state in

put(store, key, value)

Callback implementation for Mnemonix.Store.Behaviour.put/3

start_link(opts \\ [])

Starts a new Mnemonix.Store using the Mnemonix.Mnesia.Store adapter

start_link(init, opts)

Starts a new Mnemonix.Store using the Mnemonix.Mnesia.Store adapter with init opts

Functions

delete(store, key) 
delete(store, key) :: {:ok, store}

Callback implementation for Mnemonix.Store.Behaviour.delete/2.

fetch(store, key) 
fetch(store, key) :: {:ok, store, {:ok, value} | :error}

Callback implementation for Mnemonix.Store.Behaviour.fetch/2.

init(opts) 
init(opts) :: {:ok, state} | {:stop, reason :: any}

Creates a Mnesia table to store state in.

If the table specified already exists, it will use that instead.

Options

  • table: Name of the table to use, will be created if it doesn’t exist. Default: Mnemonix.Mnesia.Store.Table

  • transactional: Whether or not to perform transactional reads or writes. Allowed: :reads | :writes | :both | nil Default: :both

The rest of the options are passed into :dets.open_file/2 verbaitm, except for type:, which will always be :set.

put(store, key, value) 
put(store, key, Mnemonix.Store.value) :: {:ok, store}

Callback implementation for Mnemonix.Store.Behaviour.put/3.

start_link(opts \\ []) 
start_link(GenServer.options) :: {:ok, GenServer.server}

Starts a new Mnemonix.Store using the Mnemonix.Mnesia.Store adapter.

If you wish to pass configuration options to the adapter instead, use start_link/2 with an empty opts list.

The returned GenServer.server/0 reference can be used as the primary argument to the Mnemonix API.

Examples 

iex> {:ok, store} = Mnemonix.Mnesia.Store.start_link
iex> Mnemonix.put(store, :foo, "bar")
iex> Mnemonix.get(store, :foo)
"bar"
iex> Mnemonix.delete(store, :foo)
iex> Mnemonix.get(store, :foo)
nil
start_link(init, opts) 
start_link(Mnemonix.Store.opts, GenServer.options) :: {:ok, GenServer.server}

Starts a new Mnemonix.Store using the Mnemonix.Mnesia.Store adapter with init opts.

The returned GenServer.server/0 reference can be used as the primary argument to the Mnemonix API.