Cutelyst  3.5.0
sql.h
1 /*
2  * SPDX-FileCopyrightText: (C) 2015-2022 Daniel Nicoletti <dantti12@gmail.com>
3  * SPDX-License-Identifier: BSD-3-Clause
4  */
5 #ifndef CSQL_H
6 #define CSQL_H
7 
8 #include <QtCore/QVariant>
9 #include <QtSql/QSqlDatabase>
10 
11 #include <Cutelyst/cutelyst_global.h>
12 #include <Cutelyst/paramsmultimap.h>
13 
14 namespace Cutelyst {
15 
16 namespace Sql
17 {
18 
30 class CUTELYST_PLUGIN_UTILS_SQL_EXPORT Transaction {
31 public:
35  explicit Transaction(const QString &databaseName = QString());
36  Transaction(const QSqlDatabase &database);
37  ~Transaction();
38 
39  bool transaction() const;
40  bool commit();
41  bool rollback();
42 
43 private:
44  QSqlDatabase m_db;
45  bool m_transactionRunning;
46 };
47 
53  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QVariantHash queryToHashObject(QSqlQuery &query);
54 
60  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QVariantList queryToHashList(QSqlQuery &query);
61 
67  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QVariantMap queryToMapObject(QSqlQuery &query);
68 
73  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QJsonObject queryToJsonObject(QSqlQuery &query);
74 
81  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QVariantList queryToMapList(QSqlQuery &query);
82 
86  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QJsonArray queryToJsonObjectArray(QSqlQuery &query);
87 
92  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QVariantList queryToList(QSqlQuery &query);
93 
98  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QJsonArray queryToJsonArray(QSqlQuery &query);
99 
105  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QVariantHash queryToIndexedHash(QSqlQuery &query, const QString &key);
106 
112  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QJsonObject queryToIndexedJsonObject(QSqlQuery &query, const QString &key);
113 
119  CUTELYST_PLUGIN_UTILS_SQL_EXPORT void bindParamsToQuery(QSqlQuery &query, const Cutelyst::ParamsMultiMap &params, bool htmlEscaped = true);
120 
136  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QSqlQuery preparedQuery(const QString &query, QSqlDatabase db = QSqlDatabase(), bool forwardOnly = false);
137 
141  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QString databaseNameThread(const QString &dbName = QString());
142 
146  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QSqlDatabase databaseThread(const QString &dbName = QString());
147 
164  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QSqlQuery preparedQueryThread(const QString &query, const QString &dbName = QString(), bool forwardOnly = false);
165 }
166 
167 }
168 
169 # define CPreparedSqlQueryForDatabase(str, db) \
170  ([]() -> QSqlQuery { \
171  static thread_local QSqlQuery query_temp = \
172  Cutelyst::Sql::preparedQuery(str, db); \
173  return query_temp; \
174  }()) \
175 
176 
177 # define CPreparedSqlQuery(str) \
178  ([]() -> QSqlQuery { \
179  static QSqlQuery query_temp = \
180  Cutelyst::Sql::preparedQuery(str); \
181  return query_temp; \
182  }()) \
183 
184 
185 # define CPreparedSqlQueryThread(str) \
186  ([]() -> QSqlQuery { \
187  static thread_local QSqlQuery query_temp = \
188  Cutelyst::Sql::preparedQueryThread(str); \
189  return query_temp; \
190  }()) \
191 
192 
193 # define CPreparedSqlQueryThreadForDB(str, db) \
194  ([]() -> QSqlQuery { \
195  static thread_local QSqlQuery query_temp = \
196  Cutelyst::Sql::preparedQueryThread(str, db); \
197  return query_temp; \
198  }()) \
199 
200 
201 # define CPreparedSqlQueryForDatabaseFO(str, db) \
202  ([]() -> QSqlQuery { \
203  static thread_local QSqlQuery query_temp = \
204  Cutelyst::Sql::preparedQuery(str, db, true); \
205  return query_temp; \
206  }()) \
207 
208 
209 # define CPreparedSqlQueryFO(str) \
210  ([]() -> QSqlQuery { \
211  static QSqlQuery query_temp = \
212  Cutelyst::Sql::preparedQuery(str, QSqlDatabase(), true); \
213  return query_temp; \
214  }()) \
215 
216 
217 # define CPreparedSqlQueryThreadFO(str) \
218  ([]() -> QSqlQuery { \
219  static thread_local QSqlQuery query_temp = \
220  Cutelyst::Sql::preparedQueryThread(str, QString(), true); \
221  return query_temp; \
222  }()) \
223 
224 
225 # define CPreparedSqlQueryThreadForDBFO(str, db) \
226  ([]() -> QSqlQuery { \
227  static thread_local QSqlQuery query_temp = \
228  Cutelyst::Sql::preparedQueryThread(str, db, true); \
229  return query_temp; \
230  }()) \
231 
232 
233 #endif // CSQL_H
The Transaction class - This is a helper class to create scoped transactions.
Definition: sql.h:30
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7