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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qsqldriver.cpp -->
<title>Qt 4.8: QSqlDriver Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtsql.html">QtSql</a></li>
<li>QSqlDriver</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#protected-slots">Protected Slots</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QSqlDriver Class Reference</h1>
<!-- $$$QSqlDriver-brief -->
<p>The QSqlDriver class is an abstract base class for accessing specific SQL databases. <a href="#details">More...</a></p>
<!-- @@@QSqlDriver -->
<pre class="cpp"> <span class="preprocessor">#include <QSqlDriver></span></pre><p><b>Inherits: </b><a href="qobject.html">QObject</a>.</p>
<ul>
<li><a href="qsqldriver-members.html">List of all members, including inherited members</a></li>
<li><a href="qsqldriver-qt3.html">Qt 3 support members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#DriverFeature-enum">DriverFeature</a></b> { Transactions, QuerySize, BLOB, Unicode, ..., MultipleResultSets }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#IdentifierType-enum">IdentifierType</a></b> { FieldName, TableName }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#StatementType-enum">StatementType</a></b> { WhereStatement, SelectStatement, UpdateStatement, InsertStatement, DeleteStatement }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#QSqlDriver">QSqlDriver</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#dtor.QSqlDriver">~QSqlDriver</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#beginTransaction">beginTransaction</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#close">close</a></b> () = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#commitTransaction">commitTransaction</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QSqlResult * </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#createResult">createResult</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#escapeIdentifier">escapeIdentifier</a></b> ( const QString & <i>identifier</i>, IdentifierType <i>type</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#formatValue">formatValue</a></b> ( const QSqlField & <i>field</i>, bool <i>trimStrings</i> = false ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#handle">handle</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#hasFeature">hasFeature</a></b> ( DriverFeature <i>feature</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#isIdentifierEscaped">isIdentifierEscaped</a></b> ( const QString & <i>identifier</i>, IdentifierType <i>type</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#isOpen">isOpen</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#isOpenError">isOpenError</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSqlError </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#lastError">lastError</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSql::NumericalPrecisionPolicy </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#numericalPrecisionPolicy">numericalPrecisionPolicy</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#open">open</a></b> ( const QString & <i>db</i>, const QString & <i>user</i> = QString(), const QString & <i>password</i> = QString(), const QString & <i>host</i> = QString(), int <i>port</i> = -1, const QString & <i>options</i> = QString() ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QSqlIndex </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#primaryIndex">primaryIndex</a></b> ( const QString & <i>tableName</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QSqlRecord </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#record">record</a></b> ( const QString & <i>tableName</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#rollbackTransaction">rollbackTransaction</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#setNumericalPrecisionPolicy">setNumericalPrecisionPolicy</a></b> ( QSql::NumericalPrecisionPolicy <i>precisionPolicy</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#sqlStatement">sqlStatement</a></b> ( StatementType <i>type</i>, const QString & <i>tableName</i>, const QSqlRecord & <i>rec</i>, bool <i>preparedStatement</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#stripDelimiters">stripDelimiters</a></b> ( const QString & <i>identifier</i>, IdentifierType <i>type</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#subscribeToNotification">subscribeToNotification</a></b> ( const QString & <i>name</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#subscribedToNotifications">subscribedToNotifications</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QStringList </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#tables">tables</a></b> ( QSql::TableType <i>tableType</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#unsubscribeFromNotification">unsubscribeFromNotification</a></b> ( const QString & <i>name</i> )</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#notification">notification</a></b> ( const QString & <i>name</i> )</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#setLastError">setLastError</a></b> ( const QSqlError & <i>error</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#setOpen">setOpen</a></b> ( bool <i>open</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#setOpenError">setOpenError</a></b> ( bool <i>error</i> )</td></tr>
</table>
<ul>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
</ul>
<a name="protected-slots"></a>
<h2>Protected Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#isIdentifierEscapedImplementation">isIdentifierEscapedImplementation</a></b> ( const QString & <i>identifier</i>, IdentifierType <i>type</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#stripDelimitersImplementation">stripDelimitersImplementation</a></b> ( const QString & <i>identifier</i>, IdentifierType <i>type</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#subscribeToNotificationImplementation">subscribeToNotificationImplementation</a></b> ( const QString & <i>name</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#subscribedToNotificationsImplementation">subscribedToNotificationsImplementation</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsqldriver.html#unsubscribeFromNotificationImplementation">unsubscribeFromNotificationImplementation</a></b> ( const QString & <i>name</i> )</td></tr>
</table>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QSqlDriver-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QSqlDriver class is an abstract base class for accessing specific SQL databases.</p>
<p>This class should not be used directly. Use <a href="qsqldatabase.html">QSqlDatabase</a> instead.</p>
<p>If you want to create your own SQL drivers, you can subclass this class and reimplement its pure virtual functions and those virtual functions that you need. See <a href="sql-driver.html#how-to-write-your-own-database-driver">How to Write Your Own Database Driver</a> for more information.</p>
</div>
<p><b>See also </b><a href="qsqldatabase.html">QSqlDatabase</a> and <a href="qsqlresult.html">QSqlResult</a>.</p>
<!-- @@@QSqlDriver -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$DriverFeature$$$Transactions$$$QuerySize$$$BLOB$$$Unicode$$$PreparedQueries$$$NamedPlaceholders$$$PositionalPlaceholders$$$LastInsertId$$$BatchOperations$$$SimpleLocking$$$LowPrecisionNumbers$$$EventNotifications$$$FinishQuery$$$MultipleResultSets -->
<h3 class="fn"><a name="DriverFeature-enum"></a>enum QSqlDriver::<span class="name">DriverFeature</span></h3>
<p>This enum contains a list of features a driver might support. Use <a href="qsqldriver.html#hasFeature">hasFeature</a>() to query whether a feature is supported or not.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QSqlDriver::Transactions</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Whether the driver supports SQL transactions.</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::QuerySize</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Whether the database is capable of reporting the size of a query. Note that some databases do not support returning the size (i.e. number of rows returned) of a query, in which case <a href="qsqlquery.html#size">QSqlQuery::size</a>() will return -1.</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::BLOB</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">Whether the driver supports Binary Large Object fields.</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::Unicode</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">Whether the driver supports Unicode strings if the database server does.</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::PreparedQueries</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">Whether the driver supports prepared query execution.</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::NamedPlaceholders</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">Whether the driver supports the use of named placeholders.</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::PositionalPlaceholders</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">Whether the driver supports the use of positional placeholders.</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::LastInsertId</tt></td><td class="topAlign"><tt>7</tt></td><td class="topAlign">Whether the driver supports returning the Id of the last touched row.</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::BatchOperations</tt></td><td class="topAlign"><tt>8</tt></td><td class="topAlign">Whether the driver supports batched operations, see <a href="qsqlquery.html#execBatch">QSqlQuery::execBatch</a>()</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::SimpleLocking</tt></td><td class="topAlign"><tt>9</tt></td><td class="topAlign">Whether the driver disallows a write lock on a table while other queries have a read lock on it.</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::LowPrecisionNumbers</tt></td><td class="topAlign"><tt>10</tt></td><td class="topAlign">Whether the driver allows fetching numerical values with low precision.</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::EventNotifications</tt></td><td class="topAlign"><tt>11</tt></td><td class="topAlign">Whether the driver supports database event notifications.</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::FinishQuery</tt></td><td class="topAlign"><tt>12</tt></td><td class="topAlign">Whether the driver can do any low-level resource cleanup when <a href="qsqlquery.html#finish">QSqlQuery::finish</a>() is called.</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::MultipleResultSets</tt></td><td class="topAlign"><tt>13</tt></td><td class="topAlign">Whether the driver can access multiple result sets returned from batched statements or stored procedures.</td></tr>
</table>
<p>More information about supported features can be found in the <a href="sql-driver.html">Qt SQL driver</a> documentation.</p>
<p><b>See also </b><a href="qsqldriver.html#hasFeature">hasFeature</a>().</p>
<!-- @@@DriverFeature -->
<!-- $$$IdentifierType$$$FieldName$$$TableName -->
<h3 class="fn"><a name="IdentifierType-enum"></a>enum QSqlDriver::<span class="name">IdentifierType</span></h3>
<p>This enum contains a list of SQL identifier types.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QSqlDriver::FieldName</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">A SQL field name</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::TableName</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">A SQL table name</td></tr>
</table>
<!-- @@@IdentifierType -->
<!-- $$$StatementType$$$WhereStatement$$$SelectStatement$$$UpdateStatement$$$InsertStatement$$$DeleteStatement -->
<h3 class="fn"><a name="StatementType-enum"></a>enum QSqlDriver::<span class="name">StatementType</span></h3>
<p>This enum contains a list of SQL statement (or clause) types the driver can create.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QSqlDriver::WhereStatement</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">An SQL <tt>WHERE</tt> statement (e.g., <tt>WHERE f = 5</tt>).</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::SelectStatement</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">An SQL <tt>SELECT</tt> statement (e.g., <tt>SELECT f FROM t</tt>).</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::UpdateStatement</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">An SQL <tt>UPDATE</tt> statement (e.g., <tt>UPDATE TABLE t set f = 1</tt>).</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::InsertStatement</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">An SQL <tt>INSERT</tt> statement (e.g., <tt>INSERT INTO t (f) values (1)</tt>).</td></tr>
<tr><td class="topAlign"><tt>QSqlDriver::DeleteStatement</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">An SQL <tt>DELETE</tt> statement (e.g., <tt>DELETE FROM t</tt>).</td></tr>
</table>
<p><b>See also </b><a href="qsqldriver.html#sqlStatement">sqlStatement</a>().</p>
<!-- @@@StatementType -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QSqlDriver[overload1]$$$QSqlDriverQObject* -->
<h3 class="fn"><a name="QSqlDriver"></a>QSqlDriver::<span class="name">QSqlDriver</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs a new driver with the given <i>parent</i>.</p>
<!-- @@@QSqlDriver -->
<!-- $$$~QSqlDriver[overload1]$$$~QSqlDriver -->
<h3 class="fn"><a name="dtor.QSqlDriver"></a>QSqlDriver::<span class="name">~QSqlDriver</span> ()</h3>
<p>Destroys the object and frees any allocated resources.</p>
<!-- @@@~QSqlDriver -->
<!-- $$$beginTransaction[overload1]$$$beginTransaction -->
<h3 class="fn"><a name="beginTransaction"></a><span class="type">bool</span> QSqlDriver::<span class="name">beginTransaction</span> ()<tt> [virtual]</tt></h3>
<p>This function is called to begin a transaction. If successful, return true, otherwise return false. The default implementation does nothing and returns false.</p>
<p><b>See also </b><a href="qsqldriver.html#commitTransaction">commitTransaction</a>() and <a href="qsqldriver.html#rollbackTransaction">rollbackTransaction</a>().</p>
<!-- @@@beginTransaction -->
<!-- $$$close[overload1]$$$close -->
<h3 class="fn"><a name="close"></a><span class="type">void</span> QSqlDriver::<span class="name">close</span> ()<tt> [pure virtual]</tt></h3>
<p>Derived classes must reimplement this pure virtual function in order to close the database connection. Return true on success, false on failure.</p>
<p><b>See also </b><a href="qsqldriver.html#open">open</a>() and <a href="qsqldriver.html#setOpen">setOpen</a>().</p>
<!-- @@@close -->
<!-- $$$commitTransaction[overload1]$$$commitTransaction -->
<h3 class="fn"><a name="commitTransaction"></a><span class="type">bool</span> QSqlDriver::<span class="name">commitTransaction</span> ()<tt> [virtual]</tt></h3>
<p>This function is called to commit a transaction. If successful, return true, otherwise return false. The default implementation does nothing and returns false.</p>
<p><b>See also </b><a href="qsqldriver.html#beginTransaction">beginTransaction</a>() and <a href="qsqldriver.html#rollbackTransaction">rollbackTransaction</a>().</p>
<!-- @@@commitTransaction -->
<!-- $$$createResult[overload1]$$$createResult -->
<h3 class="fn"><a name="createResult"></a><span class="type"><a href="qsqlresult.html">QSqlResult</a></span> * QSqlDriver::<span class="name">createResult</span> () const<tt> [pure virtual]</tt></h3>
<p>Creates an empty SQL result on the database. Derived classes must reimplement this function and return a <a href="qsqlresult.html">QSqlResult</a> object appropriate for their database to the caller.</p>
<!-- @@@createResult -->
<!-- $$$escapeIdentifier[overload1]$$$escapeIdentifierconstQString&IdentifierType -->
<h3 class="fn"><a name="escapeIdentifier"></a><span class="type"><a href="qstring.html">QString</a></span> QSqlDriver::<span class="name">escapeIdentifier</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>identifier</i>, <span class="type"><a href="qsqldriver.html#IdentifierType-enum">IdentifierType</a></span> <i>type</i> ) const<tt> [virtual]</tt></h3>
<p>Returns the <i>identifier</i> escaped according to the database rules. <i>identifier</i> can either be a table name or field name, dependent on <i>type</i>.</p>
<p>The default implementation does nothing.</p>
<p><b>See also </b><a href="qsqldriver.html#isIdentifierEscaped">isIdentifierEscaped</a>().</p>
<!-- @@@escapeIdentifier -->
<!-- $$$formatValue[overload1]$$$formatValueconstQSqlField&bool -->
<h3 class="fn"><a name="formatValue"></a><span class="type"><a href="qstring.html">QString</a></span> QSqlDriver::<span class="name">formatValue</span> ( const <span class="type"><a href="qsqlfield.html">QSqlField</a></span> & <i>field</i>, <span class="type">bool</span> <i>trimStrings</i> = false ) const<tt> [virtual]</tt></h3>
<p>Returns a string representation of the <i>field</i> value for the database. This is used, for example, when constructing INSERT and UPDATE statements.</p>
<p>The default implementation returns the value formatted as a string according to the following rules:</p>
<ul>
<li>If <i>field</i> is character data, the value is returned enclosed in single quotation marks, which is appropriate for many SQL databases. Any embedded single-quote characters are escaped (replaced with two single-quote characters). If <i>trimStrings</i> is true (the default is false), all trailing whitespace is trimmed from the field.</li>
<li>If <i>field</i> is date/time data, the value is formatted in ISO format and enclosed in single quotation marks. If the date/time data is invalid, "NULL" is returned.</li>
<li>If <i>field</i> is <a href="qbytearray.html">bytearray</a> data, and the driver can edit binary fields, the value is formatted as a hexadecimal string.</li>
<li>For any other field type, toString() is called on its value and the result of this is returned.</li>
</ul>
<p><b>See also </b><a href="qvariant.html#toString">QVariant::toString</a>().</p>
<!-- @@@formatValue -->
<!-- $$$handle[overload1]$$$handle -->
<h3 class="fn"><a name="handle"></a><span class="type"><a href="qvariant.html">QVariant</a></span> QSqlDriver::<span class="name">handle</span> () const<tt> [virtual]</tt></h3>
<p>Returns the low-level database handle wrapped in a <a href="qvariant.html">QVariant</a> or an invalid variant if there is no handle.</p>
<p><b>Warning:</b> Use this with uttermost care and only if you know what you're doing.</p>
<p><b>Warning:</b> The handle returned here can become a stale pointer if the connection is modified (for example, if you close the connection).</p>
<p><b>Warning:</b> The handle can be NULL if the connection is not open yet.</p>
<p>The handle returned here is database-dependent, you should query the type name of the variant before accessing it.</p>
<p>This example retrieves the handle for a connection to sqlite:</p>
<pre class="cpp"> <span class="type"><a href="qsqldatabase.html">QSqlDatabase</a></span> db <span class="operator">=</span> <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>;
<span class="type"><a href="qvariant.html">QVariant</a></span> v <span class="operator">=</span> db<span class="operator">.</span>driver()<span class="operator">-</span><span class="operator">></span>handle();
<span class="keyword">if</span> (v<span class="operator">.</span>isValid() <span class="operator">&</span><span class="operator">&</span> qstrcmp(v<span class="operator">.</span>typeName()<span class="operator">,</span> <span class="string">"sqlite3*"</span>) <span class="operator">=</span><span class="operator">=</span> <span class="number">0</span>) {
<span class="comment">// v.data() returns a pointer to the handle</span>
sqlite3 <span class="operator">*</span>handle <span class="operator">=</span> <span class="operator">*</span><span class="keyword">static_cast</span><span class="operator"><</span>sqlite3 <span class="operator">*</span><span class="operator">*</span><span class="operator">></span>(v<span class="operator">.</span>data());
<span class="keyword">if</span> (handle <span class="operator">!</span><span class="operator">=</span> <span class="number">0</span>) { <span class="comment">// check that it is not NULL</span>
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
}
}</pre>
<p>This snippet returns the handle for PostgreSQL or MySQL:</p>
<pre class="cpp"> <span class="keyword">if</span> (qstrcmp(v<span class="operator">.</span>typeName()<span class="operator">,</span> <span class="string">"PGconn*"</span>) <span class="operator">=</span><span class="operator">=</span> <span class="number">0</span>) {
PGconn <span class="operator">*</span>handle <span class="operator">=</span> <span class="operator">*</span><span class="keyword">static_cast</span><span class="operator"><</span>PGconn <span class="operator">*</span><span class="operator">*</span><span class="operator">></span>(v<span class="operator">.</span>data());
<span class="keyword">if</span> (handle <span class="operator">!</span><span class="operator">=</span> <span class="number">0</span>) <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
}
<span class="keyword">if</span> (qstrcmp(v<span class="operator">.</span>typeName()<span class="operator">,</span> <span class="string">"MYSQL*"</span>) <span class="operator">=</span><span class="operator">=</span> <span class="number">0</span>) {
MYSQL <span class="operator">*</span>handle <span class="operator">=</span> <span class="operator">*</span><span class="keyword">static_cast</span><span class="operator"><</span>MYSQL <span class="operator">*</span><span class="operator">*</span><span class="operator">></span>(v<span class="operator">.</span>data());
<span class="keyword">if</span> (handle <span class="operator">!</span><span class="operator">=</span> <span class="number">0</span>) <span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
}</pre>
<p><b>See also </b><a href="qsqlresult.html#handle">QSqlResult::handle</a>().</p>
<!-- @@@handle -->
<!-- $$$hasFeature[overload1]$$$hasFeatureDriverFeature -->
<h3 class="fn"><a name="hasFeature"></a><span class="type">bool</span> QSqlDriver::<span class="name">hasFeature</span> ( <span class="type"><a href="qsqldriver.html#DriverFeature-enum">DriverFeature</a></span> <i>feature</i> ) const<tt> [pure virtual]</tt></h3>
<p>Returns true if the driver supports feature <i>feature</i>; otherwise returns false.</p>
<p>Note that some databases need to be <a href="qsqldriver.html#open">open</a>() before this can be determined.</p>
<p><b>See also </b><a href="qsqldriver.html#DriverFeature-enum">DriverFeature</a>.</p>
<!-- @@@hasFeature -->
<!-- $$$isIdentifierEscaped[overload1]$$$isIdentifierEscapedconstQString&IdentifierType -->
<h3 class="fn"><a name="isIdentifierEscaped"></a><span class="type">bool</span> QSqlDriver::<span class="name">isIdentifierEscaped</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>identifier</i>, <span class="type"><a href="qsqldriver.html#IdentifierType-enum">IdentifierType</a></span> <i>type</i> ) const</h3>
<p>Returns whether <i>identifier</i> is escaped according to the database rules. <i>identifier</i> can either be a table name or field name, dependent on <i>type</i>.</p>
<p><b>Warning:</b> Because of binary compatibility constraints, this function is not virtual. If you want to provide your own implementation in your <a href="qsqldriver.html">QSqlDriver</a> subclass, reimplement the <a href="qsqldriver.html#isIdentifierEscapedImplementation">isIdentifierEscapedImplementation</a>() slot in your subclass instead. The isIdentifierEscapedFunction() will dynamically detect the slot and call it.</p>
<p><b>See also </b><a href="qsqldriver.html#stripDelimiters">stripDelimiters</a>() and <a href="qsqldriver.html#escapeIdentifier">escapeIdentifier</a>().</p>
<!-- @@@isIdentifierEscaped -->
<!-- $$$isIdentifierEscapedImplementation[overload1]$$$isIdentifierEscapedImplementationconstQString&IdentifierType -->
<h3 class="fn"><a name="isIdentifierEscapedImplementation"></a><span class="type">bool</span> QSqlDriver::<span class="name">isIdentifierEscapedImplementation</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>identifier</i>, <span class="type"><a href="qsqldriver.html#IdentifierType-enum">IdentifierType</a></span> <i>type</i> ) const<tt> [protected slot]</tt></h3>
<p>This slot returns whether <i>identifier</i> is escaped according to the database rules. <i>identifier</i> can either be a table name or field name, dependent on <i>type</i>.</p>
<p>Because of binary compatibility constraints, <a href="qsqldriver.html#isIdentifierEscaped">isIdentifierEscaped</a>() function (introduced in Qt 4.5) is not virtual. Instead, <a href="qsqldriver.html#isIdentifierEscaped">isIdentifierEscaped</a>() will dynamically detect and call <i>this</i> slot. The default implementation assumes the escape/delimiter character is a double quote. Reimplement this slot in your own <a href="qsqldriver.html">QSqlDriver</a> if your database engine uses a different delimiter character.</p>
<p>This function was introduced in Qt 4.6.</p>
<p><b>See also </b><a href="qsqldriver.html#isIdentifierEscaped">isIdentifierEscaped</a>().</p>
<!-- @@@isIdentifierEscapedImplementation -->
<!-- $$$isOpen[overload1]$$$isOpen -->
<h3 class="fn"><a name="isOpen"></a><span class="type">bool</span> QSqlDriver::<span class="name">isOpen</span> () const<tt> [virtual]</tt></h3>
<p>Returns true if the database connection is open; otherwise returns false.</p>
<!-- @@@isOpen -->
<!-- $$$isOpenError[overload1]$$$isOpenError -->
<h3 class="fn"><a name="isOpenError"></a><span class="type">bool</span> QSqlDriver::<span class="name">isOpenError</span> () const</h3>
<p>Returns true if the there was an error opening the database connection; otherwise returns false.</p>
<!-- @@@isOpenError -->
<!-- $$$lastError[overload1]$$$lastError -->
<h3 class="fn"><a name="lastError"></a><span class="type"><a href="qsqlerror.html">QSqlError</a></span> QSqlDriver::<span class="name">lastError</span> () const</h3>
<p>Returns a <a href="qsqlerror.html">QSqlError</a> object which contains information about the last error that occurred on the database.</p>
<p><b>See also </b><a href="qsqldriver.html#setLastError">setLastError</a>().</p>
<!-- @@@lastError -->
<!-- $$$notification[overload1]$$$notificationconstQString& -->
<h3 class="fn"><a name="notification"></a><span class="type">void</span> QSqlDriver::<span class="name">notification</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the database posts an event notification that the driver subscribes to. <i>name</i> identifies the event notification.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>See also </b><a href="qsqldriver.html#subscribeToNotification">subscribeToNotification</a>().</p>
<!-- @@@notification -->
<!-- $$$numericalPrecisionPolicy[overload1]$$$numericalPrecisionPolicy -->
<h3 class="fn"><a name="numericalPrecisionPolicy"></a><span class="type"><a href="qsql.html#NumericalPrecisionPolicy-enum">QSql::NumericalPrecisionPolicy</a></span> QSqlDriver::<span class="name">numericalPrecisionPolicy</span> () const</h3>
<p>Returns the current default precision policy for the database connection.</p>
<p>This function was introduced in Qt 4.6.</p>
<p><b>See also </b><a href="qsql.html#NumericalPrecisionPolicy-enum">QSql::NumericalPrecisionPolicy</a>, <a href="qsqldriver.html#setNumericalPrecisionPolicy">setNumericalPrecisionPolicy</a>(), <a href="qsqlquery.html#numericalPrecisionPolicy">QSqlQuery::numericalPrecisionPolicy</a>(), and <a href="qsqlquery.html#setNumericalPrecisionPolicy">QSqlQuery::setNumericalPrecisionPolicy</a>().</p>
<!-- @@@numericalPrecisionPolicy -->
<!-- $$$open[overload1]$$$openconstQString&constQString&constQString&constQString&intconstQString& -->
<h3 class="fn"><a name="open"></a><span class="type">bool</span> QSqlDriver::<span class="name">open</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>db</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>user</i> = QString(), const <span class="type"><a href="qstring.html">QString</a></span> & <i>password</i> = QString(), const <span class="type"><a href="qstring.html">QString</a></span> & <i>host</i> = QString(), <span class="type">int</span> <i>port</i> = -1, const <span class="type"><a href="qstring.html">QString</a></span> & <i>options</i> = QString() )<tt> [pure virtual]</tt></h3>
<p>Derived classes must reimplement this pure virtual function to open a database connection on database <i>db</i>, using user name <i>user</i>, password <i>password</i>, host <i>host</i>, port <i>port</i> and connection options <i>options</i>.</p>
<p>The function must return true on success and false on failure.</p>
<p><b>See also </b><a href="qsqldriver.html#setOpen">setOpen</a>().</p>
<!-- @@@open -->
<!-- $$$primaryIndex[overload1]$$$primaryIndexconstQString& -->
<h3 class="fn"><a name="primaryIndex"></a><span class="type"><a href="qsqlindex.html">QSqlIndex</a></span> QSqlDriver::<span class="name">primaryIndex</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>tableName</i> ) const<tt> [virtual]</tt></h3>
<p>Returns the primary index for table <i>tableName</i>. Returns an empty <a href="qsqlindex.html">QSqlIndex</a> if the table doesn't have a primary index. The default implementation returns an empty index.</p>
<!-- @@@primaryIndex -->
<!-- $$$record[overload1]$$$recordconstQString& -->
<h3 class="fn"><a name="record"></a><span class="type"><a href="qsqlrecord.html">QSqlRecord</a></span> QSqlDriver::<span class="name">record</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>tableName</i> ) const<tt> [virtual]</tt></h3>
<p>Returns a <a href="qsqlrecord.html">QSqlRecord</a> populated with the names of the fields in table <i>tableName</i>. If no such table exists, an empty record is returned. The default implementation returns an empty record.</p>
<!-- @@@record -->
<!-- $$$rollbackTransaction[overload1]$$$rollbackTransaction -->
<h3 class="fn"><a name="rollbackTransaction"></a><span class="type">bool</span> QSqlDriver::<span class="name">rollbackTransaction</span> ()<tt> [virtual]</tt></h3>
<p>This function is called to rollback a transaction. If successful, return true, otherwise return false. The default implementation does nothing and returns false.</p>
<p><b>See also </b><a href="qsqldriver.html#beginTransaction">beginTransaction</a>() and <a href="qsqldriver.html#commitTransaction">commitTransaction</a>().</p>
<!-- @@@rollbackTransaction -->
<!-- $$$setLastError[overload1]$$$setLastErrorconstQSqlError& -->
<h3 class="fn"><a name="setLastError"></a><span class="type">void</span> QSqlDriver::<span class="name">setLastError</span> ( const <span class="type"><a href="qsqlerror.html">QSqlError</a></span> & <i>error</i> )<tt> [virtual protected]</tt></h3>
<p>This function is used to set the value of the last error, <i>error</i>, that occurred on the database.</p>
<p><b>See also </b><a href="qsqldriver.html#lastError">lastError</a>().</p>
<!-- @@@setLastError -->
<!-- $$$setNumericalPrecisionPolicy[overload1]$$$setNumericalPrecisionPolicyQSql::NumericalPrecisionPolicy -->
<h3 class="fn"><a name="setNumericalPrecisionPolicy"></a><span class="type">void</span> QSqlDriver::<span class="name">setNumericalPrecisionPolicy</span> ( <span class="type"><a href="qsql.html#NumericalPrecisionPolicy-enum">QSql::NumericalPrecisionPolicy</a></span> <i>precisionPolicy</i> )</h3>
<p>Sets the default numerical precision policy used by queries created by this driver to <i>precisionPolicy</i>.</p>
<p>Note: Setting the default precision policy to <i>precisionPolicy</i> doesn't affect any currently active queries.</p>
<p>This function was introduced in Qt 4.6.</p>
<p><b>See also </b><a href="qsql.html#NumericalPrecisionPolicy-enum">QSql::NumericalPrecisionPolicy</a>, <a href="qsqldriver.html#numericalPrecisionPolicy">numericalPrecisionPolicy</a>(), <a href="qsqlquery.html#setNumericalPrecisionPolicy">QSqlQuery::setNumericalPrecisionPolicy</a>(), and <a href="qsqlquery.html#numericalPrecisionPolicy">QSqlQuery::numericalPrecisionPolicy</a>().</p>
<!-- @@@setNumericalPrecisionPolicy -->
<!-- $$$setOpen[overload1]$$$setOpenbool -->
<h3 class="fn"><a name="setOpen"></a><span class="type">void</span> QSqlDriver::<span class="name">setOpen</span> ( <span class="type">bool</span> <i>open</i> )<tt> [virtual protected]</tt></h3>
<p>This function sets the open state of the database to <i>open</i>. Derived classes can use this function to report the status of <a href="qsqldriver.html#open">open</a>().</p>
<p><b>See also </b><a href="qsqldriver.html#open">open</a>() and <a href="qsqldriver.html#setOpenError">setOpenError</a>().</p>
<!-- @@@setOpen -->
<!-- $$$setOpenError[overload1]$$$setOpenErrorbool -->
<h3 class="fn"><a name="setOpenError"></a><span class="type">void</span> QSqlDriver::<span class="name">setOpenError</span> ( <span class="type">bool</span> <i>error</i> )<tt> [virtual protected]</tt></h3>
<p>This function sets the open error state of the database to <i>error</i>. Derived classes can use this function to report the status of <a href="qsqldriver.html#open">open</a>(). Note that if <i>error</i> is true the open state of the database is set to closed (i.e., <a href="qsqldriver.html#isOpen">isOpen</a>() returns false).</p>
<p><b>See also </b><a href="qsqldriver.html#isOpenError">isOpenError</a>(), <a href="qsqldriver.html#open">open</a>(), and <a href="qsqldriver.html#setOpen">setOpen</a>().</p>
<!-- @@@setOpenError -->
<!-- $$$sqlStatement[overload1]$$$sqlStatementStatementTypeconstQString&constQSqlRecord&bool -->
<h3 class="fn"><a name="sqlStatement"></a><span class="type"><a href="qstring.html">QString</a></span> QSqlDriver::<span class="name">sqlStatement</span> ( <span class="type"><a href="qsqldriver.html#StatementType-enum">StatementType</a></span> <i>type</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>tableName</i>, const <span class="type"><a href="qsqlrecord.html">QSqlRecord</a></span> & <i>rec</i>, <span class="type">bool</span> <i>preparedStatement</i> ) const<tt> [virtual]</tt></h3>
<p>Returns a SQL statement of type <i>type</i> for the table <i>tableName</i> with the values from <i>rec</i>. If <i>preparedStatement</i> is true, the string will contain placeholders instead of values.</p>
<p>This method can be used to manipulate tables without having to worry about database-dependent SQL dialects. For non-prepared statements, the values will be properly escaped.</p>
<!-- @@@sqlStatement -->
<!-- $$$stripDelimiters[overload1]$$$stripDelimitersconstQString&IdentifierType -->
<h3 class="fn"><a name="stripDelimiters"></a><span class="type"><a href="qstring.html">QString</a></span> QSqlDriver::<span class="name">stripDelimiters</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>identifier</i>, <span class="type"><a href="qsqldriver.html#IdentifierType-enum">IdentifierType</a></span> <i>type</i> ) const</h3>
<p>Returns the <i>identifier</i> with the leading and trailing delimiters removed, <i>identifier</i> can either be a table name or field name, dependent on <i>type</i>. If <i>identifier</i> does not have leading and trailing delimiter characters, <i>identifier</i> is returned without modification.</p>
<p><b>Warning:</b> Because of binary compatibility constraints, this function is not virtual, If you want to provide your own implementation in your <a href="qsqldriver.html">QSqlDriver</a> subclass, reimplement the <a href="qsqldriver.html#stripDelimitersImplementation">stripDelimitersImplementation</a>() slot in your subclass instead. The stripDelimiters() function will dynamically detect the slot and call it.</p>
<p>This function was introduced in Qt 4.5.</p>
<p><b>See also </b><a href="qsqldriver.html#isIdentifierEscaped">isIdentifierEscaped</a>().</p>
<!-- @@@stripDelimiters -->
<!-- $$$stripDelimitersImplementation[overload1]$$$stripDelimitersImplementationconstQString&IdentifierType -->
<h3 class="fn"><a name="stripDelimitersImplementation"></a><span class="type"><a href="qstring.html">QString</a></span> QSqlDriver::<span class="name">stripDelimitersImplementation</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>identifier</i>, <span class="type"><a href="qsqldriver.html#IdentifierType-enum">IdentifierType</a></span> <i>type</i> ) const<tt> [protected slot]</tt></h3>
<p>This slot returns <i>identifier</i> with the leading and trailing delimiters removed, <i>identifier</i> can either be a tablename or field name, dependent on <i>type</i>. If <i>identifier</i> does not have leading and trailing delimiter characters, <i>identifier</i> is returned without modification.</p>
<p>Because of binary compatibility constraints, the <a href="qsqldriver.html#stripDelimiters">stripDelimiters</a>() function (introduced in Qt 4.5) is not virtual. Instead, <a href="qsqldriver.html#stripDelimiters">stripDelimiters</a>() will dynamically detect and call <i>this</i> slot. It generally unnecessary to reimplement this slot.</p>
<p>This function was introduced in Qt 4.6.</p>
<p><b>See also </b><a href="qsqldriver.html#stripDelimiters">stripDelimiters</a>().</p>
<!-- @@@stripDelimitersImplementation -->
<!-- $$$subscribeToNotification[overload1]$$$subscribeToNotificationconstQString& -->
<h3 class="fn"><a name="subscribeToNotification"></a><span class="type">bool</span> QSqlDriver::<span class="name">subscribeToNotification</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i> )</h3>
<p>This function is called to subscribe to event notifications from the database. <i>name</i> identifies the event notification.</p>
<p>If successful, return true, otherwise return false.</p>
<p>The database must be open when this function is called. When the database is closed by calling <a href="qsqldriver.html#close">close</a>() all subscribed event notifications are automatically unsubscribed. Note that calling <a href="qsqldriver.html#open">open</a>() on an already open database may implicitly cause <a href="qsqldriver.html#close">close</a>() to be called, which will cause the driver to unsubscribe from all event notifications.</p>
<p>When an event notification identified by <i>name</i> is posted by the database the <a href="qsqldriver.html#notification">notification</a>() signal is emitted.</p>
<p><b>Warning:</b> Because of binary compatibility constraints, this function is not virtual. If you want to provide event notification support in your own <a href="qsqldriver.html">QSqlDriver</a> subclass, reimplement the <a href="qsqldriver.html#subscribeToNotificationImplementation">subscribeToNotificationImplementation</a>() slot in your subclass instead. The subscribeToNotification() function will dynamically detect the slot and call it.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>See also </b><a href="qsqldriver.html#unsubscribeFromNotification">unsubscribeFromNotification</a>(), <a href="qsqldriver.html#subscribedToNotifications">subscribedToNotifications</a>(), and <a href="qsqldriver.html#hasFeature">QSqlDriver::hasFeature</a>().</p>
<!-- @@@subscribeToNotification -->
<!-- $$$subscribeToNotificationImplementation[overload1]$$$subscribeToNotificationImplementationconstQString& -->
<h3 class="fn"><a name="subscribeToNotificationImplementation"></a><span class="type">bool</span> QSqlDriver::<span class="name">subscribeToNotificationImplementation</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i> )<tt> [protected slot]</tt></h3>
<p>This slot is called to subscribe to event notifications from the database. <i>name</i> identifies the event notification.</p>
<p>If successful, return true, otherwise return false.</p>
<p>The database must be open when this <i>slot</i> is called. When the database is closed by calling <a href="qsqldriver.html#close">close</a>() all subscribed event notifications are automatically unsubscribed. Note that calling <a href="qsqldriver.html#open">open</a>() on an already open database may implicitly cause <a href="qsqldriver.html#close">close</a>() to be called, which will cause the driver to unsubscribe from all event notifications.</p>
<p>When an event notification identified by <i>name</i> is posted by the database the <a href="qsqldriver.html#notification">notification</a>() signal is emitted.</p>
<p>Reimplement this slot to provide your own <a href="qsqldriver.html">QSqlDriver</a> subclass with event notification support; because of binary compatibility constraints, the <a href="qsqldriver.html#subscribeToNotification">subscribeToNotification</a>() function (introduced in Qt 4.4) is not virtual. Instead, <a href="qsqldriver.html#subscribeToNotification">subscribeToNotification</a>() will dynamically detect and call <i>this</i> slot. The default implementation does nothing and returns false.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>See also </b><a href="qsqldriver.html#subscribeToNotification">subscribeToNotification</a>().</p>
<!-- @@@subscribeToNotificationImplementation -->
<!-- $$$subscribedToNotifications[overload1]$$$subscribedToNotifications -->
<h3 class="fn"><a name="subscribedToNotifications"></a><span class="type"><a href="qstringlist.html">QStringList</a></span> QSqlDriver::<span class="name">subscribedToNotifications</span> () const</h3>
<p>Returns a list of the names of the event notifications that are currently subscribed to.</p>
<p><b>Warning:</b> Because of binary compatibility constraints, this function is not virtual. If you want to provide event notification support in your own <a href="qsqldriver.html">QSqlDriver</a> subclass, reimplement the <a href="qsqldriver.html#subscribedToNotificationsImplementation">subscribedToNotificationsImplementation</a>() slot in your subclass instead. The subscribedToNotifications() function will dynamically detect the slot and call it.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>See also </b><a href="qsqldriver.html#subscribeToNotification">subscribeToNotification</a>() and <a href="qsqldriver.html#unsubscribeFromNotification">unsubscribeFromNotification</a>().</p>
<!-- @@@subscribedToNotifications -->
<!-- $$$subscribedToNotificationsImplementation[overload1]$$$subscribedToNotificationsImplementation -->
<h3 class="fn"><a name="subscribedToNotificationsImplementation"></a><span class="type"><a href="qstringlist.html">QStringList</a></span> QSqlDriver::<span class="name">subscribedToNotificationsImplementation</span> () const<tt> [protected slot]</tt></h3>
<p>Returns a list of the names of the event notifications that are currently subscribed to.</p>
<p>Reimplement this slot to provide your own <a href="qsqldriver.html">QSqlDriver</a> subclass with event notification support; because of binary compatibility constraints, the <a href="qsqldriver.html#subscribedToNotifications">subscribedToNotifications</a>() function (introduced in Qt 4.4) is not virtual. Instead, <a href="qsqldriver.html#subscribedToNotifications">subscribedToNotifications</a>() will dynamically detect and call <i>this</i> slot. The default implementation simply returns an empty <a href="qstringlist.html">QStringList</a>.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>See also </b><a href="qsqldriver.html#subscribedToNotifications">subscribedToNotifications</a>().</p>
<!-- @@@subscribedToNotificationsImplementation -->
<!-- $$$tables[overload1]$$$tablesQSql::TableType -->
<h3 class="fn"><a name="tables"></a><span class="type"><a href="qstringlist.html">QStringList</a></span> QSqlDriver::<span class="name">tables</span> ( <span class="type"><a href="qsql.html#TableType-enum">QSql::TableType</a></span> <i>tableType</i> ) const<tt> [virtual]</tt></h3>
<p>Returns a list of the names of the tables in the database. The default implementation returns an empty list.</p>
<p>The <i>tableType</i> argument describes what types of tables should be returned. Due to binary compatibility, the string contains the value of the enum QSql::TableTypes as text. An empty string should be treated as <a href="qsql.html#TableType-enum">QSql::Tables</a> for backward compatibility.</p>
<!-- @@@tables -->
<!-- $$$unsubscribeFromNotification[overload1]$$$unsubscribeFromNotificationconstQString& -->
<h3 class="fn"><a name="unsubscribeFromNotification"></a><span class="type">bool</span> QSqlDriver::<span class="name">unsubscribeFromNotification</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i> )</h3>
<p>This function is called to unsubscribe from event notifications from the database. <i>name</i> identifies the event notification.</p>
<p>If successful, return true, otherwise return false.</p>
<p>The database must be open when this function is called. All subscribed event notifications are automatically unsubscribed from when the <a href="qsqldriver.html#close">close</a>() function is called.</p>
<p>After calling <i>this</i> function the <a href="qsqldriver.html#notification">notification</a>() signal will no longer be emitted when an event notification identified by <i>name</i> is posted by the database.</p>
<p><b>Warning:</b> Because of binary compatibility constraints, this function is not virtual. If you want to provide event notification support in your own <a href="qsqldriver.html">QSqlDriver</a> subclass, reimplement the <a href="qsqldriver.html#unsubscribeFromNotificationImplementation">unsubscribeFromNotificationImplementation</a>() slot in your subclass instead. The unsubscribeFromNotification() function will dynamically detect the slot and call it.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>See also </b><a href="qsqldriver.html#subscribeToNotification">subscribeToNotification</a>() and <a href="qsqldriver.html#subscribedToNotifications">subscribedToNotifications</a>().</p>
<!-- @@@unsubscribeFromNotification -->
<!-- $$$unsubscribeFromNotificationImplementation[overload1]$$$unsubscribeFromNotificationImplementationconstQString& -->
<h3 class="fn"><a name="unsubscribeFromNotificationImplementation"></a><span class="type">bool</span> QSqlDriver::<span class="name">unsubscribeFromNotificationImplementation</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i> )<tt> [protected slot]</tt></h3>
<p>This slot is called to unsubscribe from event notifications from the database. <i>name</i> identifies the event notification.</p>
<p>If successful, return true, otherwise return false.</p>
<p>The database must be open when <i>this</i> slot is called. All subscribed event notifications are automatically unsubscribed from when the <a href="qsqldriver.html#close">close</a>() function is called.</p>
<p>After calling <i>this</i> slot the <a href="qsqldriver.html#notification">notification</a>() signal will no longer be emitted when an event notification identified by <i>name</i> is posted by the database.</p>
<p>Reimplement this slot to provide your own <a href="qsqldriver.html">QSqlDriver</a> subclass with event notification support; because of binary compatibility constraints, the <a href="qsqldriver.html#unsubscribeFromNotification">unsubscribeFromNotification</a>() function (introduced in Qt 4.4) is not virtual. Instead, <a href="qsqldriver.html#unsubscribeFromNotification">unsubscribeFromNotification</a>() will dynamically detect and call <i>this</i> slot. The default implementation does nothing and returns false.</p>
<p>This function was introduced in Qt 4.4.</p>
<p><b>See also </b><a href="qsqldriver.html#unsubscribeFromNotification">unsubscribeFromNotification</a>().</p>
<!-- @@@unsubscribeFromNotificationImplementation -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|
