feat: Add migrate function #2043
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joc-a
force-pushed
the
joc/feat-migrate-function
branch
4 times, most recently
from
624af92
to
cf247fa
Compare
jackgisel-RL
reviewed
Apr 9, 2024
bog-walk
reviewed
Apr 10, 2024
Comment on lines
125
to
129
| * Applies a database migration from [oldVersion] to [newVersion]. | ||
| * | ||
| * If a migration script with the same name already exists, the existing one will be used as is and a new one will | ||
| * not be generated. This allows you to generate a migration script before the migration and modify it manually if | ||
| * needed. |
There was a problem hiding this comment.
Three things I thought of:
- It's just my opinion, but I think it should be made clear that the migration is being performed using Flyway. Even if the user ultimately doesn't care, at least we're being fully transparent by including it in the KDocs.
- I'd specify how exactly to generate the migration script without performing the migration (at least the name of the function). Last line might be confusing if you don't know that
generateMigrationScriptalready exists. - When KDocs are written this way (with params first & summary last), the purpose of the function is tacked on to the bottom, as part of the 'Throw' section. So mousing over or using quick docs hot keys means the user would have to scroll for the summary and might miss it. It's the same for previous migration functions.
Comment on lines
848
to
850
| * This function uses the Flyway naming convention when generating the migration script. | ||
| * If a migration script with the same name already exists, its content will be overwritten. | ||
| */ |
There was a problem hiding this comment.
If this is the Flyway overload, maybe the function name could be different to make it's purpose more obvious. Or at least the line that differentiates it from the other function should be in the summary so it's more obvious. And the KDocs changed so this paragraph isn't added to the 'Throws' section.
...d-tests/src/test/kotlin/org/jetbrains/exposed/sql/tests/shared/ddl/DatabaseMigrationTests.kt
Outdated
Show resolved
Hide resolved
...d-tests/src/test/kotlin/org/jetbrains/exposed/sql/tests/shared/ddl/DatabaseMigrationTests.kt
Outdated
Show resolved
Hide resolved
e5l
requested changes
Apr 10, 2024
joc-a
force-pushed
the
joc/feat-migrate-function
branch
from
cf247fa
to
62cd4d2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Requesting early feedback for the
migrateAPI using Flyway.The database migration is currently failing for SQLite and MariaDB and needs further investigation. For PostgreSQLNG, it does not work with Flyway without using a DataSource.