Question 40178 in PHP Question posted in
Official manual can be found here.

Symfony Migrations Bundle creating the same migration over and over again – PHP

I added an auto-update timestamp to an entity like in this blog post and it works just fine.

Here is the code snippet:

#[Entity]
class Article
{
    #[Column(type: "datetime",
        columnDefinition: "TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP",
        insertable: false,
        updatable: false,
        generated: "ALWAYS")]
    public $created;
}

The first time I run php bin/console make:migration the correct migration is generated:

$this->addSql('ALTER TABLE article ADD created TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP');

This works just fine and any DB update now updates created. However, this is also where the problems begin. Whenever I make another migration now, it tries to apply the same changes again:

$this->addSql('ALTER TABLE article CHANGE created created TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP');

How can this be, and does anyone know how to fix this?

Thank you very much for your input, I really appreciate it.

Tags:

2

Answers


  1. Chosen as BEST ANSWER
    0

    So I didn't figure out why this happens. But the solution to this problem is to check if the property in question already exists, and then ignore it when diffing: https://www.liip.ch/en/blog/doctrine-and-generated-columns

    Edit:

    So, the classes used in the blog article above are deprecated and I had to dig a little deeper into Doctrine on how to exclude specific table columns.

    I performed the following steps, and it works like a charm:

    • Read the official documentation on schema managers: https://www.doctrine-project.org/projects/doctrine-dbal/en/current/reference/schema-manager.html
    • Implement a custom SchemaManagerFactory
    • Implement a custom custom MySQLSchemaManager (at least if you use MySQL, that is)
    • Make the schema manager use a custom Comparator
    • Add schema_manager_factory: doctrine.dbal.default_schema_manager_factory to my entries in connections in doctrine.yaml
    • Alias doctrine.dbal.default_schema_manager_factory in services.yaml

    Here is some example code to make this more clear.

    doctrine:
    dbal:
        default_connection: default
        connections:
            default:
                server_version: 8.0.25
                schema_manager_factory: doctrine.dbal.default_schema_manager_factory

    services:
    doctrine.dbal.default_schema_manager_factory:
        class: AppServiceDoctrineCustomSchemaManagerFactory

    <?php

namespace AppServiceDoctrine;

use DoctrineDBALConnection;
use DoctrineDBALException;
use DoctrineDBALPlatformsMySQL80Platform;
use DoctrineDBALSchemaAbstractSchemaManager;
use DoctrineDBALSchemaDefaultSchemaManagerFactory;
use DoctrineDBALSchemaSchemaManagerFactory;

final class CustomSchemaManagerFactory implements SchemaManagerFactory
{
    private readonly SchemaManagerFactory $defaultFactory;

    public function __construct()
    {
        $this->defaultFactory = new DefaultSchemaManagerFactory();
    }

    /**
     * @throws Exception
     */
    public function createSchemaManager(Connection $connection): AbstractSchemaManager
    {
        $platform = $connection->getDatabasePlatform();
        if ($platform instanceof MySQL80Platform) {
            return new CustomMySQLSchemaManager($connection, $platform);
        }

        return $this->defaultFactory->createSchemaManager($connection);
    }
}

    <?php

namespace AppServiceDoctrine;

use DoctrineDBALPlatformsMySQLCollationMetadataProviderCachingCollationMetadataProvider;
use DoctrineDBALPlatformsMySQLCollationMetadataProviderConnectionCollationMetadataProvider;
use DoctrineDBALSchemaComparator;
use DoctrineDBALSchemaMySQLSchemaManager;

final class CustomMySQLSchemaManager extends MySQLSchemaManager
{
    public function createComparator(): Comparator
    {
        return new CustomComparator(
            $this->_platform,
            new CachingCollationMetadataProvider(
                new ConnectionCollationMetadataProvider($this->_conn),
            ),
        );
    }
}

    <?php

namespace AppServiceDoctrine;

use DoctrineDBALPlatformsMySQLComparator;
use DoctrineDBALSchemaTable;
use DoctrineDBALSchemaTableDiff;

final class CustomComparator extends Comparator
{
    public function compareTables(Table $fromTable, Table $toTable): TableDiff
    {
        $diff = parent::compareTables($fromTable, $toTable);
        
        # Your custom logic here!

        return $diff;
    }
}

  2. 0

    Doctrine sees that your actual column has a default value while none is defined in its mapping’s options (ignoring your columnDefinition). Thus, it decides it needs to generate an ALTER migration, and when doing so it does take into account your columnDefinition.

    Set options: ["default" => "CURRENT_TIMESTAMP"] in the column attributes:

    #[Entity]
class Article
{
    #[Column(type: "datetime",
        columnDefinition: "TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP",
        insertable: false,
        updatable: false,
        generated: "ALWAYS",
        options: ["default" => "CURRENT_TIMESTAMP"])]
    public $created;
}

    Alternatively, if you’re only changing entries in this table through Doctrine, you can use Doctrine lifecycle events to keep created/updated timestamp fields up-to-date.

    Login or Signup to reply.
Please signup or login to give your own answer.

Back To Top
Search