Upgrading Extension

Harshdeep Gujjar

Modified on: Fri, 21 Oct, 2022 at 11:07 AM

Version 3.x - Compatible with Magento 2.3+

There are two methods to install the Klevu Search extension:

1. Via Composer (recommended):

For Magento 2.3, you will also require the klevu/module-mysqlcompat module if it is not already specified in your composer.json. Prior to 3.1.1 this was a composer dependency in the klevu/module-search module. It has been removed now that Magento 2.3 is EOL. This is not required for Magento 2.4

composer require klevu/module-mysqlcompat

If the website is using Inventory Management (aka MSI), please execute the below composer command to install Klevu MSI compatible module.

composer require klevu/module-msi

Then for all Magento versions, use the following command to upgrade the Klevu extension to the latest version:

composer update "klevu/*"

2. Via Manual Download:

We do not recommend upgrading the Klevu module by manually downloading it and putting it into the app/code directory. Please contact Klevu support if you still wish to use this method to upgrade the module.

Version 2.x - Compatible with Magento 2.1+

For Magento Framework version 2.4 and above, we've introduced a backward compatibility module to our extension, so there are new steps required for installing and upgrading Klevu Search. Please carefully follow the instructions below.

There are two methods to install the Klevu Search extension:

1. Via Composer (recommended):

For Magento Framework version 2.4+, before running composer update, please modify your project composer.json to remove the module we've introduced for backward compatibility. Do not add this 'replace' for Magento 2.3 or lower.

"require": {
    ...
},
"replace": {
    "klevu/module-mysqlcompat": "*"
}

If the website is using Inventory Management (aka MSI), please execute the below composer command to install Klevu MSI compatible module.

composer require klevu/module-msi

Then for all Magento versions, use the following command to upgrade the Klevu extension to the latest version:

composer update "klevu/*"

If you find that composer is trying to install a very old version of Klevu, or errors relating to public vs private repositories, this may be due to a recent Magento update where composer will prefer the Magento Marketplace repository. You can override this by amending your composer.json with an exclude as follows:

"repositories": [
    {
        "type": "composer",
        "url": "https://repo.magento.com/",
        "exclude": ["klevu/*"]
    }
]

2. Via Manual Download:

Troubleshooting

If you encounter issues, ensure that Redis, Opcache (if applicable) are flushed and files are removed from the generated directory before attempting to run setup scripts again.