src/sql/kernel/qsqldatabase.h

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