Adding a custom indexer

Adding a custom indexer

This topic discusses how to create a custom indexer. We’ve recently made a performance improvment that enables you to declare one or more shared indexers; if one of the shared indexes is already up-to-date, it doesn’t need to be reindexed.

To implement your own indexer, add the following code in your module:

Custom indexer logic

Your custom indexer class should implement \Magento\Framework\Indexer\ActionInterface, and the indexer should be able to perform three types of operations:

  • Row reindex: processing a single entry from a dictionary; responsibility of executeRow($id)
  • List reindex: processing a set of dictionary entries; responsibility of executeList($ids), where $ids is an array of entity IDs
  • Full reindex: processing all entities from a specific dictionary; responsibility of executeFull()

Indexer configuration

In the etc directory of your module, add indexer.xml with the following:

  • indexer ID
  • indexer class name
  • indexer title
  • indexer description
  • indexer view ID
  • shared indexes, if any

Use the optional shared_index= parameter to improve performance if your indexer is related to another indexer. In this example, if catalog rule product needs to be reindexed, but other catalog product rule index is up-to-date, then only catalog rule product is reindexed.

All indexers related to a module should be declared in one file.

MView configuration

Add the mview.xml configuration file in the etc module directory, where you declare the following:

  • indexer view ID
  • indexer class
  • the database tables the indexer tracks
  • what column data is sent to the indexer

Example

All Mview declarations related to a module should be declared in one file.