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 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    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 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    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 #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     void setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy);

   124     QSql::NumericalPrecisionPolicy numericalPrecisionPolicy() const;

   125 

   126     QSqlDriver* driver() const;

   127 

   128     QT_STATIC_CONST char *defaultConnection;

   129 

   130     static QSqlDatabase addDatabase(const QString& type,

   131                                  const QString& connectionName = QLatin1String(defaultConnection));

   132     static QSqlDatabase addDatabase(QSqlDriver* driver,

   133                                  const QString& connectionName = QLatin1String(defaultConnection));

   134     static QSqlDatabase cloneDatabase(const QSqlDatabase &other, const QString& connectionName);

   135     static QSqlDatabase database(const QString& connectionName = QLatin1String(defaultConnection),

   136                                  bool open = true);

   137     static void removeDatabase(const QString& connectionName);

   138     static bool contains(const QString& connectionName = QLatin1String(defaultConnection));

   139     static QStringList drivers();

   140     static QStringList connectionNames();

   141     static void registerSqlDriver(const QString &name, QSqlDriverCreatorBase *creator);

   142     static bool isDriverAvailable(const QString &name);

   143 

   144 protected:

   145     explicit QSqlDatabase(const QString& type);

   146     explicit QSqlDatabase(QSqlDriver* driver);

   147 

   148 private:

   149     friend class QSqlDatabasePrivate;

   150     QSqlDatabasePrivate *d;

   151 };

   152 

   153 #ifndef QT_NO_DEBUG_STREAM

   154 Q_SQL_EXPORT QDebug operator<<(QDebug, const QSqlDatabase &);

   155 #endif

   156 

   157 QT_END_NAMESPACE

   158 

   159 QT_END_HEADER

   160 

   161 #endif // QSQLDATABASE_H