mongo-migrate-kitElegant MongoDB migrations for Node.js

Precise, safe migrations for MongoDB. Run a single file, roll back anything, and preview every change before it touches your database.

Start here

5-minute quick start

GitHub

Run one file

mmk up runs just that migration. Useful when you are testing a single change.

mmk up

Undo the right thing

Roll back the last deploy, a batch by number, the last few files, or one file by name. The history stays.

mmk down

See it before it runs

mmk dry-run lists what would run and doesn't write anything. Safe to point at production.

mmk dry-run

Deploys take turns

A lock in MongoDB lets one run go at a time. A second deploy stops and tells you who holds the lock.

How the lock works

Edits get noticed

mmk saves a checksum of each file when it runs. If someone edits an applied file later, you'll know.

Checksums

Easy move from migrate-mongo

mmk import reads your old changelog, so nothing that already ran runs again.

Switching guide

See it run

A preview, a real run, then rolling back one migration by name. This is the actual output.

Terminal: mmk dry-run up lists three pending migrations, mmk up applies them, mmk down rolls back one file by name, and mmk status shows the result

Also in VS Code

Mongo Migrate Kit for VS Code gives you a migration console, a sidebar and run links in your files. It runs your project's own mmk, so the editor and the terminal always agree.

The Mongo Migrate Kit console in VS Code: every migration on local, staging and prod; a plan of three pending migrations, applying them with mmk's output as it comes, the result, rolling the batch back, then prod (read-only) while a CI deploy holds its lock, and the form that edits an environment

You want to	In a terminal	In VS Code
See what would run, then run it	`mmk dry-run up`, then `mmk up`	Plan, then Apply, with mmk's output as it comes
Run or roll back one file	`mmk up <file>`, `mmk down <file>`	The links above `up()` and `down()`
Roll back a batch	`mmk down --batch <n>`	Roll back batch n… in the console
Compare local, staging and prod	`mmk status` once per database	One table in the console
See who holds the lock	`mmk lock`	A line in the console and the sidebar
Notice an edit to a migration that already ran	`mmk status`, after you save	A warning while you type

Install it and see what it does →

Learn it in four steps

Start at the top. Each step takes you a bit further, and you can stop whenever you have what you need.

Get it runningabout 10 minutes
Install it, write your first migration, run it and roll it back.
Quick start →
Understand itabout 15 minutes
What a batch is, where the history lives, and how the lock and checksums protect you.
How it works →
Use it in productionabout 30 minutes
Config, CI pipelines, running on app start, transactions, and what to do when something fails.
Deploying →
Bigger setupswhen you need it
Several repos on one database, moving off migrate-mongo, and long-running data changes.
Sharing a database →

Already on migrate-mongo?

Point mmk at the same database and run mmk import. It copies your history into its own collection and never changes the old one. After that, mmk up only runs what's new.

Terminal: mmk import --dry-run previews three migrate-mongo records, mmk import copies them, and mmk up applies only the one new migration

Read the switching guide →