StRoot: StDbLib/StDbManager.hh Source File

00001 /***************************************************************************
00002  *
00003  * $Id: StDbManager.hh,v 1.24 2011/02/10 17:30:42 dmitry Exp $
00004  *
00005  * Author: R. Jeff Porter
00006  ***************************************************************************
00007  *
00008  * Description:  Manages access to Servers and passes Query-by-Table to db
00009  *               --> Now a pure virtual interface
00010  *
00011  ***************************************************************************
00012  *
00013  * $Log: StDbManager.hh,v $
00014  * Revision 1.24  2011/02/10 17:30:42  dmitry
00015  * added an option to blacklist domains
00016  *
00017  * Revision 1.23  2004/01/15 00:02:25  fisyak
00018  * Replace ostringstream => StString, add option for alpha
00019  *
00020  * Revision 1.22  2003/09/16 22:44:17  porter
00021  * got rid of all ostrstream objects; replaced with ostringstream+string.
00022  * modified rules.make and added file stdb_streams.h for standalone compilation
00023  *
00024  * Revision 1.21  2003/09/02 17:57:49  perev
00025  * gcc 3.2 updates + WarnOff
00026  *
00027  * Revision 1.20  2001/02/09 23:06:24  porter
00028  * replaced ostrstream into a buffer with ostrstream creating the
00029  * buffer. The former somehow clashed on Solaris with CC5 iostream (current .dev)
00030  *
00031  * Revision 1.19  2001/01/22 18:37:55  porter
00032  * Update of code needed in next year running. This update has little
00033  * effect on the interface (only 1 method has been changed in the interface).
00034  * Code also preserves backwards compatibility so that old versions of
00035  * StDbLib can read new table structures.
00036  *  -Important features:
00037  *    a. more efficient low-level table structure (see StDbSql.cc)
00038  *    b. more flexible indexing for new systems (see StDbElememtIndex.cc)
00039  *    c. environment variable override KEYS for each database
00040  *    d. StMessage support & clock-time logging diagnostics
00041  *  -Cosmetic features
00042  *    e. hid stl behind interfaces (see new *Impl.* files) to again allow rootcint access
00043  *    f. removed codes that have been obsolete for awhile (e.g. db factories)
00044  *       & renamed some classes for clarity (e.g. tableQuery became StDataBaseI
00045  *       and mysqlAccessor became StDbSql)
00046  *
00047  * Revision 1.18  2000/06/02 13:37:37  porter
00048  * built up list of minor changes:
00049  *  - made buffer more robust for certain null inputs
00050  *  - fixed small leak in StDbTables & restructure call to createMemory
00051  *  - added dbRhic as a database domain in StDbDefs
00052  *  - added setUser() in StDbManager
00053  *  - added more diagnostic printouts in mysqlAccessor.cc
00054  *
00055  * Revision 1.17  2000/03/28 17:03:19  porter
00056  * Several upgrades:
00057  * 1. configuration by timestamp for Conditions
00058  * 2. query by whereClause made more systematic
00059  * 3. conflict between db-stored comments & number lists resolved
00060  * 4. ensure endtime is correct for certain query falures
00061  * 5. dbstl.h->handles ObjectSpace & RogueWave difference (Online vs Offline)
00062  *
00063  * Revision 1.16  2000/03/01 20:56:16  porter
00064  * 3 items:
00065  *    1. activated reConnect for server timeouts
00066  *    2. activated connection sharing; better resource utilization but poorer
00067  *       logging
00068  *    3. made rollback method in mysqlAccessor more robust (affects writes only)
00069  *
00070  * Revision 1.15  2000/02/24 20:30:46  porter
00071  * fixed padding for uchar; beginTime in mysqlAccessor;
00072  * added rollback safety checkes in StDbManger
00073  *
00074  * Revision 1.14  2000/02/18 16:58:09  porter
00075  * optimization of table-query, + whereClause gets timeStamp if indexed
00076  *  + fix to write multiple rows algorithm
00077  *
00078  * Revision 1.13  2000/02/15 20:27:44  porter
00079  * Some updates to writing to the database(s) via an ensemble (should
00080  * not affect read methods & haven't in my tests.
00081  *  - closeAllConnections(node) & closeConnection(table) method to mgr.
00082  *  - 'NullEntry' version to write, with setStoreMode in table;
00083  *  -  updated both StDbTable's & StDbTableDescriptor's copy-constructor
00084  *
00085  * Revision 1.12  2000/01/27 05:54:34  porter
00086  * Updated for compiling on CC5 + HPUX-aCC + KCC (when flags are reset)
00087  * Fixed reConnect()+transaction model mismatch
00088  * added some in-code comments
00089  *
00090  * Revision 1.11  2000/01/19 20:20:05  porter
00091  * - finished transaction model needed by online
00092  * - fixed CC5 compile problem in StDbNodeInfo.cc
00093  * - replace TableIter class by StDbTableIter to prevent name problems
00094  *
00095  * Revision 1.10  2000/01/10 20:37:54  porter
00096  * expanded functionality based on planned additions or feedback from Online work.
00097  * update includes:
00098  *      1. basis for real transaction model with roll-back
00099  *      2. limited SQL access via the manager for run-log & tagDb
00100  *      3. balance obtained between enumerated & string access to databases
00101  *      4. 3-levels of diagnostic output: Quiet, Normal, Verbose
00102  *      5. restructured Node model for better XML support
00103  *
00104  * Revision 1.9  1999/12/28 21:31:42  porter
00105  * added 'using std::vector' and 'using std::list' for Solaris CC5 compilation.
00106  * Also fixed some warnings arising from the CC5 compiles
00107  *
00108  * Revision 1.8  1999/12/03 22:24:01  porter
00109  * expanded functionality used by online, fixed bug in
00110  * mysqlAccessor::getElementID(char*), & update StDbDataSet to
00111  * conform to changes in Xml reader & writer
00112  *
00113  * Revision 1.7  1999/10/19 14:30:39  porter
00114  * modifications relevant to use with StDbBroker and future merging with
00115  * "params" database structure + some docs + suppressing diagnostics messages
00116  *
00117  * Revision 1.6  1999/09/30 02:06:07  porter
00118  * add StDbTime to better handle timestamps, modify SQL content (mysqlAccessor)
00119  * allow multiple rows (StDbTable), & Added the comment sections at top of
00120  * each header and src file
00121  *
00122  **************************************************************************/
00123 #ifndef STDBMANAGER_HH
00124 #define STDBMANAGER_HH
00125 
00126 #include <string.h>
00127 #include "StString.h"
00128 
00129 #include "stdb_streams.h"
00130 
00131 // real basic definitions
00132 #include "StDbDefs.hh"
00133 // pure virtual classes
00134 #include "StDbMessService.hh"
00135 
00136 // other classes
00137 class StDbServer;
00138 class StDataBaseI;
00139 class dbEnvList;
00140 class StDbNode;
00141 class StDbConfigNode;
00142 class StDbTable;
00143 
00144 #ifdef __ROOT__
00145 #include "TROOT.h"
00146 #endif
00147 
00148 class StDbManager {
00149 
00150 protected:
00151 
00152   bool misVerbose;         
00153   bool misQuiet;           
00154   StDbMessService* Messenger; 
00155   char* muserName;
00156   char* mpWord;
00157 
00158   bool   misTimeLogged;  
00159 
00160   StDbManager();
00161   static StDbManager* mInstance;
00162 
00163   char*         mstringDup(const char* str); 
00164 
00165 public:
00166 
00167   // access to this singleton object
00168   static StDbManager* Instance();
00169   virtual ~StDbManager();
00170 
00171   // Act as Factory object for StDbConfigNodess
00172   // --> get dbHandle & Container of StDbTables..
00173   virtual StDbConfigNode* initConfig(const char* dbName)                  =0;
00174   virtual StDbConfigNode* initConfig(const char* dbName, 
00175                                      const char* configName, int opt=0)   =0;
00176   virtual StDbConfigNode* initConfig(StDbType type, StDbDomain domain)    =0;
00177   virtual StDbConfigNode* initConfig(StDbType type, StDbDomain domain, 
00178                                      const char* configName, int opt=0)   =0;
00179   virtual StDbConfigNode* initConfig(StDbType type, StDbDomain domain, 
00180                                      unsigned int requestTime, int opt=0) =0;
00181   virtual StDbConfigNode* initConfig(const char* dbName, 
00182                                      unsigned int requestTime, int opt=0) =0;
00183 
00184   virtual char*           getConfigNodeName(StDbType t, StDbDomain d)     =0;
00185   virtual char*           getExternalVersion(StDbType t,StDbDomain d)     =0;
00186   virtual dbEnvList*      getEnvList(const char* name)                    =0;
00187 
00188   // act as a Factory object for StDbTables
00189   virtual StDbTable*      newDbTable(const char* dbName,const char* tName)=0;
00190   virtual StDbTable*      newDbTable(StDbNode* node)                      =0;
00191 
00192   // Retreive DbLib owned database & server poointers by various methods
00193   virtual StDataBaseI* findDb(StDbType type, StDbDomain domain)          =0;
00194   virtual StDataBaseI* findDb(const char* dbType, const char* dbDomain)  =0;
00195   virtual StDataBaseI* findDb(const char* databaseName)                  =0;
00196   virtual StDbServer*  findServer(StDbType type, StDbDomain domain)      =0;
00197   virtual StDbServer*  findServer(StDbNode* node)                        =0;
00198   virtual StDbServer*  findServer(const char* type, const char* domain)  =0;
00199   virtual StDbServer*  findServer(const char* databaseName)              =0;
00200   virtual StDbServer*  findDefaultServer()                               =0;
00201 
00202   // helper functions using mapped enumeration to dbType & dbDomain
00203   virtual char*      getDbTypeName(StDbType type)                        =0;
00204   virtual char*      getDbDomainName(StDbDomain domain)                  =0;
00205   virtual StDbType   getDbType(const char* typeName)                     =0;
00206   virtual StDbDomain getDbDomain(const char* domainName)                 =0;
00207   virtual char*      getDbName(const char* typeName, const char* domName)=0;
00208   virtual char*      printDbName(StDbType type, StDbDomain domain)       =0;
00209 
00210   virtual void       blacklistDbDomain(const char* domainName)           =0;
00211 
00212   // time stamp methods
00213   virtual void         setRequestTime(unsigned int time)                 =0;
00214   virtual void         setRequestTime(const char* time)                  =0;
00215   virtual unsigned int getUnixRequestTime()                              =0;
00216   virtual char*        getDateRequestTime()                              =0;
00217   virtual unsigned int getUnixCheckTime()                                =0;
00218   virtual char*        getDateCheckTime()                                =0;
00219   virtual void         setStoreTime(unsigned int time)                   =0;
00220   virtual void         setStoreTime(const char* time)                    =0;
00221   virtual unsigned int getUnixStoreTime()                                =0;
00222   virtual char*        getDateStoreTime()                                =0;
00223 
00224   // find the dbType & dbDomain for a database=>dbname
00225   virtual bool getDataBaseInfo(const char* dbname, 
00226                                char*& type, char*& domain)               =0;
00227   virtual bool getDataBaseInfo(const char* dbname,
00228                                StDbType& type, StDbDomain& domain)       =0;
00229   
00230   // fetch & store methods for data
00231   virtual bool IsValid(StDbTable* table)                                 =0;
00232   virtual bool fetchDbTable(StDbTable* table)                            =0;
00233   virtual bool fetchDbTable(StDbTable* table, char* whereClause)         =0;
00234   virtual bool fetchAllTables(StDbConfigNode* node)                      =0;
00235   virtual bool storeDbTable(StDbTable* table, bool commitWhenDone=true)  =0;
00236   virtual bool storeAllTables(StDbConfigNode* node, 
00237                               bool commitWhenDone=true)                  =0;
00238   virtual int  storeConfig(StDbConfigNode* node, int currentID, 
00239                            int& configID, bool commitWhenDone=true)      =0;
00240 
00241   // transaction methods 
00242   virtual bool rollBackAllTables(StDbConfigNode* node)                   =0;
00243   virtual bool rollBackAllNodes(StDbConfigNode* node)                    =0; 
00244   virtual bool rollBack(StDbNode* node)                                  =0;   
00245   virtual bool rollBack(StDbTable* table)                                =0; 
00246   virtual bool commitAllTables(StDbConfigNode* node)                     =0; 
00247   virtual bool commitAllNodes(StDbConfigNode* node)                      =0;  
00248 
00249   // close connection methods
00250   virtual void closeAllConnections()                                     =0; 
00251   virtual void closeAllConnections(StDbConfigNode* node)                 =0; 
00252   virtual void closeConnection(StDbNode* node)                           =0;
00253 
00254   virtual void printTimeStats()                                          =0;
00255 
00256   // messaging service directions *** These are real functions *** 
00257   virtual bool    IsVerbose() const;
00258   virtual void    setVerbose(bool isVerbose);
00259   virtual bool    IsQuiet() const ;
00260   virtual void    setQuiet(bool isQuiet);
00261   virtual void    turnOffTimeLogging();
00262   virtual void    updateMessLevel();
00263   virtual void    setMessenger(StDbMessService* service);
00264   virtual StDbMessService* getMessenger();
00265   virtual int  printInfo(const char* m1, StDbMessLevel ml, 
00266                          int lineNumber=0, const char* className=" ",
00267                          const char* methodName=" ") ;
00268   virtual int  printInfo(const char* m1,  const char* m2,
00269                          StDbMessLevel ml, int lineNumber=0,
00270                          const char* className=" ",
00271                          const char* methodName=" ");
00272 
00273   virtual char* userName();
00274   virtual char* pWord();
00275   virtual void  setUser(const char* userName, const char* pWord);
00276 
00277   // make ROOT-CLI via star-ofl "makefiles"
00278 #ifdef __ROOT__
00279   ClassDef(StDbManager,0)
00280 #endif
00281 
00282 };
00283 
00284 inline bool StDbManager::IsVerbose() const { return misVerbose;};
00285 inline void StDbManager::setVerbose(bool isVerbose){ 
00286  misVerbose=isVerbose;
00287  if(isVerbose)misQuiet=false;
00288  updateMessLevel();   
00289 };
00290 inline bool StDbManager::IsQuiet() const { return misQuiet;};
00291 inline void StDbManager::setQuiet(bool isQuiet){ 
00292    misQuiet=isQuiet;
00293    if(isQuiet) misVerbose=false;
00294    updateMessLevel();
00295 }
00296 inline void StDbManager::updateMessLevel(){
00297  Messenger->setMessLevel(dbMWarn);
00298  if(misQuiet)Messenger->setMessLevel(dbMErr);
00299  if(misVerbose)Messenger->setMessLevel(dbMDebug);
00300 }
00301 inline void StDbManager::setMessenger(StDbMessService* service){
00302   delete Messenger;
00303   Messenger=service;
00304   updateMessLevel();
00305 }
00306 inline StDbMessService* StDbManager::getMessenger(){ return Messenger; }
00307 inline char* StDbManager::userName() { return muserName; }
00308 inline char* StDbManager::pWord()    { return mpWord; }
00309 
00310 #endif
00311 
00312 
00313 
00314 
00315 
00316 
00317 
00318 
00319