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 QSQLDATABASE_H
5#define QSQLDATABASE_H
6
7#include <QtSql/qtsqlglobal.h>
8#include <QtCore/qmetaobject.h>
9#include <QtCore/qstring.h>
10
11// clazy:excludeall=qproperty-without-notify
12QT_BEGIN_NAMESPACE
13
14
15class QSqlError;
16class QSqlDriver;
17class QSqlIndex;
18class QSqlRecord;
19class QSqlQuery;
20class QSqlDatabasePrivate;
21class QThread;
22
23class Q_SQL_EXPORT QSqlDriverCreatorBase
24{
25public:
26 virtual ~QSqlDriverCreatorBase();
27 virtual QSqlDriver *createObject() const = 0;
28};
29
30template <class T>
31class QSqlDriverCreator : public QSqlDriverCreatorBase
32{
33public:
34 QSqlDriver *createObject() const override { return new T; }
35};
36
37struct QSqlDatabaseDefaultConnectionName
38{
39 // separate class because of the static inline constexpr variable
40 static constexpr const char defaultConnection[] = "qt_sql_default_connection";
41 static QString defaultConnectionName() noexcept
42 {
43 using namespace Qt::StringLiterals;
44 return u"qt_sql_default_connection"_s;
45 }
46};
47
48class Q_SQL_EXPORT QSqlDatabase : public QSqlDatabaseDefaultConnectionName
49{
50 Q_GADGET
51 Q_PROPERTY(QSql::NumericalPrecisionPolicy numericalPrecisionPolicy READ numericalPrecisionPolicy WRITE setNumericalPrecisionPolicy)
52
53public:
54
55 QSqlDatabase();
56 QSqlDatabase(const QSqlDatabase &other);
57 ~QSqlDatabase();
58
59 QSqlDatabase &operator=(const QSqlDatabase &other);
60
61 bool open();
62 bool open(const QString& user, const QString& password);
63 void close();
64 bool isOpen() const;
65 bool isOpenError() const;
66 QStringList tables(QSql::TableType type = QSql::Tables) const;
67 QSqlIndex primaryIndex(const QString& tablename) const;
68 QSqlRecord record(const QString& tablename) const;
69#if QT_DEPRECATED_SINCE(6, 6)
70 QT_DEPRECATED_VERSION_X_6_6("Use QSqlQuery::exec() instead.")
71 QSqlQuery exec(const QString& query = QString()) const;
72#endif
73 QSqlError lastError() const;
74 bool isValid() const;
75
76 bool transaction();
77 bool commit();
78 bool rollback();
79
80 void setDatabaseName(const QString& name);
81 void setUserName(const QString& name);
82 void setPassword(const QString& password);
83 void setHostName(const QString& host);
84 void setPort(int p);
85 void setConnectOptions(const QString& options = QString());
86 QString databaseName() const;
87 QString userName() const;
88 QString password() const;
89 QString hostName() const;
90 QString driverName() const;
91 int port() const;
92 QString connectOptions() const;
93 QString connectionName() const;
94 void setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy);
95 QSql::NumericalPrecisionPolicy numericalPrecisionPolicy() const;
96 bool moveToThread(QThread *targetThread);
97 QThread *thread() const;
98
99 QSqlDriver* driver() const;
100
101#if QT_SQL_REMOVED_SINCE(6, 10)
102 static const char *defaultConnection;
103#endif
104
105 static QSqlDatabase addDatabase(const QString& type,
106 const QString &connectionName = defaultConnectionName());
107 static QSqlDatabase addDatabase(QSqlDriver* driver,
108 const QString &connectionName = defaultConnectionName());
109 static QSqlDatabase cloneDatabase(const QSqlDatabase &other, const QString &connectionName);
110 static QSqlDatabase cloneDatabase(const QString &other, const QString &connectionName);
111 static QSqlDatabase database(const QString &connectionName = defaultConnectionName(),
112 bool open = true);
113 static void removeDatabase(const QString &connectionName);
114 static bool contains(const QString &connectionName = defaultConnectionName());
115 static QStringList drivers();
116 static QStringList connectionNames();
117 static void registerSqlDriver(const QString &name, QSqlDriverCreatorBase *creator);
118 static bool isDriverAvailable(const QString &name);
119
120protected:
121 explicit QSqlDatabase(const QString& type);
122 explicit QSqlDatabase(QSqlDriver* driver);
123
124private:
125 friend class QSqlDatabasePrivate;
126 QSqlDatabasePrivate *d;
127};
128
129#ifndef QT_NO_DEBUG_STREAM
130Q_SQL_EXPORT QDebug operator<<(QDebug, const QSqlDatabase &);
131#endif
132
133QT_END_NAMESPACE
134
135#endif // QSQLDATABASE_H
136

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