helm/ocaml/mathql_interpreter/mQIConn.mli

   1 (* Copyright (C) 2000, 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 (*  AUTOR: Ferruccio Guidi <fguidi@cs.unibo.it>
  27  *)
  28
  29 type connection = MySQL_C    of Mysql.dbd
  30                 | Postgres_C of Postgres.connection
  31                 | No_C
  32
  33 type flag = Galax | Postgres | Queries | Result | Source | Times | Warn
  34
  35 type handle = {
  36    log : string -> unit; (* logging function        *)
  37    set : flag list;      (* options                 *)
  38    pgc : connection;     (* PG connection           *)
  39    pgm : MQIMap.pg_map;  (* PG conversion function  *)
  40    pga : MQIMap.pg_alias (* PG table aliases        *)
  41 }
  42
  43 val string_of_flags : flag list -> string
  44 val flags_of_string : string -> flag list
  45
  46 val init      : ?flags:(flag list) -> ?log:(string -> unit) -> unit -> handle
  47 val close     : handle -> unit
  48 val connected : handle -> bool
  49 val exec      : handle -> (MQITypes.query -> unit) ->
  50                 MQITypes.table -> MQITypes.columns ->
  51                 string MQITypes.con_true -> string MQITypes.con_false ->
  52                 MQITypes.result
  53
  54 val init_if_connected : ?flags:(flag list) -> ?log:(string -> unit) -> unit -> handle
  55
  56 (* The following functions allow to read the handle internal fields.
  57  * For exclusive use of the interpreter.
  58  *)
  59
  60 val log     : handle -> string -> unit
  61 val set     : handle -> flag -> bool
  62 val flags   : handle -> flag list
  63 val tables  : handle -> MathQL.path -> MQIMap.pg_tables
  64 val field   : handle -> MathQL.path -> string -> string
  65 val resolve : handle -> string -> string