summaryrefslogtreecommitdiff
path: root/src/dal/dataprovider.h
blob: 6975d0844a684b92b0d56ffa69c582b0e7c18dd8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/*
 *  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_DATA_PROVIDER_H_
#define _TMW_DATA_PROVIDER_H_


#include <string>

#include "dalexcept.h"
#include "recordset.h"


namespace tmw
{
namespace dal
{


/**
 * Enumeration type for the database backends.
 */
typedef enum {
    MYSQL,
    SQLITE
} DbBackends;


/**
 * An abstract data provider.
 */
class DataProvider
{
    public:
        /**
         * Constructor.
         */
        DataProvider(void)
            throw();


        /**
         * Destructor.
         */
        virtual ~DataProvider(void)
            throw();


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


        /**
         * 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.
         */
        virtual void
        createDb(const std::string& dbName,
                 const std::string& dbPath = "")
            throw(DbCreationFailure,
                  std::exception) = 0;


        /**
         * 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.
         */
        virtual void
        connect(const std::string& dbName,
                const std::string& userName,
                const std::string& password)
            throw(DbConnectionFailure,
                  std::exception) = 0;


        /**
         * Create a connection to the database.
         *
         * @param dbName the database name.
         * @param dbPath the database file path.
         * @param userName the user name.
         * @param password the user password.
         *
         * @exception DbConnectionFailure if unsuccessful connection.
         * @exception std::exception if unexpected exception.
         */
        virtual void
        connect(const std::string& dbName,
                const std::string& dbPath,
                const std::string& userName,
                const std::string& password)
            throw(DbConnectionFailure,
                  std::exception) = 0;


        /**
         * Execute a SQL query.
         *
         * @param sql the SQL query.
         * @param refresh if true, refresh the cache (optional)
         *
         * @return a recordset.
         *
         * @exception DbSqlQueryExecFailure if unsuccessful execution.
         * @exception std::exception if unexpected exception.
         */
        virtual const RecordSet&
        execSql(const std::string& sql,
                const bool refresh = false)
            throw(DbSqlQueryExecFailure,
                  std::exception) = 0;


        /**
         * Close the connection to the database.
         *
         * @exception DbDisconnectionFailure if unsuccessful disconnection.
         * @exception std::exception if unexpected exception.
         */
        virtual void
        disconnect(void)
            throw(DbDisconnectionFailure,
                  std::exception) = 0;


        /**
         * Get the connection status.
         *
         * @return true if connected.
         */
        bool
        isConnected(void) const
            throw();


    protected:
        /**
         * The database name.
         */
        std::string mDbName;


        /**
         * The database path.
         */
        std::string mDbPath;


        /**
         * The connection status.
         */
        bool mIsConnected;


        /**
         * Cache the last SQL query.
         */
        std::string mSql;


        /**
         * Cache the result of the last SQL query.
         */
        RecordSet mRecordSet;
};


} // namespace dal
} // namespace tmw


#endif // _TMW_DATA_PROVIDER_H_