package irmin-pack

  1. Overview
  2. Docs
Irmin backend which stores values in a pack file

Install

Dune Dependency

Authors

Maintainers

Sources

irmin-2.10.0.tbz
sha256=58b4d058252fc3fca27aa4704594758ea17b5b549076495b53dea7217bd6e64a
sha512=3f7d7817b708d2be41bf81fb7c8f637e0331cc73ffc49d54ae809982d5f258f62255c892ed22c58688034ffa0aa7d32cb7fadb1b188a22ff0ddf80352da3d28b

doc/irmin-pack/Irmin_pack/index.html

Module Irmin_packSource

Sourcemodule Dict : sig ... end
Sourcemodule Index : sig ... end
Sourcemodule Conf : sig ... end
Sourcemodule Inode : sig ... end
Sourcemodule Pack_value : sig ... end
Sourcemodule Pack_store : sig ... end
Sourcemodule Version : sig ... end

Management of disk-format versions.

Sourceval config : ?fresh:bool -> ?readonly:bool -> ?lru_size:int -> ?index_log_size:int -> ?merge_throttle:Conf.merge_throttle -> ?freeze_throttle:Conf.freeze_throttle -> string -> Irmin.config

Configuration options for stores.

  • parameter fresh

    whether an existing store should be overwritten.

  • parameter read_only

    whether read-only mode is enabled for this store.

  • parameter lru_size

    the maximum number of bindings in the lru cache.

  • parameter index_log_size

    the maximum number of bindings in the index cache.

  • parameter index_throttle

    the strategy to use when the index cache is full and an async Index.merge in already in progress. Block_writes (the default) blocks any new writes until the merge is completed. Overcommit_memory does not block but indefinitely expands the in-memory cache.

Sourceexception RO_not_allowed
Sourcemodule Make (_ : Version.S) : sig ... end
Sourcemodule V1 : sig ... end
Sourcemodule V2 : sig ... end
Sourcemodule type S = sig ... end
Sourcemodule type Specifics = sig ... end
Sourcemodule Stats : sig ... end
Sourcemodule Layout : sig ... end

Defines the location of the IO instances within the main irmin-pack store directory.

Sourcemodule Checks : sig ... end

Offline stats for Irmin stores.

Sourceval migrate : Irmin.config -> unit

migrate conf upgrades the repository with configuration conf to use the latest storage format.

Note: performing concurrent store operations during the migration, or attempting to use pre-migration instances of the repository after the migration is complete, will result in undefined behaviour.

Sourcemodule Content_addressable : sig ... end
Sourcemodule Atomic_write : sig ... end
Sourcemodule IO : sig ... end
Sourcemodule Utils : sig ... end
Sourcemodule type Maker = functor (_ : Conf.S) -> sig ... end
OCaml

Innovation. Community. Security.