package sihl

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

The repository service deals with cleaning repositories. This is useful for integration tests.

Installation

Use the provided Sihl.Data.Repo.Service.Make to instantiate a repo service.

module Repo = Sihl.Data.Repo.Service.Make ()
module Service : sig ... end

Usage

You typically want to use the repo service in your own repositories in order to register repository cleaners. This allows Sihl to reset the state of your system after integration tests.

{ let cleaner = ... in Repo.register_cleaer cleaner; }

In order to clean all repositories that have registered cleaners you can call clean_all:

{ open Lwt.Syntax let* () = Repo.clean_all ctx in .. }

module Meta : sig ... end

Repositories can return meta data containing information like total rows affected. This can be useful for pagination.

module Dynparam : sig ... end

This module can be used to assemble dynamic repository queries. This is typically used if you don't know the number of parameters at compile time because they are provided by the user, for instance as a filter or sort. http://paurkedal.github.io/ocaml-caqti/caqti/Caqti_request/index.html#how-to-dynamically-assemble-queries-and-parameters

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