https://github.com/mustafaturan/mnesiam
Mnesiam makes clustering easy for Mnesia database.
https://github.com/mustafaturan/mnesiam
cluster elixir mnesia
Last synced: 10 months ago
JSON representation
Mnesiam makes clustering easy for Mnesia database.
- Host: GitHub
- URL: https://github.com/mustafaturan/mnesiam
- Owner: mustafaturan
- Created: 2017-04-19T21:38:50.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2021-01-13T06:36:42.000Z (over 5 years ago)
- Last Synced: 2025-08-18T18:40:24.648Z (10 months ago)
- Topics: cluster, elixir, mnesia
- Language: Elixir
- Size: 8.79 KB
- Stars: 20
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# THIS LIBRARY IS DEPRECATED IN FAVOR OF ACTIVE DEVELOPMENT AT [mnesiac LIBRARY](https://hex.pm/packages/mnesiac)([Github](https://github.com/beardedeagle/mnesiac)).
# Mnesiam
Mnesiam makes clustering easy for Mnesia database.
The module docs can be found at [https://hexdocs.pm/mnesiam](https://hexdocs.pm/mnesiam).
## Installation
The package can be installed by adding `mnesiam` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:mnesiam, "~> 0.1.1"}]
end
```
Ensure `mnesiam` is started before your application.
Elixir Version >= 1.4 with `libcluster`
```elixir
def application do
[extra_applications: [:libcluster, :mnesiam]]
end
```
Elixir Version >= 1.4 without `libcluster`
```elixir
def application do
[extra_applications: [:mnesiam]]
end
```
Edit your app's `config.exs` to add list of mnesia stores:
```elixir
config :mnesiam,
stores: [Mnesiam.Support.SampleStore, ...],
table_load_timeout: 600_000 # milliseconds
```
## Usage
### Table creation
Create a table store and add it to your app's config.exs. Note: All stores *MUST* implement its own `init_store/0` to create table and `copy_store/0` to copy table:
```elixir
defmodule Mnesiam.Support.SampleStore do
@moduledoc """
Sample store implementation
"""
alias :mnesia, as: Mnesia
@table :sample_store
@doc """
Mnesiam will call this method to init table
"""
def init_store do
Mnesia.create_table(@table,
[ram_copies: [Node.self()], attributes: [:id, :topic_id, :event]])
# Sample index
Mnesia.add_table_index(@table, :topic_id)
# Add table subscriptions to here
# ...
end
@doc """
Mnesiam will call this method to copy table
"""
def copy_store do
Mnesia.add_table_copy(@table, Node.self(), :ram_copies)
end
end
```
### Clustering
If you are using `libcluster` or another clustering library just ensure that clustering library starts earlier than `mneasiam`. That's all, you do not need to do rest.
If you are not using `libcluster` or similar clustering library then:
- When a node joins to an erlang/elixir cluster, run `Mnesiam.init_mnesia()` function on the *new node*; this will init and copy table contents from other online nodes.
Enjoy!
## Contributing
For any issues, bugs, documentation, enhancements:
1) Fork the project
2) Make your improvements and write your tests.
3) Make a pull request.
## License
Apache License 2.0
Copyright (c) 2018 Mustafa Turan
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.