{"id":378621,"date":"2023-04-27T10:27:33","date_gmt":"2023-04-27T10:27:33","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=378621"},"modified":"2026-01-07T05:13:55","modified_gmt":"2026-01-07T05:13:55","slug":"how-to-create-custom-indexer-in-magento","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/how-to-create-custom-indexer-in-magento\/","title":{"rendered":"How to create custom indexer in magento 2"},"content":{"rendered":"\n

Create a custom indexer in Magento 2<\/strong> when you need precomputed data for fast storefront reads.
In this guide, you\u2019ll learn why, when, and how to implement a robust indexer step-by-step.<\/p>\n\n\n\n

Why create a custom indexer?<\/strong><\/p>\n\n\n\n

First, an indexer<\/a> precomputes expensive queries so pages load quickly.
Therefore, it avoids heavy joins and runtime aggregations on each request.<\/p>\n\n\n\n

For example, a marketplace needs the lowest vendor price<\/strong> per product ready to read.
As a result, the category page queries a small index table instead of aggregating many rows.<\/p>\n\n\n\n

When should you build an indexer?<\/strong><\/p>\n\n\n\n

Create one when runtime calculations noticeably slow pages or APIs.
For instance, use an indexer for custom ranking, aggregated metrics, or multi-source pricing.<\/p>\n\n\n\n

However, avoid indexers for trivial values that are cheap to compute on demand.
Instead, weigh complexity versus performance benefits before adding one.<\/p>\n\n\n\n

High-level components (what you must provide)<\/strong><\/p>\n\n\n\n

First, declare the indexer in etc\/indexer.xml<\/code>.
Next, configure change-tracking in etc\/mview.xml<\/code> for schedule mode.<\/p>\n\n\n\n

Then, implement an indexer class with full and incremental methods.
Finally, optionally add observers to call reindexRow()<\/code> on model saves.<\/p>\n\n\n\n

etc\/indexer.xml<\/strong><\/em><\/code><\/p>\n\n\n\n

This file registers the indexer ID and processor class.<\/p>\n\n\n\n

<?xml version="1.0"?>\n<config xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Indexer\/etc\/indexer.xsd">\n<indexer id="vendor_price_indexer"\n         view_id="vendor_price_indexer_view"\n         class="Vendor\\PriceIndexer\\Model\\Indexer\\PriceIndexer">\n    <title>Custom Indexer<\/title>\n    <description>Custom Indexer<\/description>\n<\/indexer>\n<\/config><\/pre>\n\n\n\n
Note: view_id<\/em><\/code> links the indexer to the mview subscription.
Moreover, Magento uses this declaration to show the indexer in admin.<\/p>\n\n\n\n
etc\/mview.xml<\/strong><\/em><\/code><\/p>\n\n\n\n
Use mview.xml<\/em><\/code> to subscribe to tables for change detection.<\/p>\n\n\n\n
<?xml version="1.0"?>\n<config xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Mview\/etc\/mview.xsd">\n<view id="vendor_price_indexer_view" class="Vendor\\PriceIndexer\\Model\\Indexer\\PriceIndexer" group="indexer">\n    <subscriptions>\n        <table name="vendor_prices" entity_column="entity_id" \/>\n    <\/subscriptions>\n<\/view>\n<\/config><\/pre>\n\n\n\n
Therefore, changes to those tables are captured in the changelog for scheduled processing.
Consequently, cron + MView will call your execute()<\/em><\/code> periodically.<\/p>\n\n\n\n
Indexer class responsibilities (interfaces & methods)<\/strong><\/p>\n\n\n\n
Your indexer must implement \\Magento\\Framework\\Indexer\\ActionInterface<\/em><\/code>.
Also implement \\Magento\\Framework\\Mview\\ActionInterface<\/em><\/code> to support schedule mode.<\/p>\n\n\n\n
You must provide these methods:<\/p>\n\n\n\n