Add a `migrate:dry-run` command

[Baskarayelu]

Summary

Print the SQL the next migrate up would run without executing it.

Background

This change improves the day-to-day experience for the people who consume this code (operators, downstream contracts, frontend engineers, support). It is not a strict bug, but the current behaviour forces workarounds and the proposed change removes them.

Acceptance criteria

• The change matches the summary above.
• No regression in the existing test suite.
• The change is documented where it is observable (README, docs/, public API reference).
• Lint, type-check, and tests all pass locally.
• PR description references this issue with Closes #<this-issue>.

Implementation hints

• Keep the public API surface backwards-compatible if possible. If a breaking change is unavoidable, document the migration step.
• Land any new constant in a single place (config/, consts.rs, or the equivalent) and re-use it everywhere.
• Update the relevant docs/ page in the same PR so reviewers see the docs change together with the code change.
• Add or update the corresponding test so the new behaviour is locked in.

Repo-specific notes

• Run npx tsc --noEmit, npm test, and the security:scan / sbom:check scripts locally before pushing.
• Any new request or response shape must have a matching Zod schema and a regenerated OpenAPI entry.
• New env vars must be added to .env.example and to the relevant deployment doc.

Out of scope

• Unrelated refactors in adjacent files.
• Stylistic-only changes (formatting, renaming) that are not required by the fix.
• Anything beyond the acceptance criteria above; surface follow-ups as separate issues.

How to claim and submit

1. Comment on this issue saying you'd like to take it on; wait for a maintainer to assign you (avoids duplicated effort).
2. Open a PR that references this issue (Closes #<this-issue>).
3. Make sure CI is green and request review from a CODEOWNERS maintainer.
4. PRs that close this issue and pass review may qualify for a reward — see the MAYBE REWARDED label and the GrantFox OSS campaign page.

---

Category: enhancement  ·  Campaign: GrantFox OSS · Official Campaign · Maybe Rewarded

[Jo-anny]

@Jo-anny has applied to work on this issue as part of the Stellar Wave Program's 6th wave.

Hi, I would love to work on this issue.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Jo-anny to this issue.

[lxx197818]

Hi maintainers, I'd like to take this if it is still open.\n\nPlan:\n- inspect the existing migration runner/config first and add dry-run behavior at the same abstraction layer;\n- make dry-run report the migrations that would run without mutating the database;\n- preserve existing migration execution paths and lock/guardrail behavior for normal runs;\n- add tests using a fake migration list/runner to prove dry-run skips writes and reports planned actions;\n- document the command and run the requested type-check/test commands before PR.\n\nI will wait for assignment before opening a PR and keep the implementation focused.

[drips-wave]

Congratulations, @Jo-anny! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on June 30, 2026.

🧑‍💻 @Jo-anny: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊

[Baskarayelu]

Closing as completed by PR #600 (changes merged to main via squash; PR was closed during a bulk merge pass).

[drips-wave]

This issue has been completed by @Jo-anny as part of the Stellar Wave Program's 6th Wave 🥳

😎 @Jo-anny: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.

🧑‍💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.