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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
|
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtSql module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://www.qtsoftware.com/contact.
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qsqldriver.h"
#include "qdatetime.h"
#include "qsqlerror.h"
#include "qsqlfield.h"
#include "qsqlindex.h"
#include "private/qobject_p.h"
QT_BEGIN_NAMESPACE
static QString prepareIdentifier(const QString &identifier,
QSqlDriver::IdentifierType type, const QSqlDriver *driver)
{
Q_ASSERT( driver != NULL );
QString ret = identifier;
if (!driver->isIdentifierEscaped(identifier, type)) {
ret = driver->escapeIdentifier(identifier, type);
}
return ret;
}
class QSqlDriverPrivate : public QObjectPrivate
{
public:
QSqlDriverPrivate();
virtual ~QSqlDriverPrivate();
public:
// @CHECK: this member is never used. It was named q, which expanded to q_func().
QSqlDriver *q_func();
uint isOpen : 1;
uint isOpenError : 1;
QSqlError error;
QSql::NumericalPrecisionPolicy precisionPolicy;
};
inline QSqlDriverPrivate::QSqlDriverPrivate()
: QObjectPrivate(), isOpen(false), isOpenError(false), precisionPolicy(QSql::LowPrecisionDouble)
{
}
QSqlDriverPrivate::~QSqlDriverPrivate()
{
}
/*!
\class QSqlDriver
\brief The QSqlDriver class is an abstract base class for accessing
specific SQL databases.
\ingroup database
\inmodule QtSql
This class should not be used directly. Use QSqlDatabase instead.
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 \l{How to Write Your Own
Database Driver} for more information.
\sa QSqlDatabase, QSqlResult
*/
/*!
Constructs a new driver with the given \a parent.
*/
QSqlDriver::QSqlDriver(QObject *parent)
: QObject(*new QSqlDriverPrivate, parent)
{
}
/*!
Destroys the object and frees any allocated resources.
*/
QSqlDriver::~QSqlDriver()
{
}
/*!
\since 4.4
\fn QSqlDriver::notification(const QString &name)
This signal is emitted when the database posts an event notification
that the driver subscribes to. \a name identifies the event notification.
\sa subscribeToNotification()
*/
/*!
\fn bool QSqlDriver::open(const QString &db, const QString &user, const QString& password,
const QString &host, int port, const QString &options)
Derived classes must reimplement this pure virtual function to
open a database connection on database \a db, using user name \a
user, password \a password, host \a host, port \a port and
connection options \a options.
The function must return true on success and false on failure.
\sa setOpen()
*/
/*!
\fn bool QSqlDriver::close()
Derived classes must reimplement this pure virtual function in
order to close the database connection. Return true on success,
false on failure.
\sa open(), setOpen()
*/
/*!
\fn QSqlResult *QSqlDriver::createResult() const
Creates an empty SQL result on the database. Derived classes must
reimplement this function and return a QSqlResult object
appropriate for their database to the caller.
*/
/*!
Returns true if the database connection is open; otherwise returns
false.
*/
bool QSqlDriver::isOpen() const
{
return d_func()->isOpen;
}
/*!
Returns true if the there was an error opening the database
connection; otherwise returns false.
*/
bool QSqlDriver::isOpenError() const
{
return d_func()->isOpenError;
}
/*!
\enum QSqlDriver::DriverFeature
This enum contains a list of features a driver might support. Use
hasFeature() to query whether a feature is supported or not.
\value Transactions Whether the driver supports SQL transactions.
\value QuerySize 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
QSqlQuery::size() will return -1.
\value BLOB Whether the driver supports Binary Large Object fields.
\value Unicode Whether the driver supports Unicode strings if the
database server does.
\value PreparedQueries Whether the driver supports prepared query execution.
\value NamedPlaceholders Whether the driver supports the use of named placeholders.
\value PositionalPlaceholders Whether the driver supports the use of positional placeholders.
\value LastInsertId Whether the driver supports returning the Id of the last touched row.
\value BatchOperations Whether the driver supports batched operations, see QSqlQuery::execBatch()
\value SimpleLocking Whether the driver disallows a write lock on a table while other queries have a read lock on it.
\value LowPrecisionNumbers Whether the driver allows fetching numerical values with low precision.
\value EventNotifications Whether the driver supports database event notifications.
\value FinishQuery Whether the driver can do any low-level resource cleanup when QSqlQuery::finish() is called.
\value MultipleResultSets Whether the driver can access multiple result sets returned from batched statements or stored procedures.
More information about supported features can be found in the
\l{sql-driver.html}{Qt SQL driver} documentation.
\sa hasFeature()
*/
/*!
\enum QSqlDriver::StatementType
This enum contains a list of SQL statement (or clause) types the
driver can create.
\value WhereStatement An SQL \c WHERE statement (e.g., \c{WHERE f = 5}).
\value SelectStatement An SQL \c SELECT statement (e.g., \c{SELECT f FROM t}).
\value UpdateStatement An SQL \c UPDATE statement (e.g., \c{UPDATE TABLE t set f = 1}).
\value InsertStatement An SQL \c INSERT statement (e.g., \c{INSERT INTO t (f) values (1)}).
\value DeleteStatement An SQL \c DELETE statement (e.g., \c{DELETE FROM t}).
\sa sqlStatement()
*/
/*!
\enum QSqlDriver::IdentifierType
This enum contains a list of SQL identifier types.
\value FieldName A SQL field name
\value TableName A SQL table name
*/
/*!
\fn bool QSqlDriver::hasFeature(DriverFeature feature) const
Returns true if the driver supports feature \a feature; otherwise
returns false.
Note that some databases need to be open() before this can be
determined.
\sa DriverFeature
*/
/*!
This function sets the open state of the database to \a open.
Derived classes can use this function to report the status of
open().
\sa open(), setOpenError()
*/
void QSqlDriver::setOpen(bool open)
{
d_func()->isOpen = open;
}
/*!
This function sets the open error state of the database to \a
error. Derived classes can use this function to report the status
of open(). Note that if \a error is true the open state of the
database is set to closed (i.e., isOpen() returns false).
\sa open(), setOpen()
*/
void QSqlDriver::setOpenError(bool error)
{
d_func()->isOpenError = error;
if (error)
d_func()->isOpen = false;
}
/*!
This function is called to begin a transaction. If successful,
return true, otherwise return false. The default implementation
does nothing and returns false.
\sa commitTransaction(), rollbackTransaction()
*/
bool QSqlDriver::beginTransaction()
{
return false;
}
/*!
This function is called to commit a transaction. If successful,
return true, otherwise return false. The default implementation
does nothing and returns false.
\sa beginTransaction(), rollbackTransaction()
*/
bool QSqlDriver::commitTransaction()
{
return false;
}
/*!
This function is called to rollback a transaction. If successful,
return true, otherwise return false. The default implementation
does nothing and returns false.
\sa beginTransaction(), commitTransaction()
*/
bool QSqlDriver::rollbackTransaction()
{
return false;
}
/*!
This function is used to set the value of the last error, \a error,
that occurred on the database.
\sa lastError()
*/
void QSqlDriver::setLastError(const QSqlError &error)
{
d_func()->error = error;
}
/*!
Returns a QSqlError object which contains information about the
last error that occurred on the database.
*/
QSqlError QSqlDriver::lastError() const
{
return d_func()->error;
}
/*!
Returns a list of the names of the tables in the database. The
default implementation returns an empty list.
The \a tableType 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 QSql::Tables for
backward compatibility.
*/
QStringList QSqlDriver::tables(QSql::TableType) const
{
return QStringList();
}
/*!
Returns the primary index for table \a tableName. Returns an empty
QSqlIndex if the table doesn't have a primary index. The default
implementation returns an empty index.
*/
QSqlIndex QSqlDriver::primaryIndex(const QString&) const
{
return QSqlIndex();
}
/*!
Returns a QSqlRecord populated with the names of the fields in
table \a tableName. If no such table exists, an empty record is
returned. The default implementation returns an empty record.
*/
QSqlRecord QSqlDriver::record(const QString & /* tableName */) const
{
return QSqlRecord();
}
/*!
Returns the \a identifier escaped according to the database rules.
\a identifier can either be a table name or field name, dependent
on \a type.
The default implementation does nothing.
\sa isIdentifierEscaped()
*/
QString QSqlDriver::escapeIdentifier(const QString &identifier, IdentifierType) const
{
return identifier;
}
/*!
Returns whether \a identifier is escaped according to the database rules.
\a identifier can either be a table name or field name, dependent
on \a type.
\warning Because of binary compatability constraints, this function is not virtual.
If you want to provide your own implementation in your QSqlDriver subclass,
reimplement the isIdentifierEscapedImplementation() slot in your subclass instead.
The isIdentifierEscapedFunction() will dynamically detect the slot and call it.
\sa stripDelimiters(), escapeIdentifier()
*/
bool QSqlDriver::isIdentifierEscaped(const QString &identifier, IdentifierType type) const
{
bool result;
QMetaObject::invokeMethod(const_cast<QSqlDriver*>(this),
"isIdentifierEscapedImplementation", Qt::DirectConnection,
Q_RETURN_ARG(bool, result),
Q_ARG(QString, identifier),
Q_ARG(IdentifierType, type));
return result;
}
/*!
Returns the \a identifier with the leading and trailing delimiters removed,
\a identifier can either be a table name or field name,
dependent on \a type. If \a identifier does not have leading
and trailing delimiter characters, \a identifier is returned without
modification.
\warning Because of binary compatability constraints, this function is not virtual,
If you want to provide your own implementation in your QSqlDriver subclass,
reimplement the stripDelimitersImplementation() slot in your subclass instead.
The stripDelimiters() function will dynamically detect the slot and call it.
\since 4.5
\sa isIdentifierEscaped()
*/
QString QSqlDriver::stripDelimiters(const QString &identifier, IdentifierType type) const
{
QString result;
QMetaObject::invokeMethod(const_cast<QSqlDriver*>(this),
"stripDelimitersImplementation", Qt::DirectConnection,
Q_RETURN_ARG(QString, result),
Q_ARG(QString, identifier),
Q_ARG(IdentifierType, type));
return result;
}
/*!
Returns a SQL statement of type \a type for the table \a tableName
with the values from \a rec. If \a preparedStatement is true, the
string will contain placeholders instead of values.
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.
*/
QString QSqlDriver::sqlStatement(StatementType type, const QString &tableName,
const QSqlRecord &rec, bool preparedStatement) const
{
int i;
QString s;
s.reserve(128);
switch (type) {
case SelectStatement:
for (i = 0; i < rec.count(); ++i) {
if (rec.isGenerated(i))
s.append(prepareIdentifier(rec.fieldName(i), QSqlDriver::FieldName, this)).append(QLatin1String(", "));
}
if (s.isEmpty())
return s;
s.chop(2);
s.prepend(QLatin1String("SELECT ")).append(QLatin1String(" FROM ")).append(tableName);
break;
case WhereStatement:
if (preparedStatement) {
for (int i = 0; i < rec.count(); ++i) {
s.append(prepareIdentifier(rec.fieldName(i), FieldName,this));
if (rec.isNull(i))
s.append(QLatin1String(" IS NULL"));
else
s.append(QLatin1String(" = ?"));
s.append(QLatin1String(" AND "));
}
} else {
for (i = 0; i < rec.count(); ++i) {
s.append(prepareIdentifier(rec.fieldName(i), QSqlDriver::FieldName, this));
QString val = formatValue(rec.field(i));
if (val == QLatin1String("NULL"))
s.append(QLatin1String(" IS NULL"));
else
s.append(QLatin1String(" = ")).append(val);
s.append(QLatin1String(" AND "));
}
}
if (!s.isEmpty()) {
s.prepend(QLatin1String("WHERE "));
s.chop(5); // remove tailing AND
}
break;
case UpdateStatement:
s.append(QLatin1String("UPDATE ")).append(tableName).append(
QLatin1String(" SET "));
for (i = 0; i < rec.count(); ++i) {
if (!rec.isGenerated(i) || !rec.value(i).isValid())
continue;
s.append(prepareIdentifier(rec.fieldName(i), QSqlDriver::FieldName, this)).append(QLatin1Char('='));
if (preparedStatement)
s.append(QLatin1Char('?'));
else
s.append(formatValue(rec.field(i)));
s.append(QLatin1String(", "));
}
if (s.endsWith(QLatin1String(", ")))
s.chop(2);
else
s.clear();
break;
case DeleteStatement:
s.append(QLatin1String("DELETE FROM ")).append(tableName);
break;
case InsertStatement: {
s.append(QLatin1String("INSERT INTO ")).append(tableName).append(QLatin1String(" ("));
QString vals;
for (i = 0; i < rec.count(); ++i) {
if (!rec.isGenerated(i) || !rec.value(i).isValid())
continue;
s.append(prepareIdentifier(rec.fieldName(i), QSqlDriver::FieldName, this)).append(QLatin1String(", "));
if (preparedStatement)
vals.append(QLatin1Char('?'));
else
vals.append(formatValue(rec.field(i)));
vals.append(QLatin1String(", "));
}
if (vals.isEmpty()) {
s.clear();
} else {
vals.chop(2); // remove trailing comma
s[s.length() - 2] = QLatin1Char(')');
s.append(QLatin1String("VALUES (")).append(vals).append(QLatin1Char(')'));
}
break; }
}
return s;
}
/*!
Returns a string representation of the \a field value for the
database. This is used, for example, when constructing INSERT and
UPDATE statements.
The default implementation returns the value formatted as a string
according to the following rules:
\list
\i If \a field 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 \a trimStrings is
true (the default is false), all trailing whitespace is trimmed
from the field.
\i If \a field 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.
\i If \a field is \link QByteArray bytearray\endlink data, and the
driver can edit binary fields, the value is formatted as a
hexadecimal string.
\i For any other field type, toString() is called on its value
and the result of this is returned.
\endlist
\sa QVariant::toString()
*/
QString QSqlDriver::formatValue(const QSqlField &field, bool trimStrings) const
{
const QLatin1String nullTxt("NULL");
QString r;
if (field.isNull())
r = nullTxt;
else {
switch (field.type()) {
case QVariant::Int:
case QVariant::UInt:
if (field.value().type() == QVariant::Bool)
r = field.value().toBool() ? QLatin1String("1") : QLatin1String("0");
else
r = field.value().toString();
break;
#ifndef QT_NO_DATESTRING
case QVariant::Date:
if (field.value().toDate().isValid())
r = QLatin1Char('\'') + field.value().toDate().toString(Qt::ISODate)
+ QLatin1Char('\'');
else
r = nullTxt;
break;
case QVariant::Time:
if (field.value().toTime().isValid())
r = QLatin1Char('\'') + field.value().toTime().toString(Qt::ISODate)
+ QLatin1Char('\'');
else
r = nullTxt;
break;
case QVariant::DateTime:
if (field.value().toDateTime().isValid())
r = QLatin1Char('\'') +
field.value().toDateTime().toString(Qt::ISODate) + QLatin1Char('\'');
else
r = nullTxt;
break;
#endif
case QVariant::String:
case QVariant::Char:
{
QString result = field.value().toString();
if (trimStrings) {
int end = result.length();
while (end && result.at(end-1).isSpace()) /* skip white space from end */
end--;
result.truncate(end);
}
/* escape the "'" character */
result.replace(QLatin1Char('\''), QLatin1String("''"));
r = QLatin1Char('\'') + result + QLatin1Char('\'');
break;
}
case QVariant::Bool:
r = QString::number(field.value().toBool());
break;
case QVariant::ByteArray : {
if (hasFeature(BLOB)) {
QByteArray ba = field.value().toByteArray();
QString res;
static const char hexchars[] = "0123456789abcdef";
for (int i = 0; i < ba.size(); ++i) {
uchar s = (uchar) ba[i];
res += QLatin1Char(hexchars[s >> 4]);
res += QLatin1Char(hexchars[s & 0x0f]);
}
r = QLatin1Char('\'') + res + QLatin1Char('\'');
break;
}
}
default:
r = field.value().toString();
break;
}
}
return r;
}
/*!
Returns the low-level database handle wrapped in a QVariant or an
invalid variant if there is no handle.
\warning Use this with uttermost care and only if you know what you're doing.
\warning The handle returned here can become a stale pointer if the connection
is modified (for example, if you close the connection).
\warning The handle can be NULL if the connection is not open yet.
The handle returned here is database-dependent, you should query the type
name of the variant before accessing it.
This example retrieves the handle for a connection to sqlite:
\snippet doc/src/snippets/code/src_sql_kernel_qsqldriver.cpp 0
This snippet returns the handle for PostgreSQL or MySQL:
\snippet doc/src/snippets/code/src_sql_kernel_qsqldriver.cpp 1
\sa QSqlResult::handle()
*/
QVariant QSqlDriver::handle() const
{
return QVariant();
}
/*!
\fn QSqlRecord QSqlDriver::record(const QSqlQuery& query) const
Use query.record() instead.
*/
/*!
\fn QSqlRecord QSqlDriver::recordInfo(const QString& tablename) const
Use record() instead.
*/
/*!
\fn QSqlRecord QSqlDriver::recordInfo(const QSqlQuery& query) const
Use query.record() instead.
*/
/*!
\fn QString QSqlDriver::nullText() const
sqlStatement() is now used to generate SQL. Use tr("NULL") for example, instead.
*/
/*!
\fn QString QSqlDriver::formatValue(const QSqlField *field, bool trimStrings) const
Use the other formatValue() overload instead.
*/
/*!
This function is called to subscribe to event notifications from the database.
\a name identifies the event notification.
If successful, return true, otherwise return false.
The database must be open when this function is called. When the database is closed
by calling close() all subscribed event notifications are automatically unsubscribed.
Note that calling open() on an already open database may implicitly cause close() to
be called, which will cause the driver to unsubscribe from all event notifications.
When an event notification identified by \a name is posted by the database the
notification() signal is emitted.
\warning Because of binary compatibility constraints, this function is not virtual.
If you want to provide event notification support in your own QSqlDriver subclass,
reimplement the subscribeToNotificationImplementation() slot in your subclass instead.
The subscribeToNotification() function will dynamically detect the slot and call it.
\since 4.4
\sa unsubscribeFromNotification() subscribedToNotifications() QSqlDriver::hasFeature()
*/
bool QSqlDriver::subscribeToNotification(const QString &name)
{
bool result;
QMetaObject::invokeMethod(const_cast<QSqlDriver *>(this),
"subscribeToNotificationImplementation", Qt::DirectConnection,
Q_RETURN_ARG(bool, result),
Q_ARG(QString, name));
return result;
}
/*!
This function is called to unsubscribe from event notifications from the database.
\a name identifies the event notification.
If successful, return true, otherwise return false.
The database must be open when this function is called. All subscribed event
notifications are automatically unsubscribed from when the close() function is called.
After calling \e this function the notification() signal will no longer be emitted
when an event notification identified by \a name is posted by the database.
\warning Because of binary compatibility constraints, this function is not virtual.
If you want to provide event notification support in your own QSqlDriver subclass,
reimplement the unsubscribeFromNotificationImplementation() slot in your subclass instead.
The unsubscribeFromNotification() function will dynamically detect the slot and call it.
\since 4.4
\sa subscribeToNotification() subscribedToNotifications()
*/
bool QSqlDriver::unsubscribeFromNotification(const QString &name)
{
bool result;
QMetaObject::invokeMethod(const_cast<QSqlDriver *>(this),
"unsubscribeFromNotificationImplementation", Qt::DirectConnection,
Q_RETURN_ARG(bool, result),
Q_ARG(QString, name));
return result;
}
/*!
Returns a list of the names of the event notifications that are currently subscribed to.
\warning Because of binary compatibility constraints, this function is not virtual.
If you want to provide event notification support in your own QSqlDriver subclass,
reimplement the subscribedToNotificationsImplementation() slot in your subclass instead.
The subscribedToNotifications() function will dynamically detect the slot and call it.
\since 4.4
\sa subscribeToNotification() unsubscribeFromNotification()
*/
QStringList QSqlDriver::subscribedToNotifications() const
{
QStringList result;
QMetaObject::invokeMethod(const_cast<QSqlDriver *>(this),
"subscribedToNotificationsImplementation", Qt::DirectConnection,
Q_RETURN_ARG(QStringList, result));
return result;
}
/*!
This slot is called to subscribe to event notifications from the database.
\a name identifies the event notification.
If successful, return true, otherwise return false.
The database must be open when this \e slot is called. When the database is closed
by calling close() all subscribed event notifications are automatically unsubscribed.
Note that calling open() on an already open database may implicitly cause close() to
be called, which will cause the driver to unsubscribe from all event notifications.
When an event notification identified by \a name is posted by the database the
notification() signal is emitted.
Reimplement this slot to provide your own QSqlDriver subclass with event notification
support; because of binary compatibility constraints, the subscribeToNotification()
function (introduced in Qt 4.4) is not virtual. Instead, subscribeToNotification()
will dynamically detect and call \e this slot. The default implementation does nothing
and returns false.
\since 4.4
\sa subscribeToNotification()
*/
bool QSqlDriver::subscribeToNotificationImplementation(const QString &name)
{
Q_UNUSED(name);
return false;
}
/*!
This slot is called to unsubscribe from event notifications from the database.
\a name identifies the event notification.
If successful, return true, otherwise return false.
The database must be open when \e this slot is called. All subscribed event
notifications are automatically unsubscribed from when the close() function is called.
After calling \e this slot the notification() signal will no longer be emitted
when an event notification identified by \a name is posted by the database.
Reimplement this slot to provide your own QSqlDriver subclass with event notification
support; because of binary compatibility constraints, the unsubscribeFromNotification()
function (introduced in Qt 4.4) is not virtual. Instead, unsubscribeFromNotification()
will dynamically detect and call \e this slot. The default implementation does nothing
and returns false.
\since 4.4
\sa unsubscribeFromNotification()
*/
bool QSqlDriver::unsubscribeFromNotificationImplementation(const QString &name)
{
Q_UNUSED(name);
return false;
}
/*!
Returns a list of the names of the event notifications that are currently subscribed to.
Reimplement this slot to provide your own QSqlDriver subclass with event notification
support; because of binary compatibility constraints, the subscribedToNotifications()
function (introduced in Qt 4.4) is not virtual. Instead, subscribedToNotifications()
will dynamically detect and call \e this slot. The default implementation simply
returns an empty QStringList.
\since 4.4
\sa subscribedToNotifications()
*/
QStringList QSqlDriver::subscribedToNotificationsImplementation() const
{
return QStringList();
}
/*!
This slot returns whether \a identifier is escaped according to the database rules.
\a identifier can either be a table name or field name, dependent
on \a type.
Because of binary compatability constraints, isIdentifierEscaped() function
(introduced in Qt 4.5) is not virtual. Instead, isIdentifierEscaped() will
dynamically detect and call \e this slot. The default implementation
assumes the escape/delimiter character is a double quote. Reimplement this
slot in your own QSqlDriver if your database engine uses a different
delimiter character.
\since 4.5
\sa isIdentifierEscaped()
*/
bool QSqlDriver::isIdentifierEscapedImplementation(const QString &identifier, IdentifierType type) const
{
Q_UNUSED(type);
return identifier.size() > 2
&& identifier.startsWith(QLatin1Char('"')) //left delimited
&& identifier.endsWith(QLatin1Char('"')); //right delimited
}
/*!
This slot returns \a identifier with the leading and trailing delimiters removed,
\a identifier can either be a tablename or field name, dependent on \a type.
If \a identifier does not have leading and trailing delimiter characters, \a
identifier is returned without modification.
Because of binary compatability constraints, the stripDelimiters() function
(introduced in Qt 4.5) is not virtual. Instead, stripDelimiters() will
dynamically detect and call \e this slot. It generally unnecessary
to reimplement this slot.
\since 4.5
\sa stripDelimiters()
*/
QString QSqlDriver::stripDelimitersImplementation(const QString &identifier, IdentifierType type) const
{
QString ret;
if (this->isIdentifierEscaped(identifier, type)) {
ret = identifier.mid(1);
ret.chop(1);
} else {
ret = identifier;
}
return ret;
}
/*!
Sets the default numerical precision policy used by queries created
by this driver to \a precisionPolicy.
Note: Setting the default precision policy to \a precisionPolicy
doesn't affect any currently active queries.
\sa QSql::NumericalPrecisionPolicy, numericalPrecisionPolicy(), QSqlQuery::setNumericalPrecisionPolicy(), QSqlQuery::numericalPrecisionPolicy()
*/
void QSqlDriver::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)
{
d_func()->precisionPolicy = precisionPolicy;
}
/*!
Returns the current default precision policy for the database connection.
\sa QSql::NumericalPrecisionPolicy, setNumericalPrecisionPolicy(), QSqlQuery::numericalPrecisionPolicy(), QSqlQuery::setNumericalPrecisionPolicy()
*/
QSql::NumericalPrecisionPolicy QSqlDriver::numericalPrecisionPolicy() const
{
return d_func()->precisionPolicy;
}
QT_END_NAMESPACE
|