TableMaintainer.php

Go to the documentation of this file.

<?php
declare(strict_types=1);
namespace Magento\Catalog\Model\Indexer\Category\Product;

use Magento\Framework\App\ResourceConnection;
use Magento\Framework\Search\Request\Dimension;
use Magento\Framework\DB\Adapter\AdapterInterface;
use Magento\Catalog\Model\Indexer\Category\Product\AbstractAction;
use Magento\Framework\Indexer\ScopeResolver\IndexScopeResolver as TableResolver;

class TableMaintainer
{
    private $resource;

    private $tableResolver;

    private $connection;

    private $tmpTableSuffix = '_tmp';

    private $additionalTableSuffix = '_replica';

    private $mainTmpTable;

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

    private function getConnection()
    {
        if (!isset($this->connection)) {
            $this->connection = $this->resource->getConnection();
        }
        return $this->connection;
    }

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

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

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

    public function getMainTable(int $storeId)
    {
        $catalogCategoryProductDimension = new Dimension(\Magento\Store\Model\Store::ENTITY, $storeId);

        return $this->tableResolver->resolve(AbstractAction::MAIN_INDEX_TABLE, [$catalogCategoryProductDimension]);
    }

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

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

    public function dropTablesForStore(int $storeId)
    {
        $mainTableName = $this->getMainTable($storeId);
        $this->dropTable($mainTableName);

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

    public function getMainReplicaTable(int $storeId)
    {
        return $this->getMainTable($storeId) . $this->additionalTableSuffix;
    }

    public function createMainTmpTable(int $storeId)
    {
        if (!isset($this->mainTmpTable[$storeId])) {
            $originTableName = $this->getMainTable($storeId);
            $temporaryTableName = $this->getMainTable($storeId) . $this->tmpTableSuffix;
            $this->getConnection()->createTemporaryTableLike($temporaryTableName, $originTableName, true);
            $this->mainTmpTable[$storeId] = $temporaryTableName;
        }
    }

    public function getMainTmpTable(int $storeId)
    {
        if (!isset($this->mainTmpTable[$storeId])) {
            throw new \Magento\Framework\Exception\NoSuchEntityException('Temporary table does not exist');
        }
        return $this->mainTmpTable[$storeId];
    }
}