val create :
?hashcons:Hashcons.config ->
?node_cache:Index.t Node_cache.t ->
?lock:bool ->
?resize_step_bytes:int ->
?auto_flush_seconds:int ->
Context.config ->
string ->
(t, Error.t) Result_lwt.tCreate an empty commit store.
hashcons: Hashcons configuration node_cache: Node_cache configuration lock: Aquire a lock when true byte_per_cell: The width of the Plebeia cell hash_func: Hashing algorithm bytes_per_hash: Hash width resize_step_bytes: How much additional disk space is allocated each time when the system finds the file is full. auto_flush_seconds: How often automatically flush the additions to the disk at commit in seconds.
val open_existing_for_read :
?hashcons:Hashcons.config ->
?node_cache:Index.t Node_cache.t ->
Context.config ->
string ->
(t, Error.t) Result_lwt.tOpens a commit store of the given name if it exists. Otherwise, it creates a new store.
mode: Opening mode.
See create for the other parameters.
val open_for_write :
?hashcons:Hashcons.config ->
?node_cache:Index.t Node_cache.t ->
?resize_step_bytes:int ->
?auto_flush_seconds:int ->
Context.config ->
string ->
(t, Error.t) Result_lwt.tClose the version control. Once closed, further uses of t are unspecified.
val writer_key : t -> Storage.writer_key optionFor the writer, returns the writer key. For readers, it returns None.
val enable_process_sync :
t ->
Storage.writer_key ->
(unit, Error.t) Stdlib.result Lwt.tFor readers, enable the process sync. See Storage.enable_process_sync
val commit_db : t -> Commit_db.tval checkout : ?keep_info:bool -> t -> Commit_hash.t -> Cursor.t option Lwt.tCheckout the commit of the given commit hash
val checkout' :
?keep_info:bool ->
t ->
Commit_hash.t ->
(Commit.t * Cursor.t) 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 ->
Cursor.t ->
Cursor.t * 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 ->
Cursor.t ->
(Cursor.t * Hash.Prefix.t * Commit.t, Error.t) Stdlib.result Lwt.tCommit the contents of the cursor, then returns the updated cursor at the top, 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 may be lost if the program crashes. To make it surely persisted, call flush explicitly or set auto_flush_seconds.
val flush : t -> unit Lwt.tFlush the commits already done to the disk. The commits before the last flush call are persisted even after a system crash.
Too frequent call of this function may slow down the system.