Request_utils (u.a15c322f268e3f4cc39a9a68c0de2e3d.caqti.2.1.2.doc.caqti.platform.Caqti_platform.Request

Queries

Sourcetype linear_param =

| Linear_param : int * 'a Caqti_type.Field.t * 'a -> linear_param

val linear_param_length : 
  ?env:(string -> Caqti_query.t) ->
  Caqti_query.t ->
  int

linear_param_length templ is the number of linear parameters expected by a query represented by templ.

Source

val linear_param_order : 
  ?env:(string -> Caqti_query.t) ->
  Caqti_query.t ->
  int list list * linear_param list

linear_param_order templ describes the parameter bindings expected for templ after linearizing parameters and lifting quoted strings out of the query:

The first is a list where item number i is a list of linear parameter positions to which to bind the ith incoming parameter.

The second is a list of Linear_param (i, t, v) where i is the position of the linear parameter taking the place of a embedded value, t is its field type, and v is the value itself.

All positions are zero-based.

Source

val linear_query_string : 
  ?env:(string -> Caqti_query.t) ->
  Caqti_query.t ->
  string

linear_query_string templ is templ where "?" is substituted for parameters and quoted strings.

Parameter Encoding and Row Decoding

Source

val raise_encode_missing : 
  uri:Uri.t ->
  field_type:'a Caqti_type.Field.t ->
  unit ->
  'counit

Source

val raise_encode_rejected : 
  uri:Uri.t ->
  typ:'a Caqti_type.t ->
  Caqti_error.msg ->
  'counit

Source

val raise_encode_failed : 
  uri:Uri.t ->
  typ:'a Caqti_type.t ->
  Caqti_error.msg ->
  'counit

Source

val raise_decode_missing : 
  uri:Uri.t ->
  field_type:'a Caqti_type.Field.t ->
  unit ->
  'counit

Source

val raise_decode_rejected : 
  uri:Uri.t ->
  typ:'a Caqti_type.t ->
  Caqti_error.msg ->
  'counit

Source

val raise_response_failed : 
  uri:Uri.t ->
  query:string ->
  Caqti_error.msg ->
  'counit

Source

val raise_response_rejected : 
  uri:Uri.t ->
  query:string ->
  Caqti_error.msg ->
  'counit

Sourcetype 'a field_encoder = {

write_value : 'b. uri:Uri.t -> 'b Caqti_type.Field.t -> 'b -> 'a -> 'a;
write_null : 'b. uri:Uri.t -> 'b Caqti_type.Field.t -> 'a -> 'a;

} constraint 'e = [> `Encode_rejected of Caqti_error.coding_error ]

Source

val encode_param : 
  uri:Uri.t ->
  'a field_encoder ->
  'b Caqti_type.t ->
  'b ->
  'a ->
  'a

Sourcetype 'a field_decoder = {

read_value : 'b. uri:Uri.t -> 'b Caqti_type.Field.t -> 'a -> 'b * 'a;
skip_null : int -> 'a -> 'a option;

} constraint 'e = [> `Decode_rejected of Caqti_error.coding_error ]

Source

val decode_row : 
  uri:Uri.t ->
  'a field_decoder ->
  'b Caqti_type.t ->
  'a ->
  'b * 'a