Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

CdbMySQLQueryUtils.hh

Go to the documentation of this file.
00001 #ifndef CDB_MYSQL_QUERY_UTILS_HH
00002 #define CDB_MYSQL_QUERY_UTILS_HH
00003 
00004 // File and Version Information:
00005 //      $Id: CdbMySQLQueryUtils.hh,v 1.1 2005/11/19 04:00:22 gapon Exp $
00006 
00007 #include "CdbBase/CdbCPtr.hh"
00008 
00009 #include <string>
00010 
00011 class CdbMySQLConnection;
00012 class RdbMySQLResult;
00013 
00014 /// Utilities to help with making queries
00015 /**
00016   * This helper class executes queries and is making error reports (if required).
00017   */
00018 class CdbMySQLQueryUtils {
00019 
00020 public:
00021 
00022   /// Make a query
00023   /**
00024     * The method will execute the query and, if successfull, return a smart pointer onto
00025     * its result object. It will also make a complain onto the Standard Error Stream
00026     * if the context string is not empty.
00027     *
00028     * The method is capable of executing queries of any kind. The actual result will vary
00029     * depending on a type of a query.
00030     *
00031     * @see class RdbMySQLResult
00032     */
00033     static CdbStatus execute_query( CdbCPtr<RdbMySQLResult>&           theResultPtr,
00034                                     const CdbCPtr<CdbMySQLConnection>& theConnectionObjectPtr,
00035                                     const std::string&                 theQuery,
00036                                     const std::string&                 theContext = std::string( ));
00037 };
00038 
00039 #endif  // CDB_MYSQL_QUERY_UTILS_HH

Generated on Mon Dec 5 18:22:07 2005 for CDB by doxygen1.3-rc3