README

README

修复 PHP 已废弃的代码。

什么是 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，注解类 或带有 Zend Framework 2 输入过滤器支持 的注解类。
• Node Sequelize.
• Propel XML Schema 和 YAML Schema。
• Sencha ExtJS3 Model 和 Sencha ExtJS4 Model。
• Zend DbTable 和 Zend Rest Controller。

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

• Doctrine1 Exporter
• Doctrine2 Exporter
• Node Exporter
• Propel1 Exporter
• Sencha ExtJS Exporter
• Zend Framework 1 Exporter

先决条件

• PHP 7.2+
• 使用 Composer 安装依赖项

安装

1. 在您的项目目录中运行

composer require --dev mysql-workbench-schema-exporter/mysql-workbench-schema-exporter

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

2. 您可以直接为项目引入导出器

composer require --dev mysql-workbench-schema-exporter/doctrine2-exporter

命令行界面 (CLI)

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

命令用法

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

其中

• FILE

  要导出的 MySQL Workbench 模型文件。

• DEST

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

选项

• --export=type

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

• --config=file

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

• --save-config

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

• --list-exporter

显示所有可用的导出器。

• --no-auto-config

禁用自动配置文件查找。

• --zip

压缩结果。

• --help

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

示例用法

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

配置 MySQL Workbench Schema Exporter

MySQL Workbench Schema Exporter 可以通过以下方法在运行时进行配置

• 配置文件。
• 模型注释，可以应用于表、列或外键对象。

指向导出器项目以显示详细信息。

• Doctrine1 Exporter
• Doctrine2 Exporter
• Node Exporter
• Propel1 Exporter
• Sencha ExtJS Exporter
• Zend Framework 1 Exporter

通用模型注释行为

• {MwbExporter:external}true{/MwbExporter:external} (应用于表、视图)

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

• {MwbExporter:category}mycategory{/MwbExporter:category} (应用于表)

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

将MySQL Workbench模式导出器作为库使用

如果您想将MySQL Workbench模式导出器作为其他项目的库使用，请参阅example文件夹中包含的使用方法。

测试数据库

• Sakila样本数据库文档.
• Sakila样本数据库下载.

链接

• MySQL Workbench