package tezos-store

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Block info stored in the index map

package tezos-store

tezos-store
- Tezos_store
  - Block_key
    
    Error_table
    
    Logging
    
    Map
    
    Legacy
    
    Set
    
    Legacy
    
    Table
    
    Legacy
    
    WeakRingTable
  - Block_level
  - Block_repr
  - Block_store
  - Cemented_block_store
    
    Cemented_block_hash_index
    
    Checks
    
    Integrity_check
    
    Stat
    
    Cemented_block_level_index
    
    Checks
    
    Integrity_check
    
    Stat
  - Consistency
  - Floating_block_index
    
    Block_info
    
    Checks
    
    Integrity_check
    
    Stat
  - Floating_block_store
  - Naming
  - Protocol_store
  - Reconstruction
  - Reconstruction_events
    
    Event
  - Snapshots
  - Snapshots_events
    
    Event
  - Store
    
    Block
    
    Chain
    
    Chain_traversal
    
    Protocol
  - Store_events
  - Store_types
    
    Block_lru_cache
    
    Protocol_levels
    
    Legacy
  - Stored_data

Legend:
Library
Module
Module type
Parameter
Class
Class type

Floating blocks index map

Block info stored in the index map

module Block_info : sig ... end

Module Block_info represents the values stored in the index which are used to locate the position of a block in a floating block store and its predecessors.

Key/value index associated to a floating block store where the key is a Block_hash.t and the value is Block_info.t.

include Index.S
  with type key = Tezos_crypto.Block_hash.t
   and type value = Block_info.t

type t

The type for indexes.

type key = Tezos_crypto.Block_hash.t

The type for keys.

type value = Block_info.t

The type for values.

type cache

The type for caches of index instances.

val empty_cache : unit -> cache

Construct a new empty cache of index instances.

val v : 
  ?flush_callback:(unit -> unit) ->
  ?cache:cache ->
  ?fresh:bool ->
  ?readonly:bool ->
  ?throttle:[ `Overcommit_memory | `Block_writes ] ->
  ?lru_size:int ->
  log_size:int ->
  string ->
  t

The constructor for indexes.

parameter flush_callback
A function to be called before any new bindings are persisted to disk (including both automatic flushing and explicit calls to flush or close).
This can be used to ensure certain pre-conditions are met before bindings are persisted to disk. (For instance, if the index bindings are pointers into another data-structure d, it may be necessary to flush d first to avoid creating dangling pointers.)

parameter cache
used for instance sharing.

parameter fresh
whether an existing index should be overwritten.

parameter read_only
whether read-only mode is enabled for this index.

parameter throttle
the strategy to use when the cache are full and and async in already in progress. Block_writes (the default) blocks any new writes until the merge is completed. Overcommit_memory does not block but continues to fill the (already full) cache.

parameter log_size
the maximum number of bindings in the `log` IO.

parameter lru_size
the maximum number of recently-read index bindings kept in memory. Defaults to 30_000.

val clear : t -> unit

clear t clears t so that there are no more bindings in it.

val find : t -> key -> value

find t k is the binding of k in t.

val mem : t -> key -> bool

mem t k is true iff k is bound in t.

val replace : ?overcommit:bool -> t -> key -> value -> unit

replace t k v binds k to v in t, replacing any existing binding of k.

If overcommit is true, the operation does not triger a merge, even if the caches are full. By default overcommit is false.

val filter : t -> ((key * value) -> bool) -> unit

filter t p removes all the bindings (k, v) that do not satisfy p. This operation is costly and blocking.

val iter : (key -> value -> unit) -> t -> unit

Iterates over the index bindings. Limitations:

Order is not specified.
In case of recent replacements of existing values (since the last merge), this will hit both the new and old bindings.
May not observe recent concurrent updates to the index by other processes.

val flush : ?no_callback:unit -> ?with_fsync:bool -> t -> unit

Flushes all internal buffers of the IO instances.

Passing ~no_callback:() disables calling the flush_callback passed to v.
If with_fsync is true, this also flushes the OS caches for each IO instance.

val close : ?immediately:unit -> t -> unit

Closes all resources used by t, flushing any internal buffers in the instance.

If immediately is passed, this operation will abort any ongoing background processes. This guarantees not to corrupt the store, but may require additional work to be done on the next startup.

val sync : t -> unit

sync t syncs a read-only index with the files on disk. Raises RW_not_allowed if called by a read-write index.

val is_merging : t -> bool

is_merging t returns true if t is running a merge. Raises RO_not_allowed if called by a read-only index.

val merge : t -> unit

merge t forces a merge for t.

If there is no merge running, this operation is non-blocking, i.e. it returns immediately, with the merge running concurrently.

If a merge is running already, this operation blocks until the previous merge is complete. It then launches a merge (which runs concurrently) and returns.

val try_merge : t -> unit

try_merge is like merge but is a no-op if the number of entries in the write-ahead log is smaller than log_size.

module Checks : sig ... end

Offline fsck-like utility for checking the integrity of Index stores built using this module.