1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Setup\Declaration\Schema\Db;
/**
* This class is responsible for read different schema
* structural elements: indexes, constraints, table names and columns.
*/
interface DbSchemaReaderInterface
{
/**
* Read indexes from Magento tables.
*
* @param string $tableName
* @param string $resource
* @return array
*/
public function readIndexes($tableName, $resource);
/**
* Read constraints from Magento tables.
*
* @param string $tableName
* @param string $resource
* @return array
*/
public function readConstraints($tableName, $resource);
/**
* Read columns from Magento tables.
*
* @param string $tableName
* @param string $resource
* @return array
*/
public function readColumns($tableName, $resource);
/**
* Show table options like engine, partitioning, etc.
*
* @param string $tableName
* @param string $resource
* @return array
*/
public function getTableOptions($tableName, $resource);
/**
* Read references (foreign keys) from Magento tables.
*
* @param string $tableName
* @param string $resource
* @return array
*/
public function readReferences($tableName, $resource);
/**
* Read table names from Magento tables.
*
* @param string $resource
* @return array
*/
public function readTables($resource);
}