helm/software/components/metadata/sqlStatements.mli

   1 (* Copyright (C) 2004-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://helm.cs.unibo.it/
  24  *)
  25
  26 (** table shape kinds *)
  27 type tbl = [ `RefObj| `RefSort| `RefRel| `ObjectName| `Hits| `Count]
  28
  29 (** all functions below return either an SQL statement or a list of SQL
  30  * statements.
  31  * For functions taking as argument (string * tbl) list, the meaning is a list
  32  * of pairs <table name, table type>; where the type specify the desired kind of
  33  * table and name the desired name (e.g. create a `RefObj like table name
  34  * refObj_NEW) *)
  35
  36 val create_tables: (string * tbl) list -> string list
  37 val create_indexes: (string * tbl) list -> string list
  38 val drop_tables: (string * tbl) list -> string list
  39 val drop_indexes: (string * tbl) list -> HSql.dbtype -> HSql.dbd -> string list
  40 val rename_tables: (string * string) list -> string list
  41
  42 (** @param refObj name of the refObj table
  43  * @param hits name of the hits table *)
  44 val fill_hits: string -> string -> string list
  45
  46 (** move content [t1] [t2] [buri]
  47  *  moves all the tuples with 'source' that match regex '^buri' from t1 to t2
  48  *  *)
  49 val move_content: (string * tbl) -> (string * tbl) -> string -> HSql.dbtype ->
  50         HSql.dbd -> string
  51
  52 (** @param refObj name of the refObj table
  53  * @param src uri of the desired 'source' field *)
  54 val direct_deps: string -> UriManager.uri -> HSql.dbtype -> HSql.dbd -> string
  55
  56 (** @param refObj name of the refObj table
  57  * @param src uri of the desired 'h_occurrence' field *)
  58 val inverse_deps: string -> UriManager.uri -> HSql.dbtype -> HSql.dbd -> string
  59