(* Copyright (C) 2005, HELM Team.
 * 
 * This file is part of HELM, an Hypertextual, Electronic
 * Library of Mathematics, developed at the Computer Science
 * Department, University of Bologna, Italy.
 * 
 * HELM is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * HELM is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HELM; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
 * MA  02111-1307, USA.
 * 
 * For details, see the HELM World-Wide-Web page,
 * http://cs.unibo.it/helm/.
 *)

(**
 * {2 Proxy module around MySQL conection}
 *
 * The behaviour of this module is influenced by the Helm_registry boolean value
 * of the "db.nodb" key. When set to "false" the module works as expected. When
 * set to "true" all functions perform dummy action: connect and disconnect do
 * nothing; exec, iter, and map work like the empty set of results has been
 * returned; errno and status return Mysql.Connection_error
 *)

type dbd
type result

(* the exceptions raised are from the Mysql module *)

val quick_connect :
  ?host:string ->
  ?database:string ->
  ?port:int -> ?password:string -> ?user:string -> unit -> dbd

val disconnect : dbd -> unit

val exec: dbd -> string -> result
val map : result -> f:(string option array -> 'a) -> 'a list
val iter : result -> f:(string option array -> unit) -> unit

val errno : dbd -> Mysql.error_code
val status : dbd -> Mysql.status

val escape: string -> string