Repository navigation
Command plan
github-actions[bot] edited this page Nov 17, 2026
·
1 revision
Shows what up would do, without changing anything. Read-only.
migrate-mongo plan [--only migrations|collections] [--allow-* ...]
$ migrate-mongo plan
▶ 20261014164028 add-email-index-to-users (no transaction)
▶ 20261014164029 split-full-name (transaction)
⟳ orders
+ create companyId_1_createdAt_-1 { companyId: 1, createdAt: -1 }
~ modify closedAt_1 expireAfterSeconds 2592000 → 604800
- hide legacy_ref not declared
! keep status_1 not declared (prune: report)
⟳ customers in sync
Would apply 2 migration(s) as batch 2 and change 1 collection(s).
It takes up's --only and --allow-* options, so you can check exactly what a run with
them would do.
While migrations are pending, the collection changes are worked out against the database as it is now, so they may change once the migrations have run.
| Code | When |
|---|---|
0 |
Nothing to do. |
2 |
There are migrations to apply or collection changes to make. Use it to gate a deployment. |
4 |
A collection change isn't allowed (e.g. a rebuild with indexes.onRebuild: fail). |
Both show the same thing. plan exits 2 when there's pending work; up --dry-run
exits with the code a real up would (0 when it would succeed).
Kevsoft.MigrateMongo ·
NuGet ·
Releases ·
Issues ·
Found a mistake? These pages live in
wiki/ on main; pull requests welcome.
Get started
Migrations
- Writing Migrations
- Transactions
- Recording Results
- Dependency Injection
- Custom Templates
- Adopting an Existing Database
Collections
- Managing Collections
- Indexes
- Search Indexes
- Collection Options
- Validators
- Views
- Undeclared Collections
Deploying
Connecting
Reference
Concepts