Skip to content

Commit 7f897b3

Browse files
committed
renamed all getQtQuery and similar to getSqlQuery
These methods had a wrong names after the TinyDrivers were added as all can return QSqlXyz or Orm::Drivers::SqlXyz instances. Changing Qt to Sql covers both cases. - updated auto tests - updated docs
1 parent b455794 commit 7f897b3

File tree

14 files changed

+69
-69
lines changed

14 files changed

+69
-69
lines changed

docs/database/getting-started.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -847,16 +847,16 @@ If your application needs to use multiple connections, you may access each conne
847847
auto query = DB::connection("mysql_test").select(...);
848848
```
849849

850-
You may access the raw underlying `QSqlQuery` instance of a connection using the `getQtQuery` method on a connection instance:
850+
You may access the raw underlying `QSqlQuery` instance of a connection using the `getSqlQuery` method on a connection instance:
851851

852852
```cpp
853-
auto query = DB::connection().getQtQuery();
853+
auto query = DB::connection().getSqlQuery();
854854
```
855855

856-
Or you can use the shortcut method `qtQuery` provided by the `DB` facade:
856+
Or you can use the shortcut method `sqlQuery` provided by the `DB` facade:
857857

858858
```cpp
859-
auto query = DB::qtQuery();
859+
auto query = DB::sqlQuery();
860860
```
861861

862862
## Database Transactions

include/orm/concerns/managestransactions.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ namespace Concerns
9393
/*! Transform QtSql transaction error (QSqlError) to TinyORM SqlTransactionError
9494
exception (shortcut method). */
9595
[[noreturn]] static void
96-
throwSqlTransactionError(const QString &functionName, const QSqlQuery &qtQuery);
96+
throwSqlTransactionError(const QString &functionName, const QSqlQuery &sqlQuery);
9797
#endif
9898

9999
/*! Reset in transaction state and savepoints. */

include/orm/databaseconnection.hpp

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -144,19 +144,19 @@ namespace Orm
144144
SqlQuery unprepared(const QString &queryString);
145145

146146
/* Obtain connection instance */
147-
/*! Get underlying database connection (QSqlDatabase). */
148-
TSqlDatabase getQtConnection();
147+
/*! Get underlying database connection (Q/SqlDatabase). */
148+
TSqlDatabase getSqlConnection();
149149
/*! Get underlying database connection without executing any reconnect logic. */
150-
TSqlDatabase getRawQtConnection() const;
150+
TSqlDatabase getRawSqlConnection() const;
151151
/*! Get the connection resolver for an underlying database connection. */
152152
inline const std::function<Connectors::ConnectionName()> &
153-
getQtConnectionResolver() const noexcept;
153+
getSqlConnectionResolver() const noexcept;
154154
/*! Set the connection resolver for an underlying database connection. */
155-
DatabaseConnection &setQtConnectionResolver(
155+
DatabaseConnection &setSqlConnectionResolver(
156156
const std::function<Connectors::ConnectionName()> &resolver);
157157

158-
/*! Get a new QSqlQuery instance for the current connection. */
159-
TSqlQuery getQtQuery();
158+
/*! Get a new Q/SqlQuery instance for the current connection. */
159+
TSqlQuery getSqlQuery();
160160

161161
/*! Prepare the query bindings for execution. */
162162
QList<QVariant> &prepareBindings(QList<QVariant> &bindings) const;
@@ -320,8 +320,8 @@ namespace Orm
320320
private:
321321
/*! Prepare an SQL statement and return the query object. */
322322
TSqlQuery prepareQuery(const QString &queryString);
323-
/*! Get a new QSqlQuery instance for the pretend for the current connection. */
324-
inline TSqlQuery getQtQueryForPretend();
323+
/*! Get a new Q/SqlQuery instance for the pretend for the current connection. */
324+
inline TSqlQuery getSqlQueryForPretend();
325325

326326
/*! Prepare the QDateTime query binding for execution. */
327327
QDateTime prepareBinding(const QDateTime &binding) const;
@@ -418,22 +418,22 @@ namespace Orm
418418
/* Obtain connection instance */
419419

420420
const std::function<Connectors::ConnectionName()> &
421-
DatabaseConnection::getQtConnectionResolver() const noexcept
421+
DatabaseConnection::getSqlConnectionResolver() const noexcept
422422
{
423423
return m_qtConnectionResolver;
424424
}
425425

426426
bool DatabaseConnection::isOpen()
427427
{
428-
return m_qtConnection && getQtConnection().isOpen();
428+
return m_qtConnection && getSqlConnection().isOpen();
429429
}
430430

431431
void DatabaseConnection::connectEagerly()
432432
{
433433
reconnectIfMissingConnection();
434434

435435
// This opens a physical database connection
436-
std::ignore = getQtConnection();
436+
std::ignore = getSqlConnection();
437437
}
438438

439439
const QueryGrammar &DatabaseConnection::getQueryGrammar() const noexcept
@@ -587,9 +587,9 @@ namespace Orm
587587

588588
/* private */
589589

590-
TSqlQuery DatabaseConnection::getQtQueryForPretend()
590+
TSqlQuery DatabaseConnection::getSqlQueryForPretend()
591591
{
592-
return getQtQuery();
592+
return getSqlQuery();
593593
}
594594

595595
template<typename Return>

include/orm/databasemanager.hpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ namespace Query
6767

6868
/*! Get a new query builder instance for the connection. */
6969
std::shared_ptr<QueryBuilder> query(const QString &connection = "");
70-
/*! Get a new QSqlQuery instance for the connection. */
71-
TSqlQuery qtQuery(const QString &connection = "");
70+
/*! Get a new Q/SqlQuery instance for the connection. */
71+
TSqlQuery sqlQuery(const QString &connection = "");
7272

7373
// TODO next add support for named bindings, Using Named Bindings silverqx
7474
/*! Run a select statement against the database. */
@@ -393,9 +393,9 @@ namespace Query
393393
std::shared_ptr<DatabaseConnection>
394394
configure(std::shared_ptr<DatabaseConnection> &&connection) const;
395395

396-
/*! Refresh an underlying QSqlDatabase connection resolver on a given
396+
/*! Refresh an underlying Q/SqlDatabase connection resolver on a given
397397
TinyORM connection. */
398-
DatabaseConnection &refreshQtConnection(const QString &connection);
398+
DatabaseConnection &refreshSqlConnection(const QString &connection);
399399

400400
/*! Throw an exception if DatabaseManager instance already exists. */
401401
static void checkInstance();

include/orm/db.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ namespace Orm
6262

6363
/*! Get a new query builder instance for the connection. */
6464
static std::shared_ptr<QueryBuilder> query(const QString &connection = "");
65-
/*! Get a new QSqlQuery instance for the connection. */
66-
static TSqlQuery qtQuery(const QString &connection = "");
65+
/*! Get a new Q/SqlQuery instance for the connection. */
66+
static TSqlQuery sqlQuery(const QString &connection = "");
6767

6868
/*! Run a select statement against the database. */
6969
static SqlQuery

include/orm/tiny/model.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1802,7 +1802,7 @@ namespace Orm::Tiny
18021802
/* This makes it much safer because a user must explicitly select this
18031803
behavior using the all parameter. */
18041804
if (!all)
1805-
return {-1, getConnection().getQtQuery()};
1805+
return {-1, getConnection().getSqlQuery()};
18061806

18071807
return invokeIncrementOrDecrement(*builder, column, amount, extra, method,
18081808
all);

src/orm/concerns/managestransactions.cpp

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ bool ManagesTransactions::beginTransaction()
7878
runBeginTransaction(connection);
7979
#elif defined(TINYORM_USING_TINYDRIVERS)
8080
if (!connection.pretending())
81-
connection.getQtConnection().transaction();
81+
connection.getSqlConnection().transaction();
8282
#endif
8383
} catch (const SqlTransactionError &e) {
8484
tryAgainIfCausedByLostConnectionStart(connection, std::current_exception(),
@@ -119,7 +119,7 @@ bool ManagesTransactions::commit()
119119
runCommit(connection);
120120
#elif defined(TINYORM_USING_TINYDRIVERS)
121121
if (!connection.pretending())
122-
connection.getRawQtConnection().commit();
122+
connection.getRawSqlConnection().commit();
123123
#endif
124124
} catch (const SqlTransactionError &e) {
125125
tryAgainIfCausedByLostConnectionCommon(std::current_exception(),
@@ -160,7 +160,7 @@ bool ManagesTransactions::rollBack()
160160
runRollBack(connection);
161161
#elif defined(TINYORM_USING_TINYDRIVERS)
162162
if (!connection.pretending())
163-
connection.getRawQtConnection().rollback();
163+
connection.getRawSqlConnection().rollback();
164164
#endif
165165
} catch (const SqlTransactionError &e) {
166166
tryAgainIfCausedByLostConnectionCommon(std::current_exception(),
@@ -205,7 +205,7 @@ bool ManagesTransactions::savepoint(const QString &id)
205205
runCommonSavepointQuery(connection, queryString, *SavepointFunction);
206206
#elif defined(TINYORM_USING_TINYDRIVERS)
207207
if (!connection.pretending())
208-
connection.getQtQuery().exec(queryString);
208+
connection.getSqlQuery().exec(queryString);
209209
#endif
210210
} catch (const SqlTransactionError &e) {
211211
tryAgainIfCausedByLostConnectionCommon(std::current_exception(),
@@ -251,7 +251,7 @@ bool ManagesTransactions::rollbackToSavepoint(const QString &id)
251251
runCommonSavepointQuery(connection, queryString, *RollbackToSavepointFunction);
252252
#elif defined(TINYORM_USING_TINYDRIVERS)
253253
if (!connection.pretending())
254-
connection.getQtQuery().exec(queryString);
254+
connection.getSqlQuery().exec(queryString);
255255
#endif
256256
} catch (const SqlTransactionError &e) {
257257
tryAgainIfCausedByLostConnectionCommon(std::current_exception(),
@@ -287,7 +287,7 @@ ManagesTransactions::setSavepointNamespace(const QString &savepointNamespace)
287287
#ifdef TINYORM_USING_QTSQLDRIVERS
288288
void ManagesTransactions::runBeginTransaction(DatabaseConnection &connection)
289289
{
290-
auto qtConnection = connection.getQtConnection();
290+
auto qtConnection = connection.getSqlConnection();
291291

292292
// Nothing to do
293293
if (connection.pretending() || qtConnection.transaction())
@@ -299,7 +299,7 @@ void ManagesTransactions::runBeginTransaction(DatabaseConnection &connection)
299299

300300
void ManagesTransactions::runCommit(DatabaseConnection &connection)
301301
{
302-
auto qtConnection = connection.getRawQtConnection();
302+
auto qtConnection = connection.getRawSqlConnection();
303303

304304
// Nothing to do
305305
if (connection.pretending() || qtConnection.commit())
@@ -310,7 +310,7 @@ void ManagesTransactions::runCommit(DatabaseConnection &connection)
310310

311311
void ManagesTransactions::runRollBack(DatabaseConnection &connection)
312312
{
313-
auto qtConnection = connection.getRawQtConnection();
313+
auto qtConnection = connection.getRawSqlConnection();
314314

315315
// Nothing to do
316316
if (connection.pretending() || qtConnection.rollback())
@@ -323,13 +323,13 @@ void ManagesTransactions::runCommonSavepointQuery(
323323
DatabaseConnection &connection, const QString &queryString,
324324
const QString &functionName)
325325
{
326-
auto qtQuery = connection.getQtQuery();
326+
auto sqlQuery = connection.getSqlQuery();
327327

328328
// Nothing to do
329-
if (connection.pretending() || qtQuery.exec(queryString))
329+
if (connection.pretending() || sqlQuery.exec(queryString))
330330
return;
331331

332-
throwSqlTransactionError(functionName, qtQuery);
332+
throwSqlTransactionError(functionName, sqlQuery);
333333
}
334334

335335
void ManagesTransactions::throwSqlTransactionError(
@@ -342,13 +342,13 @@ void ManagesTransactions::throwSqlTransactionError(
342342
}
343343

344344
void ManagesTransactions::throwSqlTransactionError(const QString &functionName,
345-
const QSqlQuery &qtQuery)
345+
const QSqlQuery &sqlQuery)
346346
{
347-
auto executedQuery = qtQuery.executedQuery();
347+
auto executedQuery = sqlQuery.executedQuery();
348348
if (executedQuery.isEmpty())
349-
executedQuery = qtQuery.lastQuery();
349+
executedQuery = sqlQuery.lastQuery();
350350

351-
throwSqlTransactionError(functionName, executedQuery, qtQuery.lastError());
351+
throwSqlTransactionError(functionName, executedQuery, sqlQuery.lastError());
352352
}
353353
#endif
354354

@@ -379,7 +379,7 @@ void ManagesTransactions::tryAgainIfCausedByLostConnectionStart(
379379

380380
connection.reconnect();
381381

382-
connection.getQtConnection().transaction();
382+
connection.getSqlConnection().transaction();
383383
}
384384

385385
void ManagesTransactions::tryAgainIfCausedByLostConnectionCommon(

src/orm/databaseconnection.cpp

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ DatabaseConnection::select(const QString &queryString, QList<QVariant> bindings)
102102
-> TSqlQuery
103103
{
104104
if (m_pretending)
105-
return getQtQueryForPretend();
105+
return getSqlQueryForPretend();
106106

107107
// Prepare QSqlQuery
108108
auto query = prepareQuery(queryString_);
@@ -171,7 +171,7 @@ DatabaseConnection::statement(const QString &queryString, QList<QVariant> bindin
171171
-> TSqlQuery
172172
{
173173
if (m_pretending)
174-
return getQtQueryForPretend();
174+
return getSqlQueryForPretend();
175175

176176
// Prepare QSqlQuery
177177
auto query = prepareQuery(queryString_);
@@ -220,7 +220,7 @@ DatabaseConnection::affectingStatement(const QString &queryString,
220220
-> std::tuple<int, TSqlQuery>
221221
{
222222
if (m_pretending)
223-
return {-1, getQtQueryForPretend()};
223+
return {-1, getSqlQueryForPretend()};
224224

225225
// Prepare QSqlQuery
226226
auto query = prepareQuery(queryString_);
@@ -264,10 +264,10 @@ SqlQuery DatabaseConnection::unprepared(const QString &queryString)
264264
-> TSqlQuery
265265
{
266266
if (m_pretending)
267-
return getQtQueryForPretend();
267+
return getSqlQueryForPretend();
268268

269269
// Prepare unprepared QSqlQuery 🙂
270-
auto query = getQtQuery();
270+
auto query = getSqlQuery();
271271

272272
if (query.exec(queryString_)) {
273273
// Query statements counter
@@ -298,7 +298,7 @@ SqlQuery DatabaseConnection::unprepared(const QString &queryString)
298298

299299
/* Obtain connection instance */
300300

301-
TSqlDatabase DatabaseConnection::getQtConnection()
301+
TSqlDatabase DatabaseConnection::getSqlConnection()
302302
{
303303
if (!m_qtConnection) {
304304
// This should never happen 🤔
@@ -319,7 +319,7 @@ TSqlDatabase DatabaseConnection::getQtConnection()
319319
return TSqlDatabase::database(*m_qtConnection, true);
320320
}
321321

322-
TSqlDatabase DatabaseConnection::getRawQtConnection() const
322+
TSqlDatabase DatabaseConnection::getRawSqlConnection() const
323323
{
324324
if (!m_qtConnection)
325325
throw Exceptions::RuntimeError(
@@ -330,7 +330,7 @@ TSqlDatabase DatabaseConnection::getRawQtConnection() const
330330
}
331331

332332
DatabaseConnection &
333-
DatabaseConnection::setQtConnectionResolver(
333+
DatabaseConnection::setSqlConnectionResolver(
334334
const std::function<Connectors::ConnectionName()> &resolver)
335335
{
336336
/* Reset transaction and savepoints as the underlying connection will be
@@ -354,9 +354,9 @@ DatabaseConnection::setQtConnectionResolver(
354354
return *this;
355355
}
356356

357-
TSqlQuery DatabaseConnection::getQtQuery()
357+
TSqlQuery DatabaseConnection::getSqlQuery()
358358
{
359-
return TSqlQuery(getQtConnection());
359+
return TSqlQuery(getSqlConnection());
360360
}
361361

362362
QList<QVariant> &
@@ -432,13 +432,13 @@ bool DatabaseConnection::pingDatabase()
432432

433433
const TSqlDriver *DatabaseConnection::driver()
434434
{
435-
return getQtConnection().driver();
435+
return getSqlConnection().driver();
436436
}
437437

438438
#ifdef TINYORM_USING_TINYDRIVERS
439439
std::weak_ptr<const TSqlDriver> DatabaseConnection::driverWeak()
440440
{
441-
return getQtConnection().driverWeak();
441+
return getSqlConnection().driverWeak();
442442
}
443443
#endif
444444

@@ -483,7 +483,7 @@ void DatabaseConnection::disconnect()
483483
from QSqlDatabase connection repository, so it can be reused, it's
484484
better for performance.
485485
Revisited, it's ok and will not cause any leaks or dangling connection. */
486-
getRawQtConnection().close();
486+
getRawSqlConnection().close();
487487

488488
m_qtConnection.reset();
489489
m_qtConnectionResolver = nullptr;
@@ -532,7 +532,7 @@ bool DatabaseConnection::hasConfig(const QString &option) const
532532

533533
QString DatabaseConnection::driverName()
534534
{
535-
return getQtConnection().driverName();
535+
return getSqlConnection().driverName();
536536
}
537537

538538
/*! Printable driver name hash type. */
@@ -639,7 +639,7 @@ void DatabaseConnection::useDefaultPostProcessor()
639639
TSqlQuery DatabaseConnection::prepareQuery(const QString &queryString)
640640
{
641641
// Prepare query string
642-
auto query = getQtQuery();
642+
auto query = getSqlQuery();
643643

644644
// TODO solve setForwardOnly() in DatabaseConnection class, again this problem 🤔 silverqx
645645
// query.setForwardOnly(m_forwardOnly);

0 commit comments

Comments
 (0)