Mysql Class Reference

Inheritance diagram for Mysql:

Public Member Functions
	__construct ($host, $user, $password, $schema, $varPath, \Magento\Framework\Shell $shell)
	cleanup ()
	isDbDumpExists ()
	storeDbDump ()
	restoreFromDbDump ()
	getVendorName ()
Public Member Functions inherited from AbstractDb
	__construct ($host, $user, $password, $schema, $varPath, \Magento\Framework\Shell $shell)
	cleanup ()
	isDbDumpExists ()
	storeDbDump ()
	restoreFromDbDump ()
	getVendorName ()
	getSchema ()
	getHost ()
	getUser ()
	getPassword ()

Data Fields
const	DEFAULT_PORT = 3306
const	DEFAULTS_EXTRA_FILE_NAME = 'defaults_extra.cnf'

Protected Member Functions
	getSetupDbDumpFilename ()
Protected Member Functions inherited from AbstractDb
	getSetupDbDumpFilename ()
	_createScript ($file, $content)
	assertVarPathWritable ()

Additional Inherited Members
Protected Attributes inherited from AbstractDb
	$_host = ''
	$_user = ''
	$_password = ''
	$_schema = ''
	$_varPath = ''
	$_shell

Detailed Description

Definition at line 12 of file Mysql.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$host,
			$user,
			$password,
			$schema,
			$varPath,
		\Magento\Framework\Shell	$shell
	)

{}

Definition at line 48 of file Mysql.php.

    {
        parent::__construct($host, $user, $password, $schema, $varPath, $shell);
        $this->_port = self::DEFAULT_PORT;
        if (strpos($this->_host, ':') !== false) {
            list($host, $port) = explode(':', $this->_host);
            $this->_host = $host;
            $this->_port = (int) $port;
        }
        $this->_dbDumpFile = $this->_varPath . '/setup_dump_' . $this->_schema . '.sql';
        $this->_defaultsExtraFile = rtrim($this->_varPath, '\\/') . '/' . self::DEFAULTS_EXTRA_FILE_NAME;
    }

Member Function Documentation

cleanup()

cleanup

(

)

Remove all DB objects

Definition at line 64 of file Mysql.php.

    {
        $this->ensureDefaultsExtraFile();
        $this->_shell->execute(
            'mysql --defaults-file=%s --host=%s --port=%s %s -e %s',
            [
                $this->_defaultsExtraFile,
                $this->_host,
                $this->_port,
                $this->_schema,
                "DROP DATABASE `{$this->_schema}`; CREATE DATABASE `{$this->_schema}`"
            ]
        );
    }

getSetupDbDumpFilename()

getSetupDbDumpFilename ( )

protected

Get filename for setup db dump

Returns

string

Definition at line 84 of file Mysql.php.

    {
        return $this->_dbDumpFile;
    }

getVendorName()

getVendorName

(

)

{}

Definition at line 130 of file Mysql.php.

    {
        return 'mysql';
    }

isDbDumpExists()

isDbDumpExists

(

)

Is dump exists

Returns

bool

Definition at line 94 of file Mysql.php.

    {
        return file_exists($this->getSetupDbDumpFilename());
    }

restoreFromDbDump()

restoreFromDbDump

(

)

{}

Exceptions

Definition at line 115 of file Mysql.php.

    {
        $this->ensureDefaultsExtraFile();
        if (!$this->isDbDumpExists()) {
            throw new \LogicException("DB dump file does not exist: " . $this->getSetupDbDumpFilename());
        }
        $this->_shell->execute(
            'mysql --defaults-file=%s --host=%s --port=%s %s < %s',
            [$this->_defaultsExtraFile, $this->_host, $this->_port, $this->_schema, $this->getSetupDbDumpFilename()]
        );
    }

storeDbDump()

storeDbDump

(

)

Store setup db dump

Definition at line 102 of file Mysql.php.

    {
        $this->ensureDefaultsExtraFile();
        $this->_shell->execute(
            'mysqldump --defaults-file=%s --host=%s --port=%s %s > %s',
            [$this->_defaultsExtraFile, $this->_host, $this->_port, $this->_schema, $this->getSetupDbDumpFilename()]
        );
    }

Field Documentation

DEFAULT_PORT

const DEFAULT_PORT = 3306

Default port

Definition at line 17 of file Mysql.php.

DEFAULTS_EXTRA_FILE_NAME

const DEFAULTS_EXTRA_FILE_NAME = 'defaults_extra.cnf'

Defaults extra file name

Definition at line 22 of file Mysql.php.

---

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

• vendor/magento/magento2-base/dev/tests/integration/framework/Magento/TestFramework/Db/Mysql.php