forks/esqlite
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Specs for the backup api

Browse Source
This commit is contained in:
Maas-Maarten Zeeman
2022-05-29 17:19:04 +02:00
parent 331579e8dc
commit 540bd64263
4 changed files with 27 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/esqlite3.erl
View File

@@ -430,22 +430,28 @@ backup_init(#esqlite3{db=Dest}, DestName, #esqlite3{db=Src}, SrcName) ->
end.
%% @doc Release the resources held by the backup.
-spec backup_finish(esqlite3_backup()) -> ok | {error, _}.
-spec backup_finish(Backup) -> Result when
Backup :: esqlite3_backup(),
Result :: ok | error().
backup_finish(#esqlite3_backup{backup=Backup}) ->
esqlite3_nif:backup_finish(Backup).
%% @doc Do a backup step.
-spec backup_step(esqlite3_backup(), integer()) -> ok | {error, _}.
-spec backup_step(esqlite3_backup(), integer()) -> ok | '$done' | error().
backup_step(#esqlite3_backup{backup=Backup}, NPage) ->
esqlite3_nif:backup_step(Backup, NPage).
%% @doc Get the remaining number of pages which need to be backed up.
-spec backup_remaining(esqlite3_backup()) -> pos_integer().
-spec backup_remaining(Backup) -> Remaining when
Backup :: esqlite3_backup(),
Remaining :: integer().
backup_remaining(#esqlite3_backup{backup=Backup}) ->
esqlite3_nif:backup_remaining(Backup).
%% @doc Get the remaining number of pages which need to be backed up.
-spec backup_pagecount(esqlite3_backup()) -> pos_integer().
-spec backup_pagecount(Backup) -> Pagecount when
Backup :: esqlite3_backup(),
Pagecount :: integer().
backup_pagecount(#esqlite3_backup{backup=Backup}) ->
esqlite3_nif:backup_pagecount(Backup).