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 ****************************************************************************/
42 #ifndef QSQLDATABASE_H
43 #define QSQLDATABASE_H
45 #include <QtCore/qstring.h>
46 #include <QtSql/qsql.h>
48 #include <QtSql/qsqlrecord.h>
62 class QSqlDatabasePrivate;
64 class Q_SQL_EXPORT QSqlDriverCreatorBase
67 virtual ~QSqlDriverCreatorBase() {}
68 virtual QSqlDriver *createObject() const = 0;
72 class QSqlDriverCreator : public QSqlDriverCreatorBase
75 QSqlDriver *createObject() const { return new T; }
78 class Q_SQL_EXPORT QSqlDatabase
82 QSqlDatabase(const QSqlDatabase &other);
85 QSqlDatabase &operator=(const QSqlDatabase &other);
88 bool open(const QString& user, const QString& password);
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;
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;
101 QSqlQuery exec(const QString& query = QString()) const;
102 QSqlError lastError() const;
103 bool isValid() const;
109 void setDatabaseName(const QString& name);
110 void setUserName(const QString& name);
111 void setPassword(const QString& password);
112 void setHostName(const QString& host);
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;
121 QString connectOptions() const;
122 QString connectionName() const;
123 void setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy);
124 QSql::NumericalPrecisionPolicy numericalPrecisionPolicy() const;
126 QSqlDriver* driver() const;
128 QT_STATIC_CONST char *defaultConnection;
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),
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);
145 explicit QSqlDatabase(const QString& type);
146 explicit QSqlDatabase(QSqlDriver* driver);
149 friend class QSqlDatabasePrivate;
150 QSqlDatabasePrivate *d;
153 #ifndef QT_NO_DEBUG_STREAM
154 Q_SQL_EXPORT QDebug operator<<(QDebug, const QSqlDatabase &);
161 #endif // QSQLDATABASE_H