package irmin

  1. Overview
  2. Docs
package irmin
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Irmin

Irmin is a distributed database built on the same principles as Git. It can be used as an OCaml library that provides persistent stores with built-in snapshot, branching, merging, history tracking, and reverting mechanisms, similar to a version control system like Git, but for data rather than code.

Release 3.10.0 - %%HOMEPAGE%%

Irmin API

The irmin package defines the public API of Irmin. The module Irmin is this library's entry point.

Backends

Irmin is designed to use a large variety of backends:

  • Irmin_mem: An in-memory store provided in the irmin package (this package).
  • Irmin_git: A backend that exposes a bidirectional bridge to a Git repository, provided by the irmin-git package.
  • Irmin_pack: A space-optimised, on-disk store inspired by Git Packfiles, provided in the irmin-pack package.
  • Irmin_mirage: A MirageOS compatible store, provided in the irmin-mirage package.

Helpers and Internal Utilities

irmin.unix

The irmin.unix package provides Irmin related utilities for Unix applications.

The module Irmin_unix is this library's entry point.

irmin.data

This package contains data structure implementations used in the implementation of Irmin. It is exposed only for internal use and does not provide a stable API.

The module Irmin_data is this library's entry point.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct