include/anna/dbms.mysql/Database.hpp

   1 // ANNA - Anna is Not 'N' 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_mysql_Database_hpp
  38 #define anna_dbms_mysql_Database_hpp
  39
  40 #include <anna/dbms/Database.hpp>
  41 #include <anna/dbms/DatabaseException.hpp>
  42
  43 namespace anna {
  44
  45 namespace dbms {
  46
  47 namespace mysql {
  48
  49 /**
  50    Clase que modela la interaccion entre la RDMS MySQL (tm) y nuestra aplicacion.
  51 */
  52 class Database : public dbms::Database {
  53 public:
  54   /**
  55      Contructor.
  56      \param dbmsName Nombre de la base de datos.
  57      \param host Identificador de la máquina anfitriona, que se usará para hacer las conexiones. Puede ser NULL.
  58      \see http://dev.mysql.com/doc/refman/4.1/en/mysql-real-connect.html
  59   */
  60   Database(const char* dbmsName, const char* host);
  61
  62   /**
  63      Contructor.
  64      \param componentName Nombre logico de la base de datos por que el podemos buscar este componente.
  65      \param dbmsName Nombre de la base de datos.
  66      \param host Identificador de la máquina anfitriona, que se usará para hacer las conexiones. Puede ser NULL.
  67      \see http://dev.mysql.com/doc/refman/4.1/en/mysql-real-connect.html
  68   */
  69   Database(const char* componentName, const char* dbmsName, const char* host);
  70
  71   /**
  72      Destructor.
  73   */
  74   virtual ~Database();
  75
  76   /**
  77    * Devuelve el nombre de la máquina anfitriona indicado en el constructor.
  78    * \return El nombre de la máquina anfitriona indicado en el constructor.
  79    */
  80   const char* getHost() const throw() { return a_host; }
  81
  82   /**
  83      Devuelve la cadena por la que podemos buscar el componente.
  84      \return La cadena por la que podemos buscar el componente.
  85      \see Application::find
  86   */
  87   static const char* getClassName() { return "dbms::mysql::Database"; }
  88
  89 private:
  90   char* a_host;
  91
  92   void do_initialize() throw(RuntimeException);
  93
  94   dbms::Connection* allocateConnection(const std::string& name, const char* user, const char* password)
  95   throw(RuntimeException);
  96
  97   dbms::Statement* allocateStatement(const char* name, const std::string& expression, const bool isCritical)
  98   throw(RuntimeException);
  99
 100   dbms::InputBind* allocateInputBind(const char* name, Data&)
 101   throw(RuntimeException);
 102   void deallocate(dbms::InputBind* inputBind) throw();
 103
 104   dbms::OutputBind* allocateOutputBind(const char* name, Data&)
 105   throw(RuntimeException);
 106   void deallocate(dbms::OutputBind* outputBind) throw();
 107 };
 108
 109 #ifdef ANNA_RDBMS_TRACE
 110 #define anna_dbms_mysql_check(a,_mysql) \
 111     { \
 112        Logger::write (Logger::Debug, (#a), __FILE__, __LINE__); \
 113        const int status = (a); \
 114        if (status != 0) { \
 115           anna::dbms::mysql::ResultCode resultCode ((_mysql)); \
 116           throw DatabaseException (resultCode, __FILE__, __LINE__);  \
 117        } \
 118     }
 119 #else
 120 #define anna_dbms_mysql_check(a,_mysql) \
 121     { \
 122        const int status = (a); \
 123        if (status != 0) { \
 124           anna::dbms::mysql::ResultCode resultCode ((_mysql)); \
 125           throw DatabaseException (resultCode, __FILE__, __LINE__);  \
 126        } \
 127     }
 128 #endif
 129 }
 130 }
 131 }
 132
 133 #endif