Upgrading to a new version

We use Semantic Versioning for our extension. Our recommendation is to use Composer to update Algolia extension for both Magento Open Source and Adobe Commerce. See Upgrade an extension in the Magento developer documentation for more information.

Upgrade to a new patch version

Patch versions typically include backward-compatible bug fixes. To ensure optimal performance, you should periodically check the releases page and apply patches as soon as possible.

1
composer update algolia/algoliasearch-magento-2

Upgrade to a new major or minor version

Both major and minor version upgrade processes are the same. Specify the version number you are upgrading to.

Here is an example:

1
composer require algolia/algoliasearch-magento-2 "~3.13.0" --update-with-dependencies

You should use tilde constraints, especially if you have customized your search implementation. By doing this, composer update only pulls available patch release updates while allowing you to selectively upgrade to major and minor versions in a controlled environment where you can test the impact of the upgrade on your customizations.

For all upgrades

Updates to the extension may include data or schema patches or new dependencies.

After running Composer, make sure to run the following CLI commands to complete the upgrade.

1
2
3
bin/magento setup:di:compile
bin/magento setup:upgrade
bin/magento setup:static-content:deploy

After upgrading

After updating the extension, save the configuration again even if you didn’t change the settings: go to Stores > Configuration > Algolia Search and click Save Config at the top right.

After saving the configuration, reindex your Magento indices.

Read the extension’s change log for information about the differences between versions and any potential extra steps.

If you’re using the indexing queue, clear it after upgrading the extension, and perform a full reindex. This prevents errors with call_user_func_array() from deleted or renamed job methods.

To clear your indexing queue:

1. Go to Stores > Algolia Search > Indexing Queue and click Clear Queue at the top right

2. To perform a complete reindex, run the following command from the root of your Magento project:

   Shell

   Copy

   1
   php bin/magento indexer:reindex algolia_products algolia_categories algolia_pages algolia_suggestions algolia_additional_sections