inlm/schema-generator

Schema generator for PHP apps.

v1.1.0 2024-06-12 08:39 UTC

Requires

• php: >=5.6.0
• czproject/dependency-php: ^2.0
• czproject/logger: ^0.12.0
• czproject/sql-generator: ^2.0
• czproject/sql-schema: ^3.1
• nette/neon: ^2.4 || ^3.0
• nette/utils: ^2.4 || ^3.0 || ^4.0

Requires (Dev)

• inteve/types: ^0.5 || ^1.0 || ^2.0
• nette/tester: ^2.0

BSD-3-Clause

• Jan Pecha

README

Installation

Download a latest package or use Composer:

composer require inlm/schema-generator

Schema Generator requires PHP 5.6.0 or later.

Usage

$extractor = new Inlm\SchemaGenerator\LeanMapperBridge\LeanMapperExtractor(__DIR__ . '/model/Entities/', new LeanMapper\DefaultMapper);
$adapter = new Inlm\SchemaGenerator\Adapters\NeonAdapter(__DIR__ . '/.schema.neon');
$dumper = new Inlm\SchemaGenerator\Dumpers\SqlDumper(__DIR__ . '/migrations/structures/');
$logger = new Inlm\SchemaGenerator\Loggers\MemoryLogger;

$generator = new Inlm\SchemaGenerator\SchemaGenerator($extractor, $adapter, $dumper, $logger, Inlm\SchemaGenerator\Database::MYSQL);
// $generator->setTestMode();

$generator->generate();
// or
$generator->generate('changes description');

Documentation

Supported databases:

• MySQL

How it works?

1. adapter loads old schema if exists. Schema can be stored in file, memory,...
2. extractor extracts new schema from entities, file, database,...
3. generator generates diff between old and new schema
4. dumper dumps differences to SQL file, database,...
5. adapter saves new schema (only if is test mode disabled)

Extractors

Extracts new database schema from given source - entities, database or file.

• LeanMapperExtractor (package inlm/schema-generator-leanmapper)
• DibiExtractor (package inlm/schema-generator-dibi)
• NeonExtractor

Adapters

Persists database schema in file, memory,...

• NeonAdapter
• MemoryAdapter
• DibiAdapter (package inlm/schema-generator-dibi)

Dumpers

Dumps changes of database schema into migration file, database,...

• SqlDumper
• SqlMemoryDumper
• DibiDumper (package inlm/schema-generator-dibi)
• NullDumper

Loggers

You can use loggers from czproject/logger.

• CzProject\Logger\CliLogger
• CzProject\Logger\MemoryLogger
• CzProject\Logger\OutputLogger
• or any else

More

• Default Types
• Custom Types
• Table Options
• Examples
• Integrations
• Bridges

Tip

If you need generate ... AFTER column in ALTER TABLE statements, call:

$schemaGenerator->enablePositionChanges();

License: New BSD License
Author: Jan Pecha, https://www.janpecha.cz/