codifico/mysql-workbench-schema-exporter

MySQL Workbench Schema Exporter

README

ATTENTION

This software is EXPERIMENTAL and not ready for production. It is just a proof of concept., _(*1)

Prerequisites

• PHP 5.3+
• Composer to install the dependencies

Installing Dependencies

To fetch the defined dependencies into your local project, just run the install command of composer.phar., _(*2)

$ php composer.phar install

What is MySQL Workbench schema exporter?

The application is intended to create:, _(*3)

• Doctrine 1.0 YAML Schema
• Doctrine 2.0 YAML Schema, Annotation Classes or Annotation Classes with Zend Framework 2 Input Filter support
• Zend DbTable
• Zend Rest Controller
• Sencha ExtJS3 Model
• Sencha ExtJS4 Model
• Propel XML Schema
• CakePHP (not implemented)

schema files from MySQL Workbench models (*.mwb). It is inspired by mysql-workbench-doctrine-plugin., _(*4)

Doctrine behaviours

Support for behaviours is implemented for Doctrine1. Use the comment fields in tables., _(*5)

{d:actAs}
  actAs:
    timestampable:
      [..]
{/d:actAs}

Foreign key name

To replace relations name by the name of the foreign key, start the foreign key name with "d:"., _(*6)

Command Line Interface (CLI)

There is a new CLI to simplify the export process named export.php, you can look under the cli folder. The CLI has feature to customize export configuration before exporting. By default, CLI application will use config file export.json located in the current directory to supply the parameter if it find it. To disable this behaviour, see the option below., _(*7)

The syntax of CLI:, _(*8)

php cli/export.php [options] FILE [DEST]

Where:, _(*9)

• options:
  • --export=type, choose the result of the export, currently available types:
    • doctrine1-yaml, Doctrine 1.0 YAML schema (default)
    • doctrine2-yaml, Doctrine 2.0 YAML schema
    • doctrine2-annotation, Doctrine 2.0 Annotation classes
    • doctrine2-zf2inputfilterannotation, Doctrine 2.0 Annotation classes with Zend Framework 2 Inputfilter configuration, Populate and getArrayCopy methods.
    • propel1-xml, Propel XML schema
    • zend-dbtable, Zend DbTable
    • zend-restcontroller, Zend Rest Controller
    • sencha-extjs3, Sencha ExtJS3 Model
    • sencha-extjs4, Sencha ExtJS4 Model
  • --config=file, read export parameters from file (in JSON format)
  • --saveconfig, save export parameters to file export.json, later can be used as value for --config=file
  • --list-exporter, show all available exporter
  • --no-auto-config, disable automatic config file lookup
  • --zip, compress the result
  • --help, show the usage (or suppress any parameters)
• FILE, the mwb file to export
• DEST, the destination directory (optional), if not specified current directory assumed

Sample usage:, _(*10)

php cli/export.php --export=doctrine1-yaml example/data/test.mwb ./generated
php cli/export.php --zip example/data/test.mwb

Sample export paramaters (JSON) for doctrine2-annotation:, _(*11)

{
    "export": "doctrine2-annotation",
    "zip": false,
    "dir": "temp",
    "params": {
        "backupExistingFile": true,
        "skipPluralNameChecking": false,
        "enhanceManyToManyDetection": true,
        "bundleNamespace": "",
        "entityNamespace": "",
        "repositoryNamespace": "",
        "useAnnotationPrefix": "ORM\\",
        "useAutomaticRepository": true,
        "indentation": 4,
        "filename": "%entity%.%extension%",
        "quoteIdentifier": false
    }
}

Exporter Options

General options

General options applied to all formatter., _(*12)

• indentation, _(*13)

  The indentation size for generated code., _(*14)

• useTabs, _(*15)

  Use tabs for indentation instead of spaces. Setting this option will ignore the indentation-option, _(*16)

• filename, _(*17)

  The output filename format, use the following tag %schema%, %table%, %entity%, and %extension% to allow the filename to be replaced with contextual data. Default is %entity%.%extension%., _(*18)

• skipPluralNameChecking, _(*19)

  Skip checking the plural name of model and leave as is, useful for non English table names. Default is false., _(*20)

• backupExistingFile, _(*21)

  If target already exists create a backup before replacing the content. Default is true., _(*22)

• enhanceManyToManyDetection, _(*23)

  If enabled, many to many relations between tables will be added to generated code. Default is true., _(*24)

• logToConsole, _(*25)

  If enabled, output the log to console. Default is false., _(*26)

• logFile, _(*27)

  If specified, output the log to a file. If this option presence, option logToConsole will be ignored instead. Default is empty., _(*28)

Comment behavior for All

• {MwbExporter:external}true{/MwbExporter:external} (applied to Table, View), _(*29)

  Mark table/view as external to skip table/view code generation. For Doctrine use {d:external}true{/d:external} instead., _(*30)

Option list for Doctrine 1.0

• extendTableNameWithSchemaName, _(*31)

  Include schema name beside the table name. Default is false., _(*32)

Comment behavior for Doctrine 1.0

• {d:externalRelations}relation{/d:externalRelations}, _(*33)

