Skip to content
  • Documentation >
  • API >
  • PHP API >
  • Data migration API

Data migration API

You can use the PHP API to manage and run data migrations.

Getting migration information

To list all migration files available in the directory defined in configuration (by default, src/Migrations/Ibexa), use the MigrationService:listMigrations() method:

1
2
3
        foreach ($this->migrationService->listMigrations() as $migration) {
            $output->writeln($migration->getName());
        }

To get a single migration file by its name, use the MigrationService:findOneByName() method:

1
        $my_migration = $this->migrationService->findOneByName($migration_name);

Running migration files

To run migration file(s), use either MigrationService:executeOne() or MigrationService:executeAll():

1
        $this->migrationService->executeOne($my_migration);

Both executeOne() and executeAll() can take an optional parameter: the login of the User that you want to execute the migrations as.

Adding new migrations

To add a new migration file, use the MigrationService:add() method:

1
2
3
4
5
6
        $this->migrationService->add(
            new Migration(
                'new_migration.yaml',
                $string_with_migration_content
            )
        );