Table of Contents
- Why we have added the ChangeUnit annotation and deprecated ChangeLog
- I've migrated to Mongock 5 and there are some existing @ChangeLog classes in my project. Should I remove or change them?
- What happens if a changeUnit fails
- Should I implement the @RollbackExecution method in transactional environments?
- Can Mongock be used in applications deployed in Kubernetes?
- Does the CLI change something in my application?
- Until which Spring data version is MongockTemplate compatible with?
- I have some references to MongockTemplate in my project and I've upgraded to version 5, should I remove them?
- What's the difference between undo and rollback?
# Why we have added the ChangeUnit annotation and deprecated ChangeLog
Mongock team is aware of the implications of this change, that's why is totally backward compatible. All the old code related to
@ChangeSet will remain compatible.
However, the Mongock team has identified that the old changelog structure starts to struggle handling new features. The configuration was cumbersome and a bit more complex that needed.
This is the reason we have added the
@ChangeUnit. A more practical version of the
@ChangeLog, which can be see as a changeLog, wich a unique and mandatory changeSet(
@Execution) that also requires a complementary method
More information in the migration section.
# I've migrated to Mongock 5 and there are some existing @ChangeLog classes in my project. Should I remove or change them?
No. Your old changeLogs should remain untouched. Although deprecated, they will remain in the code for backward compatibility.
For more information about the recommended approach, please visit this section.
# What happens if a changeUnit fails
Mongock always try to rollback the failed changes. In a transactional environment, Mongock relies on the database transactional mechanism to rollback the migration changes(
@Execution method) as well as the mongock metadata associated to the change. In summary it would be like that change was never started. In a non-transactional environment, Mongock manually tries to rollback the migration change by executing the
@RollbackExecution method and marks the change entry as
ROLLED_BACK in the database. Please notice that although Mongock will try its best to achieve this, it's not guaranteed.
Once the rollback operation is performed, Mongock will abort the migration and throw an exception. The next time Mongock is executed will carry on from the failed changeUnit. You need to understand that if the changeUnit keep failing, Mongock will keep aborting. In an self-deployed infrastructure like Kubernetes this potentially means get into an infinite loop.
# Should I implement the @RollbackExecution method in transactional environments?
Yes, we highly recommend to implement the
The main reason for this is that some other operations like undo, rely on this method to work. However it's a very good practice as it provides a robust system that is less affected when moving to non-transactional environments.
# Can Mongock be used in applications deployed in Kubernetes?
Yes. Actually the main use of Mongock is as part of the application start up, shipping together code and data changes, providing safer migrations in distributed systems.
# Does the CLI change something in my application?
No. The CLI just takes from your application what is needed to run the migration.
With Mongock standalone, it takes the
MongockBuilderProvider implementations and retrieves the builder. For Springboot, by default it loads the entire Springboot context, but you can filter which configuration class to load by annotating the main class with
@MongockCliConfiguration. For more information please visit the cli page.
# Until which Spring data version is MongockTemplate compatible with?
4.2.3. But you can use more recent version of Spring Data. MongockTemplate won't reflect the new API, but it won't complain.
# I have some references to MongockTemplate in my project and I've upgraded to version 5, should I remove them?
No, even if you use a more updated version of Spring Data. You just use Spring MongoTemplate for now on.
# What's the difference between undo and rollback?
Rollback is the act of reverting a change after failing at execution time. On the other hand undo is the act of reverting a change some time after being successfully executed.