1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtSql module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
45 #include <QtCore/qobject.h>
46 #include <QtCore/qstring.h>
47 #include <QtCore/qstringlist.h>
48 #include <QtSql/qsql.h>
50 #include <QtSql/qsqlquery.h>
60 class QSqlDriverPrivate;
68 class Q_SQL_EXPORT QSqlDriver : public QObject
70 friend class QSqlDatabase;
72 Q_DECLARE_PRIVATE(QSqlDriver)
75 enum DriverFeature { Transactions, QuerySize, BLOB, Unicode, PreparedQueries,
76 NamedPlaceholders, PositionalPlaceholders, LastInsertId,
77 BatchOperations, SimpleLocking, LowPrecisionNumbers,
78 EventNotifications, FinishQuery, MultipleResultSets };
80 enum StatementType { WhereStatement, SelectStatement, UpdateStatement,
81 InsertStatement, DeleteStatement };
83 enum IdentifierType { FieldName, TableName };
85 explicit QSqlDriver(QObject *parent=0);
87 virtual bool isOpen() const;
88 bool isOpenError() const;
90 virtual bool beginTransaction();
91 virtual bool commitTransaction();
92 virtual bool rollbackTransaction();
93 virtual QStringList tables(QSql::TableType tableType) const;
94 virtual QSqlIndex primaryIndex(const QString &tableName) const;
95 virtual QSqlRecord record(const QString &tableName) const;
97 inline QT3_SUPPORT QSqlRecord record(const QSqlQuery& query) const
98 { return query.record(); }
99 inline QT3_SUPPORT QSqlRecord recordInfo(const QString& tablename) const
100 { return record(tablename); }
101 inline QT3_SUPPORT QSqlRecord recordInfo(const QSqlQuery& query) const
102 { return query.record(); }
103 inline QT3_SUPPORT QString nullText() const { return QLatin1String("NULL"); }
104 inline QT3_SUPPORT QString formatValue(const QSqlField *field, bool trimStrings = false) const
105 { return field ? formatValue(*field, trimStrings) : QString(); }
107 virtual QString formatValue(const QSqlField& field, bool trimStrings = false) const;
109 virtual QString escapeIdentifier(const QString &identifier, IdentifierType type) const;
110 virtual QString sqlStatement(StatementType type, const QString &tableName,
111 const QSqlRecord &rec, bool preparedStatement) const;
113 QSqlError lastError() const;
115 virtual QVariant handle() const;
116 virtual bool hasFeature(DriverFeature f) const = 0;
117 virtual void close() = 0;
118 virtual QSqlResult *createResult() const = 0;
120 virtual bool open(const QString& db,
121 const QString& user = QString(),
122 const QString& password = QString(),
123 const QString& host = QString(),
125 const QString& connOpts = QString()) = 0;
126 bool subscribeToNotification(const QString &name); // ### Qt 5: make virtual
127 bool unsubscribeFromNotification(const QString &name); // ### Qt 5: make virtual
128 QStringList subscribedToNotifications() const; // ### Qt 5: make virtual
130 bool isIdentifierEscaped(const QString &identifier, IdentifierType type) const; // ### Qt 5: make virtual
131 QString stripDelimiters(const QString &identifier, IdentifierType type) const; // ### Qt 5: make virtual
133 void setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy);
134 QSql::NumericalPrecisionPolicy numericalPrecisionPolicy() const;
137 void notification(const QString &name);
140 virtual void setOpen(bool o);
141 virtual void setOpenError(bool e);
142 virtual void setLastError(const QSqlError& e);
145 bool subscribeToNotificationImplementation(const QString &name); // ### Qt 5: eliminate, see subscribeToNotification()
146 bool unsubscribeFromNotificationImplementation(const QString &name); // ### Qt 5: eliminate, see unsubscribeFromNotification()
147 QStringList subscribedToNotificationsImplementation() const; // ### Qt 5: eliminate, see subscribedNotifications()
149 bool isIdentifierEscapedImplementation(const QString &identifier, IdentifierType type) const; // ### Qt 5: eliminate, see isIdentifierEscaped()
150 QString stripDelimitersImplementation(const QString &identifier, IdentifierType type) const; // ### Qt 5: eliminate, see stripDelimiters()
153 Q_DISABLE_COPY(QSqlDriver)
160 #endif // QSQLDRIVER_H