Magento Indexes
Download as PPTX, PDF31 likes16,332 views
This document discusses Magento indexers and how to create a custom indexer. It begins with an overview of how Magento uses indexers to improve performance. It then defines key indexer concepts like indexed data, indexers, and index processes. It describes the indexer workflow and various indexer entities and events. The document concludes by providing steps to create a custom "featured products" indexer, including defining the indexer in configuration, designing the index data table, implementing the model, resource model, and applying the index on the frontend.
![Implementing ModelMagento Developers Meetupclass Your_Module_Model_Indexer_Featuredextends Mage_Index_Model_Indexer_Abstract{ // … other codeprotected function _registerEvent(Mage_Index_Model_Event $event) { /* @var $entity Mage_Catalog_Model_Product */ $entity = $event->getDataObject(); if ($entity->dataHasChangedFor('is_featured')) { $event->setData('product_id', $entity->getId()); } elseif ($entity->getAttributesData()) { $attributeData = $entity->getAttributesData(); if (isset($attributeData['is_featured'])) { $event->setData('product_ids', $entity->getProductIds()); }}}}Register Event for ProcessingProduct Save RegisteringMass Action Registering](https://image.slidesharecdn.com/magentoindexes-110617101056-phpapp02/85/Magento-Indexes-27-320.jpg)
Magento Indexes
- 1. Magento IndexersIvan ChepurnyiMagento Trainer / Lead Developer
- 2. AgendaMagento Developers MeetupOverview of Indexes FunctionalityCreation of own indexes
- 3. Let Imagine…Magento Developers Meetup… that Magento doesn’t have indexes:The prices in product list are calculated on the fly depending on catalog rules, tier prices for customer groupsStock availability for configurable and bundle products can be calculated only after loading the product collectionLayered navigation data is build in real-time for product attributes informationAnchor categories recursively collects subcategories for filtering product list
- 4. It’s all about performance…Magento Developers MeetupThe main goal is minimizing amount of operations to display products to a customer
- 5. DefinitionsMagento Developers MeetupIndexed DataAggregated data for entity representation on the frontend lists.Indexer Generates index data on event or manual by process.Index EventThe moment when entity or related to it information is changed and that affects its index data.Index ProcessWrapper for indexer and contains information about its mode and statusMain Controller Forwards events to Index Process
- 6. Index WorkflowMagento Developers MeetupEventMain ControllerEventEventsProcessManualInvokeIndexerIndexed Data
- 7. Event TypesMagento Developers MeetupSave When indexed entity or related to it information was changedDeleteWhen indexed entity or related to it one was deletedMass UpdateWhen batch of entities was updated. (Update Attributes on Product Grid)
- 8. Observed Entities Magento Developers MeetupIndexed EntitiesProductProduct InventoryCategoryTagEntities ScopeCustomer GroupWebsiteStore GroupStore View
- 9. Index ProcessMagento Developers MeetupAvailable StatusesPending Indicates that indexer is up to dateRunning Index currently in process of full rebuilding index data.Require ReindexStatus for notifying admin user, that index is not up to date and should be rebuild.
- 10. Index ProcessMagento Developers MeetupIndexing ModesReal-timeManualUpdate Index DataEventEventRequire Reindex
- 11. Indexer Flow Magento Developers MeetupMatch EventMain ControllerIndex ProcessRegister Event DataReindex Data
- 12. Mage_Index ModuleMagento Developers MeetupMain ControllerMage_Index_Model_IndexerProcessMage_Index_Model_ProcessIndexer BaseMage_Index_Model_Indexer_Abstract
- 13. Index ModuleIndexers ModularityMagento Developers MeetupMage_Index_Model_Indexer_AbstractCatalog ModuleMage_Catalog_Model_Product_Indexer_EavMage_Catalog_Model_Product_Indexer_FlatMage_Catalog_Model_Product_Indexer_PriceInventory ModuleMage_CatalogIndex_Model_Indexer_Stock…
- 14. ModelMage_Index_Model_Indexer_AbstractIndexer StructureMagento Developers MeetupResource ModelMage_Index_Model_Mysql4_AbstractMatches event data and runs appropriate method in resource model for re-indexingWorks directly with database for generation of the indexed data. Usually all the data operated via MySQL queries.
- 15. What can you use?Magento Developers MeetupMage_Index_Model_IndexergetProcessByCode($indexerCode)getProcessCollection()processEntityAction($entity, $entityType, $eventType)Mage_Index_Model_ProcessreindexAll()reindexEverything()setMode($mode)
- 16. What you shouldn’t do…Magento Developers MeetupInvoke reindexAll method from index model/resource model, because it is better to let admin user know when the index was rebuild.Process entity events directly with indexer, instead of passing data through the main controller. You never know which index may depend on this event.
- 17. Creating own indexerMagento Developers MeetupDefining indexer in configurationDesigning index data tableImplementing model Implementing resource modelApplying index on the frontend
- 18. Featured ProductsMagento Developers MeetupThere is easier way to create featured products functionality, but it is a simple example on what should be done for creation own indexer.
- 19. Defining index in configurationMagento Developers Meetup<config><!-- …. module configurtaions --> <global> <!-- …. module configurtaions --> <index><indexer> <featured_products> <model>your_module/indexer_featured</model> </featured_products> </indexer> </index> </global></config>etc/config.xmlIndexer Code Indexer Model
- 20. Designing index data tableMagento Developers MeetupAdding new attribute to catalog product entity called is_featuredCreating table that will contain product ids of products that are marked as featured products.
- 21. Designing index data tableMagento Developers Meetup$this->addAttribute('catalog_product', 'is_featured', array( 'type' => 'int', 'label' => 'Is featured', 'input' => 'select', 'source' => 'eav/entity_attribute_source_boolean', 'user_defined' => false, 'required' => false));Setup ScriptAttribute Code Yes/No Dropdown
- 22. Designing index data tableMagento Developers Meetup$table = new Varien_Db_Ddl_Table();$table->setName($this->getTable(‘module/featured'));$table->addColumn('product_id', Varien_Db_Ddl_Table::TYPE_INTEGER, 11, array( 'unsigned' => true, 'nullable' => false, 'primary' => true));$this->getConnection()->createTable($table);Setup ScriptTable AliasTable Column
- 23. Designing index data tableMagento Developers Meetup$table = new Varien_Db_Ddl_Table();$table->setName($this->getTable(‘module/featured'));$table->addColumn('product_id', Varien_Db_Ddl_Table::TYPE_INTEGER, 11, array( 'unsigned' => true, 'nullable' => false, 'primary' => true));$this->getConnection()->createTable($table);Setup ScriptTable AliasTable Column
- 24. Implementing ModelMagento Developers Meetupclass Your_Module_Model_Indexer_Featuredextends Mage_Index_Model_Indexer_Abstract{ protected $_matchedEntities = array(Mage_Catalog_Model_Product::ENTITY => array(Mage_Index_Model_Event::TYPE_SAVE, Mage_Index_Model_Event::TYPE_MASS_ACTION ));}Defining Matching EventsEntity TypeEvent TypeEvent Types
- 25. Implementing ModelMagento Developers Meetupclass Your_Module_Model_Indexer_Featuredextends Mage_Index_Model_Indexer_Abstract{// … other codeprotected function _construct() { $this->_init(‘your_module/indexer_featured'); }}Defining Indexer Resource ModelResource model
- 26. Implementing ModelMagento Developers Meetupclass Your_Module_Model_Indexer_Featuredextends Mage_Index_Model_Indexer_Abstract{ // … other codepublic function getName() { return Mage::helper(‘your_module')->__('Featured Product'); } public function getDescription() { return Mage::helper(‘‘your_module')->__('Indexes something');}}Defining Indexer InformationIndexer Name in the adminIndexer Description in the admin
- 27. Implementing ModelMagento Developers Meetupclass Your_Module_Model_Indexer_Featuredextends Mage_Index_Model_Indexer_Abstract{ // … other codeprotected function _registerEvent(Mage_Index_Model_Event $event) { /* @var $entity Mage_Catalog_Model_Product */ $entity = $event->getDataObject(); if ($entity->dataHasChangedFor('is_featured')) { $event->setData('product_id', $entity->getId()); } elseif ($entity->getAttributesData()) { $attributeData = $entity->getAttributesData(); if (isset($attributeData['is_featured'])) { $event->setData('product_ids', $entity->getProductIds()); }}}}Register Event for ProcessingProduct Save RegisteringMass Action Registering
- 28. Implementing ModelMagento Developers Meetupclass Your_Module_Model_Indexer_Featuredextends Mage_Index_Model_Indexer_Abstract{ // … other code protected function _processEvent(Mage_Index_Model_Event $event) { if ($event->getData('product_id') || $event->getData('product_ids')) { $this->callEventHandler($event); }}}Processing EventCalling processor in resource modelEntity TypeEvent TypecatalogProductSave($event)catalogProductMassAction($event)
- 29. Implementing Resource ModelMagento Developers Meetupclass Your_Module_Model_Mysql4_Indexer_Featured extends Mage_Index_Model_Mysql4_Abstract{ protected function _construct() { $this->_setResource(‘your_module'); }}Define resource connectionYour module resource prefix
- 30. Implementing Resource ModelMagento Developers Meetupclass Your_Module_Model_Mysql4_Indexer_Featured extends Mage_Index_Model_Mysql4_Abstract{ // … other code protected function _reindexEntity($productId = null) { $select = $this->_getReadAdapter()->select(); /* @var $attribute Mage_Catalog_Model_Resource_Eav_Attribute */ $attribute = Mage::getSingleton('eav/config') ->getAttribute('catalog_product', 'is_featured'); $select->from($attribute->getBackendTable(), 'entity_id') ->where('value = ?', 1) ->where('attribute_id = ?', $attribute->getId());Indexing MethodRetrieving only featured product ids
- 31. Implementing Resource ModelMagento Developers Meetupif ($productId !== null) { if (!is_array($productId)) { $productId = array($productId); } $select->where('entity_id IN(?)', $productId); $this->_getWriteAdapter()->delete( $this->getTable(‘your_module/featured'), array( 'product_id IN(?)' => $productId ) ); } else { $this->_getWriteAdapter()->truncate($this->getTable(‘your_module/featured')); }Indexing MethodIf it is partial re-index, then delete only related indexed dataOtherwise clear all indexed data
- 32. Implementing Resource ModelMagento Developers Meetup$sqlStatement = $select->insertIgnoreFromSelect( $this->getTable(‘your_module/featured'), array('product_id') ); $this->_getWriteAdapter()->query($sqlStatement); }}Fulfill index data from select we created beforeIndexing Method
- 33. Implementing Resource ModelMagento Developers Meetupclass Your_Module_Model_Mysql4_Indexer_Featured extends Mage_Index_Model_Mysql4_Abstract{ // … other code public function reindexAll() { $this->_reindexEntity(); }}Handling EventsFull index re-build
- 34. Implementing Resource ModelMagento Developers Meetupclass Your_Module_Model_Mysql4_Indexer_Featured extends Mage_Index_Model_Mysql4_Abstract{ // … other codepublic function catalogProductSave($event) { $this->_reindexEntity($event->getData('product_id')); }public function catalogProductMassAction($event) { $this->_reindexEntity($event->getData('product_ids')); }}Reindexing EventsSingle Save Product EventMass Save Product Event
- 35. Applying Index for the frontendMagento Developers MeetupObserving and event catalog_product_collection_apply_limitations_afterJoining index table to product collection selectCreate sub-select filter for collection
- 36. Liked it?Magento Developers MeetupCheckout our advanced training programs:http://www.ecomdev.org/magento-development-training-programs/advancedFollow our blog posts:http://www.ecomdev.org/blog
- 37. Questions?