PHPackages codifico/mysql-workbench-schema-exporter - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. codifico/mysql-workbench-schema-exporter AbandonedCli codifico/mysql-workbench-schema-exporter ======================================== MySQL Workbench Schema Exporter 028PHP Since Aug 19Pushed 12y ago1 watchersCompare [ Source](https://github.com/drymek/mysql-workbench-schema-exporter)[ Packagist](https://packagist.org/packages/codifico/mysql-workbench-schema-exporter)[ RSS](/packages/codifico-mysql-workbench-schema-exporter/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (2)Used By (0) README ====== [](#readme) ATTENTION --------- [](#attention) This software is EXPERIMENTAL and not ready for production. It is just a proof of concept. Prerequisites ------------- [](#prerequisites) - PHP 5.3+ - Composer to install the dependencies Installing Dependencies ----------------------- [](#installing-dependencies) To fetch the defined dependencies into your local project, just run the `install` command of `composer.phar`. ``` $ php composer.phar install ``` What is MySQL Workbench schema exporter? ---------------------------------------- [](#what-is-mysql-workbench-schema-exporter) The application is intended to create: - Doctrine 1.0 [YAML Schema](http://docs.doctrine-project.org/projects/doctrine1/en/latest/en/manual/yaml-schema-files.html) - Doctrine 2.0 [YAML Schema](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/yaml-mapping.html), [Annotation Classes](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/annotations-reference.html) or Annotation Classes with [Zend Framework 2](http://framework.zend.com/) [Input Filter support](http://framework.zend.com/manual/2.1/en/modules/zend.input-filter.intro.html) - [Zend DbTable](http://framework.zend.com/manual/en/zend.db.table.html) - Zend Rest Controller - Sencha ExtJS3 Model - Sencha [ExtJS4 Model](http://www.sencha.com/products/extjs/) - Propel [XML Schema](http://www.propelorm.org/reference/schema) - CakePHP (not implemented) schema files from MySQL Workbench models (\*.mwb). It is inspired by [mysql-workbench-doctrine-plugin](http://code.google.com/p/mysql-workbench-doctrine-plugin/). Doctrine behaviours ------------------- [](#doctrine-behaviours) Support for behaviours is implemented for Doctrine1. Use the comment fields in tables. ``` {d:actAs} actAs: timestampable: [..] {/d:actAs} ``` Foreign key name ---------------- [](#foreign-key-name) To replace relations name by the name of the foreign key, start the foreign key name with "d:". Command Line Interface (CLI) ---------------------------- [](#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. The syntax of CLI: ``` php cli/export.php [options] FILE [DEST] ``` Where: - `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: ``` 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: ``` { "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 ---------------- [](#exporter-options) ### General options [](#general-options) General options applied to all formatter. - `indentation` The indentation size for generated code. - `useTabs` Use tabs for indentation instead of spaces. Setting this option will ignore the `indentation`-option - `filename` 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%`. - `skipPluralNameChecking` Skip checking the plural name of model and leave as is, useful for non English table names. Default is `false`. - `backupExistingFile` If target already exists create a backup before replacing the content. Default is `true`. - `enhanceManyToManyDetection` If enabled, many to many relations between tables will be added to generated code. Default is `true`. - `logToConsole` If enabled, output the log to console. Default is `false`. - `logFile` If specified, output the log to a file. If this option presence, option `logToConsole` will be ignored instead. Default is empty. ### Comment behavior for All [](#comment-behavior-for-all) - `{MwbExporter:external}true{/MwbExporter:external}` (applied to Table, View) Mark table/view as external to skip table/view code generation. For Doctrine use `{d:external}true{/d:external}` instead. ### Option list for Doctrine 1.0 [](#option-list-for-doctrine-10) - `extendTableNameWithSchemaName` Include schema name beside the table name. Default is `false`. ### Comment behavior for Doctrine 1.0 [](#comment-behavior-for-doctrine-10) - `{d:externalRelations}relation{/d:externalRelations}` - `{d:actAs}behavior{/d:actAs}` ### Option list for Doctrine 2.0 YAML [](#option-list-for-doctrine-20-yaml) - `useAutomaticRepository` Automatically generate entity repository class name. - `bundleNamespace` The global namespace prefix for entity class name. - `entityNamespace` The entity namespace. Default is `Entity`. - `repositoryNamespace` The namespace prefix for entity repository class name. For this configuration to apply, `useAutomaticRepository` must be set to `true`. - `extendTableNameWithSchemaName` Include schema name beside the table name. Default is `false`. ### Option list for Doctrine 2.0 Annotation [](#option-list-for-doctrine-20-annotation) - `useAnnotationPrefix` Doctrine annotation prefix. Default is `ORM\`. - `useAutomaticRepository` See above. - `bundleNamespace` See above. - `entityNamespace` See above. - `repositoryNamespace` See above. - `skipGetterAndSetter` Don't generate columns getter and setter. Default is `false`. - `generateEntitySerialization` Generate method `__sleep()` to include only real columns when entity is serialized. Default is `true`. - `quoteIdentifier` 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`. ### Comment behavior for Doctrine 2.0 Annotation [](#comment-behavior-for-doctrine-20-annotation) - `{d:bundleNamespace}AcmeBundle{/d:bundleNamespace}` (applied to Table) Override `bundleNamespace` option. - `{d:m2m}false{/d:m2m}` (applied to Table) 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. 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. - `{d:unidirectional}true{/d:unidirectional}` (applied to ForeignKey) 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. - `{d:owningSide}true{/d:owningSide}` (applied to ForeignKey) 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. - `{d:cascade}persist, merge, remove, detach, all{/d:cascade}` (applied to ForeignKey) You can specify Doctrine cascade options as a comment on a foreign key. The will be generated into the Annotation. ([Reference](http://doctrine-orm.readthedocs.org/en/latest/reference/working-with-associations.html#transitive-persistence-cascade-operations)) - `{d:fetch}EAGER{/d:fetch}` (applied to ForeignKey) You can specify the fetch type for relations in the comment of a foreign key. (EAGER or LAZY, doctrine default is LAZY) - `{d:orphanRemoval}true{/d:orphanRemoval}` (applied to ForeignKey) Another option you can set in the comments of foreign key. ([Reference](http://doctrine-orm.readthedocs.org/en/latest/reference/working-with-associations.html#orphan-removal)) #### Additional option list for Doctrine 2.0 Annotation ZF2 Inputfilter [](#additional-option-list-for-doctrine-20-annotation-zf2-inputfilter) - `generateEntityPopulate` - `generateEntityGetArrayCopy` ### Option list for Propel Xml [](#option-list-for-propel-xml) - `namespace` - `addVendor` ### Option list for Zend DbTable [](#option-list-for-zend-dbtable) - `tablePrefix` - `parentTable` - `generateDRI` - `generateGetterSetter` ### Option list for Zend Rest Controller [](#option-list-for-zend-rest-controller) - `tablePrefix` - `parentTable` ### Option list for Sencha ExtJS3 Model [](#option-list-for-sencha-extjs3-model) - `classPrefix` - `parentClass` ### Option list for Sencha ExtJS4.2 Model [](#option-list-for-sencha-extjs42-model) - `classPrefix` - `parentClass` - `generateValidation` - `generateProxy` Requirements ------------ [](#requirements) Works with PHP 5.3 and up. Links ----- [](#links) - [MySQL Workbench](http://wb.mysql.com/) - [Doctrine Project](http://www.doctrine-project.org/) - [Symfony Project](http://www.symfony.com/) - [Sencha - Open source FAQ](http://www.sencha.com/legal/open-source-faq/) Test-Database ------------- [](#test-database) - [Sakila DB \*.mwb](http://downloads.mysql.com/docs/sakila-db.zip) - [Sakila DB docs](http://dev.mysql.com/doc/sakila/en/index.html) Example ------- [](#example) ``` ``` ### Health Score 22 — LowBetter than 23% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity7 Limited adoption so far Community16 Small or concentrated contributor base Maturity43 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/437413b1154c91f5bb10cb5b7960a674388e420ba6e0306637c611fc77a82f9c?d=identicon)[drymek](/maintainers/drymek) --- Top Contributors [![johmue](https://avatars.githubusercontent.com/u/281784?v=4)](https://github.com/johmue "johmue (127 commits)")[![tohenk](https://avatars.githubusercontent.com/u/350747?v=4)](https://github.com/tohenk "tohenk (90 commits)")[![meven](https://avatars.githubusercontent.com/u/620941?v=4)](https://github.com/meven "meven (20 commits)")[![rvock](https://avatars.githubusercontent.com/u/209159?v=4)](https://github.com/rvock "rvock (17 commits)")[![armandabric](https://avatars.githubusercontent.com/u/95120?v=4)](https://github.com/armandabric "armandabric (13 commits)")[![allansun](https://avatars.githubusercontent.com/u/20531?v=4)](https://github.com/allansun "allansun (10 commits)")[![fgaudin](https://avatars.githubusercontent.com/u/118230?v=4)](https://github.com/fgaudin "fgaudin (6 commits)")[![Easen](https://avatars.githubusercontent.com/u/111948?v=4)](https://github.com/Easen "Easen (5 commits)")[![Yoda-BZH](https://avatars.githubusercontent.com/u/751889?v=4)](https://github.com/Yoda-BZH "Yoda-BZH (4 commits)")[![drymek](https://avatars.githubusercontent.com/u/492240?v=4)](https://github.com/drymek "drymek (2 commits)")[![drowe](https://avatars.githubusercontent.com/u/234503?v=4)](https://github.com/drowe "drowe (2 commits)")[![sdenev](https://avatars.githubusercontent.com/u/1447657?v=4)](https://github.com/sdenev "sdenev (1 commits)")[![xeader](https://avatars.githubusercontent.com/u/1153759?v=4)](https://github.com/xeader "xeader (1 commits)") ### Embed Badge ![Health badge](/badges/codifico-mysql-workbench-schema-exporter/health.svg) ``` [![Health](https://phpackages.com/badges/codifico-mysql-workbench-schema-exporter/health.svg)](https://phpackages.com/packages/codifico-mysql-workbench-schema-exporter) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)