1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef QSQLDRIVER_H
5#define QSQLDRIVER_H
6
7#include <QtSql/qtsqlglobal.h>
8#include <QtCore/qobject.h>
9#include <QtCore/qstring.h>
10#include <QtCore/qstringlist.h>
11
12// clazy:excludeall=qproperty-without-notify
13QT_BEGIN_NAMESPACE
14
15
16class QSqlDatabase;
17class QSqlDriverPrivate;
18class QSqlError;
19class QSqlField;
20class QSqlIndex;
21class QSqlRecord;
22class QSqlResult;
23class QVariant;
24
25class Q_SQL_EXPORT QSqlDriver : public QObject
26{
27 friend class QSqlDatabase;
28 friend class QSqlDatabasePrivate;
29 friend class QSqlResultPrivate;
30 Q_OBJECT
31 Q_PROPERTY(QSql::NumericalPrecisionPolicy numericalPrecisionPolicy READ numericalPrecisionPolicy WRITE setNumericalPrecisionPolicy)
32 Q_DECLARE_PRIVATE(QSqlDriver)
33
34public:
35 enum DriverFeature { Transactions, QuerySize, BLOB, Unicode, PreparedQueries,
36 NamedPlaceholders, PositionalPlaceholders, LastInsertId,
37 BatchOperations, SimpleLocking, LowPrecisionNumbers,
38 EventNotifications, FinishQuery, MultipleResultSets, CancelQuery };
39
40 enum StatementType { WhereStatement, SelectStatement, UpdateStatement,
41 InsertStatement, DeleteStatement };
42
43 enum IdentifierType { FieldName, TableName };
44
45 enum NotificationSource { UnknownSource, SelfSource, OtherSource };
46
47 enum DbmsType {
48 UnknownDbms,
49 MSSqlServer,
50 MySqlServer,
51 PostgreSQL,
52 Oracle,
53 Sybase,
54 SQLite,
55 Interbase,
56 DB2,
57 MimerSQL,
58 };
59
60 explicit QSqlDriver(QObject *parent = nullptr);
61 ~QSqlDriver();
62 virtual bool isOpen() const;
63 bool isOpenError() const;
64
65 virtual bool beginTransaction();
66 virtual bool commitTransaction();
67 virtual bool rollbackTransaction();
68 virtual QStringList tables(QSql::TableType tableType) const;
69 virtual QSqlIndex primaryIndex(const QString &tableName) const;
70 virtual QSqlRecord record(const QString &tableName) const;
71 virtual QString formatValue(const QSqlField &field, bool trimStrings = false) const;
72
73 virtual QString escapeIdentifier(const QString &identifier, IdentifierType type) const;
74 virtual QString sqlStatement(StatementType type, const QString &tableName,
75 const QSqlRecord &rec, bool preparedStatement) const;
76
77 QSqlError lastError() const;
78
79 virtual QVariant handle() const;
80 virtual bool hasFeature(DriverFeature f) const = 0;
81 virtual void close() = 0;
82 virtual QSqlResult *createResult() const = 0;
83
84 virtual bool open(const QString &db,
85 const QString &user = QString(),
86 const QString &password = QString(),
87 const QString &host = QString(),
88 int port = -1,
89 const QString &connOpts = QString()) = 0;
90 virtual bool subscribeToNotification(const QString &name);
91 virtual bool unsubscribeFromNotification(const QString &name);
92 virtual QStringList subscribedToNotifications() const;
93
94 virtual bool isIdentifierEscaped(const QString &identifier, IdentifierType type) const;
95 virtual QString stripDelimiters(const QString &identifier, IdentifierType type) const;
96
97 void setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy);
98 QSql::NumericalPrecisionPolicy numericalPrecisionPolicy() const;
99
100 DbmsType dbmsType() const;
101 virtual int maximumIdentifierLength(IdentifierType type) const;
102
103 QString connectionName() const;
104
105public Q_SLOTS:
106 virtual bool cancelQuery();
107
108Q_SIGNALS:
109 void notification(const QString &name, QSqlDriver::NotificationSource source, const QVariant &payload);
110
111protected:
112 QSqlDriver(QSqlDriverPrivate &dd, QObject *parent = nullptr);
113 virtual void setOpen(bool o);
114 virtual void setOpenError(bool e);
115 virtual void setLastError(const QSqlError& e);
116
117
118private:
119 Q_DISABLE_COPY(QSqlDriver)
120};
121
122QT_END_NAMESPACE
123
124#endif // QSQLDRIVER_H
125

source code of qtbase/src/sql/kernel/qsqldriver.h