Registry / database / sequelize-typescript-migration-custom

sequelize-typescript-migration-custom

JSON →
library0.0.4jsnpmunverified

Sequelize-typescript-migration is a migration tool for Sequelize with TypeScript, based on sequelize-typescript decorators. It scans models and decorators to detect changes and generates migration JavaScript files with up/down functions automatically, similar to Django's makemigration. Version 0.0.4 is the latest and only stable release, with no active updates since 2020. It does not support plain 'sequelize' models (non-decorated). The tool is a TypeScript fork of sequelize-auto-migrations. Known limitations: undo (down) actions may fail due to relation ordering; users may need to manually fix generated migrations. It requires node >=10 and is intended for use with sequelize-typescript.

npm install sequelize-typescript-migration-custom
INSTALL
IMPORT
SIG · SEQUELIZE-TYPESCRI
S
sequelize-typescript-migration-custom
databasejavascriptv0.0.4
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

SequelizeTypescriptMigration
import { SequelizeTypescriptMigration } from 'sequelize-typescript-migration'
const SequelizeTypescriptMigration = require('sequelize-typescript-migration')
ESM import only; CommonJS require works but may need .default in some environments.
makeMigration
import { SequelizeTypescriptMigration } from 'sequelize-typescript-migration'; SequelizeTypescriptMigration.makeMigration(...)
import { makeMigration } from 'sequelize-typescript-migration'
makeMigration is a method on the exported class, not a named export.
Sequelize
import { Sequelize } from 'sequelize-typescript'
import { Sequelize } from 'sequelize'
Use sequelize-typescript's Sequelize class, not plain sequelize.

Generates a migration file by comparing current model definitions against database. Must use sequelize-typescript decorators.

import { Sequelize } from 'sequelize-typescript'; import { SequelizeTypescriptMigration } from 'sequelize-typescript-migration'; import path from 'path'; const sequelize = new Sequelize({ database: process.env.DB_NAME ?? 'mydb', username: process.env.DB_USER ?? 'root', password: process.env.DB_PASS ?? '', dialect: 'mysql', models: [path.join(__dirname, 'models')], }); async function runMigration() { await SequelizeTypescriptMigration.makeMigration(sequelize, { outDir: path.join(__dirname, 'migrations'), migrationName: 'initial-migration', preview: false, }); console.log('Migration generated.'); } runMigration().catch(console.error);
Debug
Known issues
gotchaOnly works with sequelize-typescript decorators; plain Sequelize models are not supported.
fix
Ensure all models use @Table, @Column, @ForeignKey etc. from 'sequelize-typescript'.
affects: >=0.0.0
gotchaDown migration (undo) can fail or produce incorrect SQL, especially with foreign key dependencies.
fix
After generation, manually review and test down commands. Reorder operations if needed.
affects: >=0.0.0
breakingPackage is unmaintained since 2020; may not work with newer Sequelize or sequelize-typescript versions.
fix
Consider alternatives like Umzug or sequelize-auto-migrations. Fork and update if necessary.
affects: >=0.0.0
gotchaGenerated migration files use CommonJS (require) even if project uses ESM.
fix
No built-in config for ESM output; manually convert generated files or use a transpiler.
affects: >=0.0.0
deprecatedEngine requirement node >=10; no support for Node 16+ specific features.
fix
Test with your Node version; consider upgrading package or using alternative.
affects: >=0.0.0
Errors
Common errors & fixes
Cannot find module 'sequelize-typescript'
sequelize-typescript not installed
fix
npm install sequelize-typescript
TypeError: SequelizeTypescriptMigration.makeMigration is not a function
Wrong import style (ESM vs CJS)
fix
Use: import { SequelizeTypescriptMigration } from 'sequelize-typescript-migration'
ValidationError: Model 'CarBrand' is not associated with sequelize instance
Models not loaded into Sequelize instance
fix
Pass models path or add models explicitly: new Sequelize({ ..., models: [__dirname + '/models'] })
Cannot read property 'length' of undefined
Empty or invalid models directory
fix
Ensure models directory contains valid sequelize-typescript model files.
Upgrade
Version history
0.0.4latest on npm
Audit
Dependencies
sequelizerequiredRuntime peer dependency; migration commands use Sequelize types and DataTypes
sequelize-typescriptrequiredRequired for model decorators (Table, Column, ForeignKey, etc.)
Agent activity
17 hits · last 30 days
node
12
Meta
1
Resources
sequelize-typescript-migration-custom — npm install sequelize-typescript-migration-custom · libregistry