The start of something beautiful
This commit is contained in:
Vendored
+73
@@ -0,0 +1,73 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<xsd:schema xmlns="http://symfony.com/schema/dic/doctrine/migrations/3.0"
|
||||
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
||||
targetNamespace="http://symfony.com/schema/dic/doctrine/migrations/3.0"
|
||||
elementFormDefault="qualified"
|
||||
>
|
||||
|
||||
<xsd:element name="config">
|
||||
<xsd:complexType>
|
||||
|
||||
<xsd:sequence>
|
||||
<xsd:element name="migrations-path" maxOccurs="unbounded">
|
||||
<xsd:complexType>
|
||||
<xsd:simpleContent>
|
||||
<xsd:extension base="xsd:string">
|
||||
<xsd:attribute name="namespace" type="xsd:string"/>
|
||||
</xsd:extension>
|
||||
</xsd:simpleContent>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
|
||||
<xsd:element name="services" maxOccurs="unbounded" minOccurs="0">
|
||||
<xsd:complexType>
|
||||
<xsd:simpleContent>
|
||||
<xsd:extension base="xsd:string">
|
||||
<xsd:attribute name="service" type="xsd:string"/>
|
||||
</xsd:extension>
|
||||
</xsd:simpleContent>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
|
||||
|
||||
<xsd:element name="migration" type="xsd:string" maxOccurs="unbounded" minOccurs="0"/>
|
||||
|
||||
<xsd:element name="storage" minOccurs="0">
|
||||
<xsd:complexType>
|
||||
<xsd:sequence>
|
||||
<xsd:element name="table-storage" minOccurs="0">
|
||||
<xsd:complexType>
|
||||
<xsd:attribute name="table-name" type="xsd:string"/>
|
||||
<xsd:attribute name="version-column-name" type="xsd:string"/>
|
||||
<xsd:attribute name="version-column-length" type="xsd:positiveInteger"/>
|
||||
<xsd:attribute name="executed-at-column-name" type="xsd:string"/>
|
||||
<xsd:attribute name="execution-time-column-name" type="xsd:string"/>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
|
||||
</xsd:sequence>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
</xsd:sequence>
|
||||
|
||||
<xsd:attribute name="name" type="xsd:string"/>
|
||||
<xsd:attribute name="em" type="xsd:string"/>
|
||||
<xsd:attribute name="connection" type="xsd:string"/>
|
||||
<xsd:attribute name="sorter" type="xsd:string"/>
|
||||
<xsd:attribute name="all_or_nothing" type="xsd:boolean"/>
|
||||
<xsd:attribute name="check_database_platform" type="xsd:boolean"/>
|
||||
<xsd:attribute name="custom_template" type="xsd:string"/>
|
||||
<xsd:attribute name="organize-migrations">
|
||||
<xsd:simpleType>
|
||||
<xsd:restriction base="xsd:string">
|
||||
<xsd:enumeration value="BY_YEAR"/>
|
||||
<xsd:enumeration value="BY_YEAR_AND_MONTH"/>
|
||||
<xsd:enumeration value="false"/>
|
||||
</xsd:restriction>
|
||||
</xsd:simpleType>
|
||||
</xsd:attribute>
|
||||
</xsd:complexType>
|
||||
</xsd:element>
|
||||
|
||||
|
||||
</xsd:schema>
|
||||
@@ -0,0 +1,151 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
|
||||
<container xmlns="http://symfony.com/schema/dic/services"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
|
||||
|
||||
<services>
|
||||
|
||||
<service id="doctrine.migrations.dependency_factory" class="Doctrine\Migrations\DependencyFactory" public="false">
|
||||
<factory></factory>
|
||||
<argument type="service" id="doctrine.migrations.configuration_loader"/>
|
||||
<argument></argument>
|
||||
<argument type="service" id="logger" on-invalid="null"></argument>
|
||||
</service>
|
||||
|
||||
<service id="doctrine.migrations.configuration_loader" class="Doctrine\Migrations\Configuration\Migration\ExistingConfiguration" public="false">
|
||||
<argument type="service" id="doctrine.migrations.configuration"/>
|
||||
</service>
|
||||
|
||||
<service id="doctrine.migrations.connection_loader" class="Doctrine\Migrations\Configuration\Connection\ExistingConnection" public="false">
|
||||
|
||||
</service>
|
||||
|
||||
<service id="doctrine.migrations.em_loader" class="Doctrine\Migrations\Configuration\EntityManager\ExistingEntityManager" public="false">
|
||||
|
||||
</service>
|
||||
|
||||
<service id="doctrine.migrations.entity_manager_registry_loader" class="Doctrine\Migrations\Configuration\EntityManager\ManagerRegistryEntityManager" public="false">
|
||||
<factory class="Doctrine\Migrations\Configuration\EntityManager\ManagerRegistryEntityManager" method="withSimpleDefault"/>
|
||||
<argument type="service" id="doctrine"/>
|
||||
</service>
|
||||
|
||||
<service id="doctrine.migrations.connection_registry_loader" class="Doctrine\Migrations\Configuration\Connection\ConnectionRegistryConnection" public="false">
|
||||
<factory class="Doctrine\Migrations\Configuration\Connection\ConnectionRegistryConnection" method="withSimpleDefault"/>
|
||||
<argument type="service" id="doctrine"/>
|
||||
</service>
|
||||
|
||||
<service id="doctrine.migrations.configuration" class="Doctrine\Migrations\Configuration\Configuration" public="false">
|
||||
</service>
|
||||
|
||||
<service id="doctrine.migrations.migrations_factory" class="Doctrine\Migrations\Version\MigrationFactory">
|
||||
<factory service="doctrine.migrations.dependency_factory" method="getMigrationFactory"/>
|
||||
</service>
|
||||
|
||||
<service id="doctrine.migrations.container_aware_migrations_factory"
|
||||
class="Doctrine\Bundle\MigrationsBundle\MigrationsFactory\ContainerAwareMigrationFactory"
|
||||
decorates="doctrine.migrations.migrations_factory"
|
||||
>
|
||||
<argument id="doctrine.migrations.container_aware_migrations_factory.inner" type="service"/>
|
||||
<argument id="service_container" type="service"/>
|
||||
</service>
|
||||
|
||||
<service id="doctrine_migrations.diff_command" class="Doctrine\Migrations\Tools\Console\Command\DiffCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:diff</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:diff" />
|
||||
</service>
|
||||
|
||||
<service id="doctrine_migrations.sync_metadata_command" class="Doctrine\Migrations\Tools\Console\Command\SyncMetadataCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:sync-metadata-storage</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:sync-metadata-storage" />
|
||||
</service>
|
||||
|
||||
<service id="doctrine_migrations.versions_command" class="Doctrine\Migrations\Tools\Console\Command\ListCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:versions</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:list" />
|
||||
</service>
|
||||
|
||||
<service id="doctrine_migrations.current_command" class="Doctrine\Migrations\Tools\Console\Command\CurrentCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:current</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:current"/>
|
||||
</service>
|
||||
|
||||
<service id="doctrine_migrations.dump_schema_command" class="Doctrine\Migrations\Tools\Console\Command\DumpSchemaCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:dump-schema</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:dump-schema"/>
|
||||
</service>
|
||||
<service id="doctrine_migrations.execute_command" class="Doctrine\Migrations\Tools\Console\Command\ExecuteCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:execute</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:execute"/>
|
||||
</service>
|
||||
<service id="doctrine_migrations.generate_command" class="Doctrine\Migrations\Tools\Console\Command\GenerateCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:generate</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:generate"/>
|
||||
</service>
|
||||
<service id="doctrine_migrations.latest_command" class="Doctrine\Migrations\Tools\Console\Command\LatestCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:latest</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:latest"/>
|
||||
</service>
|
||||
<service id="doctrine_migrations.migrate_command" class="Doctrine\Migrations\Tools\Console\Command\MigrateCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:migrate</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:migrate" />
|
||||
</service>
|
||||
<service id="doctrine_migrations.rollup_command" class="Doctrine\Migrations\Tools\Console\Command\RollupCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:rollup</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:rollup" />
|
||||
</service>
|
||||
<service id="doctrine_migrations.status_command" class="Doctrine\Migrations\Tools\Console\Command\StatusCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:status</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:status" />
|
||||
</service>
|
||||
<service id="doctrine_migrations.up_to_date_command" class="Doctrine\Migrations\Tools\Console\Command\UpToDateCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:up-to-date</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:up-to-date" />
|
||||
</service>
|
||||
<service id="doctrine_migrations.version_command" class="Doctrine\Migrations\Tools\Console\Command\VersionCommand">
|
||||
|
||||
<argument type="service" id="doctrine.migrations.dependency_factory"/>
|
||||
<argument>doctrine:migrations:version</argument>
|
||||
|
||||
<tag name="console.command" command="doctrine:migrations:version" />
|
||||
</service>
|
||||
|
||||
</services>
|
||||
|
||||
</container>
|
||||
@@ -0,0 +1,467 @@
|
||||
DoctrineMigrationsBundle
|
||||
========================
|
||||
|
||||
Database migrations are a way to safely update your database schema both locally
|
||||
and on production. Instead of running the ``doctrine:schema:update`` command or
|
||||
applying the database changes manually with SQL statements, migrations allow to
|
||||
replicate the changes in your database schema in a safe manner.
|
||||
|
||||
Migrations are available in Symfony applications via the `DoctrineMigrationsBundle`_,
|
||||
which uses the external `Doctrine Database Migrations`_ library. Read the
|
||||
`documentation`_ of that library if you need a general introduction about migrations.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Run this command in your terminal:
|
||||
|
||||
.. code-block:: terminal
|
||||
|
||||
$ composer require doctrine/doctrine-migrations-bundle "^3.0"
|
||||
|
||||
If you don't use `Symfony Flex`_, you must enable the bundle manually in the application:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
// config/bundles.php
|
||||
// in older Symfony apps, enable the bundle in app/AppKernel.php
|
||||
return [
|
||||
// ...
|
||||
Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle::class => ['all' => true],
|
||||
];
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
If you use Symfony Flex, the ``doctrine_migrations.yaml`` config file is created
|
||||
automatically. Otherwise, create the following file and configure it for your
|
||||
application:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# config/packages/doctrine_migrations.yaml
|
||||
|
||||
doctrine_migrations:
|
||||
# List of namespace/path pairs to search for migrations, at least one required
|
||||
migrations_paths:
|
||||
'App\Migrations': '%kernel.project_dir%/src/App'
|
||||
'AnotherApp\Migrations': '/path/to/other/migrations'
|
||||
'SomeBundle\Migrations': '@SomeBundle/Migrations'
|
||||
|
||||
# List of additional migration classes to be loaded, optional
|
||||
migrations:
|
||||
- 'App\Migrations\Version123'
|
||||
- 'App\Migrations\Version123'
|
||||
|
||||
# Connection to use for the migrations
|
||||
connection: default
|
||||
|
||||
# Entity manager to use for migrations. This overrides the "connection" setting.
|
||||
em: default
|
||||
|
||||
storage:
|
||||
# Default (SQL table) metadata storage configuration
|
||||
table_storage:
|
||||
table_name: 'doctrine_migration_versions'
|
||||
version_column_name: 'version'
|
||||
version_column_length: 192
|
||||
executed_at_column_name: 'executed_at'
|
||||
|
||||
# Possible values: "BY_YEAR", "BY_YEAR_AND_MONTH", false
|
||||
organize_migrations: false
|
||||
|
||||
# Path to your custom migrations template
|
||||
custom_template: ~
|
||||
|
||||
# Run all migrations in a transaction.
|
||||
all_or_nothing: false
|
||||
|
||||
# Adds an extra check in the generated migrations to ensure that is executed on the same database type.
|
||||
check_database_platform: true
|
||||
|
||||
# Whether or not to wrap migrations in a single transaction.
|
||||
transactional: true
|
||||
|
||||
# Whether or not to enable the profiler collector to calculate and visualize migration status. This adds some queries overhead.
|
||||
# enable_profiler: false
|
||||
|
||||
services:
|
||||
# Custom migration sorting service id
|
||||
'Doctrine\Migrations\Version\Comparator': ~
|
||||
|
||||
# Custom migration classes factory
|
||||
'Doctrine\Migrations\Version\MigrationFactory': ~
|
||||
|
||||
factories:
|
||||
# Custom migration sorting service id via callables (MyCallableFactory must be a callable)
|
||||
'Doctrine\Migrations\Version\Comparator': 'MyCallableFactory'
|
||||
|
||||
- The ``services`` node allows you to provide custom services to the underlying ``DependencyFactory`` part of ``doctrine/migrations``.
|
||||
- The node ``factories`` is similar to ``services``, with the difference that it accepts only callables.
|
||||
|
||||
The provided callable must return the service to be passed to the ``DependencyFactory``.
|
||||
The callable will receive as first argument the ``DependencyFactory`` itself,
|
||||
allowing you to fetch other dependencies from the factory while instantiating your custom dependencies.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
All of the migrations functionality is contained in a few console commands:
|
||||
|
||||
.. code-block:: terminal
|
||||
|
||||
doctrine
|
||||
doctrine:migrations:current [current] Outputs the current version.
|
||||
doctrine:migrations:diff [diff] Generate a migration by comparing your current database to your mapping information.
|
||||
doctrine:migrations:dump-schema [dump-schema] Dump the schema for your database to a migration.
|
||||
doctrine:migrations:execute [execute] Execute a single migration version up or down manually.
|
||||
doctrine:migrations:generate [generate] Generate a blank migration class.
|
||||
doctrine:migrations:latest [latest] Outputs the latest version number
|
||||
doctrine:migrations:migrate [migrate] Execute a migration to a specified version or the latest available version.
|
||||
doctrine:migrations:rollup [rollup] Roll migrations up by deleting all tracked versions and inserting the one version that exists.
|
||||
doctrine:migrations:status [status] View the status of a set of migrations.
|
||||
doctrine:migrations:up-to-date [up-to-date] Tells you if your schema is up-to-date.
|
||||
doctrine:migrations:version [version] Manually add and delete migration versions from the version table.
|
||||
doctrine:migrations:sync-metadata-storage [sync-metadata-storage] Ensures that the metadata storage is at the latest version.
|
||||
doctrine:migrations:list [list-migrations] Display a list of all available migrations and their status.
|
||||
|
||||
Start by getting the status of migrations in your application by running
|
||||
the ``status`` command:
|
||||
|
||||
.. code-block:: terminal
|
||||
|
||||
$ php bin/console doctrine:migrations:status
|
||||
|
||||
This command will show you generic information about the migration status, such as how many migrations have been
|
||||
already executed, which still need to run, and the database in use.
|
||||
|
||||
Now, you can start working with migrations by generating a new blank migration
|
||||
class. Later, you'll learn how Doctrine can generate migrations automatically
|
||||
for you.
|
||||
|
||||
.. code-block:: terminal
|
||||
|
||||
$ php bin/console doctrine:migrations:generate
|
||||
|
||||
Have a look at the newly generated migration class and you will see something
|
||||
like the following:
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace DoctrineMigrations;
|
||||
|
||||
use Doctrine\DBAL\Schema\Schema;
|
||||
use Doctrine\Migrations\AbstractMigration;
|
||||
|
||||
/**
|
||||
* Auto-generated Migration: Please modify to your needs!
|
||||
*/
|
||||
final class Version20180605025653 extends AbstractMigration
|
||||
{
|
||||
public function getDescription() : string
|
||||
{
|
||||
return '';
|
||||
}
|
||||
|
||||
public function up(Schema $schema) : void
|
||||
{
|
||||
// this up() migration is auto-generated, please modify it to your needs
|
||||
|
||||
}
|
||||
|
||||
public function down(Schema $schema) : void
|
||||
{
|
||||
// this down() migration is auto-generated, please modify it to your needs
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
If you run the ``status`` command again it will now show that you have one new
|
||||
migration to execute:
|
||||
|
||||
.. code-block:: terminal
|
||||
|
||||
$ php bin/console doctrine:migrations:status
|
||||
|
||||
Now you can add some migration code to the ``up()`` and ``down()`` methods and
|
||||
finally migrate when you're ready:
|
||||
|
||||
.. code-block:: terminal
|
||||
|
||||
$ php bin/console doctrine:migrations:migrate 'DoctrineMigrations\Version20180605025653'
|
||||
|
||||
For more information on how to write the migrations themselves (i.e. how to
|
||||
fill in the ``up()`` and ``down()`` methods), see the official Doctrine Migrations
|
||||
`documentation`_.
|
||||
|
||||
Running Migrations during Deployment
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Of course, the end goal of writing migrations is to be able to use them to
|
||||
reliably update your database structure when you deploy your application.
|
||||
By running the migrations locally (or on a beta server), you can ensure that
|
||||
the migrations work as you expect.
|
||||
|
||||
When you do finally deploy your application, you just need to remember to run
|
||||
the ``doctrine:migrations:migrate`` command. Internally, Doctrine creates
|
||||
a ``migration_versions`` table inside your database and tracks which migrations
|
||||
have been executed there. So, no matter how many migrations you've created
|
||||
and executed locally, when you run the command during deployment, Doctrine
|
||||
will know exactly which migrations it hasn't run yet by looking at the ``migration_versions``
|
||||
table of your production database. Regardless of what server you're on, you
|
||||
can always safely run this command to execute only the migrations that haven't
|
||||
been run yet on *that* particular database.
|
||||
|
||||
Skipping Migrations
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You can skip single migrations by explicitly adding them to the ``migration_versions`` table:
|
||||
|
||||
.. code-block:: terminal
|
||||
|
||||
$ php bin/console doctrine:migrations:version 'App\Migrations\Version123' --add
|
||||
|
||||
.. tip::
|
||||
|
||||
Pay attention to the single quotes (``'``) used in the command above, without them
|
||||
or with the double quotes (``"``) the command will not work properly.
|
||||
|
||||
|
||||
Doctrine will then assume that this migration has already been run and will ignore it.
|
||||
|
||||
Migration Dependencies
|
||||
----------------------
|
||||
|
||||
Migrations can have dependencies on external services (such as geolocation, mailer, data processing services...) that
|
||||
can be used to have more powerful migrations. Those dependencies are not automatically injected into your migrations
|
||||
but need to be injected using custom migrations factories.
|
||||
|
||||
Here is an example on how to inject the service container into your migrations:
|
||||
|
||||
.. configuration-block::
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# config/packages/doctrine_migrations.yaml
|
||||
doctrine_migrations:
|
||||
services:
|
||||
'Doctrine\Migrations\Version\MigrationFactory': 'App\Migrations\Factory\MigrationFactoryDecorator'
|
||||
|
||||
# config/services.yaml
|
||||
services:
|
||||
App\Migrations\Factory\MigrationFactoryDecorator:
|
||||
decorates: 'doctrine.migrations.migrations_factory'
|
||||
arguments: ['@.inner', '@service_container']
|
||||
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Migrations\Factory;
|
||||
|
||||
use Doctrine\Migrations\AbstractMigration;
|
||||
use Doctrine\Migrations\Version\MigrationFactory;
|
||||
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
|
||||
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||
|
||||
class MigrationFactoryDecorator implements MigrationFactory
|
||||
{
|
||||
private $migrationFactory;
|
||||
private $container;
|
||||
|
||||
public function __construct(MigrationFactory $migrationFactory, ContainerInterface $container)
|
||||
{
|
||||
$this->migrationFactory = $migrationFactory;
|
||||
$this->container = $container;
|
||||
}
|
||||
|
||||
public function createVersion(string $migrationClassName): AbstractMigration
|
||||
{
|
||||
$instance = $this->migrationFactory->createVersion($migrationClassName);
|
||||
|
||||
if ($instance instanceof ContainerAwareInterface) {
|
||||
$instance->setContainer($this->container);
|
||||
}
|
||||
|
||||
return $instance;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
.. tip::
|
||||
|
||||
If your migration class implements the interface ``Symfony\Component\DependencyInjection\ContainerAwareInterface``
|
||||
this bundle will automatically inject the default symfony container into your migration class
|
||||
(this because the ``MigrationFactoryDecorator`` shown in this example is the default migration factory used by this bundle).
|
||||
|
||||
|
||||
Generating Migrations Automatically
|
||||
-----------------------------------
|
||||
|
||||
In reality, you should rarely need to write migrations manually, as the migrations
|
||||
library can generate migration classes automatically by comparing your Doctrine
|
||||
mapping information (i.e. what your database *should* look like) with your
|
||||
actual current database structure.
|
||||
|
||||
For example, suppose you create a new ``User`` entity and add mapping information
|
||||
for Doctrine's ORM:
|
||||
|
||||
.. configuration-block::
|
||||
|
||||
.. code-block:: php-annotations
|
||||
|
||||
// src/Entity/User.php
|
||||
namespace App\Entity;
|
||||
|
||||
use Doctrine\ORM\Mapping as ORM;
|
||||
|
||||
/**
|
||||
* @ORM\Entity
|
||||
* @ORM\Table(name="hello_user")
|
||||
*/
|
||||
class User
|
||||
{
|
||||
/**
|
||||
* @ORM\Id
|
||||
* @ORM\Column(type="integer")
|
||||
* @ORM\GeneratedValue(strategy="AUTO")
|
||||
*/
|
||||
private $id;
|
||||
|
||||
/**
|
||||
* @ORM\Column(type="string", length=255)
|
||||
*/
|
||||
private $name;
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# config/doctrine/User.orm.yaml
|
||||
App\Entity\User:
|
||||
type: entity
|
||||
table: user
|
||||
id:
|
||||
id:
|
||||
type: integer
|
||||
generator:
|
||||
strategy: AUTO
|
||||
fields:
|
||||
name:
|
||||
type: string
|
||||
length: 255
|
||||
|
||||
.. code-block:: xml
|
||||
|
||||
<!-- config/doctrine/User.orm.xml -->
|
||||
<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
|
||||
http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">
|
||||
|
||||
<entity name="App\Entity\User" table="user">
|
||||
<id name="id" type="integer" column="id">
|
||||
<generator strategy="AUTO"/>
|
||||
</id>
|
||||
<field name="name" column="name" type="string" length="255" />
|
||||
</entity>
|
||||
|
||||
</doctrine-mapping>
|
||||
|
||||
With this information, Doctrine is now ready to help you persist your new
|
||||
``User`` object to and from the ``user`` table. Of course, this table
|
||||
doesn't exist yet! Generate a new migration for this table automatically by
|
||||
running the following command:
|
||||
|
||||
.. code-block:: terminal
|
||||
|
||||
$ php bin/console doctrine:migrations:diff
|
||||
|
||||
You should see a message that a new migration class was generated based on
|
||||
the schema differences. If you open this file, you'll find that it has the
|
||||
SQL code needed to create the ``user`` table. Next, run the migration
|
||||
to add the table to your database:
|
||||
|
||||
.. code-block:: terminal
|
||||
|
||||
$ php bin/console doctrine:migrations:migrate
|
||||
|
||||
The moral of the story is this: after each change you make to your Doctrine
|
||||
mapping information, run the ``doctrine:migrations:diff`` command to automatically
|
||||
generate your migration classes.
|
||||
|
||||
If you do this from the very beginning of your project (i.e. so that even
|
||||
the first tables were loaded via a migration class), you'll always be able
|
||||
to create a fresh database and run your migrations in order to get your database
|
||||
schema fully up to date. In fact, this is an easy and dependable workflow
|
||||
for your project.
|
||||
|
||||
If you don't want to use this workflow and instead create your schema via
|
||||
``doctrine:schema:create``, you can tell Doctrine to skip all existing migrations:
|
||||
|
||||
.. code-block:: terminal
|
||||
|
||||
$ php bin/console doctrine:migrations:version --add --all
|
||||
|
||||
Otherwise Doctrine will try to run all migrations, which probably will not work.
|
||||
|
||||
Manual Tables
|
||||
-------------
|
||||
|
||||
It is a common use case, that in addition to your generated database structure
|
||||
based on your doctrine entities you might need custom tables. By default such
|
||||
tables will be removed by the ``doctrine:migrations:diff`` command.
|
||||
|
||||
If you follow a specific scheme you can configure doctrine/dbal to ignore those
|
||||
tables. Let's say all custom tables will be prefixed by ``t_``. In this case you
|
||||
just have to add the following configuration option to your doctrine configuration:
|
||||
|
||||
.. configuration-block::
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
doctrine:
|
||||
dbal:
|
||||
schema_filter: ~^(?!t_)~
|
||||
|
||||
.. code-block:: xml
|
||||
|
||||
<doctrine:dbal schema-filter="~^(?!t_)~" />
|
||||
|
||||
|
||||
.. code-block:: php
|
||||
|
||||
$container->loadFromExtension('doctrine', array(
|
||||
'dbal' => array(
|
||||
'schema_filter' => '~^(?!t_)~',
|
||||
// ...
|
||||
),
|
||||
// ...
|
||||
));
|
||||
|
||||
This ignores the tables, and any named objects such as sequences, on the DBAL level and they will be ignored by the diff command.
|
||||
|
||||
Note that if you have multiple connections configured then the ``schema_filter`` configuration
|
||||
will need to be placed per-connection.
|
||||
|
||||
Troubleshooting out of sync metadata storage issue
|
||||
--------------------------------------------------
|
||||
``doctrine/migrations`` relies on a properly configured Database server version in the connection string to manage the table storing the
|
||||
migrations, also known as the metadata storage.
|
||||
|
||||
If you encounter the error ``The metadata storage is not up to date, please run the sync-metadata-storage command to fix this issue.``
|
||||
when running the command ``doctrine:migrations:migrate`` or the suggested command itself ``doctrine:migrations:sync-metadata-storage`` please
|
||||
check the database connection string, and make sure that the proper server version is defined. If you are running a MariaDB database,
|
||||
you should prefix the server version with ``mariadb-`` (ex: ``mariadb-10.2.12``). See the `configuring_database`_ section.
|
||||
|
||||
Example connection string for MariaDB:
|
||||
|
||||
.. code-block:: terminal
|
||||
DATABASE_URL=mysql://root:@127.0.0.1:3306/testtest?serverVersion=mariadb-10.4.11
|
||||
|
||||
.. _documentation: https://www.doctrine-project.org/projects/doctrine-migrations/en/current/index.html
|
||||
.. _configuring_database: https://symfony.com/doc/current/doctrine.html#configuring-the-database
|
||||
.. _DoctrineMigrationsBundle: https://github.com/doctrine/DoctrineMigrationsBundle
|
||||
.. _`Doctrine Database Migrations`: https://github.com/doctrine/migrations
|
||||
.. _`Symfony Flex`: https://symfony.com/doc/current/setup/flex.html
|
||||
+6
@@ -0,0 +1,6 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" data-icon-name="icon-tabler-versions" width="24" height="24" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
|
||||
<rect x="10" y="5" width="10" height="14" rx="2"></rect>
|
||||
<line x1="7" y1="7" x2="7" y2="17"></line>
|
||||
<line x1="4" y1="8" x2="4" y2="16"></line>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 446 B |
@@ -0,0 +1,7 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24">
|
||||
<polygon fill="#AAA" points="0 0 24 0 24 7 17.5 7 16.5 3 15.5 7 11 7 12 3 3 3 4 7 0 7" />
|
||||
<polygon fill="#AAA" points="0 8.5 4.5 8.5 6 15.5 0 15.5" />
|
||||
<polygon fill="#AAA" points="10.5 8.5 15 8.5 13.5 15.5 9 15.5" />
|
||||
<polygon fill="#AAA" points="18 8.5 24 8.5 24 15.5 19.5 15.5" />
|
||||
<polygon fill="#AAA" points="0 17 6.5 17 7.5 21 8.5 17 13 17 12 21 21 21 20 17 24 17 24 24 0 24" />
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 493 B |
+252
@@ -0,0 +1,252 @@
|
||||
{% extends '@WebProfiler/Profiler/layout.html.twig' %}
|
||||
|
||||
{% block toolbar %}
|
||||
{% if collector.data.unavailable_migrations_count is defined %}
|
||||
{% set unavailable_migrations = collector.data.unavailable_migrations_count %}
|
||||
{% set new_migrations = collector.data.new_migrations|length %}
|
||||
{% if unavailable_migrations > 0 or new_migrations > 0 %}
|
||||
{% set executed_migrations = collector.data.executed_migrations|length %}
|
||||
{% set available_migrations = collector.data.available_migrations_count %}
|
||||
{% set status_color = unavailable_migrations > 0 ? 'yellow' : '' %}
|
||||
{% set status_color = new_migrations > 0 ? 'red' : status_color %}
|
||||
|
||||
{% set icon %}
|
||||
{% if profiler_markup_version < 3 %}
|
||||
{{ include('@DoctrineMigrations/Collector/icon.svg') }}
|
||||
{% else %}
|
||||
{{ include('@DoctrineMigrations/Collector/icon-v3.svg') }}
|
||||
{% endif %}
|
||||
|
||||
<span class="sf-toolbar-value">{{ new_migrations + unavailable_migrations }}</span>
|
||||
{% endset %}
|
||||
|
||||
{% set text %}
|
||||
<div class="sf-toolbar-info-group">
|
||||
<div class="sf-toolbar-info-piece">
|
||||
<b>Current Migration</b>
|
||||
<span>{{ executed_migrations > 0 ? collector.data.executed_migrations|last.version|split('\\')|last : 'n/a' }}</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="sf-toolbar-info-group">
|
||||
<div class="sf-toolbar-info-piece">
|
||||
<span class="sf-toolbar-header">
|
||||
<b>Database Migrations</b>
|
||||
</span>
|
||||
</div>
|
||||
<div class="sf-toolbar-info-piece">
|
||||
<b>Executed</b>
|
||||
<span class="sf-toolbar-status">{{ executed_migrations }}</span>
|
||||
</div>
|
||||
<div class="sf-toolbar-info-piece">
|
||||
<b>Unavailable</b>
|
||||
<span class="sf-toolbar-status {{ unavailable_migrations > 0 ? 'sf-toolbar-status-yellow' }}">{{ unavailable_migrations }}</span>
|
||||
</div>
|
||||
<div class="sf-toolbar-info-piece">
|
||||
<b>Available</b>
|
||||
<span class="sf-toolbar-status">{{ available_migrations }}</span>
|
||||
</div>
|
||||
<div class="sf-toolbar-info-piece">
|
||||
<b>New</b>
|
||||
<span class="sf-toolbar-status {{ new_migrations > 0 ? 'sf-toolbar-status-red' }}">{{ new_migrations }}</span>
|
||||
</div>
|
||||
</div>
|
||||
{% endset %}
|
||||
|
||||
{{ include('@WebProfiler/Profiler/toolbar_item.html.twig', { link: profiler_url, status: status_color }) }}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
|
||||
{% block menu %}
|
||||
{% if collector.data.unavailable_migrations_count is defined %}
|
||||
{% set unavailable_migrations = collector.data.unavailable_migrations_count %}
|
||||
{% set new_migrations = collector.data.new_migrations|length %}
|
||||
{% set label = unavailable_migrations > 0 ? 'label-status-warning' : '' %}
|
||||
{% set label = new_migrations > 0 ? 'label-status-error' : label %}
|
||||
<span class="label {{ label }}">
|
||||
<span class="icon">
|
||||
{% if profiler_markup_version < 3 %}
|
||||
{{ include('@DoctrineMigrations/Collector/icon.svg') }}
|
||||
{% else %}
|
||||
{{ include('@DoctrineMigrations/Collector/icon-v3.svg') }}
|
||||
{% endif %}
|
||||
</span>
|
||||
|
||||
<strong>Migrations</strong>
|
||||
{% if unavailable_migrations > 0 or new_migrations > 0 %}
|
||||
<span class="count">
|
||||
<span>{{ new_migrations + unavailable_migrations }}</span>
|
||||
</span>
|
||||
{% endif %}
|
||||
</span>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
|
||||
{% block panel %}
|
||||
{% set num_executed_migrations = collector.data.executed_migrations|length %}
|
||||
{% set num_unavailable_migrations = collector.data.unavailable_migrations_count %}
|
||||
{% set num_available_migrations = collector.data.available_migrations_count %}
|
||||
{% set num_new_migrations = collector.data.new_migrations|length %}
|
||||
|
||||
<h2>Doctrine Migrations</h2>
|
||||
<div class="metrics">
|
||||
<div class="metric">
|
||||
<span class="value">{{ num_executed_migrations }}</span>
|
||||
<span class="label">Executed</span>
|
||||
</div>
|
||||
|
||||
{% if profiler_markup_version >= 3 %}
|
||||
<div class="metric-group">
|
||||
{% endif %}
|
||||
|
||||
<div class="metric">
|
||||
<span class="value">{{ num_unavailable_migrations }}</span>
|
||||
<span class="label">Unavailable</span>
|
||||
</div>
|
||||
<div class="metric">
|
||||
<span class="value">{{ num_available_migrations }}</span>
|
||||
<span class="label">Available</span>
|
||||
</div>
|
||||
<div class="metric">
|
||||
<span class="value">{{ num_new_migrations }}</span>
|
||||
<span class="label">New</span>
|
||||
</div>
|
||||
|
||||
{% if profiler_markup_version >= 3 %}
|
||||
</div> {# closes the <div class="metric-group"> #}
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
<div class="sf-tabs">
|
||||
<div class="tab">
|
||||
<h3 class="tab-title">
|
||||
Migrations
|
||||
<span class="badge {{ num_new_migrations > 0 ? 'status-error' : num_unavailable_migrations > 0 ? 'status-warning' }}">
|
||||
{{ num_new_migrations > 0 ? num_new_migrations : num_unavailable_migrations > 0 ? num_unavailable_migrations : num_executed_migrations }}
|
||||
</span>
|
||||
</h3>
|
||||
|
||||
<div class="tab-content">
|
||||
{{ _self.render_migration_details(collector, profiler_markup_version) }}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="tab">
|
||||
<h3 class="tab-title">Configuration</h3>
|
||||
|
||||
<div class="tab-content">
|
||||
{{ _self.render_configuration_details(collector, profiler_markup_version) }}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endblock %}
|
||||
|
||||
{% macro render_migration_details(collector) %}
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th class="colored font-normal">Version</th>
|
||||
<th class="colored font-normal">Description</th>
|
||||
<th class="colored font-normal">Status</th>
|
||||
<th class="colored font-normal">Executed at</th>
|
||||
<th class="colored font-normal text-right">Execution time</th>
|
||||
</tr>
|
||||
</thead>
|
||||
{% for migration in collector.data.new_migrations %}
|
||||
{{ _self.render_migration(migration) }}
|
||||
{% endfor %}
|
||||
|
||||
{% for migration in collector.data.executed_migrations|reverse %}
|
||||
{{ _self.render_migration(migration) }}
|
||||
{% endfor %}
|
||||
</table>
|
||||
{% endmacro %}
|
||||
|
||||
{% macro render_configuration_details(collector) %}
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th colspan="2" class="colored font-normal">Storage</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<td class="font-normal">Type</td>
|
||||
<td class="font-normal">{{ collector.data.storage }}</td>
|
||||
</tr>
|
||||
{% if collector.data.table is defined %}
|
||||
<tr>
|
||||
<td class="font-normal">Table Name</td>
|
||||
<td class="font-normal">{{ collector.data.table }}</td>
|
||||
</tr>
|
||||
{% endif %}
|
||||
{% if collector.data.column is defined %}
|
||||
<tr>
|
||||
<td class="font-normal">Column Name</td>
|
||||
<td class="font-normal">{{ collector.data.column }}</td>
|
||||
</tr>
|
||||
{% endif %}
|
||||
</table>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th colspan="2" class="colored font-normal">Database</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<td class="font-normal">Driver</td>
|
||||
<td class="font-normal">{{ collector.data.driver }}</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="font-normal">Name</td>
|
||||
<td class="font-normal">{{ collector.data.name }}</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th colspan="2" class="colored font-normal">Migration Namespaces</th>
|
||||
</tr>
|
||||
</thead>
|
||||
{% for namespace, directory in collector.data.namespaces %}
|
||||
<tr>
|
||||
<td class="font-normal">{{ namespace }}</td>
|
||||
<td class="font-normal">{{ directory }}</td>
|
||||
</tr>
|
||||
{% endfor %}
|
||||
</table>
|
||||
{% endmacro %}
|
||||
|
||||
{% macro render_migration(migration, profiler_markup_version) %}
|
||||
<tr>
|
||||
<td class="font-normal">
|
||||
{% if migration.file %}
|
||||
<a href="{{ migration.file|file_link(1) }}" title="{{ migration.file }}">{{ migration.version }}</a>
|
||||
{% else %}
|
||||
{{ migration.version }}
|
||||
{% endif %}
|
||||
</td>
|
||||
<td class="font-normal">{{ migration.description }}</td>
|
||||
<td class="font-normal align-right">
|
||||
{% if migration.is_new %}
|
||||
<span class="{{ profiler_markup_version >= 3 ? 'badge badge-error' : 'label status-error' }}">NOT EXECUTED</span>
|
||||
{% elseif migration.is_unavailable %}
|
||||
<span class="{{ profiler_markup_version >= 3 ? 'badge badge-warning' : 'label status-warning' }}">UNAVAILABLE</span>
|
||||
{% else %}
|
||||
<span class="{{ profiler_markup_version >= 3 ? 'badge badge-success' : 'label status-success' }}">EXECUTED</span>
|
||||
{% endif %}
|
||||
</td>
|
||||
<td class="font-normal">{{ migration.executed_at ? migration.executed_at|date('M j, Y H:i') : 'n/a' }}</td>
|
||||
<td class="font-normal text-right">
|
||||
{% if migration.execution_time is null %}
|
||||
n/a
|
||||
{% elseif migration.execution_time < 1 %}
|
||||
{{ (migration.execution_time * 1000)|number_format(0) }} ms
|
||||
{% else %}
|
||||
{{ migration.execution_time|number_format(2) }} seconds
|
||||
{% endif %}
|
||||
</td>
|
||||
</tr>
|
||||
{% endmacro %}
|
||||
Reference in New Issue
Block a user