package bistro

  1. Overview
  2. Docs
package bistro
Legend:
Library
Module
Module type
Parameter
Class
Class type

A database to cache workflow result and execution traces

It is implemented as a directory in the file system.

type t

An abstract type for databases

type id = string
val init : string -> (t, [ `Msg of string ]) result

init path creates a database located at path path, which can be absolute or relative. If the path already exists, its contents is inspected to see if it looks like a bistro database; if not, a fresh database is created on the filesystem.

Returns an error message if path is occupied with something else than a bistro database.

val init_exn : string -> t
val tmp_dir : t -> string
val cache_dir : t -> string
val stdout_dir : t -> string
val stderr_dir : t -> string
val build_dir : t -> string
val singularity_image_dir : t -> string
val tmp : t -> id -> string
val cache : t -> id -> string
val stdout : t -> id -> string
val stderr : t -> id -> string
val build : t -> id -> string
val singularity_image : t -> Bistro_internals.Workflow.container_image -> string
val container_image_identifier : Bistro_internals.Workflow.container_image -> string
val fold_cache : t -> init:'a -> f:('a -> id -> 'a) -> 'a
val path : t -> Bistro_internals.Workflow.path -> string
val is_in_cache : t -> Bistro_internals.Workflow.any -> bool
val remove : t -> id -> (unit, [> `Msg of string ]) result