src/sql/kernel/qsqldriver.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtSql module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** Commercial Usage
  11 ** Licensees holding valid Qt Commercial licenses may use this file in
  12 ** accordance with the Qt Commercial License Agreement provided with the
  13 ** Software or, alternatively, in accordance with the terms contained in
  14 ** a written agreement between you and Nokia.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** GNU General Public License Usage
  29 ** Alternatively, this file may be used under the terms of the GNU
  30 ** General Public License version 3.0 as published by the Free Software
  31 ** Foundation and appearing in the file LICENSE.GPL included in the
  32 ** packaging of this file.  Please review the following information to
  33 ** ensure the GNU General Public License version 3.0 requirements will be
  34 ** met: http://www.gnu.org/copyleft/gpl.html.
  35 **
  36 ** If you have questions regarding the use of this file, please contact
  37 ** Nokia at qt-info@nokia.com.
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QSQLDRIVER_H
  43 #define QSQLDRIVER_H
  44
  45 #include <QtCore/qobject.h>
  46 #include <QtCore/qstring.h>
  47 #include <QtCore/qstringlist.h>
  48 #include <QtSql/qsql.h>
  49 #ifdef QT3_SUPPORT
  50 #include <QtSql/qsqlquery.h>
  51 #endif
  52
  53 QT_BEGIN_HEADER
  54
  55 QT_BEGIN_NAMESPACE
  56
  57 QT_MODULE(Sql)
  58
  59 class QSqlDatabase;
  60 class QSqlDriverPrivate;
  61 class QSqlError;
  62 class QSqlField;
  63 class QSqlIndex;
  64 class QSqlRecord;
  65 class QSqlResult;
  66 class QVariant;
  67
  68 class Q_SQL_EXPORT QSqlDriver : public QObject
  69 {
  70     friend class QSqlDatabase;
  71     Q_OBJECT
  72     Q_DECLARE_PRIVATE(QSqlDriver)
  73
  74 public:
  75     enum DriverFeature { Transactions, QuerySize, BLOB, Unicode, PreparedQueries,
  76                          NamedPlaceholders, PositionalPlaceholders, LastInsertId,
  77                          BatchOperations, SimpleLocking, LowPrecisionNumbers,
  78                          EventNotifications, FinishQuery, MultipleResultSets };
  79
  80     enum StatementType { WhereStatement, SelectStatement, UpdateStatement,
  81                          InsertStatement, DeleteStatement };
  82
  83     enum IdentifierType { FieldName, TableName };
  84
  85     explicit QSqlDriver(QObject *parent=0);
  86     ~QSqlDriver();
  87     virtual bool isOpen() const;
  88     bool isOpenError() const;
  89
  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;
  96 #ifdef QT3_SUPPORT
  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(); }
 106 #endif
 107     virtual QString formatValue(const QSqlField& field, bool trimStrings = false) const;
 108
 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;
 112
 113     QSqlError lastError() const;
 114
 115     virtual QVariant handle() const;
 116     virtual bool hasFeature(DriverFeature f) const = 0;
 117     virtual void close() = 0;
 118     virtual QSqlResult *createResult() const = 0;
 119
 120     virtual bool open(const QString& db,
 121                       const QString& user = QString(),
 122                       const QString& password = QString(),
 123                       const QString& host = QString(),
 124                       int port = -1,
 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
 129
 130 Q_SIGNALS:
 131     void notification(const QString &name);
 132
 133 protected:
 134     virtual void setOpen(bool o);
 135     virtual void setOpenError(bool e);
 136     virtual void setLastError(const QSqlError& e);
 137
 138 protected Q_SLOTS:
 139     bool subscribeToNotificationImplementation(const QString &name);        // ### Qt 5: eliminate, see subscribeToNotification()
 140     bool unsubscribeFromNotificationImplementation(const QString &name);    // ### Qt 5: eliminate, see unsubscribeFromNotification()
 141     QStringList subscribedToNotificationsImplementation() const;            // ### Qt 5: eliminate, see subscribedNotifications()
 142
 143 private:
 144     Q_DISABLE_COPY(QSqlDriver)
 145 };
 146
 147 QT_END_NAMESPACE
 148
 149 QT_END_HEADER
 150
 151 #endif // QSQLDRIVER_H