Custom Indexers — Creating Your Own Indexer

Indexer.xml Configuration

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:framework:Indexer/etc/indexer.xsd">
    <indexer id="vendor_product_enrichment"
             class="Vendor\Module\Model\Indexer\ProductEnrichment"
             productType="catalog_product"
             label="Product Enrichment Index"
             description="Custom index for product enrichment data"/>
</config>

Indexer Class

namespace Vendor\Module\Model\Indexer;

use Magento\Framework\Indexer\ActionInterface;
use Magento\Framework\Indexer\IndexerRegistry;

class ProductEnrichment implements ActionInterface
{
    public function __construct(
        private IndexerRegistry $indexerRegistry,
        private DataProvider $dataProvider,
        private IndexWriter $indexWriter
    ) {}

    public function executeFull()
    {
        $this->indexWriter->clearIndex();
        $items = $this->dataProvider->getAllItems();
        foreach ($items as $item) {
            $this->indexRow($item->getId());
        }
    }

    public function executeList(array $ids)
    {
        foreach ($ids as $id) {
            $this->indexRow($id);
        }
    }

    public function executeRow($id)
    {
        $data = $this->dataProvider->getItemData($id);
        $this->indexWriter->saveIndex($id, $data);
    }
}

Indexer Interface Methods

Data Provider Class

namespace Vendor\Module\Model\Indexer;

use Magento\Framework\DB\Select;

class DataProvider
{
    public function __construct(
        private \Magento\Framework\App\ResourceConnection $resource
    ) {}

    public function getAllItems(): array
    {
        $connection = $resource->getConnection();
        $select = $connection->select()->from('catalog_product_entity');
        return $connection->fetchAll($select);
    }

    public function getItemData(int $id): array
    {
        $connection = $resource->getConnection();
        $select = $connection->select()
            ->from('catalog_product_entity')
            ->where('entity_id = ?', $id);
        return $connection->fetchRow($select);
    }

    public function getItemsByIds(array $ids): array
    {
        $connection = $resource->getConnection();
        $select = $connection->select()
            ->from('catalog_product_entity')
            ->where('entity_id IN (?)', $ids);
        return $connection->fetchAll($select);
    }
}

EAV Data Provider

namespace Vendor\Module\Model\Indexer;

class EavDataProvider
{
    public function getItemData(int $id): array
    {
        $product = $this->productFactory->create()->load($id);
        return [
            'entity_id' => $product->getId(),
            'sku' => $product->getSku(),
            'name' => $product->getName(),
            'price' => $product->getPrice(),
            'custom_data' => $this->computeCustomData($product)
        ];
    }
}

Index Writer

namespace Vendor\Module\Model\Indexer;

class IndexWriter
{
    public function __construct(
        private \Magento\Framework\App\ResourceConnection $resource
    ) {}

    public function clearIndex(): void
    {
        $connection = $resource->getConnection();
        $connection->truncateTable('vendor_product_enrichment_index');
    }

    public function saveIndex(int $id, array $data): void
    {
        $connection = $resource->getConnection();
        $connection->insertOnDuplicate(
            'vendor_product_enrichment_index',
            array_merge(['entity_id' => $id], $data)
        );
    }

    public function deleteIndex(int $id): void
    {
        $connection = $resource->getConnection();
        $connection->delete(
            'vendor_product_enrichment_index',
            ['entity_id = ?' => $id]
        );
    }
}

Index Table Schema

<!-- db_schema.xml -->
<table name="vendor_product_enrichment_index" resource="default" engine="innodb">
    <column xsi:type="int" name="entity_id" padding="10" unsigned="true" nullable="false"/>
    <column xsi:type="varchar" name="sku" nullable="false" length="255"/>
    <column xsi:type="varchar" name="enriched_name" nullable="true" length="500"/>
    <column xsi:type="decimal" name="computed_price" scale="4" precision="12" unsigned="false" nullable="true"/>
    <constraint xsi:type="primary" referenceId="PRIMARY">
        <column name="entity_id"/>
    </constraint>
</table>

CLI Testing

# Check indexer appears
php bin/magento indexer:info

# Check status
php bin/magento indexer:status vendor_product_enrichment

# Full reindex
php bin/magento indexer:reindex vendor_product_enrichment

# Partial reindex
php bin/magento indexer:reindex vendor_product_enrichment 101 102

Unit Test

namespace Vendor\Module\Test\Unit\Model\Indexer;

use PHPUnit\Framework\TestCase;
use Vendor\Module\Model\Indexer\ProductEnrichment;

class ProductEnrichmentTest extends TestCase
{
    public function testExecuteRow(): void
    {
        $indexer = $this->createMock(ProductEnrichment::class);
        $indexer->expects($this->once())
            ->method('executeRow')
            ->with(101);
        
        $indexer->executeRow(101);
    }
}

Integration Test

namespace Vendor\Module\Test\Integration\Model\Indexer;

use Magento\TestFramework\Helper\Bootstrap;

class ProductEnrichmentTest extends TestCase
{
    public function testFullReindex(): void
    {
        $indexer = Bootstrap::getObjectManager()
            ->get(\Magento\Framework\Indexer\IndexerRegistry::class)
            ->get('vendor_product_enrichment');
        
        $indexer->reindexFull();
        
        $this->assertEquals('valid', $indexer->getState()->getStatus());
    }
}

Debug Commands

# Check index data
mysql -u root -p -e "SELECT COUNT(*) FROM vendor_product_enrichment_index;"

# Check indexer state
mysql -u root -p -e "SELECT * FROM indexer_state WHERE indexer_id = 'vendor_product_enrichment';"

# Reset indexer
php bin/magento indexer:reset vendor_product_enrichment