Registry / database / sequelize-typescript-migration

sequelize-typescript-migration

library0.0.1-beta.3jsnpmunverified

sequelize-typescript-migration is a migration tool for Sequelize with TypeScript, inspired by Django's makemigration command. It scans TypeScript models decorated with @Table, @Column, @ForeignKey etc., detects schema changes, and auto-generates migration files with up/down commands. Version 0.0.1-beta.3 is an early beta with limited feature completeness — it only supports creation of tables, not advanced operations like column alterations or renames. Release cadence is low; the project is unmaintained since 2020. Key differentiator: it eliminates manual migration writing for TypeScript Sequelize users, but lacks support for existing Sequelize JavaScript models and may produce unreliable down migrations.

database devops

npm install sequelize-typescript-migration

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SEQUELIZE-TYPESCRI

sequelize-typescript-migration

databasejavascriptv0.0.1-beta.3

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'

✗ import SequelizeTypescriptMigration from 'sequelize-typescript-migration'

Named export only, no default export. Cannot use require() as it's ESM-style.

MigrationOptions

✓ import { MigrationOptions } from 'sequelize-typescript-migration'

Type export for TypeScript, not runtime. Define options object inline without import if preferred.

Sequelize (from sequelize-typescript)

✓ import { Sequelize } from 'sequelize-typescript'

✗ import { Sequelize } from 'sequelize'

Must use sequelize-typescript's Sequelize instance, not plain sequelize, for decorator integration.

Generates a migration file by scanning sequelize-typescript models; requires sequelize-typescript instance, not plain sequelize.

import { Sequelize } from 'sequelize-typescript'; import { SequelizeTypescriptMigration } from 'sequelize-typescript-migration'; import * as path from 'path'; const sequelize = new Sequelize({ database: process.env.DB_NAME ?? 'test', username: process.env.DB_USER ?? 'root', password: process.env.DB_PASS ?? '', host: process.env.DB_HOST ?? 'localhost', dialect: 'mysql', models: [__dirname + '/models'], // path to your models }); async function runMigration() { await SequelizeTypescriptMigration.makeMigration(sequelize, { outDir: path.join(__dirname, '../migrations'), migrationName: 'add-awesome-field-in-my-table', preview: false, }); console.log('Migration file generated!'); } runMigration().catch(console.error);

Debug

Known issues

breakingThis package is in early beta (0.0.1-beta) and has been abandoned since 2020. No further updates or bug fixes are expected.

fix

Consider alternatives like umzug directly, or use sequelize-cli with manual migration scripts.

affects: *

deprecatedRequires sequelize-typescript v1.x; incompatible with sequelize-typescript v2 or newer which uses different decorators.

fix

Ensure dependency resolution pins sequelize-typescript to v1.x; upgrade not possible without forking.

affects: >=0.0.0

gotchaThe generated migration only detects table creation; it does not detect column additions, deletions, or alterations. Down migrations may be incomplete.

fix

Manually edit generated migrations for any schema changes beyond initial table creation.

affects: *

gotchaOnly works with models defined using sequelize-typescript decorators; plain Sequelize model definitions are not supported.

fix

Rewrite models with decorators or use a different migration tool.

affects: *

Errors

Common errors & fixes

TypeError: sequelize_typescript_1.SequelizeTypescriptMigration.makeMigration is not a function

Importing default instead of named export.

fix

Use `import { SequelizeTypescriptMigration } from 'sequelize-typescript-migration'`

Error: Cannot find module 'sequelize-typescript-migration'

Package not installed in node_modules.

fix

Run `npm install -D sequelize-typescript-migration`

SequelizeTypescriptMigration is not a constructor

Attempting to instantiate the class via `new SequelizeTypescriptMigration()`, but API expects static method call.

fix

Call `await SequelizeTypescriptMigration.makeMigration(sequelize, options)` directly.

Upgrade

Version history

0.0.1-beta.3latest on npm

Audit

Dependencies

sequelizerequiredPeer dependency required for Sequelize migration execution

sequelize-typescriptrequiredCore dependency for TypeScript decorator scanning

Agent activity

16 hits · last 30 days

node

Resources

githubgit://github.com/kimjbstar/sequelize-typescript-migration ↗

packagesequelize-typescript-migration ↗

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