Working with EAV data storage in Magento 2: Part 2

How EAV Data Storage Works in Magento 2: Part 2

There is not much difference for a developer in EAV and Flat collections. The creation of models, resource models and collections is very similar. Let’s describe the key differences between EAV and flat table collections and consider creating classes for EAV (City) and Flat (Country). This is Part 2 of the EAV data storage review, check out Part 1 to catch up on the topic.

Collections
Resource models
Models
The differences between EAV and FLAT classes
When to use EAV for a new entity
The pros and cons of EAV architecture

Collections

EAV

<?php
namespace Belvg\Geo\Model\ResourceModel\City;
class Collection extends \Magento\Eav\Model\Entity\Collection\AbstractCollection
{
   protected function _construct()
   {
       $this->_init(
           'Belvg\Geo\Model\City',
           'Belvg\Geo\Model\ResourceModel\City'
       );
   }
}

<?php

namespace Belvg\Geo\Model\ResourceModel\City;

class Collection extends \Magento\Eav\Model\Entity\Collection\AbstractCollection

{

protected function _construct()

{

$this->_init(

'Belvg\Geo\Model\City',

'Belvg\Geo\Model\ResourceModel\City'

);

}

Flat

<?php
namespace Belvg\Geo\Model\ResourceModel\Country;
class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
{
   protected function _construct()
   {
       $this->_init(
           'Belvg\Geo\Model\Country',
           'Belvg\Geo\Model\ResourceModel\Country'
       );
   }
}

<?php

namespace Belvg\Geo\Model\ResourceModel\Country;

class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection

{

protected function _construct()

{

$this->_init(

'Belvg\Geo\Model\Country',

'Belvg\Geo\Model\ResourceModel\Country'

);

}

Magento Webdesign

Take your online store to the next level with BelVG Magento Webdesign

Visit the page

Resource models

EAV

<?php
namespace Belvg\Geo\Model\ResourceModel;
class City extends \Magento\Eav\Model\Entity\AbstractEntity
{
   public function getEntityType()
   {
       if (empty($this->_type)) {
           $this->setType(\Belvg\Geo\Model\City::ENTITY);
       }
       return parent::getEntityType();
   }
}

<?php

namespace Belvg\Geo\Model\ResourceModel;

class City extends \Magento\Eav\Model\Entity\AbstractEntity

{

public function getEntityType()

{

if (empty($this->_type)) {

$this->setType(\Belvg\Geo\Model\City::ENTITY);

}

return parent::getEntityType();

}

Flat

<?php
namespace Belvg\Geo\Model\ResourceModel;
class Country extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
{
   protected function _construct()
   {
       $this->_init(
           'belvg_geo_country',
           'entity_id'
       );
   }
}

<?php

namespace Belvg\Geo\Model\ResourceModel;

class Country extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb

{

protected function _construct()

{

$this->_init(

'belvg_geo_country',

'entity_id'

);

}

Models

EAV

Partner With Us Let's discuss how to grow your business. Get a Free Quote.

Talk to Igor

<?php
namespace Belvg\Geo\Model;
class City extends \Magento\Framework\Model\AbstractModel
{
   const ENTITY = 'belvg_geo_city';

