include/anna/dbms/functions.hpp

   1 // ANNA - Anna is Not Nothingness Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_dbms_functions_hpp
  38 #define anna_dbms_functions_hpp
  39
  40 #include <anna/core/RuntimeException.hpp>
  41
  42 namespace anna {
  43 namespace dbms {
  44 class Connection;
  45 }
  46 }
  47
  48 namespace anna {
  49 namespace dbms {
  50
  51 using namespace anna;
  52
  53
  54 /**
  55    Métodos usados habitualmente para trabajar contra la base de datos.
  56 */
  57 struct functions {
  58 public:
  59   /**
  60    * Este metodo asegura la integridad entre el esquema de tablas instalado y el esperado por los procesos de un proyecto.
  61    * Para ello cada uno de los proyectos debe invocar a este método indicado los parámetro requeridos. Es imprescindible
  62    * que la versión esperada del esquema de base de datos esté definida en una única variable centralizada.
  63    *
  64    * La idea es que cada vez que hagamos un cambio en la estructura de tablas de una cierta entidad cambiemos la versión
  65    * del esquema, y ese cambio deberá reflejarse en la invocación a este nuevo método.
  66    *
  67    * Este método lanzará una excepción si el último parche instalado en el esquema de base de datos no coincide
  68    * con el valor de la variable \em requiredPatch.
  69    *
  70    * Cada proceso debe invocar la comprobación de esquema en cuanto la base de datos tenga una conexión disponible, de forma
  71    * que si el esquema de base de datos no coincide con el esperado el proceso mostrará un error indicado el esquema de base
  72    * de datos esperado y el esquema de base datos instalado.
  73    *
  74    * Para usar este método el esquema de base de nuestro proyecto debe disponer de una tabla  que debe contener, al menos,
  75    * la siguiente estructura:
  76    *
  77    * \code
  78    * -- Ejemplo de creación para Oracle(tm)
  79    * create table axe_dataScheme (
  80    *    id varchar(8) not null,
  81    *    installation_date date default sysdate not null
  82    * );
  83    *
  84    * alter table axe_dataScheme add constraint axe_dataScheme_pk primary key (id);
  85    *
  86    * \endcode
  87    *
  88    * \code
  89    * -- Ejemplo de creación para PostgreSQL
  90    * create table data_scheme (
  91    *    id varchar(8) not null,
  92    *    installation_date timestamp default now (),
  93    *    primary key (id)
  94    * );
  95    * \endcode
  96    *
  97    * El nombre de la tabla y los campos de las columnas podrían ser distintos ya que este método los recibe como parámetros.
  98    *
  99    * Un ejemplo de implementación podría ser:
 100    *
 101    * \code
 102    * //static
 103    * void axe::storage::functions::verifyDataScheme (dbms::Connection& connection)
 104    *    throw (RuntimeException)
 105    * {
 106    *    anna::dbms::functions::verifyDataScheme (connection, "axe_dataScheme", "v1.3");
 107    * }
 108    * \endcode
 109    *
 110    * \param connection Conexión usada para acceder a los datos.
 111    * \param tableName Nombre de la tabla que contiene las versiones instaladas.
 112    * \param requiredPatch Identificador de parche de base de base de datos requerido por los procesos de nuestro proyecto.
 113    * Este indicador debería estar definido en un único punto para todo nuestro proyecto.
 114    * \param columnID Nombre de la columna que contiene el identificador de cada uno de los parches instalados.
 115    * \param columnDate Nombre de la columna que contiene la fecha de instalación de cada parche.
 116    */
 117   static void verifyDataScheme(dbms::Connection& connection, const char* tableName, const char* requiredPatch, const char* columnID = "id", const char* columnDate = "installation_date")
 118   throw(RuntimeException);
 119 };
 120
 121 }
 122 }
 123
 124 #endif