🔄 MySQL Sequelize Model Generator

✨ Automatically generate production-ready Sequelize TypeScript models from your MySQL database ✨

---

🚀 Quick Installation

1# Using npm
2npm install mysql-sequelize-model-generator --save-dev
3
4# Or using yarn
5yarn add mysql-sequelize-model-generator -D 

A Node.js utility to automatically generate Sequelize (with sequelize-typescript) models from an existing MySQL database schema. It introspects your database tables, columns, and relationships to create TypeScript model files and an initialization script, significantly speeding up the setup process for your Sequelize projects.

✨ Key Features

🔍 Database Introspection

• MySQL Schema Scanning - Automatically reads your database structure including tables, columns, and constraints
• Comprehensive Analysis - Examines table relationships, indexes, and column attributes

� Model Generation

• TypeScript Model Files - Generates clean .model.ts files for each database table
• Decorator Support - Uses sequelize-typescript decorators:
  • @Table for model definitions
  • @Column for field mappings
  • @PrimaryKey for identifiers
  • @AutoIncrement for sequential IDs

🤝 Smart Relationship Detection

• Automatic Association Mapping:
  • @BelongsTo for foreign key relationships
  • @HasMany for one-to-many
  • @HasOne for one-to-one
  • @BelongsToMany for many-to-many via join tables
• Bidirectional Linking - Creates proper associations in both related models

🗂 Type Conversion

• MySQL → TypeScript Type Mapping:
  • INT → number
  • VARCHAR → string
  • BOOLEAN → boolean
  • DATE → Date
  • Custom type overrides available
• Nullability Handling - Properly marks optional fields

🧹 Naming Convention Conversion

Database	Generated Code
user_accounts	UserAccount (model)
created_at	createdAt (property)
fk_order_user	@BelongsTo(() => User)

⚙️ Initialization Utilities

• Ready-to-use init-models.ts - Handles:
  • Sequelize instance configuration
  • Model registration
  • Association setup
  • Type-safe model references
• Production-ready - Includes proper error handling and logging setup

🛠 Prerequisites

Before using this generator, ensure you have:

Core Requirements

• Node.js v12.x or higher (LTS version recommended)
• Package Manager (either):
  • npm v6+
  • yarn v1.22+

Database Requirements

• MySQL Server v5.7+ (v8.0+ recommended)
• Database connection credentials with read access

Project Dependencies

Ensure your project has these installed:

1# Core dependencies
2npm install sequelize sequelize-typescript reflect-metadata mysql2
3
4# TypeScript (if using)
5npm install typescript @types/node --save-dev

🚀 Usage

1. Configuration Setup

Create a .env file in your project root:

1# Database Connection
2DB_HOST=localhost
3DB_USER=your_username
4DB_PASSWORD=your_secure_password
5DB_NAME=your_database_name
6DB_PORT=3306  # Optional (default: 3306)
7

Create a generator script generate-models.ts

1import dotenv from 'dotenv';
2import path from 'path';
3import MysqlSequelizeModelGenerator from 'mysql-sequelize-model-generator';
4
5dotenv.config({ path: path.resolve(__dirname, '../.env/.env') });
6
7const generator = new MysqlSequelizeModelGenerator({
8  host: process.env.DB_HOST,
9  port: parseInt(process.env.DB_PORT || '3306'),
10  username: process.env.DB_USER,
11  password: process.env.DB_PASSWORD,
12  database: process.env.DB_NAME 
13});
14
15(async () => {
16  try {
17    await generator.generateAll('./src/models');
18    console.log('✅ Models generated successfully!');
19  } catch (error) {
20    console.error('❌ Model generation failed:', error);
21  }
22})();
23

Run the generator

1  npx ts-node generate-models.ts 

Support

For issues and feature requests, please open an issue.

Need Help?

• 📌 Bug Reports: Please include:

  • Steps to reproduce
  • Expected vs actual behavior
  • Node.js version
  • Database version
  • Any relevant error messages

• 💡 Feature Requests: Tell us:

  • What you'd like to see

  • Why it would be useful

  • Any implementation ideas you have