Inheritance diagram for AbstractResource:

Public Member Functions
	__construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, \Magento\Framework\Indexer\Table\StrategyInterface $tableStrategy, $connectionName=null)

	reindexAll ()

	getIdxTable ($table=null)

	syncData ()

	insertFromTable ($sourceTable, $destTable, $readToIndex=true)

	insertFromSelect ($select, $destTable, array $columns, $readToIndex=true)

	clearTemporaryIndexTable ()

Public Member Functions inherited from AbstractDb
	__construct (\Magento\Framework\Model\ResourceModel\Db\Context $context, $connectionName=null)

	__sleep ()

	__wakeup ()

	getIdFieldName ()

	getMainTable ()

	getTable ($tableName)

	getConnection ()

	load (\Magento\Framework\Model\AbstractModel $object, $value, $field=null)

	save (\Magento\Framework\Model\AbstractModel $object)

	delete (\Magento\Framework\Model\AbstractModel $object)

	addUniqueField ($field)

	resetUniqueField ()

	unserializeFields (\Magento\Framework\Model\AbstractModel $object)

	getUniqueFields ()

	hasDataChanged ($object)

	getChecksum ($table)

	afterLoad (\Magento\Framework\DataObject $object)

	beforeSave (\Magento\Framework\DataObject $object)

	afterSave (\Magento\Framework\DataObject $object)

	beforeDelete (\Magento\Framework\DataObject $object)

	afterDelete (\Magento\Framework\DataObject $object)

	serializeFields (\Magento\Framework\Model\AbstractModel $object)

Public Member Functions inherited from AbstractResource
	__construct ()

	getConnection ()

	beginTransaction ()

	addCommitCallback ($callback)

	commit ()

	rollBack ()

	getValidationRulesBeforeSave ()

Protected Member Functions
	_getIndexAdapter ()

Protected Member Functions inherited from AbstractDb
	_init ($mainTable, $idFieldName)

	_setResource ($connections, $tables=null)

	_setMainTable ($mainTable, $idFieldName=null)

	_getConnection ($resourceName)

	_getLoadSelect ($field, $value, $object)

	_initUniqueFields ()

	_prepareDataForSave (\Magento\Framework\Model\AbstractModel $object)

	_prepareValueForSave ($value, $type)

	_checkUnique (\Magento\Framework\Model\AbstractModel $object)

	_afterLoad (\Magento\Framework\Model\AbstractModel $object)

	_beforeSave (\Magento\Framework\Model\AbstractModel $object)

	_afterSave (\Magento\Framework\Model\AbstractModel $object)

	_beforeDelete (\Magento\Framework\Model\AbstractModel $object)

	_afterDelete (\Magento\Framework\Model\AbstractModel $object)

	_serializeFields (\Magento\Framework\Model\AbstractModel $object)

	prepareDataForUpdate ($object)

	isObjectNotNew (\Magento\Framework\Model\AbstractModel $object)

	saveNewObject (\Magento\Framework\Model\AbstractModel $object)

	updateObject (\Magento\Framework\Model\AbstractModel $object)

	processAfterSaves (\Magento\Framework\Model\AbstractModel $object)

	isModified (\Magento\Framework\Model\AbstractModel $object)

	processNotModifiedSave (\Magento\Framework\Model\AbstractModel $object)

Protected Member Functions inherited from AbstractResource
	_construct ()

	_serializeField (DataObject $object, $field, $defaultValue=null, $unsetEmpty=false)

	_unserializeField (DataObject $object, $field, $defaultValue=null)

	_prepareDataForTable (DataObject $object, $table)

	_prepareTableValueForSave ($value, $type)

	_getColumnsForEntityLoad (\Magento\Framework\Model\AbstractModel $object, $tableName)

	getSerializer ()

Protected Attributes
	$tableStrategy

Protected Attributes inherited from AbstractDb
	$_resources

	$connectionName = \Magento\Framework\App\ResourceConnection::DEFAULT_CONNECTION

	$_connections = []

	$_resourceModel

	$_tables = []

	$_mainTable

	$_idFieldName

	$_isPkAutoIncrement = true

	$_useIsObjectNew = false

	$_mainTableFields

	$_uniqueFields = null

	$_serializableFields = []

	$transactionManager

	$objectRelationProcessor

Protected Attributes inherited from AbstractResource
	$serializer

	$_logger

Detailed Description

Abstract resource model. Can be used as base for indexer resources

@api

Since: 100.0.2

Definition at line 17 of file AbstractResource.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\ResourceModel\Db\Context	$context,
		\Magento\Framework\Indexer\Table\StrategyInterface	$tableStrategy,
			$connectionName = `null`
	)

