package sihl

  1. Overview
  2. Docs
package sihl
Legend:
Library
Module
Module type
Parameter
Class
Class type
include Core.Container.SERVICE
val lifecycle : Core__.Core_container.Lifecycle.t
val start : Core__.Core_ctx.t -> Core__.Core_ctx.t Lwt.t
val stop : Core__.Core_ctx.t -> unit Lwt.t

Create a database connection pool. Raises Data_db_core.Exception.

val ctx_with_pool : unit -> Core.Ctx.t

Create a database connection pool and attach the pool to an empty context.

val add_pool : Core.Ctx.t -> Core.Ctx.t

Create a database connection pool and attach to provided context.

val query : Core.Ctx.t -> (Caqti_lwt.connection -> ('a, Caqti_error.t) Stdlib.Result.t Lwt.t) -> 'a Lwt.t

Run a database query.

The context has to contain a database connection or a database connection pool.

val with_connection : Core.Ctx.t -> (Core.Ctx.t -> 'a Lwt.t) -> 'a Lwt.t

Run a database query on a single connection. Can be used to set session variables that are bound to the same connection.

val atomic : Core.Ctx.t -> (Core.Ctx.t -> 'a Lwt.t) -> 'a Lwt.t

Run a database query atomically on a connection.

The context has to contain a database connection or a database connection pool. Fetch a database connection from context if necessary to make sure, that every query runs on the same connection.

val with_disabled_fk_check : Core.Ctx.t -> (Core.Ctx.t -> 'a Lwt.t) -> 'a Lwt.t

Disables foreign key checks if supported by the database.

Use very carefully, data might become inconsistent!

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