path: root/src/dal/mysqldataprovider.h

/*
 *  The Mana World Server
 *  Copyright 2004 The Mana World Development Team
 *
 *  This file is part of The Mana World.
 *
 *  The Mana World  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 any later version.
 *
 *  The Mana  World 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 The Mana  World; if not, write to the  Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 *  $Id$
 */


#ifndef _TMWSERV_MYSQL_DATA_PROVIDER_H_
#define _TMWSERV_MYSQL_DATA_PROVIDER_H_


#include <iosfwd>
// added to compile under windows
#ifdef WIN32
#include <winsock2.h>
#endif
#include <mysql/mysql.h>

#include "dataprovider.h"
#include "common/configuration.hpp"
#include "utils/logger.h"

namespace dal
{


/**
 * A MySQL Data Provider.
 */
class MySqlDataProvider: public DataProvider
{
    public:

        /**
         * Replacement for mysql my_bool datatype used in mysql_autocommit()
         * function.
         */
        enum {
            AUTOCOMMIT_OFF = 0,
            AUTOCOMMIT_ON = 1
        };

        /**
         * Constructor.
         */
        MySqlDataProvider(void)
            throw();


        /**
         * Destructor.
         */
        ~MySqlDataProvider(void)
            throw();


        /**
         * Get the name of the database backend.
         *
         * @return the database backend name.
         */
        DbBackends
        getDbBackend(void) const
            throw();


        /**
         * Create a connection to the database.
         *
         * @exception DbConnectionFailure if unsuccessful connection.
         */
        void connect();


        /**
         * Execute a SQL query.
         *
         * @param sql the SQL query.
         * @param refresh if true, refresh the cache (default = false).
         *
         * @return a recordset.
         *
         * @exception DbSqlQueryExecFailure if unsuccessful execution.
         * @exception std::runtime_error if trying to query a closed database.
         */
        const RecordSet&
        execSql(const std::string& sql,
                const bool refresh = false);


        /**
         * Close the connection to the database.
         *
         * @exception DbDisconnectionFailure if unsuccessful disconnection.
         */
        void
        disconnect(void);

        /**
         * Starts a transaction.
         *
         * @exception std::runtime_error if a transaction is still open
         */
        void
        beginTransaction(void)
            throw (std::runtime_error);

        /**
         * Commits a transaction.
         *
         * @exception std::runtime_error if no connection is currently open.
         */
        void
        commitTransaction(void)
            throw (std::runtime_error);

        /**
         * Rollback a transaction.
         *
         * @exception std::runtime_error if no connection is currently open.
         */
        void
        rollbackTransaction(void)
            throw (std::runtime_error);

        /**
         * Returns the number of changed rows by the last executed SQL
         * statement.
         *
         * @return Number of rows that have changed.
         */
        const unsigned int
        getModifiedRows(void) const;

        /**
         * Returns the last inserted value of an autoincrement column after an
         * INSERT statement.
         *
         * @return last autoincrement value.
         */
        const unsigned int
        getLastId(void) const;

    private:

        /** defines the name of the hostname config parameter */
        static const std::string CFGPARAM_MYSQL_HOST;
        /** defines the name of the server port config parameter */
        static const std::string CFGPARAM_MYSQL_PORT;
        /** defines the name of the database config parameter */
        static const std::string CFGPARAM_MYSQL_DB;
        /** defines the name of the username config parameter */
        static const std::string CFGPARAM_MYSQL_USER;
        /** defines the name of the password config parameter */
        static const std::string CFGPARAM_MYSQL_PWD;

        /** defines the default value of the CFGPARAM_MYSQL_HOST parameter */
        static const std::string CFGPARAM_MYSQL_HOST_DEF;
        /** defines the default value of the CFGPARAM_MYSQL_PORT parameter */
        static const unsigned int CFGPARAM_MYSQL_PORT_DEF;
        /** defines the default value of the CFGPARAM_MYSQL_DB parameter */
        static const std::string CFGPARAM_MYSQL_DB_DEF;
        /** defines the default value of the CFGPARAM_MYSQL_USER parameter */
        static const std::string CFGPARAM_MYSQL_USER_DEF;
        /** defines the default value of the CFGPARAM_MYSQL_PWD parameter */
        static const std::string CFGPARAM_MYSQL_PWD_DEF;


        MYSQL* mDb; /**< the handle to the database connection */
};


} // namespace dal

#endif // _TMWSERV_MYSQL_DATA_PROVIDER_H_