To focus the search input from anywhere on the page, press the 'S' key.
in-package search v0.1.0
Library
Module
Module type
Parameter
Class
Class type
The type describing the response and containing returned data from a request execution.
'bis the type of a single row'mis the possible multiplicities of rows
Result inspection
val returned_count :
('b, 'm) t ->
(int, [> Caqti_error.retrieve | `Unsupported ]) result Lwt.treturned_count resp is the number of rows returned by resp. This function may not be available for all databases.
val affected_count :
('b, 'm) t ->
(int, [> Caqti_error.retrieve ]) result Lwt.taffected_count resp is the number of rows affected by the updated the produced resp.
Result retrieval
val exec :
(unit, [< `Zero ]) t ->
(unit, [> Caqti_error.retrieve ]) result Lwt.texec resp checks that resp succeeded with no result rows.
val find : ('b, [< `One ]) t -> ('b, [> Caqti_error.retrieve ]) result Lwt.tfind resp checks that resp succeeded with a single row, and returns the decoded row.
val find_opt :
('b, [< `Zero | `One ]) t ->
('b option, [> Caqti_error.retrieve ]) result Lwt.tfind_opt resp checks that resp succeeded with at most one row, and returns the row if any.
val fold :
('b -> 'c -> 'c) ->
('b, 'm) t ->
'c ->
('c, [> Caqti_error.retrieve ]) result Lwt.tfold f resp folds f over the decoded rows returned in resp.
val fold_s :
('b -> 'c -> ('c, 'e) result Lwt.t) ->
('b, 'm) t ->
'c ->
('c, [> Caqti_error.retrieve ] as 'e) result Lwt.tfold_s f resp folds f over the decoded rows returned by resp within the IO and result monad.
Note. Do not make nested queries in the callback to this function. If you use the same connection, it may lead to data corruption. If you pull a different connection from the same pool, it may deadlock if the pool runs out of connections. Also, some drivers may not support simpltaneous connections.
val iter_s :
('b -> (unit, 'e) result Lwt.t) ->
('b, 'm) t ->
(unit, [> Caqti_error.retrieve ] as 'e) result Lwt.titer_s f resp iterates f over the decoded rows returned by resp within the IO and result monad.
Note. Do not make nested queries in the callback to this function. Cf. fold_s.
val to_stream : ('b, 'm) t -> ('b, [> Caqti_error.retrieve ] as 'err) Stream.tto_stream resp returns a stream whose elements are the decoded rows returned by resp.