Calibration/rdbModel/include/rdbModel/Db/MysqlConnection.h

Go to the documentation of this file.

// $Header: /bes/bes/BossCvs/Calibration/rdbModel/rdbModel/Db/MysqlConnection.h,v 1.3
// 2009/03/18 02:01:02 huangb Exp $
#ifndef RDBMODEL_MYSQLCONNECTION_H
#define RDBMODEL_MYSQLCONNECTION_H
 
#include "rdbModel/Db/Connection.h"
#include "rdbModel/Management/Visitor.h"
#include "rdbModel/Tables/Assertion.h"
#include <iostream>
#include <map>
 
typedef struct st_mysql     MYSQL;
typedef struct st_mysql_res MYSQL_RES;
 
namespace rdbModel {
 
  class MysqlResults;
  class Datatype;
  /**
      Class to handle connection to a MySQL database
 
        - initiate connection
        - make queries, including making returned data from queries available
        - issue SQL statements such as INSERT and UPDATE which have no
          returned data other than status
        - close down connection.
      Someday it might also have a method to create a database
 
      Initial design will just use host, password, userid passed in.
      Will be up to caller to insure that the userid has the right
      privilages for the operations caller intends to do.
  */
  class MysqlConnection : public virtual Connection, public Visitor {
  public:
    /** Open a connection
        Allowed operations will depend on userid, etc., specified
        return true if successful
    */
    MysqlConnection( std::ostream* out = 0, std::ostream* errOut = 0 );
    virtual ~MysqlConnection();
    virtual bool open( const std::string& host, const std::string& userid,
                       const std::string& password, const std::string& dbName );
    //                      ,unsigned int       port=0);
 
    /** Parameter is normally path for an xml file descrbing the
        connection parameters */
    virtual bool open( const std::string& parms );
 
    /** Close the current open connection , if any.  Return true if there
     was a connection to close and it was closed successfully */
    virtual bool close();
 
    /// Return true iff open has been done with no matching close
    virtual bool isConnected() { return m_connected; }
 
    std::ostream* getOut() const { return m_out; }
    std::ostream* getErrOut() const { return m_err; }
    /**
       Check to what degree local schema definition is compatible with
       remote db accessed via this connection.  By default check db names
       match, but this may be disabled.
 
       If match is successful, may also want to cache information about
       some things; for example, rows for which agent = "service"
    */
    virtual MATCH matchSchema( Rdb* rdb, bool matchDbName = true );
 
    /** Typical derived class will form a syntactically correct
        INSERT statement from the input arguments and issue it to
        the dbms. Return true if row was inserted successfully
        If @a auto_value is non-zero and the table has an auto-increment
        column, its value will be returned.
        If @a nullCols is non-zero, insertRow will treat each string
        in the vector as a column name whose value should be set to
        NULL
 
        Might also want to add a routine for INSERT ... SELECT
    */
 
    virtual bool insertRow( const std::string& tableName, const StringVector& colNames,
                            const StringVector& values, int* auto_value = 0,
                            const StringVector* nullCols = 0 );
 
    /**
      Generic UPDATE. Return value is number of rows changed.
    */
    virtual unsigned int update( const std::string& tableName, const StringVector& colNames,
                                 const StringVector& values, const Assertion* where = 0,
                                 const StringVector* nullCols = 0 );
 
    /**
      Support only for relatively simple SELECT, involving just
      one table.
      @param tableName
      @param getCols   vector of columns to be retrieved
      @param where     ptr to an Assertion object
      @param rowLimit  max number of rows to return
      @param rowOffset offset for first row returned among those satisfying
                       conditions; ignored if 0.
      @return If the SELECT succeeds, a pointer to an object which
       manages the returned data; else 0.  Caller is responsible for
       deleting the ResultHandle object.
    */
    virtual ResultHandle* select( const std::string& tableName, const StringVector& getCols,
                                  const StringVector& orderCols, const Assertion* where = 0,
                                  int rowLimit = 0, int rowOffset = 0 );
 
    /**
      Transmit raw request of any form to our other end.  If it is a
      request that returns results, those results will be stored in a
      newly-allocated ResultHandle and dbRequest will return a pointer
      to it. Otherwise dbRequest will return a null pointer.
      Throw an exception if request fails for any reason.
    */
    virtual ResultHandle* dbRequest( const std::string& request );
 
    /**
      compile method for assertions.  Use it internally, but also make
      it publicly available so assertions belonging to a table
      can save the compiled version.
    */
    virtual bool compileAssertion( const Assertion* a, std::string& sqlString ) const;
 
    /**
      Turn select and update into no-ops: output SQL string for
      debugging but don't change db
    */
    virtual void disableModify( bool disable ) { m_writeDisabled = disable; }
 
    // Needed to satisfy Visitor interface:
    virtual Visitor::VisitorState visitRdb( Rdb* );
    virtual Visitor::VisitorState visitTable( Table* );
    virtual Visitor::VisitorState visitColumn( Column* );
    virtual Visitor::VisitorState visitIndex( Index* );
    virtual Visitor::VisitorState visitAssertion( Assertion* );
 
    virtual VisitorState visitInsertNew( InsertNew* );
    virtual VisitorState visitSupersede( Supersede* );
    virtual VisitorState visitQuery( Query* );
    virtual VisitorState visitSet( Set* );
    virtual VisitorState visitInterRow( InterRow* );
 
  private:
    /// Someday we may want more than one kind of visitor; for example,
    /// might want one to create dbs
    enum VISITOR { VISITORundefined, VISITORmatch };
 
    MYSQL* m_mysql;
    bool   m_connected;
 
    std::string   m_dbName;
    std::ostream* m_out;
    std::ostream* m_err;
 
    // Following collection of data members is only of interest while
    // visit is in progress.
 
    VISITOR m_visitorType;
    bool    m_matchDbName;
 
    /// Keep track of status during matching process
    MATCH m_matchReturn;
 
    /// If successful match, save pointer to schema for use with smart insert
    Rdb* m_rdb;
 
    /// Also save list of columns we ("service") are responsible for
    /// Could organize this by table, or just use Column::getTableName()
    std::vector<Column*> m_ourCols;
 
    /// For query results while visiting.
    MYSQL_RES* m_tempRes;
 
    /// Index by colname; data is row number with "SHOW COLUMNS.." result set
    std::map<std::string, unsigned int> m_colIx;
 
    std::string m_primColName;
 
    static bool m_compileInit;
    bool        m_writeDisabled;
 
    static void compileInit();
    static bool compileComparison( Assertion::Operator* op, std::string& sqlString );
    static bool compileOperator( Assertion::Operator* op, std::string& sqlString );
 
    bool checkDType( Datatype* dtype, const std::string& sqlType );
 
    // huangb add to store the database information
    std::string m_host;
    std::string m_user;
    std::string m_password;
    //    std::string m_dbName;
  };
 
} // end namespace rdbModel
#endif