amnesia v0.2.2 Amnesia.Backup behaviour
This module provides a behavior to implement a backup module and helpers to use backups.
Summary
Functions
Create a checkpoint, see mnesia:activate_checkpoint
Create a checkpoint with the given name, see mnesia:activate_checkpoint
Install a fallback with the default backup module, see mnesia:install_fallback
Install a fallback with the given backup module, see mnesia:install_fallback
Install a fallback with the given backup module and options, see mnesia:install_fallback
Restore a backup, see mnesia:restore
Restore a backup with the given module, see mnesia:restore
Start a backup with the default backup module, see mnesia:backup
Start a backup of a given checkpoint, see mnesia:backup_checkpoint
Traverse a backup, see mnesia:traverse_backup
Traverse a backup with custom backup modules, see mnesia:traverse_backup
Uninstall a fallback, see mnesia:uninstall_fallback
Uninstall a fallback, see mnesia:uninstall_fallback
Uninstall a fallback, see mnesia:uninstall_fallback
Callbacks
Close the backup if the backup is interrupted
Close the backup
Commit the write to the backup
Open the backup for reading
Open the backup for writing
Read terms from the backup
Write the given terms to the backup
Types
Functions
Specs
checkpoint(Keyword.t) ::
{:ok, any, [node]} |
{:error, any}
Create a checkpoint, see mnesia:activate_checkpoint
.
Specs
checkpoint(any, Keyword.t) ::
{:ok, any, [node]} |
{:error, any}
Create a checkpoint with the given name, see mnesia:activate_checkpoint
.
Specs
install(any) :: :ok | {:error, any}
install(atom | any) :: :ok | {:error, any}
Install a fallback with the default backup module, see mnesia:install_fallback
.
Specs
install(atom, any, i) :: :ok | {:error, any}
Install a fallback with the given backup module and options, see mnesia:install_fallback
.
Specs
restore(any, r) :: [atom] | {:error, any}
Restore a backup, see mnesia:restore
.
Specs
restore(atom, any, r) ::
{:atomic, [atom]} |
{:aborted, any}
Restore a backup with the given module, see mnesia:restore
.
Specs
start(any) :: :ok | {:error, any}
Start a backup with the default backup module, see mnesia:backup
.
Specs
start(any, any) :: :ok | {:error, any}
Start a backup of a given checkpoint, see mnesia:backup_checkpoint
.
Specs
traverse(any, any, any, ([tuple], any -> any)) ::
{:ok, any} |
{:error, any}
Traverse a backup, see mnesia:traverse_backup
.
Specs
traverse(atom, any, atom, any, any, ([tuple], any -> any)) ::
{:ok, any} |
{:error, any}
Traverse a backup with custom backup modules, see mnesia:traverse_backup
.
Specs
uninstall :: :ok | {:error, any}
Uninstall a fallback, see mnesia:uninstall_fallback
.
Specs
uninstall(i) :: :ok | {:error, any}
Uninstall a fallback, see mnesia:uninstall_fallback
.
Specs
uninstall(atom, i) :: :ok | {:error, any}
Uninstall a fallback, see mnesia:uninstall_fallback
.