Doctrine Migrations

TDBM integrates well with Symfony, as you are able to use the DoctrineMigrationsBundle.

TDBM provides wrappers around this library for:

Building your database structure with fluid schemas (i.e., $x->foo()->bar()->baz()).
Defining your GraphQL types and their fields.

note

📣 All commands have to be run in the api service (make api).

Create a migration#

console

php bin/console doctrine:migrations:generate

This command will generate a new empty migration in the src/api/migrations folder.

Add a meaningful description:

public function getDescription() : string
{
    return 'Create X, Y and Z tables.';
}

And throw the following exception in the down method:

public function down(Schema $schema) : void
{
    throw new RuntimeException('Never rollback a migration!');
}

You may now update the up method. For instance:

use TheCodingMachine\FluidSchema\TdbmFluidSchema;

public function up(Schema $schema): void
{
    $db = new TdbmFluidSchema($schema);

    $db->table('users')
        ->column('id')->guid()->primaryKey()->comment('@UUID')
        ->column('first_name')->string(255)->notNull()
        ->column('last_name')->string(255)->notNull()
        ->column('email')->string(255)->notNull()->unique()
        ->column('password')->string(255)->null()->default(null)
        ->column('locale')->string(2)->notNull()
        ->column('profile_picture')->string(255)->null()->default(null)
        ->column('role')->string(255)->notNull();

    $db->table('reset_password_tokens')
        ->column('id')->guid()->primaryKey()->comment('@UUID')
        ->column('user_id')->references('users')->notNull()->unique()
        ->column('token')->string(255)->notNull()->unique()
        ->column('valid_until')->datetimeImmutable()->notNull();
}

note

📣 A table name should be plural.

If you're updating an existing table, it would be better to edit the corresponding migration instead of creating a new migration.

note

📣 Do not edit a migration if a remote environment like your production did apply the migration.

Apply migrations#

console

php bin/console doctrine:migrations:migrate -n

This command will apply the new migrations to the database.

note

📣 In development, the api service does it on startup.

If you've edited an existing migration, you'll have to reset the database first:

console

php bin/console doctrine:database:drop -n --force &&
php bin/console doctrine:database:create -n &&
php bin/console doctrine:migrations:migrate -n

note

📣 Reminder: Do not edit a migration if a remote environment like your production did apply the migration.