@mikro-orm/migrations

What is @mikro-orm/migrations?

@mikro-orm/migrations is a package for handling database migrations in MikroORM, an ORM for Node.js. It allows you to create, run, and manage database schema changes in a structured and version-controlled manner.

What are @mikro-orm/migrations's main functionalities?

Creating Migrations

This feature allows you to create a new migration file based on the current state of your entities. The migration file will contain the necessary SQL statements to update the database schema.

const { MikroORM } = require('@mikro-orm/core');
const { Migrator } = require('@mikro-orm/migrations');

(async () => {
  const orm = await MikroORM.init();
  const migrator = orm.getMigrator();
  await migrator.createMigration(); // creates file MigrationYYYYMMDDHHMMSS.ts
})();

Running Migrations

This feature allows you to apply all pending migrations to the database, ensuring that the schema is up-to-date with the latest changes.

const { MikroORM } = require('@mikro-orm/core');
const { Migrator } = require('@mikro-orm/migrations');

(async () => {
  const orm = await MikroORM.init();
  const migrator = orm.getMigrator();
  await migrator.up(); // runs all pending migrations
})();

Reverting Migrations

This feature allows you to revert the last applied migration, which is useful for rolling back changes in case of errors or issues.

const { MikroORM } = require('@mikro-orm/core');
const { Migrator } = require('@mikro-orm/migrations');

(async () => {
  const orm = await MikroORM.init();
  const migrator = orm.getMigrator();
  await migrator.down(); // reverts the last migration
})();

Other packages similar to @mikro-orm/migrations

sequelize-cli

sequelize-cli is a command-line interface for Sequelize, a popular ORM for Node.js. It provides similar functionalities for managing database migrations, including creating, running, and reverting migrations. Compared to @mikro-orm/migrations, sequelize-cli is more widely used and has a larger community, but it is specific to Sequelize.

knex

Knex is a SQL query builder for Node.js that also includes a powerful migration tool. It allows you to create, run, and rollback migrations in a similar manner to @mikro-orm/migrations. Knex is more flexible as it can be used with various SQL databases and is not tied to a specific ORM.

typeorm

TypeORM is another ORM for Node.js that includes built-in support for migrations. It provides similar functionalities for managing database schema changes. TypeORM is comparable to MikroORM in terms of features and capabilities, but it has a different API and design philosophy.

README

TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL and SQLite (including libSQL) databases.

Heavily inspired by Doctrine and Hibernate.

🤔 Unit of What?

You might be asking: What the hell is Unit of Work and why should I care about it?

Unit of Work maintains a list of objects (entities) affected by a business transaction and coordinates the writing out of changes. (Martin Fowler)

Identity Map ensures that each object (entity) gets loaded only once by keeping every loaded object in a map. Looks up objects using the map when referring to them. (Martin Fowler)

So what benefits does it bring to us?

Implicit Transactions

First and most important implication of having Unit of Work is that it allows handling transactions automatically.

When you call em.flush(), all computed changes are queried inside a database transaction (if supported by given driver). This means that you can control the boundaries of transactions simply by calling em.persistLater() and once all your changes are ready, calling flush() will run them inside a transaction.

You can also control the transaction boundaries manually via em.transactional(cb).

const user = await em.findOneOrFail(User, 1);
user.email = '[e-mail]';
const car = new Car();
user.cars.add(car);

// thanks to bi-directional cascading we only need to persist user entity
// flushing will create a transaction, insert new car and update user with new email
// as user entity is managed, calling flush() is enough
await em.flush();

ChangeSet based persistence

MikroORM allows you to implement your domain/business logic directly in the entities. To maintain always valid entities, you can use constructors to mark required properties. Let's define the User entity used in previous example:

@Entity()
export class User {

  @PrimaryKey()
  id!: number;

  @Property()
  name!: string;

  @OneToOne(() => Address)
  address?: Address;

  @ManyToMany(() => Car)
  cars = new Collection<Car>(this);

