blob: 8efcc0ddc7972e5998279854f3b55ce8f9ff151d (
plain) (
tree)
|
|
/*
* The Mana Server
* Copyright (C) 2004 The Mana World Development Team
*
* This file is part of The Mana Server.
*
* The Mana Server 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 Server 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 Server. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MYSQL_DATA_PROVIDER_H
#define MYSQL_DATA_PROVIDER_H
#include <iosfwd>
// added to compile under windows
#ifdef WIN32
#include <winsock2.h>
#endif
#include <mysql/mysql.h>
#include <climits>
#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()
throw();
/**
* Destructor.
*/
~MySqlDataProvider()
throw();
/**
* Get the name of the database backend.
*
* @return the database backend name.
*/
DbBackends getDbBackend() 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();
/**
* Starts a transaction.
*
* @exception std::runtime_error if a transaction is still open
*/
void beginTransaction()
throw (std::runtime_error);
/**
* Commits a transaction.
*
* @exception std::runtime_error if no connection is currently open.
*/
void commitTransaction()
throw (std::runtime_error);
/**
* Rollback a transaction.
*
* @exception std::runtime_error if no connection is currently open.
*/
void rollbackTransaction()
throw (std::runtime_error);
/**
* Returns the number of changed rows by the last executed SQL
* statement.
*
* @return Number of rows that have changed.
*/
unsigned getModifiedRows() const;
/**
* Returns the last inserted value of an autoincrement column after an
* INSERT statement.
*
* @return last autoincrement value.
*/
unsigned getLastId() const;
/**
* Prepare SQL statement
*/
bool prepareSql(const std::string &sql);
/**
* Process SQL statement
* SQL statement needs to be prepared and parameters binded before
* calling this function
*/
const RecordSet& processSql() ;
/**
* Bind Value (String)
* @param place - which parameter to bind to
* @param value - the string to bind
*/
void bindValue(int place, const std::string &value);
/**
* Bind Value (Integer)
* @param place - which parameter to bind to
* @param value - the integer to bind
*/
void bindValue(int place, int value);
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 */
MYSQL_STMT *mStmt; /**< the prepared statement to process */
std::vector<MYSQL_BIND*> mBind;
};
} // namespace dal
#endif // MYSQL_DATA_PROVIDER_H
|