impl/sqlgg_traits.ml

   1 (**
   2   OCaml traits signature for sqlgg
   3   by ygrek
   4   2014-06-08
   5
   6   This is free and unencumbered software released into the public domain.
   7
   8   Anyone is free to copy, modify, publish, use, compile, sell, or
   9   distribute this software, either in source code form or as a compiled
  10   binary, for any purpose, commercial or non-commercial, and by any
  11   means.
  12
  13   For more information, please refer to <http://unlicense.org/>
  14 *)
  15
  16 module type M = sig
  17
  18   type statement
  19   type connection
  20   type params
  21   type row
  22   type result
  23
  24   (** datatypes *)
  25   type num = int64
  26   type text = string
  27   type any = text
  28   type datetime = float
  29
  30   exception Oops of string
  31
  32   val get_column_Int : row -> int -> num
  33   val get_column_Text : row -> int -> text
  34   val get_column_Any : row -> int -> any
  35   val get_column_Float : row -> int -> float
  36   val get_column_Datetime : row -> int -> datetime
  37
  38   val start_params : statement -> int -> params
  39   val finish_params : params -> result
  40
  41   (** [set_param_* stmt index val]. [index] is 0-based,
  42     @raise Oops on error *)
  43   val set_param_null : params -> int -> unit
  44   val set_param_Text : params -> int -> text -> unit
  45   val set_param_Any : params -> int -> any -> unit
  46   val set_param_Int : params -> int -> num -> unit
  47   val set_param_Float : params -> int -> float -> unit
  48   val set_param_Datetime : params -> int -> datetime -> unit
  49
  50   val no_params : statement -> result
  51
  52   (**
  53     Perform query and return results via callback for each row
  54     @raise Oops on error
  55   *)
  56   val select : connection -> string -> (statement -> result) -> (row -> unit) -> unit
  57
  58   (**
  59     Perform query and return first row if available
  60     @raise Oops on error
  61   *)
  62   val select1 : connection -> string -> (statement -> result) -> (row -> 'b) -> 'b option
  63
  64   (** Execute non-query.
  65     @raise Oops on error
  66     @return number of affected rows
  67   *)
  68   val execute : connection -> string -> (statement -> result) -> int64
  69
  70 end