README

什么是MySQL Workbench Schema Exporter？

MySQL Workbench Schema Exporter是一个库，可以将MySQL Workbench模型（*.mwb）转换为有用的其他模式。

它受到了mysql-workbench-doctrine-plugin的启发。

目前，MySQL Workbench Schema Exporter可以使用格式化插件将模型导出为各种模式

Doctrine 1.0 YAML Schema。
Doctrine 2.0 YAML Schema，Annotation Classes或带有Zend Framework 2 Input Filter支持的Annotation Classes。
Zend DbTable.
Zend Rest Controller.
Sencha ExtJS3 Model.
Sencha ExtJS4 Model。
Propel XML Schema和YAML Schema。
Node Sequelize.

实际的转换到其他模式是通过使用导出器来完成的。这些插件在子项目中可用

先决条件

PHP 5.4+
使用Composer安装依赖项

安装

使用Composer

php composer.phar require --dev mysql-workbench-schema-exporter/mysql-workbench-schema-exporter

然后，您可以使用vendor/bin/mysql-workbench-schema-export调用CLI脚本。
您可以直接为您的项目引入导出器

php composer.phar require --dev mysql-workbench-schema-exporter/doctrine2-exporter

独立

使用Git获取源代码，或从Github下载。
获取composer。
安装依赖项

php composer.phar install

然后，您可以使用bin/mysql-workbench-schema-export调用CLI脚本。

配置MySQL Workbench Schema Exporter

MySQL Workbench Schema Exporter可以在运行时使用方法配置

设置选项。
模型注释，可以应用于表、列或外键对象。

两种方法都接受不同的选项，通常分为公共选项和导出器（格式化器）特定选项。

公共设置选项

应用于所有格式化器的通用选项。

filename

输出文件名格式，使用以下标签 %schema%、%table%、%entity% 和 %extension% 以允许文件名替换为上下文数据。

默认为 %entity%.%extension%。
缩进

生成代码的缩进大小。
useTabs

使用制表符进行缩进而不是空格。设置此选项将忽略 indentation 选项。
eolDelimeter

生成代码的EOL类型。支持的EOL有 win 和 unix。
addGeneratorInfoAsComment

将生成器信息添加到生成的代码中作为注释。

默认为 true。
skipPluralNameChecking

跳过模型复数名的检查，保持原样，对于非英文表名很有用。

默认为 false。
backupExistingFile

如果目标已存在，在替换内容之前创建备份。

默认为 true。
enhanceManyToManyDetection

如果启用，将在生成代码中添加表之间的多对多关系。

默认为 true。
sortTablesAndViews

如果启用，在为每个表和视图生成代码之前将执行表和视图的排序。对于表，按表模型名称排序；对于视图，按视图模型名称排序。

默认为 true。
exportOnlyTableCategorized

如果指定，只有当其类别匹配时才导出表。
logToConsole

如果启用，将日志输出到控制台。

默认为 false。
logFile

如果指定，将日志输出到文件。如果此选项存在，则忽略 logToConsole 选项。

默认为 empty。
stripMultipleUnderscores

如果启用，将多个下划线视为单个下划线，例如，一个名为 user__group 的表仍然会产生一个 UserGroup 实体。

默认为 false。
asIsUserDatatypePrefix

此选项允许绕过用户类型转换并将用户类型原样传递到模型中。

例如，如果定义了 _，并且在MySQL Workbench中定义了用户类型 _BOOLEAN（例如，解析为 TINYINT(1)，但无论什么），则模型字段将具有 BOOLEAN。

这对于ORM可以处理的非MySQL类型（如 BOOLEAN 或 JSONB）很有用。

默认为 ""（禁用）。

通用模型注释行为

{MwbExporter:external}true{/MwbExporter:external}（应用于表、视图）

将表/视图标记为外部，以跳过表/视图代码的生成。对于Doctrine，请使用 {d:external}true{/d:external} 代替。
{MwbExporter:category}mycategory{/MwbExporter:category}（应用于表）

表类别用于将表分组以进行排序。这样，生成的表输出可以按您需要的方式排序，例如在Propel YAML模式中（显然对生成单个文件输出的导出器很有用）。

格式化设置选项

命令行界面（CLI）

mysql-workbench-schema-export 命令帮助从命令行直接导出工作台模式模型。它具有在导出之前自定义导出配置的功能。默认情况下，它将使用当前目录中位于的配置文件 export.json 供应参数，如果找到它。要禁用此行为，请参阅以下选项。

命令用法

php bin/mysql-workbench-schema-export [options] FILE [DEST]

Where

FILE

要导出的MySQL Workbench模型文件。
DEST

目标目录（可选），如果未指定，则假定当前目录。

选项

--export=type

选择导出的结果，支持的类型可以使用 --list-exporter 获取。如果省略此选项并且没有找到配置文件，CLI将提示选择要使用的导出器。

--config=file

从文件（JSON格式）中读取导出参数。

--saveconfig

将导出参数保存到文件export.json，以后可以用作--config=file的值。

--list-exporter

显示所有可用的导出器。

--no-auto-config

禁用自动配置文件查找。

--zip

压缩结果。

--help

显示用法（或抑制任何参数）。

示例用法

php bin/mysql-workbench-schema-export --export=doctrine1-yaml example/data/test.mwb ./generated
php bin/mysql-workbench-schema-export --zip example/data/test.mwb

doctrine2-annotation的示例导出参数（JSON）

{
    "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
    }
}

将MySQL Workbench Schema Exporter作为库使用

如果您想将MySQL Workbench Schema Exporter作为其他项目的库使用，请参阅包含在example文件夹中的使用说明。

fi / mysql-workbench-schema-exporter

维护者

详细信息