include/anna/dbms.mysql/Statement.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_Statement_hpp
  38 #define anna_dbms_mysql_Statement_hpp
  39
  40 #include <anna/dbms/Statement.hpp>
  41
  42 #include <anna/dbms.mysql/forward.hpp>
  43
  44 namespace anna {
  45
  46 namespace dbms {
  47
  48 class Connection;
  49
  50 namespace mysql {
  51
  52 class Database;
  53
  54 /**
  55    Clase que facilita la ejecucion de sentencias SQL a traves del RDBMS MySQL (tm).
  56
  57    Esta clase no puede usarse directamente, ya que la capa ANNA.dbms obliga a que todas las peticiones
  58    se hagan atraves de una instancia anna::dbms::Statement.
  59
  60    Para obtener la instancia de un comando para una determinada base de datos habra que instanciar
  61    dicha base de datos e invocar al metodo createStatement. Independientemente del tipo de comando
  62    particular que la base de datos retorne, debemos asignarlo a un puntero de tipo anna::dbms::Statement.
  63  */
  64 class Statement : public dbms::Statement {
  65 public:
  66   /**
  67      Destructor.
  68   */
  69   virtual ~Statement();
  70
  71   /**
  72      Operador de conversion.
  73      \return El puntero MYSQL_STMT de esta sentencia.
  74   */
  75   operator st_mysql_stmt*() throw() { return a_mysqlStmt; }
  76
  77   /**
  78    * Obtiene el array asociado a los valores de entrada.
  79    * \return El array asociado a los valores de entrada.
  80    * \warning Exclusivamente uso interno.
  81    */
  82   st_mysql_bind* getBindParams() throw() { return a_params; }
  83
  84   /**
  85    * Obtiene el array asociado a los valores de salida.
  86    * \return El array asociado a los valores de salida.
  87    * \warning Exclusivamente uso interno.
  88    */
  89   st_mysql_bind* getBindResults() throw() { return a_results; }
  90
  91 private:
  92   st_mysql_stmt* a_mysqlStmt;
  93
  94   st_mysql_bind* a_params;
  95   st_mysql_bind* a_results;
  96
  97   Statement(Database& database, const char* name, const char* expression, const bool isCritical) :
  98     dbms::Statement(database, name, expression, isCritical),
  99     a_mysqlStmt(NULL),
 100     a_params(NULL),
 101     a_results(NULL) {}
 102
 103   Statement(Database& database, const char* name, const std::string& expression, const bool isCritical) :
 104     dbms::Statement(database, name, expression, isCritical),
 105     a_mysqlStmt(NULL),
 106     a_params(NULL),
 107     a_results(NULL) {}
 108
 109   st_mysql_bind* create(const int size, const char* whatis) throw(RuntimeException);
 110
 111   void prepare(dbms::Connection* connection) throw(RuntimeException, DatabaseException);
 112   dbms::ResultCode execute(dbms::Connection* connection) throw(RuntimeException, DatabaseException);
 113   bool fetch() throw(RuntimeException, DatabaseException);
 114
 115   friend class Database;
 116 };
 117
 118 }
 119 }
 120 }
 121
 122 #endif
 123