Upgrade and remove

For arlanix/product-feed 1.0.0

Upgrade and remove

This page is for the developer who looks after a store with Arlanix Product Feed installed. It covers moving to a new version and taking the modules out. To install them, see Install.

Upgrade to a new version

Each module lists its changes in CHANGELOG.md, in its package: vendor/arlanix/module-feed/CHANGELOG.md and the others under vendor/arlanix/. Read them for the versions between yours and the new one before you deploy. A change that needs something of you, such as a renamed class your own code extends, says so there.

  1. Update the packages. To move to the newest version your composer.json allows, run the following in the Magento root:

    composer update arlanix/product-feed --with-dependencies
    

    To move past what it allows, require the version instead:

    composer require arlanix/product-feed:VERSION
    

    Replace VERSION with the version to install, such as 1.1.0.

  2. Upgrade the installation:

    bin/magento setup:upgrade
    bin/magento setup:di:compile
    bin/magento setup:static-content:deploy -f
    bin/magento cache:flush
    

    In developer mode the setup:di:compile and setup:static-content:deploy lines can be left out.

  3. Check that the feeds deliver. In Arlanix → Feeds, each row's Last delivery shows a new time after the feed's next run.

When the new version changes what the catalogue holds, Magento's indexer cron builds it again after the upgrade, and no feed is delivered until it is done. Meanwhile, Last delivery says Catalogue: being built. To build it at once, run bin/magento indexer:reindex arlanix_feed_product; see The indexers.

An upgrade leaves the indexers' modes as they were, and keeps every feed, dictionary, connection and setting.

The support bundle's Arlanix modules and versions item lists the version of each module, for checking what a store runs without SSH; see Support bundle.

Remove the modules

The modules have no uninstall script: removing them leaves their data in the database, and what they delivered where it went. Back up the database first.

  1. Put the indexers on Update on Save, so that Magento removes their database triggers:

    bin/magento indexer:set-mode realtime arlanix_feed_product arlanix_feed_category arlanix_feed_inventory
    

    Leave out arlanix_feed_inventory if Arlanix_FeedInventory is already disabled. A module disabled with its indexers on schedule leaves the triggers in the product tables, writing to changelog tables nothing reads.

  2. Disable the modules:

    bin/magento module:disable Arlanix_FeedInventory Arlanix_FeedSftp Arlanix_FeedGoogleMerchant Arlanix_Feed Arlanix_Core
    

    Leave out Arlanix_Core if the store has other Arlanix modules: they share it.

  3. Remove the packages and upgrade the installation:

    composer remove arlanix/product-feed
    bin/magento setup:upgrade
    bin/magento setup:di:compile
    bin/magento cache:flush
    

    If you installed single packages rather than the metapackage, remove those: composer remove arlanix/module-feed ….

What stays behind

The following stay until you remove them:

  • The database tables: arlanix_feed and the tables whose names start with arlanix_feed_ or arlanix_gmc_, the indexers' changelog tables among them. Drop them by hand to remove the feeds, dictionaries, connections and run history.
  • The settings: rows in core_config_data whose path starts with arlanix_feed/, arlanix_feed_sftp/, arlanix_feed_google_merchant/ or arlanix_logging/, and any you set in app/etc/env.php.
  • The published files, in pub/media/arlanix/feeds/. A platform that fetches a feed keeps reading the last file until it is deleted, so delete the files, or remove the feeds from the platforms, first.
  • What was delivered elsewhere: the files on SFTP servers, and in Google Merchant Center the data sources the module created and the products it sent. Delete them there.
  • The log, var/log/arlanix.log.