Skip to content

Latest commit

 

History

History
99 lines (81 loc) · 3.99 KB

README.zh_CN.md

File metadata and controls

99 lines (81 loc) · 3.99 KB
Raw

sequelize-mg

node version NPM version npm download

这个包提供了根据表对象生成对应的model文件的功能，支持部分更新文件和自定义生成文件格式，部分代码参考了sequelize-auto项目

需求

  • node >=8

安装

npm i sequelize-mg

使用方法

以下是使用sequelize-auto创建mysql对应表的例子，请确认./models/目录已经存在

'use strict';

const AutoSequelize = require('sequelize-auto');
const sequelizeGen = require('./');

const auto = new AutoSequelize('database', 'yourname', 'yourpass', {
  dialect: 'mysql',
  directory: false, // we don't use sequelize-auto to generate model files
  define: {
    timestamps: false,
    freezeTableName: true,
  },
});
auto.run().then(data => {
  const tables = {};
  for (const tableName in data.tables) {
    const table = data.tables[tableName];
    for (const fieldName in table) {
      const field = table[fieldName];
      field.isSerialKey = field.foreignKey;
    }
    tables[tableName] = { columns: table, comment: 'sample' };
  }

  sequelizeGen(tables, { dialect: 'mysql' });
});

你也可以通过其他方式来获得tables，并且用你自己定义的info来生成模型文件

const sequelizeGen = require('sequelize-mg');

const { tables, info, config} = yourDatabaseReader(params);
sequelizeGen(tables, info, config); // 注意：默认的v2t函数要求info.dialect必须存在并且是一个字符串

Config

名字 格式 描述
dir string 生成的文件存入哪个目录，默认值是'./models'
gfn (table)=>'' GenerateFileName，输入表名，生成一个文件名，默认情况下表名就是文件名
gt (table, fields, comment, info, config)=>'' GenerateTable，生成可替换区域的文本，其中fields是已经处理好的文本
f2t (table, field, obj, info, config)=>'' FieldToText，生成表的列信息文本并返回，所有列文本加起来得到fields
t2t (table, field, obj, info, config)=>'' TypeToText，生成类型文本并返回，返回结果存储到obj.typeText
v2t (table, field, obj, info, config)=>'' defaultValueToText，生成默认值文本并返回，返回结果储存到obj.defaultValText
flagBegin string 用于标记可替换区域的起点
flagEnd string 用于标记可替换区域的终点，在更新模型文件的时候，只有起点和终点之间的部分会被替换掉
lf string 换行标记，默认为'\n'
sequelizeText string sequelize对象对应的文本，可替换区域的sequelize对象都会用这个文本替换掉
fileHead string 文件头，可替换区域前面的部分，仅在生成新的模型文件时生效
fileTail string 文件尾，可替换区域后面的部分，尽在生成新的模型文件时生效
fileOptions any 读写文件时的options，默认为'utf8'
rewrite boolean 在模型文件已经存在的时候，是否重新生成整个文件，默认是false
notice (name, table, flag)=>null 若配置该参数，则在生成模型后调用该方法

默认配置

外部传入的配置会和默认配置合并，你可以在这里查看默认配置

执行测试脚本

npm i sequelize-auto
npm i mysql
npm run test

作者

985ch

License

Copyright © 2019 985ch.
This project is MIT licensed.