  constructor(name: string) {
    this.name = name;
  }

}

Now to create new instance of the User entity, we are forced to provide the name:

const user = new User('John Doe'); // name is required to create new user instance
user.address = new Address('10 Downing Street'); // address is optional

Once your entities are loaded, make a number of synchronous actions on your entities, then call em.flush(). This will trigger computing of change sets. Only entities (and properties) that were changed will generate database queries, if there are no changes, no transaction will be started.

const user = await em.findOneOrFail(User, 1, {
  populate: ['cars', 'address.city'],
});
user.title = 'Mr.';
user.address.street = '10 Downing Street'; // address is 1:1 relation of Address entity
user.cars.getItems().forEach(car => car.forSale = true); // cars is 1:m collection of Car entities
const car = new Car('VW');
user.cars.add(car);

// now we can flush all changes done to managed entities
await em.flush();

em.flush() will then execute these queries from the example above:

begin;
update "user" set "title" = 'Mr.' where "id" = 1;
update "user_address" set "street" = '10 Downing Street' where "id" = 123;
update "car"
  set "for_sale" = case
    when ("id" = 1) then true
    when ("id" = 2) then true
    when ("id" = 3) then true
    else "for_sale" end
  where "id" in (1, 2, 3)
insert into "car" ("brand", "owner") values ('VW', 1);
commit;

Identity Map

Thanks to Identity Map, you will always have only one instance of given entity in one context. This allows for some optimizations (skipping loading of already loaded entities), as well as comparison by identity (ent1 === ent2).

📖 Documentation

MikroORM documentation, included in this repo in the root directory, is built with Docusaurus and publicly hosted on GitHub Pages at https://mikro-orm.io.

There is also auto-generated CHANGELOG.md file based on commit messages (via semantic-release).

✨ Core Features

• Clean and Simple Entity Definition
• Identity Map
• Entity References
• Using Entity Constructors
• Modelling Relationships
• Collections
• Unit of Work
• Transactions
• Cascading persist and remove
• Composite and Foreign Keys as Primary Key
• Filters
• Using QueryBuilder
• Preloading Deeply Nested Structures via populate
• Property Validation
• Lifecycle Hooks
• Vanilla JS Support
• Schema Generator
• Entity Generator

📦 Example Integrations

You can find example integrations for some popular frameworks in the mikro-orm-examples repository:

TypeScript Examples

• Express + MongoDB
• Nest + MySQL
• RealWorld example app (Nest + MySQL)
• Koa + SQLite
• GraphQL + PostgreSQL
• Inversify + PostgreSQL
• NextJS + MySQL
• Accounts.js REST and GraphQL authentication + SQLite
• Nest + Shopify + PostgreSQL + GraphQL
• Elysia.js + libSQL + Bun
• Electron.js + PostgreSQL

JavaScript Examples

• Express + SQLite

🚀 Quick Start

First install the module via yarn or npm and do not forget to install the database driver as well:

Since v4, you should install the driver package, but not the db connector itself, e.g. install @mikro-orm/sqlite, but not sqlite3 as that is already included in the driver package.

yarn add @mikro-orm/core @mikro-orm/mongodb       # for mongo
yarn add @mikro-orm/core @mikro-orm/mysql         # for mysql/mariadb
yarn add @mikro-orm/core @mikro-orm/mariadb       # for mysql/mariadb
yarn add @mikro-orm/core @mikro-orm/postgresql    # for postgresql
yarn add @mikro-orm/core @mikro-orm/mssql         # for mssql
yarn add @mikro-orm/core @mikro-orm/sqlite        # for sqlite
yarn add @mikro-orm/core @mikro-orm/better-sqlite # for better-sqlite
yarn add @mikro-orm/core @mikro-orm/libsql        # for libsql

or

