|

Database.hpp

Go to the documentation of this file.

#ifndef IONFLUX_TOOLS_DATABASE
#define IONFLUX_TOOLS_DATABASE
/* ==========================================================================
 * Ionflux Tools
 * Copyright (c) 2004 Joern P. Meier
 * mail@ionflux.org
 * --------------------------------------------------------------------------
 * Database.hpp                   Database (abstract class).
 * ==========================================================================
 * 
 * This file is part of Ionflux Tools.
 * 
 * Ionflux Tools is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at  your option)
 * any later version.
 * 
 * Ionflux Tools is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Ionflux Tools; if not, write to the Free Software Foundation, 
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 * 
 * ========================================================================== */

#include <string>
#include <vector>
#include <map>
#include "ionflux/Node.hpp"
#include "ionflux/ManagedObject.hpp"

namespace Ionflux
{

namespace Tools
{


typedef std::vector<std::string> DbRow;
typedef std::map<std::string, std::string> DbRowMap;
typedef std::vector<DbRow> DbResult;
typedef std::vector<DbRowMap> DbResultMap;
typedef std::vector<std::string> DbTables;
typedef std::vector<std::string> DbColumns;

struct DatabaseConfig
{
    std::string server;
    unsigned int port;
    std::string username;
    std::string password;
    std::string database;
};

struct DatabaseError
{
    unsigned int errNum;
    std::string error;
};

class DatabaseClassInfo
: public ClassInfo
{
    public:
        DatabaseClassInfo();
        virtual ~DatabaseClassInfo() { };
};

class Database
: public ManagedObject
{
    public:
        static const int NODE_ORDER_ROWS;
        static const int NODE_ORDER_NAMED_FIELDS;
        static const int NODE_ORDER_COLUMNS;
        static const DatabaseClassInfo databaseClassInfo;
        static const ClassInfo* CLASS_INFO;
        
        Database();
        
        Database(const DatabaseConfig &initConfig);
        
        virtual ~Database();
        
        virtual void setConfig(const DatabaseConfig &newConfig) = 0;
        
        virtual void setConfig(Ionflux::Tools::Node &newConfig) = 0;
        
        virtual DatabaseConfig getConfig() = 0;
        
        virtual bool connect() = 0;
        
        virtual void close() = 0;
        
        virtual bool query(const std::string &command) = 0;
        
        virtual bool listTables(DbTables &tables, 
            const std::string &pattern = "") = 0;
        
        virtual bool listColumns(DbColumns &columns, 
            const std::string &table) = 0;
        
        virtual unsigned int getNumRows(const std::string &table) = 0;
        
        virtual unsigned int getNumRows() = 0;
        
        virtual unsigned int getNumAffectedRows() = 0;
        
        virtual bool fetchRow(DbRow &row) = 0;
        
        virtual bool fetchRowMap(DbRowMap &rowMap) = 0;
        
        virtual bool fetchRowTree(Node &rowNode) = 0;
        
        virtual bool fetchResult(DbResult &result) = 0;
        
        virtual bool fetchResultMap(DbResultMap &resultMap) = 0;
        
        virtual bool fetchResultTree(Node &resultNode, int nodeOrder) = 0;
        
        virtual std::string sqlEscape(const std::string &source) = 0;
        
        virtual bool validateTable(const std::string& tableName, 
            const std::string& createTemplate = "", 
            Node* createConfig = 0) = 0;
        
        virtual DatabaseError getError() = 0;
        
};


}

}

#endif

---