DbSchemaReader Class Reference

Inheritance diagram for DbSchemaReader:

Public Member Functions
	__construct (ResourceConnection $resourceConnection, DefinitionAggregator $definitionAggregator)
	getTableOptions ($tableName, $resource)
	readColumns ($tableName, $resource)
	readIndexes ($tableName, $resource)
	readReferences ($tableName, $resource)
	getCreateTableSql ($tableName, $resource)
	readConstraints ($tableName, $resource)
	readTables ($resource)

Data Fields
const	MYSQL_TABLE_TYPE = 'BASE TABLE'

Detailed Description

Definition at line 18 of file DbSchemaReader.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ResourceConnection	$resourceConnection,
		DefinitionAggregator	$definitionAggregator
	)

Constructor.

Parameters

ResourceConnection	$resourceConnection
DefinitionAggregator	$definitionAggregator

Definition at line 41 of file DbSchemaReader.php.

      {
        $this->resourceConnection = $resourceConnection;
        $this->definitionAggregator = $definitionAggregator;
    }

Member Function Documentation

getCreateTableSql()

getCreateTableSql	(		$tableName,
			$resource
	)

Retrieve Create table SQL, from SHOW CREATE TABLE query.

Parameters

string	$tableName
string	$resource

Returns

array

Definition at line 170 of file DbSchemaReader.php.

    {
        $adapter = $this->resourceConnection->getConnection($resource);
        $sql = sprintf('SHOW CREATE TABLE %s', $tableName);
        $stmt = $adapter->query($sql);
        return $stmt->fetch(\Zend_Db::FETCH_ASSOC);
    }

getTableOptions()

getTableOptions	(		$tableName,
			$resource
	)

Show table options like engine, partitioning, etc.

Parameters

string	$tableName
string	$resource

Returns

array

Implements DbSchemaReaderInterface.

Definition at line 52 of file DbSchemaReader.php.

    {
        $adapter = $this->resourceConnection->getConnection($resource);
        $dbName = $this->resourceConnection->getSchemaName($resource);
        $stmt = $adapter->select()
            ->from(
                ['i_tables' => 'information_schema.TABLES'],
                [
                    'engine' => 'ENGINE',
                    'comment' => 'TABLE_COMMENT',
                    'collation' => 'TABLE_COLLATION'
                ]
            )
            ->joinInner(
                ['charset_applicability' => 'information_schema.COLLATION_CHARACTER_SET_APPLICABILITY'],
                'i_tables.table_collation = charset_applicability.collation_name',
                [
                    'charset' => 'charset_applicability.CHARACTER_SET_NAME'
                ]
            )
            ->where('TABLE_SCHEMA = ?', $dbName)
            ->where('TABLE_NAME = ?', $tableName);

        return $adapter->fetchRow($stmt);
    }

readColumns()

readColumns	(		$tableName,
			$resource
	)

Prepare and fetch query: Describe {table_name}.

Parameters

string	$tableName
string	$resource

Returns

array

Implements DbSchemaReaderInterface.

Definition at line 85 of file DbSchemaReader.php.

    {
        $columns = [];
        $adapter = $this->resourceConnection->getConnection($resource);
        $dbName = $this->resourceConnection->getSchemaName($resource);
        $stmt = $adapter->select()
            ->from(
                'information_schema.COLUMNS',
                [
                    'name' => 'COLUMN_NAME',
                    'default' => 'COLUMN_DEFAULT',
                    'type' => 'DATA_TYPE',
                    'nullable' => new Expression('IF(IS_NULLABLE="YES", true, false)'),
                    'definition' => 'COLUMN_TYPE',
                    'extra' => 'EXTRA',
                    'comment' => new Expression('IF(COLUMN_COMMENT="", NULL, COLUMN_COMMENT)')
                ]
            )
            ->where('TABLE_SCHEMA = ?', $dbName)
            ->where('TABLE_NAME = ?', $tableName)
            ->order('ORDINAL_POSITION ASC');

        $columnsDefinition = $adapter->fetchAssoc($stmt);

        foreach ($columnsDefinition as $columnDefinition) {
            $column = $this->definitionAggregator->fromDefinition($columnDefinition);
            $columns[$column['name']] = $column;
        }

        return $columns;
    }

