Cutelyst  2.13.0
sql.h
1 /*
2  * Copyright (C) 2015-2017 Daniel Nicoletti <dantti12@gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 #ifndef CSQL_H
19 #define CSQL_H
20 
21 #include <QtCore/QVariant>
22 #include <QtSql/QSqlDatabase>
23 
24 #include <Cutelyst/cutelyst_global.h>
25 #include <Cutelyst/paramsmultimap.h>
26 
27 namespace Cutelyst {
28 
29 namespace Sql
30 {
31 
43 class CUTELYST_PLUGIN_UTILS_SQL_EXPORT Transaction {
44 public:
48  explicit Transaction(const QString &databaseName = QString());
49  Transaction(const QSqlDatabase &database);
50  ~Transaction();
51 
52  bool transaction() const;
53  bool commit();
54  bool rollback();
55 
56 private:
57  QSqlDatabase m_db;
58  bool m_transactionRunning;
59 };
60 
66  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QVariantHash queryToHashObject(QSqlQuery &query);
67 
73  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QVariantList queryToHashList(QSqlQuery &query);
74 
80  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QVariantMap queryToMapObject(QSqlQuery &query);
81 
86  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QJsonObject queryToJsonObject(QSqlQuery &query);
87 
94  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QVariantList queryToMapList(QSqlQuery &query);
95 
99  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QJsonArray queryToJsonObjectArray(QSqlQuery &query);
100 
105  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QVariantList queryToList(QSqlQuery &query);
106 
111  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QJsonArray queryToJsonArray(QSqlQuery &query);
112 
118  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QVariantHash queryToIndexedHash(QSqlQuery &query, const QString &key);
119 
125  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QJsonObject queryToIndexedJsonObject(QSqlQuery &query, const QString &key);
126 
132  CUTELYST_PLUGIN_UTILS_SQL_EXPORT void bindParamsToQuery(QSqlQuery &query, const Cutelyst::ParamsMultiMap &params, bool htmlEscaped = true);
133 
149  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QSqlQuery preparedQuery(const QString &query, QSqlDatabase db = QSqlDatabase(), bool forwardOnly = false);
150 
154  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QString databaseNameThread(const QString &dbName = QString());
155 
159  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QSqlDatabase databaseThread(const QString &dbName = QString());
160 
177  CUTELYST_PLUGIN_UTILS_SQL_EXPORT QSqlQuery preparedQueryThread(const QString &query, const QString &dbName = QString(), bool forwardOnly = false);
178 }
179 
180 }
181 
182 # define CPreparedSqlQueryForDatabase(str, db) \
183  ([]() -> QSqlQuery { \
184  static thread_local QSqlQuery query_temp = \
185  Cutelyst::Sql::preparedQuery(str, db); \
186  return query_temp; \
187  }()) \
188 
189 
190 # define CPreparedSqlQuery(str) \
191  ([]() -> QSqlQuery { \
192  static QSqlQuery query_temp = \
193  Cutelyst::Sql::preparedQuery(str); \
194  return query_temp; \
195  }()) \
196 
197 
198 # define CPreparedSqlQueryThread(str) \
199  ([]() -> QSqlQuery { \
200  static thread_local QSqlQuery query_temp = \
201  Cutelyst::Sql::preparedQueryThread(str); \
202  return query_temp; \
203  }()) \
204 
205 
206 # define CPreparedSqlQueryThreadForDB(str, db) \
207  ([]() -> QSqlQuery { \
208  static thread_local QSqlQuery query_temp = \
209  Cutelyst::Sql::preparedQueryThread(str, db); \
210  return query_temp; \
211  }()) \
212 
213 
214 # define CPreparedSqlQueryForDatabaseFO(str, db) \
215  ([]() -> QSqlQuery { \
216  static thread_local QSqlQuery query_temp = \
217  Cutelyst::Sql::preparedQuery(str, db, true); \
218  return query_temp; \
219  }()) \
220 
221 
222 # define CPreparedSqlQueryFO(str) \
223  ([]() -> QSqlQuery { \
224  static QSqlQuery query_temp = \
225  Cutelyst::Sql::preparedQuery(str, QSqlDatabase(), true); \
226  return query_temp; \
227  }()) \
228 
229 
230 # define CPreparedSqlQueryThreadFO(str) \
231  ([]() -> QSqlQuery { \
232  static thread_local QSqlQuery query_temp = \
233  Cutelyst::Sql::preparedQueryThread(str, QString(), true); \
234  return query_temp; \
235  }()) \
236 
237 
238 # define CPreparedSqlQueryThreadForDBFO(str, db) \
239  ([]() -> QSqlQuery { \
240  static thread_local QSqlQuery query_temp = \
241  Cutelyst::Sql::preparedQueryThread(str, db, true); \
242  return query_temp; \
243  }()) \
244 
245 
246 #endif // CSQL_H
Cutelyst::ParamsMultiMap
QMap< QString, QString > ParamsMultiMap
Definition: paramsmultimap.h:36
Cutelyst::Sql::Transaction
The Transaction class - This is a helper class to create scoped transactions.
Definition: sql.h:43
Cutelyst
The Cutelyst namespace holds all public Cutelyst API.
Definition: Mainpage.dox:7