Predictable QueryBuilder::executeQuery() and QueryBuilder::executeStatement()
#4578
Conversation
PowerKiKi
force-pushed
the
semantical-execute-methods-query-builder
branch
from
1034d56
to
d9b67ba
Compare
|
If we do this change, then we could look to add this |
The naming problem is not on our end. The "statement" on the left-hand side is a prepared statement. The "statement" on the right-hand side is a SQL statement (DDL/DML/DCL) as opposed to an SQL query. Having it named as |
|
Looks good to me. @beberlei do you want to backport it to |
|
@morozov the query builder change is ok for 3.1.x I believe, since the API for QueryBuilder::execute() does not return a boolean, it is already ok to use, would be a new migration step in the future for users. I don't believe there is pressure moving this to 2.13 |
|
#4580 would be the one that is more interesting for the 2.x branches |
There was a problem hiding this comment.
@PowerKiKi please add a runtime deprecation using Deprecation::trigger().
|
I added the |
PowerKiKi
force-pushed
the
semantical-execute-methods-query-builder
branch
from
8975f66
to
c8f1a38
Compare
| @@ -300,19 +300,57 @@ public function fetchFirstColumn(): array | |||
| return $this->connection->fetchFirstColumn($this->getSQL(), $this->params, $this->paramTypes); | |||
| } | |||
|
|
|||
| /** | |||
| * Executes an SQL query (SELECT) and returns a Result. | |||
There was a problem hiding this comment.
This may be misleading since it works also for DESCRIBE, SHOW and so on. Let's rephrase to:
Executes an SQL query that returns a Result.
There was a problem hiding this comment.
I'd agree with that on the Connection class, but AFAIK, there is no way to build anything else than a SELECT query with a QueryBuilder. So I don't think we should document an impossible use-case.
WDYT ?
see:
dbal/src/Query/QueryBuilder.php
Lines 40 to 46 in 461b3b7
There was a problem hiding this comment.
You're right, I didn't take the scope into account. Sorry for the confusion.
| /** | ||
| * Executes an SQL statement and returns the number of affected rows. | ||
| * | ||
| * Should be used for INSERT, UPDATE and DELETE |
There was a problem hiding this comment.
It's not limited to DML (INSERT, etc.), it could be also DDL and other non-DQL statements. See JDBC for reference.
There was a problem hiding this comment.
Idem, the QueryBuilder cannot build anything else than DML. Should we really mention that ?
…Statement()` This deprecates `QueryBuilder::execute()`, because its return type is unpredictable and raises issues with static analysis tools such as PHPStan. Instead you should use either `QueryBuilder::executeQuery()` or `QueryBuilder::executeStatement()`, depending on whether the queryBuilder is a query (SELECT) or a statement (INSERT, UPDATE, DELETE). You might also consider the use of the new shortcut methods, such as: - `fetchAllAssociative()` - `fetchAllAssociativeIndexed()` - `fetchAllKeyValue()` - `fetchAllNumeric()` - `fetchAssociative()` - `fetchFirstColumn()` - `fetchNumeric()` - `fetchOne()` This commit is a direct follow-up to doctrine#4461 where those shortcut methods where introduced.
PowerKiKi
force-pushed
the
semantical-execute-methods-query-builder
branch
from
100cde2
to
7b5dd78
Compare
|
Thanks, @PowerKiKi. |
Summary
This deprecates
QueryBuilder::execute(), because its return type isunpredictable and raises issues with static analysis tools such as PHPStan.
Instead you should use either
QueryBuilder::executeQuery()orQueryBuilder::executeStatement(), depending on whether the queryBuilder is a query (SELECT)or a statement (INSERT, UPDATE, DELETE).
You might also consider the use of the new shortcut methods, such as:
fetchAllAssociative()fetchAllAssociativeIndexed()fetchAllKeyValue()fetchAllNumeric()fetchAssociative()fetchFirstColumn()fetchNumeric()fetchOne()This commit is a direct follow-up to #4461
where those shortcut methods where introduced.