1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
<title>DataBase.DataBase Class Reference</title>
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
<link href="tabs.css" rel="stylesheet" type="text/css">
7
<!-- Generated by Doxygen 1.5.4 -->
10
<li><a href="index.html"><span>Main Page</span></a></li>
11
<li><a href="namespaces.html"><span>Packages</span></a></li>
12
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
13
<li><a href="files.html"><span>Files</span></a></li>
18
<li><a href="annotated.html"><span>Class List</span></a></li>
19
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
20
<li><a href="functions.html"><span>Class Members</span></a></li>
24
<a class="el" href="namespaceDataBase.html">DataBase</a>.<a class="el" href="classDataBase_1_1DataBase.html">DataBase</a></div>
25
<h1>DataBase.DataBase Class Reference</h1><!-- doxytag: class="DataBase::DataBase" -->Database interfaze class.
26
<a href="#_details">More...</a>
30
<a href="classDataBase_1_1DataBase-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
32
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
33
<tr><td class="memItemLeft" nowrap align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataBase_1_1DataBase.html#3a1260f97f5523dd29544765dd508c17">__init__</a></td></tr>
35
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the attributes of the class to None. <a href="#3a1260f97f5523dd29544765dd508c17"></a><br></td></tr>
36
<tr><td class="memItemLeft" nowrap align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataBase_1_1DataBase.html#df9919fd7b5b81e1bb168bb86dadfedd">openCon</a></td></tr>
38
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a connection to the HdLorean database, if the database does not exist create a new one. <a href="#df9919fd7b5b81e1bb168bb86dadfedd"></a><br></td></tr>
39
<tr><td class="memItemLeft" nowrap align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataBase_1_1DataBase.html#a72fefd9bf491d48a6992701bd6bb4e4">createTables</a></td></tr>
41
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the tables needed to the HdLorean aplication. <a href="#a72fefd9bf491d48a6992701bd6bb4e4"></a><br></td></tr>
42
<tr><td class="memItemLeft" nowrap align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataBase_1_1DataBase.html#48f6645cc7790bcfd1a0b977aa4ce0cf">closeCon</a></td></tr>
44
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="namespaceClose.html">Close</a> connection to the database. <a href="#48f6645cc7790bcfd1a0b977aa4ce0cf"></a><br></td></tr>
45
<tr><td class="memItemLeft" nowrap align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataBase_1_1DataBase.html#c06253e13b76a82218bc0ebeed4c5344">insertJournal</a></td></tr>
47
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inserts in the journal table a new row with the values of the parameters. <a href="#c06253e13b76a82218bc0ebeed4c5344"></a><br></td></tr>
48
<tr><td class="memItemLeft" nowrap align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataBase_1_1DataBase.html#26e1648459992b95c1cd2311eef86972">select</a></td></tr>
50
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts from the table the information requested. <a href="#26e1648459992b95c1cd2311eef86972"></a><br></td></tr>
51
<tr><td class="memItemLeft" nowrap align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataBase_1_1DataBase.html#9a289182d1a2df49a4ef5506705f5934">update</a></td></tr>
53
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a update query from the input data. <a href="#9a289182d1a2df49a4ef5506705f5934"></a><br></td></tr>
54
<tr><td class="memItemLeft" nowrap align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataBase_1_1DataBase.html#3d85c1c9f5aae1b9058dc9014aa10763">delete</a></td></tr>
56
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a delete query from the input data. <a href="#3d85c1c9f5aae1b9058dc9014aa10763"></a><br></td></tr>
57
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
58
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataBase_1_1DataBase.html#ad5ba7c6b17ecb803850bef9da7122d8">__sqlite3_conn</a></td></tr>
60
<tr><td class="mdescLeft"> </td><td class="mdescRight">Keeps de conection to the database. <a href="#ad5ba7c6b17ecb803850bef9da7122d8"></a><br></td></tr>
61
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataBase_1_1DataBase.html#6ecc1d4e4edb7556a164dad68188d761">__sqlite3_cur</a></td></tr>
63
<tr><td class="mdescLeft"> </td><td class="mdescRight">Keeps the cursor. <a href="#6ecc1d4e4edb7556a164dad68188d761"></a><br></td></tr>
65
<hr><a name="_details"></a><h2>Detailed Description</h2>
66
Database interfaze class.
68
This class implements all the functions needed to control the database of HdLorean <hr><h2>Member Function Documentation</h2>
69
<a class="anchor" name="3a1260f97f5523dd29544765dd508c17"></a><!-- doxytag: member="DataBase::DataBase::__init__" ref="3a1260f97f5523dd29544765dd508c17" args="" -->
71
<div class="memproto">
72
<table class="memname">
74
<td class="memname">def DataBase.DataBase.__init__ </td>
76
<td class="paramtype"> </td>
77
<td class="paramname"> <em>self</em> </td>
78
<td> ) </td>
79
<td width="100%"></td>
86
Set the attributes of the class to None.
91
<a class="anchor" name="df9919fd7b5b81e1bb168bb86dadfedd"></a><!-- doxytag: member="DataBase::DataBase::openCon" ref="df9919fd7b5b81e1bb168bb86dadfedd" args="" -->
93
<div class="memproto">
94
<table class="memname">
96
<td class="memname">def DataBase.DataBase.openCon </td>
98
<td class="paramtype"> </td>
99
<td class="paramname"> <em>self</em> </td>
100
<td> ) </td>
101
<td width="100%"></td>
108
Create a connection to the HdLorean database, if the database does not exist create a new one.
113
<a class="anchor" name="a72fefd9bf491d48a6992701bd6bb4e4"></a><!-- doxytag: member="DataBase::DataBase::createTables" ref="a72fefd9bf491d48a6992701bd6bb4e4" args="" -->
114
<div class="memitem">
115
<div class="memproto">
116
<table class="memname">
118
<td class="memname">def DataBase.DataBase.createTables </td>
120
<td class="paramtype"> </td>
121
<td class="paramname"> <em>self</em> </td>
122
<td> ) </td>
123
<td width="100%"></td>
130
Create the tables needed to the HdLorean aplication.
132
<dl compact><dt><b>Exceptions:</b></dt><dd>
133
<table border="0" cellspacing="2" cellpadding="0">
134
<tr><td valign="top"></td><td valign="top"><em></em> </td><td>Standarderror if the table exists in de database. </td></tr>
140
<a class="anchor" name="48f6645cc7790bcfd1a0b977aa4ce0cf"></a><!-- doxytag: member="DataBase::DataBase::closeCon" ref="48f6645cc7790bcfd1a0b977aa4ce0cf" args="" -->
141
<div class="memitem">
142
<div class="memproto">
143
<table class="memname">
145
<td class="memname">def DataBase.DataBase.closeCon </td>
147
<td class="paramtype"> </td>
148
<td class="paramname"> <em>self</em> </td>
149
<td> ) </td>
150
<td width="100%"></td>
157
<a class="el" href="namespaceClose.html">Close</a> connection to the database.
162
<a class="anchor" name="c06253e13b76a82218bc0ebeed4c5344"></a><!-- doxytag: member="DataBase::DataBase::insertJournal" ref="c06253e13b76a82218bc0ebeed4c5344" args="" -->
163
<div class="memitem">
164
<div class="memproto">
165
<table class="memname">
167
<td class="memname">def DataBase.DataBase.insertJournal </td>
169
<td class="paramtype"> </td>
170
<td class="paramname"> <em>self</em>, </td>
173
<td class="paramkey"></td>
175
<td class="paramtype"> </td>
176
<td class="paramname"> <em>timestamp</em>, </td>
179
<td class="paramkey"></td>
181
<td class="paramtype"> </td>
182
<td class="paramname"> <em>chtype</em>, </td>
185
<td class="paramkey"></td>
187
<td class="paramtype"> </td>
188
<td class="paramname"> <em>init</em>, </td>
191
<td class="paramkey"></td>
193
<td class="paramtype"> </td>
194
<td class="paramname"> <em>final</em>, </td>
197
<td class="paramkey"></td>
199
<td class="paramtype"> </td>
200
<td class="paramname"> <em>wrote</em></td><td> </td>
205
<td></td><td></td><td width="100%"></td>
212
Inserts in the journal table a new row with the values of the parameters.
214
<dl compact><dt><b>Parameters:</b></dt><dd>
215
<table border="0" cellspacing="2" cellpadding="0">
216
<tr><td valign="top"></td><td valign="top"><em>timestamp</em> </td><td>value for the field timestamp of the journal table.. </td></tr>
217
<tr><td valign="top"></td><td valign="top"><em>chtype</em> </td><td>value for the field chtype of the journal table. </td></tr>
218
<tr><td valign="top"></td><td valign="top"><em>init</em> </td><td>value for the field initpath of the journal table. </td></tr>
219
<tr><td valign="top"></td><td valign="top"><em>final</em> </td><td>value for the field finalpath of the journal table. </td></tr>
220
<tr><td valign="top"></td><td valign="top"><em>wrote</em> </td><td>value for the field wrote of the journal table.</td></tr>
223
<dl compact><dt><b>Exceptions:</b></dt><dd>
224
<table border="0" cellspacing="2" cellpadding="0">
225
<tr><td valign="top"></td><td valign="top"><em></em> </td><td>StandardError if the row is in the table (Integrity error) or if the query is wrong (DatabaseError) </td></tr>
231
<a class="anchor" name="26e1648459992b95c1cd2311eef86972"></a><!-- doxytag: member="DataBase::DataBase::select" ref="26e1648459992b95c1cd2311eef86972" args="" -->
232
<div class="memitem">
233
<div class="memproto">
234
<table class="memname">
236
<td class="memname">def DataBase.DataBase.select </td>
238
<td class="paramtype"> </td>
239
<td class="paramname"> <em>self</em>, </td>
242
<td class="paramkey"></td>
244
<td class="paramtype"> </td>
245
<td class="paramname"> <em>table</em>, </td>
248
<td class="paramkey"></td>
250
<td class="paramtype"> </td>
251
<td class="paramname"> <em>listcolumns</em>, </td>
254
<td class="paramkey"></td>
256
<td class="paramtype"> </td>
257
<td class="paramname"> <em>listcond</em> = <code>[]</code>, </td>
260
<td class="paramkey"></td>
262
<td class="paramtype"> </td>
263
<td class="paramname"> <em>listord</em> = <code>[]</code>, </td>
266
<td class="paramkey"></td>
268
<td class="paramtype"> </td>
269
<td class="paramname"> <em>listgroup</em> = <code>[]</code>, </td>
272
<td class="paramkey"></td>
274
<td class="paramtype"> </td>
275
<td class="paramname"> <em>listhav</em> = <code>[]</code></td><td> </td>
280
<td></td><td></td><td width="100%"></td>
287
Extracts from the table the information requested.
289
Create a select query from the input data and returns the results in an array.<p>
290
<dl compact><dt><b>Parameters:</b></dt><dd>
291
<table border="0" cellspacing="2" cellpadding="0">
292
<tr><td valign="top"></td><td valign="top"><em>table</em> </td><td>table where de selec query is executed. </td></tr>
293
<tr><td valign="top"></td><td valign="top"><em>listcolums</em> </td><td>column list to draw from the table. Example: ['timestamp','wrote'] </td></tr>
294
<tr><td valign="top"></td><td valign="top"><em>listcond</em> </td><td>list of conditions. Example: ['timestamp=02.03.07','and','wrote=0'] </td></tr>
295
<tr><td valign="top"></td><td valign="top"><em>listord</em> </td><td>list of orders. Example: ['timestamp ASC','wrote'] </td></tr>
296
<tr><td valign="top"></td><td valign="top"><em>listgroup</em> </td><td>list of groups. Example: ['wrote'] </td></tr>
297
<tr><td valign="top"></td><td valign="top"><em>listhav</em> </td><td>list of having. </td></tr>
300
<dl class="return" compact><dt><b>Returns:</b></dt><dd>: An array with the selected tuples</dd></dl>
301
<dl compact><dt><b>Exceptions:</b></dt><dd>
302
<table border="0" cellspacing="2" cellpadding="0">
303
<tr><td valign="top"></td><td valign="top"><em></em> </td><td>StandardError if the sql query is wrong (DatabaseError) </td></tr>
309
<a class="anchor" name="9a289182d1a2df49a4ef5506705f5934"></a><!-- doxytag: member="DataBase::DataBase::update" ref="9a289182d1a2df49a4ef5506705f5934" args="" -->
310
<div class="memitem">
311
<div class="memproto">
312
<table class="memname">
314
<td class="memname">def DataBase.DataBase.update </td>
316
<td class="paramtype"> </td>
317
<td class="paramname"> <em>self</em>, </td>
320
<td class="paramkey"></td>
322
<td class="paramtype"> </td>
323
<td class="paramname"> <em>table</em>, </td>
326
<td class="paramkey"></td>
328
<td class="paramtype"> </td>
329
<td class="paramname"> <em>mcolumn</em>, </td>
332
<td class="paramkey"></td>
334
<td class="paramtype"> </td>
335
<td class="paramname"> <em>listcond</em></td><td> </td>
340
<td></td><td></td><td width="100%"></td>
347
Create a update query from the input data.
349
<dl compact><dt><b>Parameters:</b></dt><dd>
350
<table border="0" cellspacing="2" cellpadding="0">
351
<tr><td valign="top"></td><td valign="top"><em>table</em> </td><td>table where update is done. </td></tr>
352
<tr><td valign="top"></td><td valign="top"><em>column</em> </td><td>column of the table to update. Example: timestamp. </td></tr>
353
<tr><td valign="top"></td><td valign="top"><em>listcond</em> </td><td>List of conditions for upgrade. Example: ['timestamp=02.03.07','and','wrote=0']</td></tr>
356
<dl compact><dt><b>Exceptions:</b></dt><dd>
357
<table border="0" cellspacing="2" cellpadding="0">
358
<tr><td valign="top"></td><td valign="top"><em></em> </td><td>StandardError if the row is in the table (Integrity error) or if the query is wrong (DatabaseError) </td></tr>
364
<a class="anchor" name="3d85c1c9f5aae1b9058dc9014aa10763"></a><!-- doxytag: member="DataBase::DataBase::delete" ref="3d85c1c9f5aae1b9058dc9014aa10763" args="" -->
365
<div class="memitem">
366
<div class="memproto">
367
<table class="memname">
369
<td class="memname">def DataBase.DataBase.delete </td>
371
<td class="paramtype"> </td>
372
<td class="paramname"> <em>self</em>, </td>
375
<td class="paramkey"></td>
377
<td class="paramtype"> </td>
378
<td class="paramname"> <em>table</em>, </td>
381
<td class="paramkey"></td>
383
<td class="paramtype"> </td>
384
<td class="paramname"> <em>listcond</em></td><td> </td>
389
<td></td><td></td><td width="100%"></td>
396
Create a delete query from the input data.
398
<dl compact><dt><b>Parameters:</b></dt><dd>
399
<table border="0" cellspacing="2" cellpadding="0">
400
<tr><td valign="top"></td><td valign="top"><em>table</em> </td><td>table where row is deleted. </td></tr>
401
<tr><td valign="top"></td><td valign="top"><em>listcond</em> </td><td>List of conditions for delete. Example: ['timestamp=02.03.07','and','wrote=0']</td></tr>
404
<dl compact><dt><b>Exceptions:</b></dt><dd>
405
<table border="0" cellspacing="2" cellpadding="0">
406
<tr><td valign="top"></td><td valign="top"><em></em> </td><td>StandardError if the query is wrong (DatabaseError) </td></tr>
412
<hr><h2>Member Data Documentation</h2>
413
<a class="anchor" name="ad5ba7c6b17ecb803850bef9da7122d8"></a><!-- doxytag: member="DataBase::DataBase::__sqlite3_conn" ref="ad5ba7c6b17ecb803850bef9da7122d8" args="" -->
414
<div class="memitem">
415
<div class="memproto">
416
<table class="memname">
418
<td class="memname"><a class="el" href="classDataBase_1_1DataBase.html#ad5ba7c6b17ecb803850bef9da7122d8">DataBase.DataBase.__sqlite3_conn</a><code> [private]</code> </td>
425
Keeps de conection to the database.
430
<a class="anchor" name="6ecc1d4e4edb7556a164dad68188d761"></a><!-- doxytag: member="DataBase::DataBase::__sqlite3_cur" ref="6ecc1d4e4edb7556a164dad68188d761" args="" -->
431
<div class="memitem">
432
<div class="memproto">
433
<table class="memname">
435
<td class="memname"><a class="el" href="classDataBase_1_1DataBase.html#6ecc1d4e4edb7556a164dad68188d761">DataBase.DataBase.__sqlite3_cur</a><code> [private]</code> </td>
447
<hr>The documentation for this class was generated from the following file:<ul>
448
<li>workspace/unstable/db/src/<a class="el" href="DataBase_8py.html">DataBase.py</a></ul>
449
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Dec 15 14:21:09 2007 by
450
<a href="http://www.doxygen.org/index.html">
451
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>