helm/software/components/hmysql/hSql.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 type dbd
  27 type result
  28 type error_code =
  29  | OK
  30  | Table_exists_error
  31  | Dup_keyname
  32  | No_such_table
  33  | No_such_index
  34  | Bad_table_error
  35  | GENERIC_ERROR of string
  36
  37 exception Error of string
  38
  39 (* the exceptions raised are from the Mysql module *)
  40
  41 type dbtype = User | Library | Legacy
  42
  43   (* host port dbname user password type *)
  44 type dbspec
  45
  46 val mk_dbspec :
  47   (string * int option * string * string * string option * dbtype) list ->
  48     dbspec
  49
  50 val quick_connect : dbspec -> dbd
  51
  52 val disconnect : dbd -> unit
  53
  54 val exec: dbtype -> dbd -> string -> result
  55 val map : result -> f:(string option array -> 'a) -> 'a list
  56 val iter : result -> f:(string option array -> unit) -> unit
  57
  58
  59 val errno : dbtype -> dbd -> error_code
  60 (* val status : dbd -> Mysql.status *)
  61
  62 val escape: dbtype -> dbd -> string -> string
  63
  64 val escape_string_for_like: dbtype -> dbd -> ('a,'b,'c,'a) format4
  65
  66 val isMysql : dbtype -> dbd -> bool
  67
  68 (* this dbd can't do queries, used only in table_creator *)
  69 val fake_db_for_mysql: dbtype -> dbd
  70