npm i -s @mikro-orm/core @mikro-orm/mongodb       # for mongo
npm i -s @mikro-orm/core @mikro-orm/mysql         # for mysql/mariadb
npm i -s @mikro-orm/core @mikro-orm/mariadb       # for mysql/mariadb
npm i -s @mikro-orm/core @mikro-orm/postgresql    # for postgresql
npm i -s @mikro-orm/core @mikro-orm/mssql         # for mssql
npm i -s @mikro-orm/core @mikro-orm/sqlite        # for sqlite
npm i -s @mikro-orm/core @mikro-orm/better-sqlite # for better-sqlite
npm i -s @mikro-orm/core @mikro-orm/libsql        # for libsql

Next, if you want to use decorators for your entity definition, you will need to enable support for decorators as well as esModuleInterop in tsconfig.json via:

"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"esModuleInterop": true,

Alternatively, you can use EntitySchema.

Then call MikroORM.init as part of bootstrapping your app:

To access driver specific methods like em.createQueryBuilder() we need to specify the driver type when calling MikroORM.init(). Alternatively we can cast the orm.em to EntityManager exported from the driver package:

import { EntityManager } from '@mikro-orm/postgresql';
const em = orm.em as EntityManager;
const qb = em.createQueryBuilder(...);

import type { PostgreSqlDriver } from '@mikro-orm/postgresql'; // or any other SQL driver package

const orm = await MikroORM.init<PostgreSqlDriver>({
  entities: ['./dist/entities'], // path to your JS entities (dist), relative to `baseDir`
  dbName: 'my-db-name',
  type: 'postgresql',
});
console.log(orm.em); // access EntityManager via `em` property

There are more ways to configure your entities, take a look at installation page.

Read more about all the possible configuration options in Advanced Configuration section.

Then you will need to fork entity manager for each request so their identity maps will not collide. To do so, use the RequestContext helper:

const app = express();

app.use((req, res, next) => {
  RequestContext.create(orm.em, next);
});

You should register this middleware as the last one just before request handlers and before any of your custom middleware that is using the ORM. There might be issues when you register it before request processing middleware like queryParser or bodyParser, so definitely register the context after them.

More info about RequestContext is described here.

Now you can start defining your entities (in one of the entities folders). This is how simple entity can look like in mongo driver:

./entities/MongoBook.ts

@Entity()
export class MongoBook {

  @PrimaryKey()
  _id: ObjectID;

  @SerializedPrimaryKey()
  id: string;

  @Property()
  title: string;

  @ManyToOne(() => Author)
  author: Author;

  @ManyToMany(() => BookTag)
  tags = new Collection<BookTag>(this);

  constructor(title: string, author: Author) {
    this.title = title;
    this.author = author;
  }

}

For SQL drivers, you can use id: number PK:

./entities/SqlBook.ts

@Entity()
export class SqlBook {

  @PrimaryKey()
  id: number;

}

Or if you want to use UUID primary keys:

./entities/UuidBook.ts

import { v4 } from 'uuid';

@Entity()
export class UuidBook {

  @PrimaryKey()
  uuid = v4();

}

More information can be found in defining entities section in docs.

When you have your entities defined, you can start using ORM either via EntityManager or via EntityRepositorys.

To save entity state to database, you need to persist it. Persist takes care or deciding whether to use insert or update and computes appropriate change-set. Entity references that are not persisted yet (does not have identifier) will be cascade persisted automatically.

// use constructors in your entities for required parameters
const author = new Author('Jon Snow', '[e-mail]');
author.born = new Date();

const publisher = new Publisher('7K publisher');

const book1 = new Book('My Life on The Wall, part 1', author);
book1.publisher = publisher;
const book2 = new Book('My Life on The Wall, part 2', author);
book2.publisher = publisher;
const book3 = new Book('My Life on The Wall, part 3', author);
book3.publisher = publisher;

// just persist books, author and publisher will be automatically cascade persisted
await em.persistAndFlush([book1, book2, book3]);

To fetch entities from database you can use find() and findOne() of EntityManager:

const authors = em.find(Author, {}, { populate: ['books'] });

