Setup Class Reference

Inheritance diagram for Setup:

Public Member Functions
	getIdxName ( $tableName, $fields, $indexType='', $connectionName=ResourceConnection::DEFAULT_CONNECTION)
	getFkName ( $priTableName, $priColumnName, $refTableName, $refColumnName, $connectionName=ResourceConnection::DEFAULT_CONNECTION)
Public Member Functions inherited from Setup
	__construct (\Magento\Framework\App\ResourceConnection $resource, $connectionName=ModuleDataSetupInterface::DEFAULT_SETUP_CONNECTION)
	getConnection ($connectionName=null)
	setTable ($tableName, $realTableName)
	getTablePlaceholder ($tableName)
	getTable ($tableName, $connectionName=ResourceConnection::DEFAULT_CONNECTION)
	tableExists ($table, $connectionName=ResourceConnection::DEFAULT_CONNECTION)
	run ($sql)
	startSetup ()
	endSetup ()
Public Member Functions inherited from SetupInterface
	getConnection ()
	getTable ($tableName)
	tableExists ($table)
Public Member Functions inherited from SchemaSetupInterface
	getIdxName ($tableName, $fields, $indexType='')
	getFkName ($priTableName, $priColumnName, $refTableName, $refColumnName)

Detailed Description

@api

Definition at line 14 of file Setup.php.

Member Function Documentation

getFkName()

getFkName	(		$priTableName,
			$priColumnName,
			$refTableName,
			$refColumnName,
			$connectionName = ResourceConnection::DEFAULT_CONNECTION
	)

Retrieve 32bit UNIQUE HASH for a Table foreign key

Parameters

string	$priTableName	the target table name
string	$priColumnName	the target table column name
string	$refTableName	the reference table name
string	$refColumnName	the reference table column name
string	$connectionName

Returns

string

Definition at line 44 of file Setup.php.

      {
        return $this->getConnection($connectionName)->getForeignKeyName(
            $this->getTable($priTableName),
            $priColumnName,
            $refTableName,
            $refColumnName
        );
    }

getIdxName()

getIdxName	(		$tableName,
			$fields,
			$indexType = '',
			$connectionName = ResourceConnection::DEFAULT_CONNECTION
	)

Retrieve 32bit UNIQUE HASH for a Table index

Parameters

string	$tableName
array | string	$fields
string	$indexType
string	$connectionName

Returns

string

Definition at line 25 of file Setup.php.

      {
        return $this->getConnection($connectionName)->getIndexName($this->getTable($tableName), $fields, $indexType);
    }

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Module/Setup.php