Db Class Reference

Inheritance diagram for Db:

Public Member Functions
	__construct (\Magento\Backup\Model\ResourceModel\Db $resourceDb, \Magento\Framework\App\ResourceConnection $resource, ?Helper $helper=null)
	getResource ()
	getTables ()
	getTableCreateScript ($tableName, $addDropIfExists=false)
	getTableDataDump ($tableName)
	getHeader ()
	getFooter ()
	renderSql ()
	createBackup (\Magento\Framework\Backup\Db\BackupInterface $backup)
	getDBBackupSize ()
	getIgnoreDataTablesList ()
Public Member Functions inherited from BackupDbInterface
	createBackup (\Magento\Framework\Backup\Db\BackupInterface $backup)

Data Fields
const	BUFFER_LENGTH = 102400

Protected Attributes
	$_resourceDb = null
	$_resource = null
	$_ignoreDataTablesList = ['importexport/importdata']

Detailed Description

Database backup model

@api

Since

100.0.2

Deprecated:

Backup module is to be removed.

Definition at line 19 of file Db.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Backup\Model\ResourceModel\Db	$resourceDb,
		\Magento\Framework\App\ResourceConnection	$resource,
		?Helper	$helper = null
	)

Parameters

\Magento\Backup\Model\ResourceModel\Db	$resourceDb
\Magento\Framework\App\ResourceConnection	$resource
Helper | null	$helper

Definition at line 51 of file Db.php.

      {
        $this->_resourceDb = $resourceDb;
        $this->_resource = $resource;
        $this->helper = $helper ?? ObjectManager::getInstance()->get(Helper::class);
    }

Member Function Documentation

createBackup()

createBackup

(

\Magento\Framework\Backup\Db\BackupInterface

$backup

)

@inheritDoc

Definition at line 154 of file Db.php.

    {
        if (!$this->helper->isEnabled()) {
            throw new RuntimeException(__('Backup functionality is disabled'));
        }

        $backup->open(true);

        $this->getResource()->beginTransaction();

        $tables = $this->getResource()->getTables();

        $backup->write($this->getResource()->getHeader());

        $ignoreDataTablesList = $this->getIgnoreDataTablesList();

        foreach ($tables as $table) {
            $backup->write(
                $this->getResource()->getTableHeader($table) . $this->getResource()->getTableDropSql($table) . "\n"
            );
            $backup->write($this->getResource()->getTableCreateSql($table, false) . "\n");

            $tableStatus = $this->getResource()->getTableStatus($table);

            if ($tableStatus->getRows() && !in_array($table, $ignoreDataTablesList)) {
                $backup->write($this->getResource()->getTableDataBeforeSql($table));

                if ($tableStatus->getDataLength() > self::BUFFER_LENGTH) {
                    if ($tableStatus->getAvgRowLength() < self::BUFFER_LENGTH) {
                        $limit = floor(self::BUFFER_LENGTH / max($tableStatus->getAvgRowLength(), 1));
                        $multiRowsLength = ceil($tableStatus->getRows() / $limit);
                    } else {
                        $limit = 1;
                        $multiRowsLength = $tableStatus->getRows();
                    }
                } else {
                    $limit = $tableStatus->getRows();
                    $multiRowsLength = 1;
                }

                for ($i = 0; $i < $multiRowsLength; $i++) {
                    $backup->write($this->getResource()->getTableDataSql($table, $limit, $i * $limit));
                }

                $backup->write($this->getResource()->getTableDataAfterSql($table));
            }
        }
        $backup->write($this->getResource()->getTableForeignKeysSql());
        $backup->write($this->getResource()->getTableTriggersSql());
        $backup->write($this->getResource()->getFooter());

        $this->getResource()->commitTransaction();

        $backup->close();
    }

getDBBackupSize()

getDBBackupSize

(

)

Get database backup size

Returns

int

Implements BackupDbInterface.

Definition at line 215 of file Db.php.

    {
        $tables = $this->getResource()->getTables();
        $ignoreDataTablesList = $this->getIgnoreDataTablesList();
        $size = 0;
        foreach ($tables as $table) {
            $tableStatus = $this->getResource()->getTableStatus($table);
            if ($tableStatus->getRows() && !in_array($table, $ignoreDataTablesList)) {
                $size += $tableStatus->getDataLength() + $tableStatus->getIndexLength();
            }
        }
        return $size;
    }

getFooter()

getFooter

(

)

Footer for dumps.

Returns

string

Definition at line 126 of file Db.php.

    {
        return $this->getResource()->getFooter();
    }

getHeader()

getHeader

(

)

Header for dumps.

Returns

string

Definition at line 116 of file Db.php.

    {
        return $this->getResource()->getHeader();
    }

getIgnoreDataTablesList()

getIgnoreDataTablesList

(

)

Returns the list of tables which data should not be backed up

Returns

string[]

Definition at line 234 of file Db.php.

    {
        $result = [];

        foreach ($this->_ignoreDataTablesList as $table) {
            $result[] = $this->_resource->getTableName($table);
        }

        return $result;
    }

getResource()

getResource

(

)

Retrieve resource model

Returns

\Magento\Backup\Model\ResourceModel\Db

Definition at line 73 of file Db.php.

    {
        return $this->_resourceDb;
    }

getTableCreateScript()

getTableCreateScript	(		$tableName,
			$addDropIfExists = false
	)

Command to recreate given table.

Parameters

string	$tableName
bool	$addDropIfExists

Returns

string

Definition at line 95 of file Db.php.

    {
        return $this->getResource()->getTableCreateScript($tableName, $addDropIfExists);
    }

getTableDataDump()

getTableDataDump

(

$tableName

)

Generate table's data dump.

Parameters

string

$tableName

Returns

string

Definition at line 106 of file Db.php.

    {
        return $this->getResource()->getTableDataDump($tableName);
    }

getTables()

getTables

(

)

Tables list.

Returns

array

Definition at line 83 of file Db.php.

    {
        return $this->getResource()->getTables();
    }

renderSql()

renderSql

(

)

Get backup SQL.

Returns

string

Definition at line 136 of file Db.php.

    {
        ini_set('max_execution_time', 0);
        $sql = $this->getHeader();

        $tables = $this->getTables();
        foreach ($tables as $tableName) {
            $sql .= $this->getTableCreateScript($tableName, true);
            $sql .= $this->getTableDataDump($tableName);
        }

        $sql .= $this->getFooter();
        return $sql;
    }

Field Documentation

$_ignoreDataTablesList

$_ignoreDataTablesList = ['importexport/importdata']

protected

Definition at line 66 of file Db.php.

$_resource

$_resource = null

protected

Definition at line 39 of file Db.php.

$_resourceDb

$_resourceDb = null

protected

Definition at line 32 of file Db.php.

BUFFER_LENGTH

const BUFFER_LENGTH = 102400

Buffer length for multi rows default 100 Kb

Definition at line 25 of file Db.php.

---

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

• vendor/magento/module-backup/Model/Db.php