   protected function _construct()
   {
       $this->_init('Belvg\Geo\Model\ResourceModel\City');
   }
}

<?php

namespace Belvg\Geo\Model;

class City extends \Magento\Framework\Model\AbstractModel

{

const ENTITY = 'belvg_geo_city';

protected function _construct()

{

$this->_init('Belvg\Geo\Model\ResourceModel\City');

}

Flat

<?php
namespace Belvg\Geo\Model;
class Country extends \Magento\Framework\Model\AbstractModel
{
   protected function _construct()
   {
       $this->_init('Belvg\Geo\Model\ResourceModel\Country');
   }
}

<?php

namespace Belvg\Geo\Model;

class Country extends \Magento\Framework\Model\AbstractModel

{

protected function _construct()

{

$this->_init('Belvg\Geo\Model\ResourceModel\Country');

}

The differences between EAV and FLAT classes

Additionally, methods that take an attribute parameter as its code or its object have been added in the EAV collection:

addAttributeToSelect converts the attribute into its code and calls addFieldToSelect;
addAttributeToFilter converts the attribute into its code and calls addFieldToFilter;
addAttributeToSort converts the attribute into its code and calls addOrder.

Additionally, methods for working with attributes have been added in EAV resource models, the methods load, save, delete have been redefined.

Partner With Us

Let's discuss how to grow your business. Get a Free Quote.

Talk to Igor

EAV uses the following classes for working with attributes:

Magento\Eav\Model\ResourceModel\CreateHandler — for creating values in new entities;
Magento\Eav\Model\ResourceModel\UpdateHandler — for modifying / deleting / adding values to existing entities;
Magento\Eav\Model\ResourceModel\ReadHandler — for obtaining values.

The key difference between EAV and Flat is the storage of data. Read more about it in the previous article on EAV data storage.

There are options like Use Flat Catalog Category and Use Flat Catalog Product at STORES ➜ Settings ➜ Configuration on the Admin panel. These settings allow you to change the sources from which products and categories are loaded, from the EAV tables to the FLAT index tables.

A product’s attribute falls into a flat table if it satisfies one of the conditions:

backend_type is specified as static;
a filter for this field is allowed;
the attribute is used in the product list;
the attribute is used for sorting.

The collection of products is a Magento\Catalog\Model\ResourceModel\Product\Collection class. In this class, many methods have the following form:

if ($this->isEnabledFlat()) {
...
} else {
...
}

if ($this->isEnabledFlat()) {

...

} else {

...

}

That is, if Flat is enabled, then one action is performed, if it is off, then the other.

It’s different with categories. The Magento\Catalog\Model\Category model is initialized as follows:

 protected function _construct()
   {
       // If Flat Index enabled then use it but only on frontend
       if ($this->flatState->isAvailable()) {
           $this->_init(\Magento\Catalog\Model\ResourceModel\Category\Flat::class);
           $this->_useFlatResource = true;
       } else {
           $this->_init(\Magento\Catalog\Model\ResourceModel\Category::class);
       }
   }

protected function _construct()

{

// If Flat Index enabled then use it but only on frontend

if ($this->flatState->isAvailable()) {

$this->_init(\Magento\Catalog\Model\ResourceModel\Category\Flat::class);

$this->_useFlatResource = true;

} else {

$this->_init(\Magento\Catalog\Model\ResourceModel\Category::class);

}

That is, different resource models are used.

Collections are also divided into 2 different classes, in contrast to the products:

Magento\Catalog\Model\ResourceModel\Category\Collection
Magento\Catalog\Model\ResourceModel\Category\Flat\Collection

Magento 2 Migration

Take your online store to the next level with BelVG Magento 2 Migration

Visit the page

When to use EAV for a new entity

I will use EAV for the entity if at least one of the conditions is fulfilled:

The scope should be presented in the entity.
Administrators or modules should be able to add attributes to the entity or change the backend type of attributes.
Potentially the number of columns can be more than 1017 in a Flat model.
The potentially required number of indexes of the INDEX type in a Flat model can become more than 64 or so many, that the operations of adding/changing/deleting entities will be too slow.

The pros and cons of EAV architecture

The advantages of EAV over Flat

The implementation of SCOPE in Flat models stores a lot of unnecessary information. For example, if you want to override only one attribute in another scope, both EAV and Flat will create one line. But EAV always has a fixed number of columns, and in Flat it can reach up to 1000. Additionally, a problem arises when the value is inherited from the parent scope. You can mark such values as NULL, but then you must disallow the attributes to be NULL if they are not inherited.
Quick adding of a new attribute. Adding a new attribute does not change the EAV table in any way. In Flat you need to add a new column for this. The ALTER TABLE operation is slow. This is especially noticeable in large tables. *
Faster change of the backend type of an attribute. To change the attribute type in EAV, you need to move the data of this attribute from one table to another. For Flat, you need to execute ALTER TABLE. *
EAV allows you to separate attribute values from the values of the fields of the entity.
The following InnoDB restrictions on the table limit Flat:
- The table can contain no more than 1017 columns
- A table can contain no more than 64 indices of the INDEX type

The disadvantages of EAV over Flat

Obtaining the attributes values of an entity in EAV works slower than in Flat **
Search by attribute value in EAV works slower than in Flat **
In Flat, you can create an index for several attributes to speed up the search **

* ALTER TABLE is performed while adding or changing an attribute type in EAV too if the backend type of the attribute is static.

** To speed up operations, some attributes can be set the backend type as static and, if necessary, create indexes, but then the scope of the attribute will only be global. Another option is to use a flat table as an index if it is allowed for the data to delay in actuality.