helm/software/components/hmysql/hMysql.mli

   1 (* Copyright (C) 2005, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://cs.unibo.it/helm/.
  24  *)
  25
  26 (**
  27  * {2 Proxy module around MySQL conection}
  28  *
  29  * The behaviour of this module is influenced by the Helm_registry boolean value
  30  * of the "db.nodb" key. When set to "false" the module works as expected. When
  31  * set to "true" all functions perform dummy action: connect and disconnect do
  32  * nothing; exec, iter, and map work like the empty set of results has been
  33  * returned; errno and status return Mysql.Connection_error
  34  *)
  35
  36 type dbd
  37 type result
  38
  39 (* the exceptions raised are from the Mysql module *)
  40
  41 val quick_connect :
  42   ?host:string ->
  43   ?database:string ->
  44   ?port:int -> ?password:string -> ?user:string -> unit -> dbd
  45
  46 val disconnect : dbd -> unit
  47
  48 val exec: dbd -> string -> result
  49 val map : result -> f:(string option array -> 'a) -> 'a list
  50 val iter : result -> f:(string option array -> unit) -> unit
  51
  52 val errno : dbd -> Mysql.error_code
  53 val status : dbd -> Mysql.status
  54
  55 val escape: string -> string
  56