C (u.9c94ee1093bf5e4955a781918b551052.caqti.1.9.0.doc.caqti.Caqti_connection.Make

Query

module Response : 
  Caqti_response_sig.S
    with type 'a future := 'a Sys.future
     and type ('a, 'err) stream := ('a, 'err) Sys.Stream.t

val call : 
  f:(('b, 'm) Response.t -> ('c, 'e) result Sys.future) ->
  ('a, 'b, 'm) Caqti_request.t ->
  'a ->
  ('c, [> Caqti_error.call ] as 'e) result Sys.future

call ~f request params performs request with parameters params invoking f to process the result. The argument of f is only valid during the call to f, and must not be returned or operated on by other threads.

val set_statement_timeout : 
  float option ->
  (unit, [> Caqti_error.call ]) result Sys.future

Set or clear the timeout after which a running SQL statement will be terminated if supported by the driver. This is currently supported for MariaDB (using max_statement_time) and PostgreSQL (using statement_timeout) and has no effect for SQLite3.

Transactions

val start : unit -> (unit, [> Caqti_error.transact ]) result Sys.future

Starts a transaction if supported by the underlying database, otherwise does nothing.

val commit : unit -> (unit, [> Caqti_error.transact ]) result Sys.future

Commits the current transaction if supported by the underlying database, otherwise does nothing.

val rollback : unit -> (unit, [> Caqti_error.transact ]) result Sys.future

Rolls back a transaction if supported by the underlying database, otherwise does nothing.

Disconnection and Reuse

val deallocate : 
  ('a, 'b, 'm) Caqti_request.t ->
  (unit, [> Caqti_error.call ]) result Sys.future

deallocate req deallocates the prepared query for req if it was allocated. The request must not be oneshot.

val disconnect : unit -> unit Sys.future

Calling disconnect () closes the connection to the database and frees up related resources.

val validate : unit -> bool Sys.future

For internal use by Caqti_pool. Tries to ensure the validity of the connection and must return false if unsuccessful.

val check : (bool -> unit) -> unit

For internal use by Caqti_pool. Called after a connection has been used. check f must call f () exactly once with an argument indicating whether to keep the connection in the pool or discard it.