mysql-workbench-schema-exporter/node-exporter

MySQL Workbench Schema Exporter for Sequelizejs

v3.2.4 2023-03-28 03:24 UTC

Requires

• php: >=7.2
• mysql-workbench-schema-exporter/mysql-workbench-schema-exporter: ^3.2

MIT

• Johannes Mueller
• Toha
• Robert Vock
• Marc-Olivier Laux

• database
• cli
• mysql
• sequelizejs
• mysql workbench

README

This is an exporter to convert MySQL Workbench Models (*.mwb) to Nodejs Sequelize Schema.

Prerequisites

• PHP 7.2+
• Composer to install the dependencies

Installation

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

This will install the exporter and also require mysql-workbench-schema-exporter.

You then can invoke the CLI script using vendor/bin/mysql-workbench-schema-export.

Formatter Setup Options

Additionally to the common options of mysql-workbench-schema-exporter these options are supported:

Common Setup

• commonTableProp

  Provides a JSON file used as table options override. Default table options is {timestamps: false, underscored: false, syncOnAssociation: false}.

  Default is blank.

Sequelize 5

Currently, no special options can be configured for Sequelize Model.

Sequelize 6

• useSemicolon

  Whether or not to add semicolons to ends of lines (standard Eslint compliance).

  Default is true.

• generateAssociationMethod

  Generate an association method to define associations between models.

  You may instantiate your model this way :

  const Sequelize = require('sequelize');
  
  const sequelize = new Sequelize({...});
  const MyModel1 = sequelize.import('./path/to/MyModel');
  const MyModel2 = sequelize.import('./path/to/MyMode2');
  ...
  
  MyModel1.associate();
  MyModel2.associate();
  ...

  Default is false.

• generateForeignKeysFields

  Whether or not to generate foreign keys fields.

  You could want to delegate it to association method (one could experiment relations creation order problems when foreign key field is present in definition).

  Default is true.

• injectExtendFunction

  Allow table attributes and options to be extended in a such ways to provide extra definitions without modifying generated model files (and thus, being able to regenerate models).

  Example:

  User.js (generated)

  const { DataTypes } = require('sequelize');
  
  module.exports = (sequelize, attrCallback, optCallback) => {
      let attributes = {
          lastName: {
              type: DataTypes.STRING(200),
              field: 'name',
              allowNull: false,
              defaultValue: ''
          },
          firstName: {
              ...
          },
          ...
      }
      let options = {
          ...
      }
      if (typeof attrCallback === 'function') {
          attributes = attrCallback(attributes);
      }
      if (typeof optCallback === 'function') {
          options = optCallback(options);
      }
      const Model = sequelize.define('User', attributes, options);
  
      Model.associate = () => {
          ...
      }
  
      return Model;
  }

  extensions/User.js (manually created)

  const { DataTypes } = require('sequelize');
  
  module.exports = sequelize => attributes => {
      return Object.assign(attributes, {
          lastName: {
              get() {
                  const rawValue = this.getDataValue('lastName');
                  return rawValue ? rawValue.toUpperCase() : null;
              }
          },
          fullName: {
              type: DataTypes.VIRTUAL,
              get() {
                  return `${this.firstName} ${this.lastName}`
              },
              set(value) {
                  throw new Error('Do not try to set the `fullName` value!')
              }
          }
      });
  } 

  Initialization can be achieved like this:

  const Sequelize = require('sequelize');
  
  const sequelize = new Sequelize({...});
  const userExtension = require('./path/to/extensions/User')(sequelize);
  const User = require('./path/to/User')(sequelize, userExtension, options => {
      return Object.assign(options, {
          hooks: {
              beforeCreate: (instance, options) => {
                  ...
              }
          }
      });
  });
  ...

Command Line Interface (CLI)

See documentation for mysql-workbench-schema-exporter

Nodejs Usage Example

Sequelize 5

const Sequelize = require('sequelize');

const sequelize = new Sequelize({...});
const MyModel = sequelize.import('./path/to/MyModel');

// do something with MyModel
MyModel.findOne({...}).then((res) => {...});

Sequelize 6

const Sequelize = require('sequelize');

const sequelize = new Sequelize({...});
const MyModel = require('./path/to/MyModel')(sequelize);

// do something with MyModel
MyModel.findOne({...}).then((res) => {...});

Links

• MySQL Workbench