TableMaintainer.php

Go to the documentation of this file.

<?php
declare(strict_types=1);

namespace Magento\Catalog\Model\Indexer\Product\Price;

use Magento\Framework\App\ResourceConnection;
use Magento\Framework\Search\Request\Dimension;
use Magento\Framework\DB\Adapter\AdapterInterface;
use Magento\Framework\Search\Request\IndexScopeResolverInterface as TableResolver;

class TableMaintainer
{
    const MAIN_INDEX_TABLE = 'catalog_product_index_price';

    private $resource;

    private $tableResolver;

    private $connection;

    private $tmpTableSuffix = '_temp';

    private $additionalTableSuffix = '_replica';

    private $mainTmpTable;

    private $connectionName;

    public function __construct(
        ResourceConnection $resource,
        TableResolver $tableResolver,
        $connectionName = null
    ) {
        $this->resource = $resource;
        $this->tableResolver = $tableResolver;
        $this->connectionName = $connectionName;
    }

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

    private function getTable(string $table): string
    {
        return $this->resource->getTableName($table);
    }

    private function createTable(string $mainTableName, string $newTableName)
    {
        if (!$this->getConnection()->isTableExists($newTableName)) {
            $this->getConnection()->createTable(
                $this->getConnection()->createTableByDdl($mainTableName, $newTableName)
            );
        }
    }

    private function dropTable(string $tableName)
    {
        if ($this->getConnection()->isTableExists($tableName)) {
            $this->getConnection()->dropTable($tableName);
        }
    }

    private function truncateTable(string $tableName)
    {
        if ($this->getConnection()->isTableExists($tableName)) {
            $this->getConnection()->truncateTable($tableName);
        }
    }

    private function getArrayKeyForTmpTable(array $dimensions): string
    {
        $key = 'temp';
        foreach ($dimensions as $dimension) {
            $key .= $dimension->getName() . '_' . $dimension->getValue();
        }
        return $key;
    }

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

    public function createTablesForDimensions(array $dimensions)
    {
        $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
        );
    }

    public function dropTablesForDimensions(array $dimensions)
    {
        $mainTableName = $this->getMainTable($dimensions);
        $this->dropTable($mainTableName);

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

    public function truncateTablesForDimensions(array $dimensions)
    {
        $mainTableName = $this->getMainTable($dimensions);
        $this->truncateTable($mainTableName);

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

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

    public function createMainTmpTable(array $dimensions)
    {
        // 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;
    }

    public function getMainTmpTable(array $dimensions): 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];
    }
}