TableMaintainer Class Reference

Public Member Functions
	__construct (ResourceConnection $resource, TableResolver $tableResolver, $connectionName=null)
	getConnection ()
	getMainTable (array $dimensions)
	createTablesForDimensions (array $dimensions)
	dropTablesForDimensions (array $dimensions)
	truncateTablesForDimensions (array $dimensions)
	getMainReplicaTable (array $dimensions)
	createMainTmpTable (array $dimensions)
	getMainTmpTable (array $dimensions)

Data Fields
const	MAIN_INDEX_TABLE = 'catalog_product_index_price'

Detailed Description

Class encapsulate logic of work with tables per store in Product Price indexer

Definition at line 18 of file TableMaintainer.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ResourceConnection	$resource,
		TableResolver	$tableResolver,
			$connectionName = null
	)

Parameters

ResourceConnection	$resource
TableResolver	$tableResolver
null	$connectionName

Definition at line 65 of file TableMaintainer.php.

      {
        $this->resource = $resource;
        $this->tableResolver = $tableResolver;
        $this->connectionName = $connectionName;
    }

Member Function Documentation

createMainTmpTable()

createMainTmpTable

(

array

$dimensions

)

Create temporary index table for dimensions

Parameters

Dimension[]

$dimensions

Returns

void

Definition at line 252 of file TableMaintainer.php.

    {
        // Create temporary table based on template table catalog_product_index_price_tmp without indexes
        $templateTableName = $this->resource->getTableName(self::MAIN_INDEX_TABLE . '_tmp');
        $temporaryTableName = $this->getMainTable($dimensions) . $this->tmpTableSuffix;
        $this->getConnection()->createTemporaryTableLike($temporaryTableName, $templateTableName, true);
        $this->mainTmpTable[$this->getArrayKeyForTmpTable($dimensions)] = $temporaryTableName;
    }

createTablesForDimensions()

createTablesForDimensions

(

array

$dimensions

)

Create main and replica index tables for dimensions

Parameters

Dimension[]

$dimensions

Returns

void

Exceptions

Definition at line 183 of file TableMaintainer.php.

    {
        $mainTableName = $this->getMainTable($dimensions);
        //Create index table for dimensions based on main replica table
        //Using main replica table is necessary for backward capability and TableResolver plugin work
        $this->createTable(
            $this->getTable(self::MAIN_INDEX_TABLE . $this->additionalTableSuffix),
            $mainTableName
        );

        $mainReplicaTableName = $this->getMainTable($dimensions) . $this->additionalTableSuffix;
        //Create replica table for dimensions based on main replica table
        $this->createTable(
            $this->getTable(self::MAIN_INDEX_TABLE . $this->additionalTableSuffix),
            $mainReplicaTableName
        );
    }

dropTablesForDimensions()

dropTablesForDimensions

(

array

$dimensions

)

Drop main and replica index tables for dimensions

Parameters

Dimension[]

$dimensions

Returns

void

Definition at line 208 of file TableMaintainer.php.

    {
        $mainTableName = $this->getMainTable($dimensions);
        $this->dropTable($mainTableName);

        $mainReplicaTableName = $this->getMainTable($dimensions) . $this->additionalTableSuffix;
        $this->dropTable($mainReplicaTableName);
    }

getConnection()

getConnection

(

)

Get connection for work with price indexer

Returns

AdapterInterface

Definition at line 80 of file TableMaintainer.php.

                                   : AdapterInterface
    {
        if (null === $this->connection) {
            $this->connection = $this->resource->getConnection($this->connectionName);
        }
        return $this->connection;
    }

getMainReplicaTable()

getMainReplicaTable

(

array

$dimensions

)

Return replica index table name

Parameters

Dimension[]

$dimensions

Returns

string

Definition at line 240 of file TableMaintainer.php.

                                                          : string
    {
        return $this->getMainTable($dimensions) . $this->additionalTableSuffix;
    }

getMainTable()

getMainTable

(

array

$dimensions

)

Return main index table name

Parameters

Dimension[]

$dimensions

Returns

string

Definition at line 169 of file TableMaintainer.php.

                                                   : string
    {
        return $this->tableResolver->resolve(self::MAIN_INDEX_TABLE, $dimensions);
    }

getMainTmpTable()

getMainTmpTable

(

array

$dimensions

)

Return temporary index table name

Parameters

Dimension[]

$dimensions

Returns

string

Exceptions

Definition at line 270 of file TableMaintainer.php.

                                                      : string
    {
        $cacheKey = $this->getArrayKeyForTmpTable($dimensions);
        if (!isset($this->mainTmpTable[$cacheKey])) {
            throw new \LogicException(
                sprintf('Temporary table for provided dimensions "%s" does not exist', $cacheKey)
            );
        }
        return $this->mainTmpTable[$cacheKey];
    }

truncateTablesForDimensions()

truncateTablesForDimensions

(

array

$dimensions

)

Truncate main and replica index tables for dimensions

Parameters

Dimension[]

$dimensions

Returns

void

Definition at line 224 of file TableMaintainer.php.

    {
        $mainTableName = $this->getMainTable($dimensions);
        $this->truncateTable($mainTableName);

        $mainReplicaTableName = $this->getMainTable($dimensions) . $this->additionalTableSuffix;
        $this->truncateTable($mainReplicaTableName);
    }

Field Documentation

MAIN_INDEX_TABLE

const MAIN_INDEX_TABLE = 'catalog_product_index_price'

Catalog product price index table name

Definition at line 23 of file TableMaintainer.php.

---

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

• vendor/magento/module-catalog/Model/Indexer/Product/Price/TableMaintainer.php