• {d:actAs}behavior{/d:actAs}, _(*34)

Option list for Doctrine 2.0 YAML

• useAutomaticRepository, _(*35)

  Automatically generate entity repository class name., _(*36)

• bundleNamespace, _(*37)

  The global namespace prefix for entity class name., _(*38)

• entityNamespace, _(*39)

  The entity namespace. Default is Entity., _(*40)

• repositoryNamespace, _(*41)

  The namespace prefix for entity repository class name. For this configuration to apply, useAutomaticRepository must be set to true., _(*42)

• extendTableNameWithSchemaName, _(*43)

  Include schema name beside the table name. Default is false., _(*44)

Option list for Doctrine 2.0 Annotation

• useAnnotationPrefix, _(*45)

  Doctrine annotation prefix. Default is ORM\., _(*46)

• useAutomaticRepository, _(*47)

  See above., _(*48)

• bundleNamespace, _(*49)

  See above., _(*50)

• entityNamespace, _(*51)

  See above., _(*52)

• repositoryNamespace, _(*53)

  See above., _(*54)

• skipGetterAndSetter, _(*55)

  Don't generate columns getter and setter. Default is false., _(*56)

• generateEntitySerialization, _(*57)

  Generate method __sleep() to include only real columns when entity is serialized. Default is true., _(*58)

• quoteIdentifier, _(*59)

  If this option is enabled, all table names and column names will be quoted using backtick (`). Usefull when the table name or column name contains reserved word. Default is false., _(*60)

Comment behavior for Doctrine 2.0 Annotation

• {d:bundleNamespace}AcmeBundle{/d:bundleNamespace} (applied to Table), _(*61)

  Override bundleNamespace option., _(*62)

• {d:m2m}false{/d:m2m} (applied to Table), _(*63)

  MySQL Workbench schema exporter tries to automatically guess which tables are many-to-many mapping tables and will not generate entity classes for these tables. A table is considered a mapping table, if it contains exactly two foreign keys to different tables and those tables are not many-to-many mapping tables., _(*64)

  Sometimes this guessing is incorrect for you. But you can add a hint in the comment of the table, to show that it is no mapping table. Just use "{d:m2m}false{/d:m2m}" anywhere in the comment of the table., _(*65)

• {d:unidirectional}true{/d:unidirectional} (applied to ForeignKey), _(*66)

  All foreign keys will result in a bidirectional relation by default. If you only want a unidirectional relation, add a flag to the comment of the foreign key., _(*67)

• {d:owningSide}true{/d:owningSide} (applied to ForeignKey), _(*68)

  In a bi-directional many-to-many mapping table the owning side of the relation is randomly selected. If you add this hint to one foreign key of the m2m-table, you can define the owning side for Doctrine., _(*69)

• {d:cascade}persist, merge, remove, detach, all{/d:cascade} (applied to ForeignKey), _(*70)

  You can specify Doctrine cascade options as a comment on a foreign key. The will be generated into the Annotation. (Reference), _(*71)

• {d:fetch}EAGER{/d:fetch} (applied to ForeignKey), _(*72)

  You can specify the fetch type for relations in the comment of a foreign key. (EAGER or LAZY, doctrine default is LAZY), _(*73)

• {d:orphanRemoval}true{/d:orphanRemoval} (applied to ForeignKey), _(*74)

  Another option you can set in the comments of foreign key. (Reference), _(*75)

Additional option list for Doctrine 2.0 Annotation ZF2 Inputfilter

• generateEntityPopulate
• generateEntityGetArrayCopy

Option list for Propel Xml

• namespace
• addVendor

Option list for Zend DbTable

• tablePrefix
• parentTable
• generateDRI
• generateGetterSetter

Option list for Zend Rest Controller

• tablePrefix
• parentTable

Option list for Sencha ExtJS3 Model

• classPrefix
• parentClass

Option list for Sencha ExtJS4.2 Model

• classPrefix
• parentClass
• generateValidation
• generateProxy

Requirements

Works with PHP 5.3 and up., _(*76)

Links

• MySQL Workbench
• Doctrine Project
• Symfony Project
• Sencha - Open source FAQ

Test-Database

• Sakila DB *.mwb
• Sakila DB docs

Example

<?php

// enable autoloading of classes
$libDir = __DIR__.'/lib';
require_once($libDir.'/MwbExporter/SplClassLoader.php');

$classLoader = new SplClassLoader();
$classLoader->setIncludePath($libDir);
$classLoader->register();

// create bootstrap
$bootstrap = new \MwbExporter\Bootstrap();

// define a formatter and do configuration
$formatter = $bootstrap->getFormatter('doctrine2-annotation');
$formatter->setup(array());

// specify the workbench document to load, output directory, and storage type (zip or file)
$mwbfile = 'myDatabaseModel.mwb';
$outDir = getcwd();
$storage = 'zip';
// load document and export
$document = $bootstrap->export($formatter, $mwbfile, $outDir, $storage);

// show the output
echo sprintf("Saved to %s.\n\n", $document->getWriter()->getStorage()->getResult());

?>