summaryrefslogtreecommitdiff
path: root/src/dal/mysqldataprovider.h
diff options
context:
space:
mode:
authorHuynh Tran <nthuynh75@gmail.com>2005-06-13 17:44:49 +0000
committerHuynh Tran <nthuynh75@gmail.com>2005-06-13 17:44:49 +0000
commit57d846f38d510ab37e706f0bd42fd740a5cbfea0 (patch)
tree343efae315e830dc961db6b251eb65a595810a04 /src/dal/mysqldataprovider.h
parent7c7a1348faa3867f6f2e5fcaf2b671774b1b018a (diff)
downloadmanaserv-57d846f38d510ab37e706f0bd42fd740a5cbfea0.tar.gz
manaserv-57d846f38d510ab37e706f0bd42fd740a5cbfea0.tar.bz2
manaserv-57d846f38d510ab37e706f0bd42fd740a5cbfea0.tar.xz
manaserv-57d846f38d510ab37e706f0bd42fd740a5cbfea0.zip
Initial release of the Database Abstraction Layer
Diffstat (limited to 'src/dal/mysqldataprovider.h')
-rw-r--r--src/dal/mysqldataprovider.h136
1 files changed, 136 insertions, 0 deletions
diff --git a/src/dal/mysqldataprovider.h b/src/dal/mysqldataprovider.h
new file mode 100644
index 00000000..687ed38f
--- /dev/null
+++ b/src/dal/mysqldataprovider.h
@@ -0,0 +1,136 @@
+/*
+ * 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 _TMW_MYSQL_DATA_PROVIDER_H_
+#define _TMW_MYSQL_DATA_PROVIDER_H_
+
+
+#include <string>
+
+#include "dataprovider.h"
+
+
+namespace tmw
+{
+namespace dal
+{
+
+
+/**
+ * A MySQL Data Provider.
+ */
+class MySqlDataProvider: public DataProvider
+{
+ public:
+ /**
+ * Constructor.
+ */
+ MySqlDataProvider(void)
+ throw();
+
+
+ /**
+ * Destructor.
+ */
+ ~MySqlDataProvider(void)
+ throw();
+
+
+ /**
+ * Get the database backend name.
+ *
+ * @return the database backend name.
+ */
+ DbBackends
+ getDbBackend(void) const
+ throw();
+
+
+ /**
+ * Create a new database.
+ *
+ * @param dbName the database name.
+ * @param dbPath the database file path (optional)
+ *
+ * @exception DbCreationFailure if unsuccessful creation.
+ * @exception std::exception if unexpected exception.
+ */
+ void
+ createDb(const std::string& dbName,
+ const std::string& dbPath = "")
+ throw(DbCreationFailure,
+ std::exception);
+
+
+ /**
+ * Create a connection to the database.
+ *
+ * @param dbName the database name.
+ * @param userName the user name.
+ * @param password the user password.
+ *
+ * @exception DbConnectionFailure if unsuccessful connection.
+ * @exception std::exception if unexpected exception.
+ */
+ void
+ connect(const std::string& dbName,
+ const std::string& userName,
+ const std::string& password)
+ throw(DbConnectionFailure,
+ std::exception);
+
+
+ /**
+ * Execute a SQL query.
+ *
+ * @param sql the SQL query.
+ *
+ * @return a recordset.
+ *
+ * @exception DbSqlQueryExecFailure if unsuccessful execution.
+ * @exception std::exception if unexpected exception.
+ */
+ const RecordSet&
+ execSql(const std::string& sql)
+ throw(DbSqlQueryExecFailure,
+ std::exception);
+
+
+ /**
+ * Close the connection to the database.
+ *
+ * @exception DbDisconnectionFailure if unsuccessful disconnection.
+ * @exception std::exception if unexpected exception.
+ */
+ void
+ disconnect(void)
+ throw(DbDisconnectionFailure,
+ std::exception);
+};
+
+
+} // namespace dal
+} // namespace tmw
+
+
+#endif // _TMW_MYSQL_DATA_PROVIDER_H_