Qt 4.8
qsqldriver.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 QSQLDRIVER_H
43 #define QSQLDRIVER_H
44 
45 #include <QtCore/qobject.h>
46 #include <QtCore/qstring.h>
47 #include <QtCore/qstringlist.h>
48 #include <QtSql/qsql.h>
49 #ifdef QT3_SUPPORT
50 #include <QtSql/qsqlquery.h>
51 #endif
52 
54 
56 
57 QT_MODULE(Sql)
58 
59 class QSqlDatabase;
60 class QSqlDriverPrivate;
61 class QSqlError;
62 class QSqlField;
63 class QSqlIndex;
64 class QSqlRecord;
65 class QSqlResult;
66 class QVariant;
67 
69 {
70  friend class QSqlDatabase;
71  Q_OBJECT
73 
74 public:
75  enum DriverFeature { Transactions, QuerySize, BLOB, Unicode, PreparedQueries,
76  NamedPlaceholders, PositionalPlaceholders, LastInsertId,
77  BatchOperations, SimpleLocking, LowPrecisionNumbers,
78  EventNotifications, FinishQuery, MultipleResultSets };
79 
80  enum StatementType { WhereStatement, SelectStatement, UpdateStatement,
81  InsertStatement, DeleteStatement };
82 
83  enum IdentifierType { FieldName, TableName };
84 
85  explicit QSqlDriver(QObject *parent=0);
86  ~QSqlDriver();
87  virtual bool isOpen() const;
88  bool isOpenError() const;
89 
90  virtual bool beginTransaction();
91  virtual bool commitTransaction();
92  virtual bool rollbackTransaction();
93  virtual QStringList tables(QSql::TableType tableType) const;
94  virtual QSqlIndex primaryIndex(const QString &tableName) const;
95  virtual QSqlRecord record(const QString &tableName) const;
96 #ifdef QT3_SUPPORT
97  inline QT3_SUPPORT QSqlRecord record(const QSqlQuery& query) const
98  { return query.record(); }
99  inline QT3_SUPPORT QSqlRecord recordInfo(const QString& tablename) const
100  { return record(tablename); }
101  inline QT3_SUPPORT QSqlRecord recordInfo(const QSqlQuery& query) const
102  { return query.record(); }
103  inline QT3_SUPPORT QString nullText() const { return QLatin1String("NULL"); }
104  inline QT3_SUPPORT QString formatValue(const QSqlField *field, bool trimStrings = false) const
105  { return field ? formatValue(*field, trimStrings) : QString(); }
106 #endif
107  virtual QString formatValue(const QSqlField& field, bool trimStrings = false) const;
108 
109  virtual QString escapeIdentifier(const QString &identifier, IdentifierType type) const;
110  virtual QString sqlStatement(StatementType type, const QString &tableName,
111  const QSqlRecord &rec, bool preparedStatement) const;
112 
113  QSqlError lastError() const;
114 
115  virtual QVariant handle() const;
116  virtual bool hasFeature(DriverFeature f) const = 0;
117  virtual void close() = 0;
118  virtual QSqlResult *createResult() const = 0;
119 
120  virtual bool open(const QString& db,
121  const QString& user = QString(),
122  const QString& password = QString(),
123  const QString& host = QString(),
124  int port = -1,
125  const QString& connOpts = QString()) = 0;
126  bool subscribeToNotification(const QString &name); // ### Qt 5: make virtual
127  bool unsubscribeFromNotification(const QString &name); // ### Qt 5: make virtual
128  QStringList subscribedToNotifications() const; // ### Qt 5: make virtual
129 
130  bool isIdentifierEscaped(const QString &identifier, IdentifierType type) const; // ### Qt 5: make virtual
131  QString stripDelimiters(const QString &identifier, IdentifierType type) const; // ### Qt 5: make virtual
132 
135 
136 Q_SIGNALS:
137  void notification(const QString &name);
138 
139 protected:
140  virtual void setOpen(bool o);
141  virtual void setOpenError(bool e);
142  virtual void setLastError(const QSqlError& e);
143 
144 protected Q_SLOTS:
145  bool subscribeToNotificationImplementation(const QString &name); // ### Qt 5: eliminate, see subscribeToNotification()
146  bool unsubscribeFromNotificationImplementation(const QString &name); // ### Qt 5: eliminate, see unsubscribeFromNotification()
147  QStringList subscribedToNotificationsImplementation() const; // ### Qt 5: eliminate, see subscribedNotifications()
148 
149  bool isIdentifierEscapedImplementation(const QString &identifier, IdentifierType type) const; // ### Qt 5: eliminate, see isIdentifierEscaped()
150  QString stripDelimitersImplementation(const QString &identifier, IdentifierType type) const; // ### Qt 5: eliminate, see stripDelimiters()
151 
152 private:
154 };
155 
157 
159 
160 #endif // QSQLDRIVER_H
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
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
void close()
Closes the database connection, freeing any resources acquired, and invalidating any existing QSqlQue...
NumericalPrecisionPolicy
Definition: qsql.h:82
bool isOpen() const
Returns true if the database connection is currently open; otherwise returns false.
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
DriverFeature
This enum contains a list of features a driver might support.
Definition: qsqldriver.h:75
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
QSqlRecord record() const
Returns a QSqlRecord containing the field information for the current query.
Definition: qsqlquery.cpp:858
StatementType
This enum contains a list of SQL statement (or clause) types the driver can create.
Definition: qsqldriver.h:80
The QSqlQuery class provides a means of executing and manipulating SQL statements.
Definition: qsqlquery.h:63
The QSqlDatabase class represents a connection to a database.
Definition: qsqldatabase.h:78
QLatin1String(DBUS_INTERFACE_DBUS))) Q_GLOBAL_STATIC_WITH_ARGS(QString
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
The QSqlRecord class encapsulates a database record.
Definition: qsqlrecord.h:58
#define Q_SLOTS
Definition: qobjectdefs.h:71
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
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
#define Q_SIGNALS
Definition: qobjectdefs.h:72
QSqlIndex primaryIndex(const QString &tablename) const
Returns the primary index for table tablename.
int port() const
Returns the connection&#39;s port number.
#define Q_SQL_EXPORT
Definition: qglobal.h:1451
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
QSqlRecord record(const QString &tablename) const
Returns a QSqlRecord populated with the names of all the fields in the table (or view) called tablena...
QSql::NumericalPrecisionPolicy numericalPrecisionPolicy() const
Returns the current default precision policy for the database connection.
QSqlError lastError() const
Returns information about the last error that occurred on the database.
const char * name
The QStringList class provides a list of strings.
Definition: qstringlist.h:66
TableType
Definition: qsql.h:74
#define Q_OBJECT
Definition: qobjectdefs.h:157
QString password() const
Returns the connection&#39;s password.
static bool hasFeature(const QDockWidgetPrivate *priv, QDockWidget::DockWidgetFeature feature)
Definition: qdockwidget.cpp:74
bool isOpenError() const
Returns true if there was an error opening the database connection; otherwise returns false...
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
The QSqlField class manipulates the fields in SQL database tables and views.
Definition: qsqlfield.h:56
#define QT_END_HEADER
Definition: qglobal.h:137
The QSqlResult class provides an abstract interface for accessing data from specific SQL databases...
Definition: qsqlresult.h:63
QStringList tables(QSql::TableType type=QSql::Tables) const
Returns a list of the database&#39;s tables, system tables and views, as specified by the parameter type...
IdentifierType
This enum contains a list of SQL identifier types.
Definition: qsqldriver.h:83
int open(const char *, int,...)
void setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)
Sets the default numerical precision policy used by queries created on this database connection to pr...