update
This commit is contained in:
niamtokik
@@ -1,5 +1,61 @@
|
||||
%%%===================================================================
|
||||
%%% @doc
|
||||
%%% @doc
|
||||
%%%
|
||||
%%% This module implement a Mnesia backend of Unix Filesystem (UFS,
|
||||
%%% FFS, EXT4) as backend example. Behaviors, specifications and
|
||||
%%% perhaps macros will be also created here and shared for other
|
||||
%%% projects.
|
||||
%%%
|
||||
%%% == Database Structure ==
|
||||
%%%
|
||||
%%% ```
|
||||
%%% mnesia_unixfs
|
||||
%%% |-- table_name1
|
||||
%%% | |-- tn1_key1
|
||||
%%% | |-- tn1_key1.key
|
||||
%%% | |-- tn1_key1.meta
|
||||
%%% | |-- tn1_key2
|
||||
%%% | |-- tn1_key2.key
|
||||
%%% | |-- tn1_key2.meta
|
||||
%%% | |-- tn1_keyN
|
||||
%%% | |-- tn1_keyN.key
|
||||
%%% | `-- tn1_keyN.meta
|
||||
%%% |-- table_name2
|
||||
%%% | |-- tn2_key1
|
||||
%%% | |-- tn2_key2
|
||||
%%% | `-- tn2_keyN
|
||||
%%% `-- table_nameN
|
||||
%%% |-- tnN_key1
|
||||
%%% |-- tnN_key2
|
||||
%%% `-- tnN_keyN
|
||||
%%% '''
|
||||
%%%
|
||||
%%% === Table Name ===
|
||||
%%%
|
||||
%%% The table name is created using an atom and must be unique.
|
||||
%%%
|
||||
%%% === Key Identifier ===
|
||||
%%%
|
||||
%%% The Key identifier is a bit complex to easily store with filename
|
||||
%%% size limitation but a simple rule can be created:
|
||||
%%%
|
||||
%%% <ul>
|
||||
%%% <li>If the key is an `integer()`, the key will be directly set
|
||||
%%% with this value without any encoding.
|
||||
%%% </li>
|
||||
%%% <li>If the key is any other structure, a checksum must be used,
|
||||
%%% and the real identifier will be stored in the `.key' file
|
||||
%%% stored alongside the key and encoded using ETF.
|
||||
%%% </li>
|
||||
%%% </ul>
|
||||
%%%
|
||||
%%% Note: some structures don't have guarantees their orders, in this
|
||||
%%% case, an external encoding system like `sext' could be used.
|
||||
%%%
|
||||
%%% === Value Store ===
|
||||
%%%
|
||||
%%% Stored values will be encoded using ETF as binary file.
|
||||
%%%
|
||||
%%% @end
|
||||
%%%===================================================================
|
||||
-module(mnesia_unixfs).
|
||||
@@ -13,9 +69,9 @@
|
||||
%%--------------------------------------------------------------------
|
||||
-export([add_aliases/1]).
|
||||
-export([create_schema/1, create_schema/2]).
|
||||
%% -export([init_backend/0]).
|
||||
%% -export([check_definition/4]).
|
||||
%% -export([close_table/2, create_table/2]).
|
||||
-export([init_backend/0]).
|
||||
-export([check_definition/4]).
|
||||
-export([close_table/2, create_table/2]).
|
||||
%% -export([delete/3, delete_table/2]).
|
||||
%% -export([fixtable/3]).
|
||||
%% -export([first/2, last/2, next/3, prev/3]).
|
||||
@@ -44,11 +100,11 @@
|
||||
%%--------------------------------------------------------------------
|
||||
-type nodes() :: [node(), ...].
|
||||
-type aliases() :: [atom(), ...].
|
||||
-type key() :: any().
|
||||
%% -type tab() :: atom().
|
||||
%% -type rec_name() :: atom().
|
||||
%% -type type() :: set | bag | ordered_set.
|
||||
%% -type proplist() :: [{atom(), any()}].
|
||||
%% -type key() :: any().
|
||||
%% -type db_object() :: tuple().
|
||||
%% -type matchspec() :: ets:match_spec().
|
||||
%% -type limit() :: integer() | infinity.
|
||||
@@ -94,4 +150,101 @@ create_schema(Nodes, Aliases)
|
||||
%% @doc
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
create_table(Alias, Table, Props) -> throw(todo).
|
||||
-spec create_table(Alias, Table, Properties) -> Return when
|
||||
Alias :: alias(),
|
||||
Table :: tab(),
|
||||
Properties :: proplists:proplist(),
|
||||
Return :: tab().
|
||||
|
||||
create_table(Alias, Table, Properties) -> throw(todo).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc Close an open and active table. This callback is called by
|
||||
%% many different mnesia modules:
|
||||
%%
|
||||
%% <ul>
|
||||
%% <li>`mnesia_bup:delete_ext/2'</li>
|
||||
%% <li>`mnesia_checkpoint:retainer_delete/1'</li>
|
||||
%% <li>`mnesia_dumper:disc_delete_table/2'</li>
|
||||
%% <li>`mnesia_dumper:do_close/5'</li>
|
||||
%% <li>`mnesia_index:delete_transient_index/3'</li>
|
||||
%% <li>`mnesia_loader:down/2'</li>
|
||||
%% <li>`mnesia_schema:undo_prepare_op/2'</li>
|
||||
%% </ul>
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
-spec close_table(Alias, Table) -> Return when
|
||||
Alias :: alias(),
|
||||
Table :: tab(),
|
||||
Return :: ok.
|
||||
|
||||
close_table(Alias, Table) -> ok.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc Initialize the environment for the backend. This callback is
|
||||
%% called by `mnesia_schema:init_backend/2' and must return ok to
|
||||
%% continue the execution and add aliases.
|
||||
%%
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
init_backend() ->
|
||||
application:start(mnesia_unixfs),
|
||||
ok.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc this callback is called by
|
||||
%% `mnesia_schema:verify_external_copy/2'
|
||||
%%
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
-spec check_definition(Alias, Table, Nodes, Properties) -> Return when
|
||||
Alias :: alias(),
|
||||
Table :: tab(),
|
||||
Nodes :: nodes(),
|
||||
Properties :: proplists:proplist(),
|
||||
Return :: ok.
|
||||
|
||||
check_definition(Alias, Table, Nodes, Properties) ->
|
||||
ok.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc Delete a key in an opened and active table. This callback is
|
||||
%% called by:
|
||||
%%
|
||||
%% <ul>
|
||||
%% <li>`mnesia:delete/3'</li>
|
||||
%% <li>`mnesia_lib:do_erase/3'</li>
|
||||
%% <li>`mnesia_loader:down/2'</li>
|
||||
%% </ul>
|
||||
%%
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
-spec delete(Alias, Table, Key) -> Return when
|
||||
Alias :: alias(),
|
||||
Table :: tab(),
|
||||
Key :: key(),
|
||||
Return :: ok.
|
||||
|
||||
delete(Alias, Table, Key) -> ok.
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
%% @doc Delete a table.
|
||||
%%
|
||||
%% <ul>
|
||||
%% <li>`mnesia_bup:delete_ext/2'</li>
|
||||
%% <li>`mnesia_checkpoint:retainer_create/5'</li>
|
||||
%% <li>`mnesia_checkpoint:retainer_delete/1'</li>
|
||||
%% <li>`mnesia_dumper:disc_delete_table/2'</li>
|
||||
%% <li>`mnesia_dumper:inset_op/5'</li>
|
||||
%% <li>`mnesia_index:delete_transient_index/3'</li>
|
||||
%% <li>`mnesia_schema:undo_prepare_op/2'</li>
|
||||
%% </ul>
|
||||
%%
|
||||
%% @end
|
||||
%%--------------------------------------------------------------------
|
||||
-spec delete_table(Alias, Table) -> Return when
|
||||
Alias :: alias(),
|
||||
Table :: tab(),
|
||||
Return :: ok.
|
||||
|
||||
delete_table(Alias, Table) -> ok.
|
||||
|
||||
Reference in New Issue
Block a user