for (const author of authors) {
  console.log(author); // instance of Author entity
  console.log(author.name); // Jon Snow

  for (const book of author.books) { // iterating books collection
    console.log(book); // instance of Book entity
    console.log(book.title); // My Life on The Wall, part 1/2/3
  }
}

More convenient way of fetching entities from database is by using EntityRepository, that carries the entity name, so you do not have to pass it to every find and findOne calls:

const booksRepository = em.getRepository(Book);

const books = await booksRepository.find({ author: '...' }, { 
  populate: ['author'],
  limit: 1,
  offset: 2,
  orderBy: { title: QueryOrder.DESC },
});

console.log(books); // Loaded<Book, 'author'>[]

Take a look at docs about working with EntityManager or using EntityRepository instead.

🤝 Contributing

Contributions, issues and feature requests are welcome. Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.

Authors

👤 Martin Adámek

• Twitter: @B4nan
• Github: @b4nan

See also the list of contributors who participated in this project.

Show Your Support

Please ⭐️ this repository if this project helped you!

📝 License

Copyright © 2018 Martin Adámek.

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

6.4.0 (2024-11-11)

Bug Fixes

• core: add missing getterName option (aa18e57), closes #6127
• core: allow upserting POJO with embeddded instances (159fd4a), closes #6198
• core: check that inverse side exists when mapping collection items via dataloader (#6149) (f580598), closes #6148
• core: ensure decimal type that maps to number won't produce extra updates (cc67ca4)
• core: fix double processing of custom types in em.nativeUpdate (1b39846), closes #6206
• core: fix explicit serialization typing via wrap().serialize and BaseEntity.serialize (d93b325)
• core: ignore collection properties when entity constructors are enforced (78a5937)
• core: improve comparison of decimal values (66e60cb), closes #6194
• core: improve error handling for comparing invalid dates (#6120) (1aa940b)
• core: pass correct values to constructor for props using custom types (58c8ce4)
• core: rename tsNode option to preferTs (#6214) (194f511)
• core: revert workaround for Date properties in clone() helper (c1af3db), closes #6118
• core: use db value for identity map key of PKs with custom type (aa1dd3c), closes #6150
• entity-generator: output inverse sides for pure pivot tables when outputted (#6196) (e4b048b), closes #6192
• mssql: map property names to field names when processing composite keys (cf687e8), closes #6204
• postgres: make upsert where conditions fully qualified (b4b3cab), closes #6203
• postgres: return all results for multi statement raw queries (adcef5f), closes #6009
• postgres: support raw fragments in qb.distinctOn() (f8580c8)
• query-builder: fix detection of raw fragments in update queries with not matching field names (22b918f), closes #6177
• query-builder: fix serialization of nested relations (3850c1e), closes #6194

Features

• core: add @Transactional() decorator (#6143) (babe4da)
• core: add onQuery hook (#6200) (6f98b3c)
• core: add prefixMode option to embeddables (#6113) (5df26e1), closes #6112
• core: allow defining multiple named configurations in one config file (#6201) (cecea34), closes #6067
• core: improve support for sharing columns in multiple properties (05318c1)
• core: schedule orphan removal on old 1:1 relations regardless of their init state (fc9a1c1), closes #5213
• core: upsert managed entities (#6197) (a3b5e57), closes #6055
• core: validate non-persistent relations are not composite (#6216) (16c8b48)
• entity-generator: added support for forceUndefined being false (#5849) (e0ce840)
• migrations: allow passing list of classes to migrationsList (#6102) (35d84ac), closes #6099
• migrations: allow subscribing to migrator events (18a425c), closes #5763
• mssql: add support for smalldatetime type (#6128) (998509b), closes #5904
• query-builder: add qb.andHaving() and qb.orHaving() methods (c36d4c8), closes #5796
• query-builder: allow joins on update queries (782e227), closes #6150
• schema: diff foreign keys also by the constraint name (93ade9d), closes #6146

Performance Improvements

• schema: filter tables before fetching table details (#6138) (74bf43f), closes #5900