-
-
Notifications
You must be signed in to change notification settings - Fork 384
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add onMigrationsQueryExecuting
and onMigrationsQueryExecuted
events
#906
Open
pulzarraider
wants to merge
1
commit into
doctrine:3.1.x
Choose a base branch
from
pulzarraider:query_events
base: 3.1.x
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
61 changes: 61 additions & 0 deletions
61
lib/Doctrine/Migrations/Event/MigrationsQueryEventArgs.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Doctrine\Migrations\Event; | ||
|
||
use Doctrine\Common\EventArgs; | ||
use Doctrine\DBAL\Connection; | ||
use Doctrine\Migrations\Metadata\MigrationPlan; | ||
use Doctrine\Migrations\MigratorConfiguration; | ||
use Doctrine\Migrations\Query\Query; | ||
|
||
/** | ||
* The MigrationsQueryEventArgs class is passed to events related to a single migration query from a version. | ||
*/ | ||
final class MigrationsQueryEventArgs extends EventArgs | ||
{ | ||
/** @var Connection */ | ||
private $connection; | ||
|
||
/** @var MigrationPlan */ | ||
private $plan; | ||
|
||
/** @var MigratorConfiguration */ | ||
private $migratorConfiguration; | ||
|
||
/** @var Query */ | ||
private $query; | ||
|
||
public function __construct( | ||
Connection $connection, | ||
MigrationPlan $plan, | ||
MigratorConfiguration $migratorConfiguration, | ||
Query $query | ||
) { | ||
$this->connection = $connection; | ||
$this->plan = $plan; | ||
$this->migratorConfiguration = $migratorConfiguration; | ||
$this->query = $query; | ||
} | ||
|
||
public function getConnection() : Connection | ||
{ | ||
return $this->connection; | ||
} | ||
|
||
public function getPlan() : MigrationPlan | ||
{ | ||
return $this->plan; | ||
} | ||
|
||
public function getMigratorConfiguration() : MigratorConfiguration | ||
{ | ||
return $this->migratorConfiguration; | ||
} | ||
|
||
public function getQuery() : Query | ||
{ | ||
return $this->query; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Doctrine\Migrations\Query; | ||
|
||
/** | ||
* The Query wraps the sql query, parameters and types. It used in MigrationsQueryEventArgs. | ||
*/ | ||
final class Query | ||
{ | ||
/** @var string */ | ||
private $statement; | ||
|
||
/** @var mixed[] */ | ||
private $parameters; | ||
|
||
/** @var mixed[] */ | ||
private $types; | ||
|
||
/** | ||
* @param mixed[] $parameters | ||
* @param mixed[] $types | ||
*/ | ||
public function __construct(string $statement, array $parameters = [], array $types = []) | ||
{ | ||
$this->statement = $statement; | ||
$this->parameters = $parameters; | ||
$this->types = $types; | ||
} | ||
|
||
public function getStatement() : string | ||
{ | ||
return $this->statement; | ||
} | ||
|
||
/** @return mixed[] */ | ||
public function getParameters() : array | ||
{ | ||
return $this->parameters; | ||
} | ||
|
||
/** @return mixed[] */ | ||
public function getTypes() : array | ||
{ | ||
return $this->types; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Doctrine\Migrations\Tests\Query; | ||
|
||
use Doctrine\Migrations\Query\Query; | ||
use Doctrine\Migrations\Tests\MigrationTestCase; | ||
|
||
final class QueryTest extends MigrationTestCase | ||
{ | ||
public function testGetQuery() : void | ||
{ | ||
$query = new Query('foo', ['bar', 'baz'], ['qux', 'quux']); | ||
|
||
self::assertSame('foo', $query->getStatement()); | ||
self::assertSame(['bar', 'baz'], $query->getParameters()); | ||
self::assertSame(['qux', 'quux'], $query->getTypes()); | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I personally don't like that the check is done here. It is already too late, the migration process already started. Databases as MYSQL are not that good at transactions and altering the schema.
I would suggest to trigger a new event type right before the
if (count($this->sql) !== 0) {
check in theexecuteMigration
method.In that moment the execution of SQL commands did not start yet and is much safer to interrupt it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would also expect that, when I consider the example use case, if a big table was the reason why an migration was aborted, that the previous executed queries of the same version on the smaller tables are rolled back. Maybe a test can cover that.