Qt 4.8
qsqldatabase.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtSql module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
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 
52 
54 
55 QT_MODULE(Sql)
56 
57 class QSqlError;
58 class QSqlDriver;
59 class QSqlIndex;
60 class QSqlRecord;
61 class QSqlQuery;
63 
65 {
66 public:
68  virtual QSqlDriver *createObject() const = 0;
69 };
70 
71 template <class T>
73 {
74 public:
75  QSqlDriver *createObject() const { return new T; }
76 };
77 
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;
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 
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;
151 };
152 
153 #ifndef QT_NO_DEBUG_STREAM
155 #endif
156 
158 
160 
161 #endif // QSQLDATABASE_H
The QSqlError class provides SQL database error information.
Definition: qsqlerror.h:53
The QSqlIndex class provides functions to manipulate and describe database indexes.
Definition: qsqlindex.h:55
The QDebug class provides an output stream for debugging information.
Definition: qdebug.h:62
NumericalPrecisionPolicy
Definition: qsql.h:82
int type
Definition: qmetatype.cpp:239
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
#define QT_MODULE(x)
Definition: qglobal.h:2783
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
QSqlDatabasePrivate * d
Definition: qsqldatabase.h:150
The QSqlQuery class provides a means of executing and manipulating SQL statements.
Definition: qsqlquery.h:63
The QSqlDriverCreator class is a template class that provides a SQL driver factory for a specific dri...
Definition: qsqldatabase.h:72
The QSqlDatabase class represents a connection to a database.
Definition: qsqldatabase.h:78
QLatin1String(DBUS_INTERFACE_DBUS))) Q_GLOBAL_STATIC_WITH_ARGS(QString
The QSqlRecord class encapsulates a database record.
Definition: qsqlrecord.h:58
The QSqlDriver class is an abstract base class for accessing specific SQL databases.
Definition: qsqldriver.h:68
The QString class provides a Unicode character string.
Definition: qstring.h:83
virtual ~QSqlDriverCreatorBase()
Destroys the SQL driver creator object.
Definition: qsqldatabase.h:67
#define Q_SQL_EXPORT
Definition: qglobal.h:1451
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
const char * name
The QStringList class provides a list of strings.
Definition: qstringlist.h:66
Q_SQL_EXPORT QDebug operator<<(QDebug, const QSqlDatabase &)
TableType
Definition: qsql.h:74
#define QT_STATIC_CONST
Definition: qglobal.h:1040
QT_STATIC_CONST char * defaultConnection
Definition: qsqldatabase.h:128
The QSqlDriverCreatorBase class is the base class for SQL driver factories.
Definition: qsqldatabase.h:64
#define QT_END_HEADER
Definition: qglobal.h:137
QSqlDriver * createObject() const
Reimplemented Function
Definition: qsqldatabase.h:75
int open(const char *, int,...)