Registry / database / sequelize-typescript-model-migration

sequelize-typescript-model-migration

library1.0.13jsnpmunverified

Auto-generate migration scripts from sequelize-typescript model decorators, similar to Django's makemigration. Stable version 1.0.13, based on sequelize-typescript-migration but with fixes for @Index not working, SequelizeMeta table issues, and table option underscore:true. Supports sequelize-typescript 2.x and sequelize 6.x. Uses snapshot files to store model state. Adds prettier formatting for generated files. Release cadence is low; no recent updates indicating active development.

database

npm install sequelize-typescript-model-migration

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SEQUELIZE-TYPESCRI

sequelize-typescript-model-migration

databasejavascriptv1.0.13

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.

generateMigration

✓ import { generateMigration } from 'sequelize-typescript-model-migration'

✗ const generateMigration = require('sequelize-typescript-model-migration').generateMigration

ESM only; use import syntax

generateMigration

✓ const { generateMigration } = require('sequelize-typescript-model-migration')

✗ import * as migration from 'sequelize-typescript-model-migration'

CommonJS users: destructure require

default

✓ import migrationTool from 'sequelize-typescript-model-migration'

✗ import { default } from 'sequelize-typescript-model-migration'

No default export; use named export

Shows how to import generateMigration, create Sequelize instance with models, and generate a migration with options.

import { Sequelize } from 'sequelize-typescript'; import { generateMigration } from 'sequelize-typescript-model-migration'; const sequelize = new Sequelize({ database: 'test', username: 'root', password: '', host: 'localhost', dialect: 'mysql', models: [__dirname + '/models'] }); await generateMigration(sequelize, { outDir: __dirname + '/migrations', snapshotDir: __dirname + '/snapshots', migrationName: 'initial', prettierOptions: { singleQuote: true } }); console.log('Migration generated');

Debug

Known issues

gotchaSnapshot directory must exist or be created before generation; library does not create it automatically.

fix

Use fs.mkdirSync to ensure snapshotDir exists before calling generateMigration.

affects: >=1.0.0

breakingRequires sequelize-typescript 2.x or later; incompatible with sequelize-typescript 1.x.

fix

Upgrade sequelize-typescript to 2.x or later.

affects: >=1.0.0

deprecatedThe library is a fork of sequelize-typescript-migration which is no longer maintained.

fix

Consider using Sequelize's native migrations or a more maintained alternative.

affects: >=1.0.0

brokengenerateMigration may fail if models are not loaded into Sequelize before calling.

fix

Ensure models are loaded via sequelize.addModels() or by passing them in the Sequelize constructor options.

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: sequelize.models is not iterable

Models not loaded into sequelize instance

fix

Add models to Sequelize constructor or call sequelize.addModels([...models]) before generateMigration.

Cannot find module 'sequelize-typescript-model-migration'

Package not installed

fix

Run npm install --save-dev sequelize-typescript-model-migration

Upgrade

Version history

1.0.13latest on npm

Audit

Dependencies

sequelize-typescriptrequiredpeer dependency for model decorators and Sequelize instance

sequelizerequiredpeer dependency for Sequelize instance and migration runner

Agent activity

18 hits · last 30 days

node