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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Simple&nbsp;C++&nbsp;ODBC&nbsp;Database&nbsp;API: SimpleDB::Database Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="pages.html">Related Pages</a> | <a class="qindex" href="examples.html">Examples</a></div>
<div class="nav">
<a class="el" href="namespaceSimpleDB.html">SimpleDB</a>::<a class="el" href="classSimpleDB_1_1Database.html">Database</a></div>
<h1>SimpleDB::Database Class Reference</h1>This class represents a database connection.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="Database_8h-source.html">Database.h</a>></code>
<p>
<a href="classSimpleDB_1_1Database-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database.html#a0">Database</a> (std::string dsn)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor creates the database connection. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classSimpleDB_1_1Query.html">Query</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database.html#a1">newQuery</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a query object for this database. <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database.html#a2">voidQuery</a> (const std::string &query) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">void <a class="el" href="classSimpleDB_1_1Query.html">Query</a>, query the database and don't worry about return types or if its a successful query. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database.html#a3">intQuery</a> (const std::string &query) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">long <a class="el" href="classSimpleDB_1_1Query.html">Query</a>, query the database for a single integer result. <a href="#a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database.html#a4">strQuery</a> (const std::string &query, long bufSize=1000) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="classSimpleDB_1_1Query.html">Query</a> interface that returns a string result. <a href="#a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const SQLHDBC </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database.html#a5">getConnectionHandle</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function to retrieve the database connection handle. <a href="#a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="SimpleDB::Database::~Database"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database.html#a6">~Database</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database.html#e0">escapeString</a> (const std::string &input)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Escapes special characters in a string to be sent as part of a database query. <a href="#e0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database.html#e1">boolToStr</a> (const bool in)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts a boolean input to the equivalent database value. <a href="#e1"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p0" doxytag="SimpleDB::Database::connectionHandle"></a>
SQLHDBC </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database.html#p0">connectionHandle</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ODBC connection handle. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">SQLHENV </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database.html#p1">odbc_environment_handle</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ODBC environment handle. <a href="#p1"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database_1_1Exception.html">Exception</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This class is thrown in case of any database exception. <a href="classSimpleDB_1_1Database_1_1Exception.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimpleDB_1_1Database_1_1NoDataException.html">NoDataException</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classSimpleDB_1_1Database_1_1Exception.html">Exception</a> class thrown when no data is available. <a href="classSimpleDB_1_1Database_1_1NoDataException.html#_details">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class represents a database connection.
<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>: Overload the default assignment operator so that database objects can be assigned without causing problems with connection handles </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="complete_8cpp-example.html#_a3">complete.cpp</a>, and <a class="el" href="simple_8cpp-example.html#_a22">simple.cpp</a>.</dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="SimpleDB::Database::Database"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">Database::Database </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::string </td>
<td class="mdname1" valign="top" nowrap> <em>dsn</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Constructor creates the database connection.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dsn</em> </td><td>The ODBC data source to connect to. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e1" doxytag="SimpleDB::Database::boolToStr"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const std::string Database::boolToStr </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const bool </td>
<td class="mdname1" valign="top" nowrap> <em>in</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Converts a boolean input to the equivalent database value.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>in</em> </td><td>The boolean to convert </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the converted string. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="e0" doxytag="SimpleDB::Database::escapeString"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const std::string Database::escapeString </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>input</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Escapes special characters in a string to be sent as part of a database query.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>The input string to be escaped. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The escaped version of the input string. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="SimpleDB::Database::getConnectionHandle"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const SQLHDBC Database::getConnectionHandle </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Function to retrieve the database connection handle.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The database connection handle. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="SimpleDB::Database::intQuery"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">long Database::intQuery </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>query</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
long <a class="el" href="classSimpleDB_1_1Query.html">Query</a>, query the database for a single integer result.
<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSimpleDB_1_1Database_1_1Exception.html">SimpleDB::Database::Exception</a></em> </td><td>Thrown if error with syntax etc. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSimpleDB_1_1Database_1_1NoDataException.html">SimpleDB::Database::NoDataException</a></em> </td><td>Thrown if now rows are returned by the query.</td></tr>
</table>
</dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>the query to execute </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the integer result from the query </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="SimpleDB::Database::newQuery"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classSimpleDB_1_1Query.html">Query</a> Database::newQuery </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Creates a query object for this database.
<p>
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="classSimpleDB_1_1Query.html">Query</a> The new query object. </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="complete_8cpp-example.html#a5">complete.cpp</a>, and <a class="el" href="simple_8cpp-example.html#a24">simple.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="SimpleDB::Database::strQuery"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::string Database::strQuery </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname" nowrap> <em>query</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>long </td>
<td class="mdname" nowrap> <em>bufSize</em> = <code>1000</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A <a class="el" href="classSimpleDB_1_1Query.html">Query</a> interface that returns a string result.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>The query to execute. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bufSize</em> </td><td>The max size of the string buffer expected to be returned. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>resultant string of the query. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="SimpleDB::Database::voidQuery"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void Database::voidQuery </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>query</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
void <a class="el" href="classSimpleDB_1_1Query.html">Query</a>, query the database and don't worry about return types or if its a successful query.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>query</em> </td><td>The query to execute. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="p1" doxytag="SimpleDB::Database::odbc_environment_handle"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">SQLHENV <a class="el" href="classSimpleDB_1_1Database.html#p1">SimpleDB::Database::odbc_environment_handle</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
ODBC environment handle.
<p>
This handle is created by the constructor and freed in the destructor. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Database_8h-source.html">Database.h</a><li>Database.cpp</ul>
<hr>
<div align="right"><small>
Copyright (C) 2005 <a target="top" href="http://www.eminence.com.au">Eminence Technology Pty Ltd</a>.<br>
Documentation pages generated by doxygen.</small><br>
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=129109&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
</div>
|
