package octez-internal-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65
doc/octez-internal-libs.irmin_pack/Irmin_pack/Conf/index.html
Module Irmin_pack.ConfSource
type inode_child_order = [ | `Seeded_hash(*use a non-crypto seeded-hash of the step
*)| `Hash_bits(*crypto hash the step and extract the relevant bits.
*)| `Custom of depth:int -> bytes -> int(*use a custom index
*)
]Strategy for when attempting to write when the index log is full and waiting for an in-progress merge to complete.
`Block_writeswill block writes`Overcommit_memorywill allow writes by growing the in-memory cache indefinitely
Flag to indicate that the store will start with fresh data on disk. Warning: setting this to true will delete existing data. Default is false.
Maximum size, in number of entries, of LRU cache. Default 100_000. Unused if lru_max_memory is set.
Maximum memory, in bytes, for the LRU cache to use. Default None, which falls back to lru_size for LRU limit.
Size, in number of entries, of index log. Default 2_500_000.
Flag for opening data in read-only mode. Default false.
Strategy for how to handle writes when index log is full and a merge is in-progress. Default `Block_writes.
Location of directory for saving data on disk.
Note: The path before the root directory must exist. Only the final directory in the path will be created if it is missing.
Optional path for lower layer directory. Default None.
The presence or not of a lower layer has implications on the behaviour of the GC: if a lower layer is present, the GC will archive data instead of deleting it.
Strategy for choosing which objects to index. See Indexing_strategy.t for more discussion. Default Indexing_strategy.default
Flag to indicate that fsync should be used to enforce durability when flushing data to disk. Default false.
Size, in bytes, when automatic flushing of dict file to disk. Default 1_000_000.
Size, in bytes, when automatic flushing of suffix file to disk. Default 1_000_000.
Flag to prevent migration of data. Default false.
val init :
?fresh:bool ->
?readonly:bool ->
?lru_size:int ->
?lru_max_memory:int option ->
?index_log_size:int ->
?merge_throttle:merge_throttle ->
?indexing_strategy:Indexing_strategy.t ->
?use_fsync:bool ->
?dict_auto_flush_threshold:int ->
?suffix_auto_flush_threshold:int ->
?no_migrate:bool ->
?lower_root:string option ->
string ->
Irmin.configinit root creates a backend configuration for storing data with default configuration parameters and stored at root. Flags are documented above.