ht-sequelize

library1.4.5jsnpmunverified

A migration generation tool for Sequelize with TypeScript decorators (sequelize-typescript). Version 1.4.5 scans model decorators to detect schema changes and auto-generates up/down migration files, similar to Django's makemigration. Compatible with sequelize v6 (use ~2.0.0) and v4 (use ~1.0.0). Requires Node >=12. Key differentiator: automatic diff-based migration for decorator-based models, reducing manual migration writing. Development is sporadic; forked from multiple community repositories. Down migrations may be unreliable due to relation ordering issues.

database

npm install ht-sequelize

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · HT-SEQUELIZE

ht-sequelize

databasejavascriptv1.4.5

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-ht'

✗ const SequelizeTypescriptMigration = require('sequelize-typescript-migration-ht')

Package supports both ESM and CJS. TypeScript types are included.

makeMigration

✓ import { SequelizeTypescriptMigration } from 'sequelize-typescript-migration-ht'; SequelizeTypescriptMigration.makeMigration(sequelize, options)

✗ import { makeMigration } from 'sequelize-typescript-migration-ht'

makeMigration is a static method on the default export's main class, not a named export.

Generates a migration file by comparing current model decorators to existing database schema. Run this after defining/updating models.

import { Sequelize } from 'sequelize-typescript'; import { join } from 'path'; import { SequelizeTypescriptMigration } from 'sequelize-typescript-migration-ht'; const sequelize = new Sequelize({ dialect: 'sqlite', storage: './database.sqlite', models: [__dirname + '/models'] }); SequelizeTypescriptMigration.makeMigration(sequelize, { outDir: join(__dirname, './migrations'), migrationName: 'initial-migration', preview: false }).then(() => { console.log('Migration generated'); }).catch(err => console.error(err));

Debug

Known issues

gotchaPackage works only with sequelize-typescript decorator-based models, NOT raw sequelize define models.

fix

Use sequelize-typescript decorators (@Table, @Column, etc.) on your models.

affects: >=1.0.0

breakingDown (undo) migrations may fail due to incorrect ordering of foreign key dependencies.

fix

Manually edit the down migration order or review generated migration files before running.

affects: >=1.0.0

gotchaPackage is a fork of several community repositories; it may have unpatched bugs or missing features.

fix

Test thoroughly in development before using in production. Consider alternatives like sequelize-auto-migrations.

affects: all

gotchaMigration name is auto-generated as 'noname' if not provided in options.

fix

Always provide a descriptive migrationName in options.

affects: >=1.0.0

Errors

Common errors & fixes

Error: No models found. Make sure your models are loaded using sequelize-typescript.

Sequelize instance is not initialized with sequelize-typescript models, or models directory is incorrect.

fix

Use `new Sequelize({ models: [__dirname + '/models'] })` or explicitly add models via `sequelize.addModels([...])`.

SequelizeTypescriptMigration is not a constructor

Incorrect import: trying to use `new SequelizeTypescriptMigration()` instead of calling static method.

fix

Use `SequelizeTypescriptMigration.makeMigration(sequelize, options)` directly, no instantiation needed.

Upgrade

Version history

1.4.5latest on npm

Audit

Dependencies

sequelize-typescriptrequiredRequired for model decorator parsing (not raw sequelize)

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/alin1124/sequelize-typescript-migration ↗

packageht-sequelize ↗

homepagehttps://github.com/alin1124/sequelize-typescript-migration ↗