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
|
/*
* 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
*/
#ifndef _TMWSERV_SQLITE_DATA_PROVIDER_H_
#define _TMWSERV_SQLITE_DATA_PROVIDER_H_
#include <iosfwd>
#include "limits.h"
#include <sqlite3.h>
#include "common/configuration.hpp"
// sqlite3_int64 is the preferred new datatype for 64-bit int values.
// see: http://www.sqlite.org/capi3ref.html#sqlite3_int64
#ifndef sqlite3_int64
typedef sqlite_int64 sqlite3_int64;
#endif
#include "dataprovider.h"
namespace dal
{
/**
* A SQLite Data Provider.
*/
class SqLiteDataProvider: public DataProvider
{
public:
/**
* Constructor.
*/
SqLiteDataProvider(void)
throw();
/**
* Destructor.
*/
~SqLiteDataProvider(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;
/**
* 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 String
* @param place - which parameter to bind to
* @param value - the string to bind
*/
void bindString(int place, const std::string &value);
/**
* Bind Integer
* @param place - which parameter to bind to
* @param value - the integer to bind
*/
void bindInteger(int place, int value);
/**
* Bind Float
* @param place - which parameter to bind to
* @param value - the float to bind
*/
void bindFloat(int place, float value);
private:
/** defines the name of the database config parameter */
static const std::string CFGPARAM_SQLITE_DB;
/** defines the default value of the CFGPARAM_SQLITE_DB parameter */
static const std::string CFGPARAM_SQLITE_DB_DEF;
/**
* Returns wheter the connection has a open transaction or is in auto-
* commit mode.
*
* @return true, if a transaction is open.
*/
const bool
inTransaction(void) const;
sqlite3 *mDb; /**< the handle to the database connection */
sqlite3_stmt *mStmt; /**< the prepared statement to process */
};
} // namespace dal
#endif // _TMWSERV_SQLITE_DATA_PROVIDER_H_
|
