src/sql/kernel/qsqldatabase.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 QSQLDATABASE_H
  43 #define QSQLDATABASE_H
  44
  45 #include <QtCore/qstring.h>
  46 #include <QtSql/qsql.h>
  47 #ifdef QT3_SUPPORT
  48 #include <QtSql/qsqlrecord.h>
  49 #endif
  50
  51 QT_BEGIN_HEADER
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 QT_MODULE(Sql)
  56
  57 class QSqlError;
  58 class QSqlDriver;
  59 class QSqlIndex;
  60 class QSqlRecord;
  61 class QSqlQuery;
  62 class QSqlDatabasePrivate;
  63
  64 class Q_SQL_EXPORT QSqlDriverCreatorBase
  65 {
  66 public:
  67     virtual ~QSqlDriverCreatorBase() {}
  68     virtual QSqlDriver *createObject() const = 0;
  69 };
  70
  71 template <class T>
  72 class QSqlDriverCreator : public QSqlDriverCreatorBase
  73 {
  74 public:
  75     QSqlDriver *createObject() const { return new T; }
  76 };
  77
  78 class Q_SQL_EXPORT QSqlDatabase
  79 {
  80 public:
  81     QSqlDatabase();
  82     QSqlDatabase(const QSqlDatabase &other);
  83     ~QSqlDatabase();
  84
  85     QSqlDatabase &operator=(const QSqlDatabase &other);
  86
  87     bool open();
  88     bool open(const QString& user, const QString& password);
  89     void close();
  90     bool isOpen() const;
  91     bool isOpenError() const;
  92     QStringList tables(QSql::TableType type = QSql::Tables) const;
  93     QSqlIndex primaryIndex(const QString& tablename) const;
  94     QSqlRecord record(const QString& tablename) const;
  95 #ifdef QT3_SUPPORT
  96     QT3_SUPPORT QSqlRecord record(const QSqlQuery& query) const;
  97     inline QT3_SUPPORT QSqlRecord recordInfo(const QString& tablename) const
  98     { return record(tablename); }
  99     QT3_SUPPORT QSqlRecord recordInfo(const QSqlQuery& query) const;
 100 #endif
 101     QSqlQuery exec(const QString& query = QString()) const;
 102     QSqlError lastError() const;
 103     bool isValid() const;
 104
 105     bool transaction();
 106     bool commit();
 107     bool rollback();
 108
 109     void setDatabaseName(const QString& name);
 110     void setUserName(const QString& name);
 111     void setPassword(const QString& password);
 112     void setHostName(const QString& host);
 113     void setPort(int p);
 114     void setConnectOptions(const QString& options = QString());
 115     QString databaseName() const;
 116     QString userName() const;
 117     QString password() const;
 118     QString hostName() const;
 119     QString driverName() const;
 120     int port() const;
 121     QString connectOptions() const;
 122     QString connectionName() const;
 123
 124     QSqlDriver* driver() const;
 125
 126     QT_STATIC_CONST char *defaultConnection;
 127
 128     static QSqlDatabase addDatabase(const QString& type,
 129                                  const QString& connectionName = QLatin1String(defaultConnection));
 130     static QSqlDatabase addDatabase(QSqlDriver* driver,
 131                                  const QString& connectionName = QLatin1String(defaultConnection));
 132     static QSqlDatabase cloneDatabase(const QSqlDatabase &other, const QString& connectionName);
 133     static QSqlDatabase database(const QString& connectionName = QLatin1String(defaultConnection),
 134                                  bool open = true);
 135     static void removeDatabase(const QString& connectionName);
 136     static bool contains(const QString& connectionName = QLatin1String(defaultConnection));
 137     static QStringList drivers();
 138     static QStringList connectionNames();
 139     static void registerSqlDriver(const QString &name, QSqlDriverCreatorBase *creator);
 140     static bool isDriverAvailable(const QString &name);
 141
 142 protected:
 143     explicit QSqlDatabase(const QString& type);
 144     explicit QSqlDatabase(QSqlDriver* driver);
 145
 146 private:
 147     friend class QSqlDatabasePrivate;
 148     QSqlDatabasePrivate *d;
 149 };
 150
 151 #ifndef QT_NO_DEBUG_STREAM
 152 Q_SQL_EXPORT QDebug operator<<(QDebug, const QSqlDatabase &);
 153 #endif
 154
 155 QT_END_NAMESPACE
 156
 157 QT_END_HEADER
 158
 159 #endif // QSQLDATABASE_H