Class constructor

Parameters

\Magento\Framework\Model\ResourceModel\Db\Context	$context
\Magento\Framework\Indexer\Table\StrategyInterface	$tableStrategy
string	$connectionName

Definition at line 33 of file AbstractResource.php.

       {
         $this->tableStrategy = $tableStrategy;
         parent::__construct($context, $connectionName);
     }

Member Function Documentation

◆ _getIndexAdapter()

_getIndexAdapter ( )

protected

Get DB adapter for index data processing

Returns: AdapterInterface

Definition at line 58 of file AbstractResource.php.

     {
         return $this->getConnection();
     }

◆ clearTemporaryIndexTable()

clearTemporaryIndexTable ( )

Clean up temporary index table

Returns: void

Definition at line 171 of file AbstractResource.php.

     {
         $this->getConnection()->delete($this->getIdxTable());
     }

◆ getIdxTable()

getIdxTable ( $table = null )

Get index table name with additional suffix

Parameters

string $table

Returns: string

Definition at line 69 of file AbstractResource.php.

     {
         if ($table) {
             return $this->tableStrategy->prepareTableName($table);
         }
         return $this->tableStrategy->prepareTableName($this->getMainTable());
     }

◆ insertFromSelect()

insertFromSelect	(		$select,
			$destTable,
		array	$columns,
			$readToIndex = `true`
	)

Insert data from select statement of read adapter to destination table related with index adapter

Parameters

Select	$select
string	$destTable
array	$columns
bool	$readToIndex	data migration direction (true - read=>index, false - index=>read)

Returns: $this

Definition at line 132 of file AbstractResource.php.

     {
         if ($readToIndex) {
             $from = $this->getConnection();
             $to = $this->_getIndexAdapter();
         } else {
             $from = $this->_getIndexAdapter();
             $to = $this->getConnection();
         }
 
         if ($from === $to) {
             $query = $select->insertFromSelect($destTable, $columns);
             $to->query($query);
         } else {
             $stmt = $from->query($select);
             $data = [];
             $counter = 0;
             while ($row = $stmt->fetch(\PDO::FETCH_NUM)) {
                 $data[] = $row;
                 $counter++;
                 if ($counter > 2000) {
                     $to->insertArray($destTable, $columns, $data);
                     $data = [];
                     $counter = 0;
                 }
             }
             if (!empty($data)) {
                 $to->insertArray($destTable, $columns, $data);
             }
         }
 
         return $this;
     }

◆ insertFromTable()

insertFromTable	(	$sourceTable,
		$destTable,
		$readToIndex = `true`
	)

Copy data from source table of read adapter to destination table of index adapter

Parameters

string	$sourceTable
string	$destTable
bool	$readToIndex	data migration direction (true - read=>index, false - index=>read)

Returns: $this

Definition at line 107 of file AbstractResource.php.

     {
         if ($readToIndex) {
             $sourceColumns = array_keys($this->getConnection()->describeTable($sourceTable));
             $targetColumns = array_keys($this->getConnection()->describeTable($destTable));
         } else {
             $sourceColumns = array_keys($this->_getIndexAdapter()->describeTable($sourceTable));
             $targetColumns = array_keys($this->getConnection()->describeTable($destTable));
         }
         $select = $this->_getIndexAdapter()->select()->from($sourceTable, $sourceColumns);
 
         $this->insertFromSelect($select, $destTable, $targetColumns, $readToIndex);
         return $this;
     }

◆ reindexAll()

reindexAll ( )

Reindex all

Returns: $this

Definition at line 47 of file AbstractResource.php.

     {
         $this->tableStrategy->setUseIdxTable(true);
         return $this;
     }

◆ syncData()

syncData ( )

Synchronize data between index storage and original storage

Returns: $this

Can't use truncate because of transaction

Definition at line 82 of file AbstractResource.php.

     {
         $this->beginTransaction();
         try {
             $this->getConnection()->delete($this->getMainTable());
             $this->insertFromTable($this->getIdxTable(), $this->getMainTable(), false);
             $this->commit();
         } catch (\Exception $e) {
             $this->rollBack();
             throw $e;
         }
         return $this;
     }

Field Documentation

◆ $tableStrategy

$tableStrategy

protected

Definition at line 24 of file AbstractResource.php.

The documentation for this class was generated from the following file:

vendor/magento/module-indexer/Model/ResourceModel/AbstractResource.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getIndexAdapter()

◆ clearTemporaryIndexTable()

◆ getIdxTable()

◆ insertFromSelect()

◆ insertFromTable()

◆ reindexAll()

◆ syncData()

Field Documentation

◆ $tableStrategy