Add migrate options: --one, --all, --to, --only

[realkarych]

Implements #631 according to #633

[realkarych]

@dossy please review

[dossy]

Code and tests look fair, although questionable whether it's better to parameterize the migrate function vs. duplicating it with minor changes, and tests are passing, which is good.

However, I won't be approving this PR because I recognize that the decision to accept or reject this change needs to be made by someone who is better qualified to decide if this is a good change or not.

See also: #316, #434, #438.

[realkarych]

Code and tests look fair, although questionable whether it's better to parameterize the migrate function vs. duplicating it with minor changes, and tests are passing, which is good.

However, I won't be approving this PR because I have elected to not involve myself in feature requests of this nature as I have no use for them, and I feel it encourages use of dbmate that are better served by other tools.

See also: #316, #434, #438.

Okey, who can make a decision about this feature? I agree that the option of the migrate command instead migrate-next would be better.

@amacneil Hi! What do you think about that?

[amacneil]

There is lots of prior discussion about this:

• add ability to specify rollback limit/amount and the target version to migrate to #256
• Add --number flag to dbmate down #316
• specify specific migrations to use #434
• Filter migrations #438

Including some thoughts I posted in #438 (comment)

I would like to see a proposal that solves all (or most) of these use cases:

1. Apply or rollback 1 (or n?) pending migrations
2. Apply or rollback a specific migration
3. Apply all migrations up to (and including) a specific migration version
4. Rollback all migrations down to (excluding) a specific migration version
5. Rollback all migrations

I think we can do this within the scope of the current migrate and rollback commands, without introducing a new command.

For example (open for comments, I think these cover all the needs people have expressed in the past):

# these flags would be supported for `dbmate up` and `dbmate down` too

dbmate migrate               # existing: apply all pending migrations
dbmate rollback              # existing: rollback one version

dbmate migrate --only 0003   # apply only this version
dbmate rollback --only 0003  # rollback only this version

dbmate migrate --to 0003     # migrate up to this version (inclusive)
dbmate rollback --to 0003    # roll back to this version (exclusive, i.e. the specified version will become the current applied version)

dbmate migrate --one         # apply one pending migration
dbmate rollback --one        # this is the default, maybe included for consistency?

dbmate rollback --all        # special case to rollback all migrations
dbmate migrate --all         # this is the default, maybe included for consistency?

[realkarych]

There is lots of prior discussion about this:

• add ability to specify rollback limit/amount and the target version to migrate to #256
• Add --number flag to dbmate down #316
• specify specific migrations to use #434
• Filter migrations #438

Including some thoughts I posted in #438 (comment)

I would like to see a proposal that solves all (or most) of these use cases:

1. Apply or rollback 1 (or n?) pending migrations
2. Apply or rollback a specific migration
3. Apply all migrations up to (and including) a specific migration version
4. Rollback all migrations down to (excluding) a specific migration version
5. Rollback all migrations

I think we can do this within the scope of the current migrate and rollback commands, without introducing a new command.

For example (open for comments, I think these cover all the needs people have expressed in the past):

# these flags would be supported for `dbmate up` and `dbmate down` too

dbmate migrate               # existing: apply all pending migrations
dbmate rollback              # existing: rollback one version

dbmate migrate --only 0003   # apply only this version
dbmate rollback --only 0003  # rollback only this version

dbmate migrate --to 0003     # migrate up to this version (inclusive)
dbmate rollback --to 0003    # roll back to this version (exclusive, i.e. the specified version will become the current applied version)

dbmate migrate --one         # apply one pending migration
dbmate rollback --one        # this is the default, maybe included for consistency?

dbmate rollback --all        # special case to rollback all migrations
dbmate migrate --all         # this is the default, maybe included for consistency?

So good, I'll implement this in current PR this week.

[amacneil]

epic!

let us know when ready for a review

[realkarych]

@amacneil @dossy Ready for Review! 😊

[tjarbo]

Hi, first of all thank you very much for the PR! These features are really missing IMO and are making dbmate a perfect tool for our use-cases.

In order to make my contribution to the project, I had a closer look on the code changes and I have two comments/questions. Hope this can bring the PR a bit closer to get merged in the future!

[tjarbo]

Compared to the RollbackTo func, the MigrateTo func applies changes even if the intended target does not exists. I would suggest to align the behaviour here and fail with an error msg before any changes are applied if the defined target does not exist.

[realkarych]

Correct! Thanks for feedback. I fixed this case: added step that checks if target exists in window to apply.

[tjarbo]

Any specific reason, why you are reimplementing the "apply migrations steps" (as far as I can see, this is just duplicated code) and not reusing the MigrateOnly function?
Same question of course applies to the Rollback* equivalent functions of course.

[realkarych]

No reason :)
Fixed!

[realkarych]

@tjarbo Ready for re-review =)

[tjarbo]

The code looks good to me. Thanks a lot!
A disclaimer for the the maintainers: I have not tested the code functionally speaking.

I just have another two small comments, but they are not worth to block the PR. I leave it up to you whether to implement them or not.

[tjarbo]

Hi @amacneil
is there anything else I can do to unblock this PR so that it can be merged?

Best regards

[NINNiT]

Thanks for your work - really looking forward to this! It would help immensely in our CI pipelines / tests.

Any news on when this will make it in? 🚀

[realkarych]

Thanks for your work - really looking forward to this! It would help immensely in our CI pipelines / tests.

Any news on when this will make it in? 🚀

Call for @amacneil =)

I will resolve conflict if this pr will be merged after that.