Registry / database / sequelize-typescript-migration-rafaeltab

sequelize-typescript-migration-rafaeltab

library0.0.1-beta.9jsnpmunverified

This package is a migration tool for Sequelize with TypeScript decorators (sequelize-typescript), generating migration files by scanning model decorators to detect changes. Version 0.0.1-beta.9 is the latest, based on a fork fixing an issue in getDiffActionsFromTables.ts. It is inspired by Django's makemigration but for Sequelize, and it supports only sequelize-typescript model code (not raw Sequelize). The tool generates both up and down functions automatically, though down actions may sometimes fail due to relation ordering. Maintenance is sporadic, and the package is in beta with limited community support.

database

npm install sequelize-typescript-migration-rafaeltab

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SEQUELIZE-TYPESCRI

sequelize-typescript-migration-rafaeltab

databasejavascriptv0.0.1-beta.9

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

Named export, not default. Use ESM import as shown.

makeMigration

✓ SequelizeTypescriptMigration.makeMigration(sequelize, options)

The only exported method. Options include outDir, migrationName, and preview.

default import

✓ import * as SequelizeTypescriptMigration from 'sequelize-typescript-migration'

✗ import SequelizeTypescriptMigration from 'sequelize-typescript-migration'

Package has no default export; use named import or namespace import.

Generates a migration file by scanning sequelize-typescript models. Adjust database config and model path accordingly.

import { Sequelize } from 'sequelize-typescript'; import { SequelizeTypescriptMigration } from 'sequelize-typescript-migration'; import * as path from 'path'; const sequelize = new Sequelize({ database: 'test', dialect: 'sqlite', storage: ':memory:', models: [__dirname + '/models'], // Path to your decorated models }); async function migrate() { await SequelizeTypescriptMigration.makeMigration(sequelize, { outDir: path.join(__dirname, './migrations'), migrationName: 'initial', preview: false, }); console.log('Migration files generated.'); } migrate().catch(console.error);

Debug

Known issues

breakingDown actions may fail due to relation ordering issues.

fix

Manually adjust generated migration code to ensure correct order of operations.

affects: >=0.0.1

deprecatedPackage is in beta with infrequent updates; consider official Sequelize migrations or other maintained tools.

fix

Evaluate alternatives like sequelize-cli or umzug for production use.

affects: >=0.0.1

gotchaOnly supports sequelize-typescript decorator models, not raw Sequelize model definitions.

fix

Ensure all models use @Table and @Column decorators from sequelize-typescript.

affects: >=0.0.1

Errors

Common errors & fixes

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

Package not installed or import path incorrect.

fix

Run 'npm install sequelize-typescript-migration' and verify import path matches package name.

TypeError: SequelizeTypescriptMigration.makeMigration is not a function

Default import used instead of named import.

fix

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

Upgrade

Version history

0.0.1-beta.9latest on npm

Audit

Dependencies

sequelize-typescriptrequiredRequired to define models with decorators that this tool scans.

Agent activity

14 hits · last 30 days

node