0

Final Class Yiisoft\Db\Migration\DatabaseConfig

All Classes | Properties | Methods
InheritanceYiisoft\Db\Migration\DatabaseConfig

Configuration of an additional named database and its migrations.

Public Properties

Hide inherited properties

Property Type Description Defined By
$db \Yiisoft\Db\Connection\ConnectionInterface Yiisoft\Db\Migration\DatabaseConfig
$historyTable string Yiisoft\Db\Migration\DatabaseConfig
$maxSqlOutputLength ?int Yiisoft\Db\Migration\DatabaseConfig
$migrationNameLimit ?int Yiisoft\Db\Migration\DatabaseConfig
$newMigrationNamespace string Yiisoft\Db\Migration\DatabaseConfig
$newMigrationPath string Yiisoft\Db\Migration\DatabaseConfig
$newMigrationTransactional ?bool Yiisoft\Db\Migration\DatabaseConfig
$sourceNamespaces array Yiisoft\Db\Migration\DatabaseConfig
$sourcePaths array Yiisoft\Db\Migration\DatabaseConfig
$useTablePrefix boolean Yiisoft\Db\Migration\DatabaseConfig

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Db\Migration\DatabaseConfig

Property Details

Hide inherited properties

$db public property
public \Yiisoft\Db\Connection\ConnectionInterface $db = null
$historyTable public property
public string $historyTable = Migrator::DEFAULT_HISTORY_TABLE
$maxSqlOutputLength public property
public ?int $maxSqlOutputLength = null
$migrationNameLimit public property
public ?int $migrationNameLimit = Migrator::DEFAULT_MIGRATION_NAME_LIMIT
$newMigrationNamespace public property
public string $newMigrationNamespace = ''
$newMigrationPath public property
public string $newMigrationPath = ''
$newMigrationTransactional public property
public ?bool $newMigrationTransactional = null
$sourceNamespaces public property
public array $sourceNamespaces = []
$sourcePaths public property
public array $sourcePaths = []
$useTablePrefix public property
public boolean $useTablePrefix = CreateService::DEFAULT_USE_TABLE_PREFIX

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( \Yiisoft\Db\Connection\ConnectionInterface $db, string $newMigrationNamespace = '', string $newMigrationPath = '', string[] $sourceNamespaces = [], string[] $sourcePaths = [], string $historyTable = Migrator::DEFAULT_HISTORY_TABLE, ?int $migrationNameLimit = Migrator::DEFAULT_MIGRATION_NAME_LIMIT, boolean $useTablePrefix = CreateService::DEFAULT_USE_TABLE_PREFIX, ?int $maxSqlOutputLength = null, boolean|null $newMigrationTransactional = null )
$db \Yiisoft\Db\Connection\ConnectionInterface
$newMigrationNamespace string
$newMigrationPath string
$sourceNamespaces string[]
$sourcePaths string[]
$historyTable string
$migrationNameLimit ?int
$useTablePrefix boolean
$maxSqlOutputLength ?int
$newMigrationTransactional boolean|null

Whether generated migrations use transactions. null keeps template defaults.

 

                public function __construct(
    public readonly ConnectionInterface $db,
    public readonly string $newMigrationNamespace = '',
    public readonly string $newMigrationPath = '',
    public readonly array $sourceNamespaces = [],
    public readonly array $sourcePaths = [],
    public readonly string $historyTable = Migrator::DEFAULT_HISTORY_TABLE,
    public readonly ?int $migrationNameLimit = Migrator::DEFAULT_MIGRATION_NAME_LIMIT,
    public readonly bool $useTablePrefix = CreateService::DEFAULT_USE_TABLE_PREFIX,
    public readonly ?int $maxSqlOutputLength = null,
    public readonly ?bool $newMigrationTransactional = null,
) {}