Skip to content

Update from v4.4.x to v4.5

This update procedure applies if you are using a v4.4 installation.

Update from v4.4.x to v4.4.latest

Before you update to v4.5, you need to go through the following steps to update to the latest maintenance release of v4.4 (v4.4.4).

Update the application to v4.4.latest

Run:

1
composer require ibexa/content:4.4.4 --with-all-dependencies --no-scripts
1
composer require ibexa/experience:4.4.4 --with-all-dependencies --no-scripts
1
composer require ibexa/commerce:4.4.4 --with-all-dependencies --no-scripts

Update from v4.4.latest to v4.5

When you have the latest version of v4.4, you can update to v4.5.

Update the application

First, run:

1
2
composer require ibexa/content:4.5.5 --with-all-dependencies --no-scripts
composer recipes:install ibexa/content --force -v
1
2
composer require ibexa/experience:4.5.5 --with-all-dependencies --no-scripts
composer recipes:install ibexa/experience --force -v
1
2
composer require ibexa/commerce:4.5.5 --with-all-dependencies --no-scripts
composer recipes:install ibexa/commerce --force -v

The recipes:install command installs new YAML configuration files. Review the old YAML files and move your custom configuration to the relevant new files.

Define measurement base unit in configuration

If your installation has defined measurement units in the configuration, you need to specify one of them as base unit in the config/packages/ibexa_measurement.yaml file:

1
2
3
4
ibexa_measurement:
    types:
        my_type:
            my_unit: { symbol: my, is_base_unit: true }

Next, add unit conversion to src/bundle/Resources/config/services/conversion.yaml. For more information, see Modify and add Measurement types and units.

Update the database

Next, update the database:

Caution

Always back up your data before running any database update scripts.

After updating the database, clear the cache.

Do not use --force argument for mysql / psql commands when performing update queries. If there is any problem during the update, it is best if the query fails immediately, so you can fix the underlying problem before you execute the update again. If you leave this for later you risk ending up with an incompatible database, though the problems might not surface immediately.

Apply the following database update scripts:

1
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-4.4.latest-to-4.5.0.sql
1
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-4.4.latest-to-4.5.0.sql

Migrate richtext namespaces

If you earlier upgraded from v3.3 to v4.x and haven't run the migrate script yet, do it now, run:

1
php bin/console ibexa:migrate:richtext-namespaces

Ibexa Open Source

If you have no access to Ibexa DXP's ibexa/installer package, apply the following database update:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
CREATE TABLE ibexa_token_type
(
    id int(11) NOT NULL AUTO_INCREMENT,
    identifier varchar(64) NOT NULL,
    PRIMARY KEY (id),
    UNIQUE KEY ibexa_token_type_unique (identifier)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;

CREATE TABLE ibexa_token
(
    id int(11) NOT NULL AUTO_INCREMENT,
    type_id int(11) NOT NULL,
    token varchar(255) NOT NULL,
    identifier varchar(128) DEFAULT NULL,
    created int(11) NOT NULL DEFAULT 0,
    expires int(11) NOT NULL DEFAULT 0,
    PRIMARY KEY (id),
    UNIQUE KEY ibexa_token_unique (token,identifier,type_id),
    CONSTRAINT ibexa_token_type_id_fk
        FOREIGN KEY (type_id) REFERENCES ibexa_token_type (id)
            ON DELETE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
CREATE TABLE ibexa_token_type
(
    id serial PRIMARY KEY,
    identifier varchar(64) NOT NULL
);

CREATE TABLE ibexa_token
(
    id serial PRIMARY KEY,
    type_id int NOT NULL
        CONSTRAINT ibexa_token_type_id_fk
            REFERENCES ibexa_token_type (id)
            ON DELETE CASCADE,
    token varchar(255) NOT NULL,
    identifier varchar(128) DEFAULT NULL,
    created int NOT NULL DEFAULT 0,
    expires int NOT NULL DEFAULT 0
);

Clean-up taxonomy database

If you didn't run it already when migrating from 4.2 to 4.3, run the following command for each of your taxonomies to ensure that there are no Content items orphaned during deletion of subtrees inherited from the earlier version's database:

php bin/console ibexa:taxonomy:remove-orphaned-content <taxonomy> --force

For example:

1
2
php bin/console ibexa:taxonomy:remove-orphaned-content tags --force
php bin/console ibexa:taxonomy:remove-orphaned-content product_categories --force

Finish code update

Finish the code update by running:

1
composer run post-install-cmd

Run data migration

If you are using Ibexa Experience or Ibexa Commerce, you can now run data migration required by the Customer Portal and Commerce features to finish the update process:

  • Customer Portal
1
2
php bin/console ibexa:migrations:import vendor/ibexa/corporate-account/src/bundle/Resources/migrations/customer_portal.yaml --name=2023_03_06_13_00_customer_portal.yaml
php bin/console ibexa:migrations:migrate --file=2023_03_06_13_00_customer_portal.yaml
  • Corporate access role update
1
2
php bin/console ibexa:migrations:import vendor/ibexa/corporate-account/src/bundle/Resources/migrations/2023_05_09_12_40_corporate_access_role_update.yaml --name=2023_05_09_12_40_corporate_access_role_update.yaml
php bin/console ibexa:migrations:migrate --file=2023_05_09_12_40_corporate_access_role_update.yaml
  • Corporate account

This migration allows all company members to shop in the frontend shop. If you have implemented business logic that depends on keeping company members out of the frontend shop, you can skip it:

1
2
php bin/console ibexa:migrations:import vendor/ibexa/storefront/src/bundle/Resources/migrations/2023_04_27_10_30_corporate_account.yaml --name=2023_04_27_10_30_corporate_account.yaml
php bin/console ibexa:migrations:migrate --file=2023_04_27_10_30_corporate_account.yaml
  • Storefront user update
1
2
php bin/console ibexa:migrations:import vendor/ibexa/storefront/src/bundle/Resources/migrations/2023_04_27_11_20_storefront_user_role_update.yaml --name=2023_04_27_11_20_storefront_user_role_update.yaml
php bin/console ibexa:migrations:migrate --file=2023_04_27_11_20_storefront_user_role_update.yaml
  • Shipment permissions
1
2
php bin/console ibexa:migrations:import vendor/ibexa/shipping/src/bundle/Resources/install/migrations/shipment_permissions.yaml --name=shipment_permissions.yaml
php bin/console ibexa:migrations:migrate --file=shipment_permissions.yaml
  • Order permissions
1
2
php bin/console ibexa:migrations:import vendor/ibexa/order-management/src/bundle/Resources/install/migrations/order_permissions.yaml --name=order_permissions.yaml
php bin/console ibexa:migrations:migrate --file=order_permissions.yaml

v4.5.2

Database update

Run the following scripts:

1
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-4.5.1-to-4.5.2.sql
1
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-4.5.1-to-4.5.2.sql

v4.5.3

Database update

Run the following scripts:

1
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-4.5.2-to-4.5.3.sql
1
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-4.5.2-to-4.5.3.sql

v4.5.4

Database update

Run the following scripts:

1
mysql -u <username> -p <password> <database_name> < vendor/ibexa/installer/upgrade/db/mysql/ibexa-4.5.3-to-4.5.4.sql
1
psql <database_name> < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-4.5.3-to-4.5.4.sql