SYNC provides functions to synchronization an Irmin store with local and remote Irmin stores.
val pp_fetch_error : fetch_error Fmt.tpp_fetch_error pretty prints fetch errors.
val fetch :
db ->
?depth:int ->
remote ->
(commit, fetch_error) Result.result Lwt.tfetch t ?depth r populate the local store t with objects for the remote store r, using t's current branch. The depth parameter limits the history depth. Return None if either the local or remote store do not have a valid head.
Same as fetch but raise Invalid_argument if either the local or remote store do not have a valid head.
val pull :
db ->
?depth:int ->
remote ->
[ `Merge of Info.f | `Set ] ->
(unit, [ fetch_error | Merge.conflict ]) Result.result Lwt.tpull t ?depth r s is similar to fetch but it also updates t's current branch. s is the update strategy:
`Merge uses S.Head.merge. Can return a conflict.`Set uses S.Head.set.Same as pull but raise Invalid_arg in case of conflict.
The type for push errors.
val pp_push_error : push_error Fmt.tpp_push_error pretty-prints push errors.
val push : db -> ?depth:int -> remote -> (unit, push_error) Result.result Lwt.tpush t ?depth r populates the remote store r with objects from the current store t, using t's current branch. If b is t's current branch, push also updates the head of b in r to be the same as in t.
Note: Git semantics is to update b only if the new head if more recent. This is not the case in Irmin.