sulu/phpcr-migration-bundle

The bundle provides command to migrate the Sulu database from phpCr to the SuluContentBundle.

1.0.0-alpha2 2025-05-02 15:47 UTC

Requires

• php: ^8.1
• jackalope/jackalope-doctrine-dbal: ^1.3.4 || ^2.0
• jackalope/jackalope-jackrabbit: ^1.3 || ^2.0
• symfony/config: ^6.0 | ^7.0
• symfony/console: ^6.0 | ^7.0
• symfony/dependency-injection: ^6.0 | ^7.0
• symfony/framework-bundle: ^6.0 | ^7.0
• symfony/property-access: ^6.0 | ^7.0

Requires (Dev)

• jangregor/phpstan-prophecy: ^1.0
• php-cs-fixer/shim: ^3.62
• phpspec/prophecy-phpunit: ^2.1
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpstan/phpstan-doctrine: ^1.3
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-symfony: ^1.3
• phpstan/phpstan-webmozart-assert: ^1.2
• phpunit/phpunit: ^10.0
• qossmic/deptrac: ^1.0
• rector/rector: ^1.0
• symfony/dotenv: ^6.0 || ^7.0
• thecodingmachine/phpstan-strict-rules: ^1.0

MIT

• Sulu Community

• phpcr
• migration
• sulu
• content-bundle

README

Upgrading Data from Sulu 2.6 to Sulu 3.0

![Note] The upgrade from Sulu 2.6 to Sulu 3.0 is a major upgrade and will require some migration steps.

You can find the full upgrade guide here: sulu/sulu UPGRADE.md

How to install

Install the package:

composer require sulu/phpcr-migration-bundle

Add the new migration bundle to your config/bundles.php:

// config/bundles.php

return [
    // ...
+   Sulu\Bundle\PhpcrMigrationBundle\SuluPhpcrMigrationBundle::class => ['all' => true],

Configure the SuluPhpcrMigrationBundle in config/packages/sulu_phpcr_migration.yaml:

If you are currently using Jackrabbit, use the "jackrabbit://" based DSN string. After the upgrade, Apache Jackrabbit is no longer used by Sulu’s new content storage and can be removed from your projects in most situations.

# config/packages/sulu_phpcr_migration.yaml

sulu_phpcr_migration:
    # dbal://<dbalConnection>?workspace=<workspaceName>
    # jackrabbit://<user>:<password>@<host>:<port>/server?workspace=<workspaceName>
    #    DSN: "dbal://default?workspace=%env(PHPCR_WORKSPACE)%"
    #    DSN: "jackrabbit://admin:admin@127.0.0.1:8080/server?workspace=%env(PHPCR_WORKSPACE)%"
    DSN: "dbal://default?workspace=%env(PHPCR_WORKSPACE)%"
    target:
        dbal:
            connection: default

How to use

# Update the database to the latest phpcr migration to prepare the structure
php bin/adminconsole phpcr:migrations:migrate

# Run the command to migrate for the data
php bin/adminconsole sulu:phpcr-migration:migrate

In case of some errors on customized code, you can try to fix it and rerun the command. The migration command can be rerun, the existing already migrated content will be overwritten and not duplicated.

If you only want to migrate certain document types pass them as an argument (or comma separated if it's a list)

php bin/adminconsole sulu:phpcr-migration:migrate snippet

Allowed types are: snippet, page, article

❤️  Support and Contributions

The Sulu content management system is a community-driven open source project backed by various partner companies. We are committed to a fully transparent development process and highly appreciate any contributions.

In case you have questions, we are happy to welcome you in our official Slack channel. If you found a bug or miss a specific feature, feel free to file a new issue with a respective title and description on the sulu/SuluPHPCRMigrationBundle repository.

📘  License

The Sulu content management system is released under the under terms of the MIT License.