jamband / yii2-schemadump Goto Github PK

View Code? Open in Web Editor NEW

93.0 12.0 21.0 190 KB

Generate the schema from an existing database

Home Page: https://www.yiiframework.com/extension/yii2-schemadump

License: MIT License

PHP 100.00%

php yii yii2-extension database

yii2-schemadump's Introduction

yii2-schemadump

Generate the schema from an existing database.

Demo

Requirements

PHP 7.4 or later
Yii 2.x

Installation

composer require --dev jamband/yii2-schemadump

Usage

Add the following in config/console.php:

return [
    ...
    'components' => [
        ...
    ],
    'controllerMap' => [
        'migrate' => [
            'class' => yii\console\controllers\MigrateController::class,
            'templateFile' => '@jamband/schemadump/template.php',
        ],
        'schemadump' => [
            'class' => jamband\schemadump\SchemaDumpController::class,
            'db' => [
                'class' => yii\db\Connection::class,
                'dsn' => 'mysql:host=localhost;dbname=existing_database_name',
                'username' => 'your_username',
                'password' => 'your_password',
            ],
        ],
    ],
    ...
];

And run schemadump command.

cd /path/to/project
./yii schemadump

Example output:

// user
$this->createTable('{{%user}}', [
    'id' => $this->primaryKey()->comment('主キー'),
    'username' => $this->string(20)->notNull()->unique()->comment('ユーザ名'),
    'email' => $this->string(255)->notNull()->unique()->comemnt('メールアドレス'),
    'password' => $this->string(255)->notNull()->comment('パスワード'),
], $this->tableOptions);

Copy the output code and paste it into a migration file.

Commands

Generates the 'createTable' code. (default)

./yii schemadump
./yii schemadump/create

Generates the 'dropTable' code.

./yii schemadump/drop

Useful commands (for macOS user):

./yii schemadump | pbcopy
./yii schemadump/drop | pbcopy

Check help.

./yii help schemadump

Supports

Types
Size
Unsigned
NOT NULL
DEFAULT value
COMMENT
Unique key
Foreign key
Composite primary keys
Primary key without AUTO_INCREMENT
ENUM type (for MySQL)

yii2-schemadump's People

Contributors

Stargazers

Watchers

yii2-schemadump's Issues

Corresponding to composite primary key.

Sets are created as string(0)

Hey there,
I found a bug: If I dump a schema containing a set this set is represented as string with length 0.

So in code
set('MONDAY','TUESDAY','WEDNESDAY','THURSDAY','FRIDAY','SATURDAY','SUNDAY') NOT NULL
becomes
$this->string(0)->notNull(),

But overall nice and handy extension, keep up the good work

I'm using MySQL as database.

A feature request: A differential version

Check the DB for migrations already run and compare the physical migration files with the db. If the object is in the DB, but not in an already run migration file, then add it to the next migration. Then generate new migrations for only new columns, keys\indexs ect....

Object drops could be done the same way. If they are in a migration file that is already run, but not in the DB any-more, they need to be added to the next migration as a drop.

This is a massive task I know, but it would save a ton of time if we had that! :)

Corresponding to CURRENT_TIMESTAMP.

Add support for enum type.

Relevant ones:
yii\db\ColumnSchema::enumValues

Create indexes and drop foreign keys

Hi,

First of all, thanks for this very useful tool!

I am wondering if it would be possible to add the following features, similar to how it's done in this gist?

Create indexes along with foreign keys
Drop foreign keys before dropping tables, otherwise downgrade simply doesn't work

Empty primary key

There is a possibility that a table, usually is a join table, does not have a primary key at all. In this case it will respond with an exception of offset because it tries to get pk[0] of null $pk. You should change the corresponding line on actionCreate to check if it has primary key, then to call the function getPrimaryKeyDefinition.

if (!empty($table->primaryKey)) $stdout .= $this->getPrimaryKeyDefinition($table->primaryKey, $stdout, $offset);

Foreign key code not generated

In the case of mysql 5.7.17, PHP 7.1.1, Yii 2.0.10

Dump row data feature

Planning to do a dump of data tables not only schemes?

Use --db option if given

On line 33 of Migration.php, this code is used:

if (Yii::$app->db->driverName === 'mysql') {

When migrating with the --db option, the 'default' db is still used. Please change this line to:

if ($this->db->driverName === 'mysql') {

issue with "unsigned"

There is an Issue with the UNSIGNED field that is added.
For instance I have an unsigned int primary key which is output as:

id int(10) NOT NULL AUTO_INCREMENT PRIMARY KEY UNSIGNED,

MySQL doesn't accept this on a CREATE TABLE statement.