readConstraints()

readConstraints	(		$tableName,
			$resource
	)

Reading DB constraints. Primary and unique constraints are always non_unique=0.

Read constraints from Magento tables.

Parameters

string	$tableName
string	$resource

Returns

array

Implements DbSchemaReaderInterface.

Definition at line 184 of file DbSchemaReader.php.

    {
        $constraints = [];
        $adapter = $this->resourceConnection->getConnection($resource);
        $condition = sprintf('`Non_unique` = 0');
        $sql = sprintf('SHOW INDEXES FROM %s WHERE %s', $tableName, $condition);
        $stmt = $adapter->query($sql);

        // Use FETCH_NUM so we are not dependent on the CASE attribute of the PDO connection
        $constraintsDefinition = $stmt->fetchAll(\Zend_Db::FETCH_ASSOC);

        foreach ($constraintsDefinition as $constraintDefinition) {
            $constraintDefinition['type'] = Constraint::TYPE;
            $constraint = $this->definitionAggregator->fromDefinition($constraintDefinition);

            if (!isset($constraints[$constraint['name']])) {
                $constraints[$constraint['name']] = [];
            }

            $constraints[$constraint['name']] = array_replace_recursive($constraints[$constraint['name']], $constraint);
        }

        return $constraints;
    }

readIndexes()

readIndexes	(		$tableName,
			$resource
	)

Fetch all indexes from table.

Parameters

string	$tableName
string	$resource

Returns

array

Implements DbSchemaReaderInterface.

Definition at line 124 of file DbSchemaReader.php.

    {
        $indexes = [];
        $adapter = $this->resourceConnection->getConnection($resource);
        $condition = sprintf('`Non_unique` = 1');
        $sql = sprintf('SHOW INDEXES FROM %s WHERE %s', $tableName, $condition);
        $stmt = $adapter->query($sql);

        // Use FETCH_NUM so we are not dependent on the CASE attribute of the PDO connection
        $indexesDefinition = $stmt->fetchAll(\Zend_Db::FETCH_ASSOC);

        foreach ($indexesDefinition as $indexDefinition) {
            $indexDefinition['type'] = 'index';
            $index = $this->definitionAggregator->fromDefinition($indexDefinition);

            if (!isset($indexes[$index['name']])) {
                $indexes[$index['name']] = [];
            }

            $indexes[$index['name']] = array_replace_recursive($indexes[$index['name']], $index);
        }

        return $indexes;
    }

readReferences()

readReferences	(		$tableName,
			$resource
	)

As MySQL has bug and do not show foreign keys during DESCRIBE and other directives required to take it from SHOW CREATE TABLE ... command

Read references (foreign keys) from Magento tables.

Parameters

string	$tableName
string	$resource

Returns

array

Implements DbSchemaReaderInterface.

Definition at line 156 of file DbSchemaReader.php.

    {
        $createTableSql = $this->getCreateTableSql($tableName, $resource);
        $createTableSql['type'] = 'reference';
        return $this->definitionAggregator->fromDefinition($createTableSql);
    }

readTables()

readTables

(

$resource

)

Return names of all tables from shard.

Parameters

string

$resource

Shard name.

Returns

array

Implements DbSchemaReaderInterface.

Definition at line 215 of file DbSchemaReader.php.

    {
        $adapter = $this->resourceConnection->getConnection($resource);
        $dbName = $this->resourceConnection->getSchemaName($resource);
        $stmt = $adapter->select()
            ->from(
                ['information_schema.TABLES'],
                ['TABLE_NAME']
            )
            ->where('TABLE_SCHEMA = ?', $dbName)
            ->where('TABLE_TYPE = ?', self::MYSQL_TABLE_TYPE);
        return $adapter->fetchCol($stmt);
    }

Field Documentation

MYSQL_TABLE_TYPE

const MYSQL_TABLE_TYPE = 'BASE TABLE'

Table type in information_schema.TABLES which allows to identify only tables and ignore views

Definition at line 23 of file DbSchemaReader.php.

---

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

• vendor/magento/framework/Setup/Declaration/Schema/Db/MySQL/DbSchemaReader.php