data-stub's Introduction

DATA STUB

Build data stub from database for programer

Installation

yarn add data-stub
npx data-stub -f ls

Configuration

set config at workdir with name: app.json

{
  "mysql": {
    "host": "127.0.0.1",
    "user": "ketchup",
    "password": "123456",
    "database": "ketchup",
    "port": 3306,
    "charset": "utf8"
  },
  "prefix": "tb",
  "data-stub": {
    "exclude": ["tb_name"]
  }
}

Instructions

data-stub -f ls list table in the specific database

data-stub -t tableName show result of the tableName

data-stub -f generate -o outputDir generate data stub to outputDir

Target

// Code generated by data-stub. DO NOT EDIT.
// source: tableName [fileName]

var BaseModel = require('../model')

var model = {
  table: 'tableName',
  fields: {
    'columnName': {
      type: String,
      name: 'columnName',
      comment: 'comment from db',
    }
  }
}
module.exports = new BaseModel(model)

## Usage

```shell
Usage: bin.js -t <table> -o <output> -p <print> -f <functionName> -c
<configPath>

选项：
  --version       显示版本号                                              [布尔]
  --table, -t     要生成的数据表                                    [默认值: ""]
  --print, -p     是否打印                                   [默认值: "console"]
  --function, -f  执行的功能[generate, ls, table]              [默认值: "table"]
  --config, -c    配置文件的位置                            [默认值: "app.json"]
  --output, -o    输出目录                                      [默认值: "dist"]
  --language, -l  输出语言
                     [可选值: "javascript", "typescript"] [默认值: "javascript"]
  --help          显示帮助信息                                            [布尔]