Version control
Version control
Type of version controller
val create :
?hashcons:Hashcons.config ->
?node_cache:Index.t Node_cache.t ->
?lock:bool ->
?resize_step_bytes:int ->
?auto_flush_seconds:int ->
Context.config ->
Fs_nameenc.t ->
string ->
(t, Error.t) Result_lwt.tCreate an empty commit store
val open_existing_for_read :
?hashcons:Hashcons.config ->
?node_cache:Index.t Node_cache.t ->
Context.config ->
Fs_nameenc.t ->
string ->
(t, Error.t) Result_lwt.tOpens a commit store of the given name if it exists. Otherwise, it creates a new store.
val open_for_write :
?hashcons:Hashcons.config ->
?node_cache:Index.t Node_cache.t ->
?resize_step_bytes:int ->
?auto_flush_seconds:int ->
Context.config ->
Fs_nameenc.t ->
string ->
(t, Error.t) Result_lwt.tClose the version control. Once closed, further uses of t are unspecified.
Returns a cursor pointing to a leaf with the value specified by the given bytes
val checkout : t -> Commit_hash.t -> Fs.cursor option Lwt.tCheckout the commit of the given commit hash
val checkout' : t -> Commit_hash.t -> (Commit.t * Fs.cursor) option Lwt.tSame as checkout but returns the commit information together
val mem : t -> Commit_hash.t -> bool Lwt.tCheck the given commit hash is known
val compute_commit_hash :
t ->
parent:Commit_hash.t option ->
Fs.cursor ->
Fs.cursor * Commit_hash.tCompute the commit hash for the root of the current tree. The cursor is moved to the root.
Note that the commit hash is NOT the top Merkle hash of the cursor. It is computed from the top Merkle hash and the parent commit hash
val commit :
?allow_missing_parent:bool ->
t ->
parent:Commit_hash.t option ->
hash_override:Commit_hash.t option ->
(Hash.Prefix.t * Commit.t) Fs.Op_lwt.tCommit the contents of the cursor at the root. It then returns the updated cursor, the hash, and the commit information.
If override is false (by default), hash collision fails the function. If it is true, it overwrites the hash.
The commit will be persisted to the disk eventually, but may be lost if the program crashes. To make it surely persisted, sync must be called explicitly.
val flush : t -> unit Lwt.tSynchronize the commits to the disk. Commits after the last call of this flush may be lost when the program crashes.
Too frequent call of this function may slow down the system.
val commit_db : t -> Commit_db.tUnderlying commit database