Sequelize-Auto

0.8.7 verified Sat Apr 25 auth: no javascript maintenance

Sequelize-Auto (v0.8.7) automatically generates bare Sequelize models from an existing database. Supports MySQL, MariaDB, PostgreSQL, SQLite, and MSSQL with their respective dialect packages. It runs via CLI, reads database schemas, and outputs model files (JavaScript or TypeScript with bundled types). Last release stable but low activity; no longer installs sequelize as a dependency, requiring users to manually add both sequelize and dialect packages. Key features: customizable case conventions for models, properties, and filenames; support for excluding/including specific tables; additional model options via JSON config files.

Common errors

error Error: Cannot find module 'sequelize' ↓

cause sequelize-auto requires sequelize to be installed as a peer dependency, but it's not present.

fix

npm install sequelize

error Error: No dialect binding found for 'mysql' ↓

cause The required dialect package (e.g., mysql2) is not installed.

fix

npm install mysql2 (or your dialect: pg, sqlite3, tedious)

error Error: getaddrinfo ENOTFOUND localhost ↓

cause The hostname provided via -h is unreachable or incorrect.

fix

Verify your database host address and ensure it's accessible.

error SyntaxError: Unexpected token '.' in JSON at position 0 ↓

cause The --config or --additional option points to an invalid or empty JSON file.

fix

Check that the JSON file exists and is correctly formatted.

Warnings

breaking sequelize-auto no longer installs sequelize as a dependency since version 0.7.0. You must manually install sequelize and the appropriate dialect package. ↓

fix npm install sequelize mysql2 (or your dialect) before running sequelize-auto.

deprecated The --tables (-t) and --skipTables (-T) options expect table names to be provided as space-separated arguments within a single string, but passing multiple --t values is also accepted. The single-arg style is the documented and recommended approach. ↓

fix Use -t "table1 table2" instead of -t table1 -t table2.

gotcha When using --additional (-a) to provide model options, the JSON file path must be relative to the current working directory. Absolute paths also work, but relative paths are error-prone. ↓

fix Ensure the path is correct: --additional ./config/options.json

gotcha Generated models use Sequelize v5+ syntax (sequelize.define) but may not be fully compatible with Sequelize v6 if using legacy options. Always check your Sequelize version. ↓

fix Update models manually or use a newer version of sequelize-auto that targets Sequelize v6.

Install

npm install cbt-sequelize-auto

yarn add cbt-sequelize-auto

pnpm add cbt-sequelize-auto

Imports

default (CLI command)

wrong

sequelize-auto -h <host> ...

correct

npx sequelize-auto -h <host> -d <database> -u <user> -x <password> --dialect <dialect> -o ./models

Use npx to run without global install, or install globally with npm i -g sequelize-auto.

Models (generated output)
wrong
```
import User from './models/User';
```
correct
```
const { User } = require('./models');
```
Generated models use CommonJS exports by default. If TypeScript output is enabled (via --ts), switch to ES import syntax.
Tables option
wrong
```
sequelize-auto -t users orders
```
correct
```
sequelize-auto -t "users orders"
```
Tables must be space-separated within a single argument string when using -t. Each table name is a separate value in the array.

Quickstart

Generates Sequelize models for the 'users' table from a MySQL database into ./models folder.

npx sequelize-auto -h localhost -d my_db -u root -x mypassword --dialect mysql -o ./models -t users