On This Page
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
package caqti-async
Module CONNECTION.ResponseSource
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
Source
val returned_count :
('b, 'm) t ->
(int, [> Caqti_error.retrieve | `Unsupported ]) result
Async_kernel.Deferred.treturned_count resp is the number of rows returned by resp. This function may not be available for all drivers.
Source
val affected_count :
('b, 'm) t ->
(int, [> Caqti_error.retrieve | `Unsupported ]) result
Async_kernel.Deferred.taffected_count resp is the number of rows affected by the updated the produced resp. This function may not be available for all drivers.
Result retrieval
Source
val exec :
(unit, [< `Zero ]) t ->
(unit, [> Caqti_error.retrieve ]) result Async_kernel.Deferred.texec resp checks that resp succeeded with no result rows.
Source
val find :
('b, [< `One ]) t ->
('b, [> Caqti_error.retrieve ]) result Async_kernel.Deferred.tfind resp checks that resp succeeded with a single row, and returns the decoded row.
Source
val find_opt :
('b, [< `Zero | `One ]) t ->
('b option, [> Caqti_error.retrieve ]) result Async_kernel.Deferred.tfind_opt resp checks that resp succeeded with at most one row, and returns the row if any.
Source
val fold :
('b -> 'c -> 'c) ->
('b, 'm) t ->
'c ->
('c, [> Caqti_error.retrieve ]) result Async_kernel.Deferred.tfold f resp folds f over the decoded rows returned in resp.
Source
val fold_s :
('b -> 'c -> ('c, 'e) result Async_kernel.Deferred.t) ->
('b, 'm) t ->
'c ->
('c, [> Caqti_error.retrieve ] as 'e) result Async_kernel.Deferred.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.
Source
val iter_s :
('b -> (unit, 'e) result Async_kernel.Deferred.t) ->
('b, 'm) t ->
(unit, [> Caqti_error.retrieve ] as 'e) result Async_kernel.Deferred.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.
to_stream resp returns a stream whose elements are the decoded rows returned by resp.
On This Page