This is a potentially destructive feature, which should not be turned on in production. It is useful mostly to quickly test uncommited or inconsistent changes in development. + * + * @return + * possible object is + * {@link Boolean } + * + */ + public Boolean isMigrationAllowInvalidCommits() { + return migrationAllowInvalidCommits; + } + + /** + * Whether migrations to invalid commits ({@link org.jooq.Commit#valid()}) are allowed.
This is a potentially destructive feature, which should not be turned on in production. It is useful mostly to quickly test uncommited or inconsistent changes in development. + * + * @param value + * allowed object is + * {@link Boolean } + * + */ + public void setMigrationAllowInvalidCommits(Boolean value) { + this.migrationAllowInvalidCommits = value; } /** @@ -9415,8 +9441,17 @@ public class Settings * Whether migrations are allowed to be executed in inverse order.
This is a potentially destructive feature, which should not be turned on in production. It is useful mostly to quickly switch between branches in a development environment. This feature is available only in commercial distributions. * */ - public Settings withMigrationAllowsUndo(Boolean value) { - setMigrationAllowsUndo(value); + public Settings withMigrationAllowUndo(Boolean value) { + setMigrationAllowUndo(value); + return this; + } + + /** + * Whether migrations to invalid commits ({@link org.jooq.Commit#valid()}) are allowed.
This is a potentially destructive feature, which should not be turned on in production. It is useful mostly to quickly test uncommited or inconsistent changes in development.
+ *
+ */
+ public Settings withMigrationAllowInvalidCommits(Boolean value) {
+ setMigrationAllowInvalidCommits(value);
return this;
}
@@ -9985,7 +10020,8 @@ public class Settings
builder.append("migrationDefaultSchema", migrationDefaultSchema);
builder.append("migrationSchemataCreateSchemaIfNotExists", migrationSchemataCreateSchemaIfNotExists);
builder.append("migrationDefaultContentType", migrationDefaultContentType);
- builder.append("migrationAllowsUndo", migrationAllowsUndo);
+ builder.append("migrationAllowUndo", migrationAllowUndo);
+ builder.append("migrationAllowInvalidCommits", migrationAllowInvalidCommits);
builder.append("migrationRevertUntracked", migrationRevertUntracked);
builder.append("migrationAutoBaseline", migrationAutoBaseline);
builder.append("migrationAutoVerification", migrationAutoVerification);
@@ -11841,12 +11877,21 @@ public class Settings
return false;
}
}
- if (migrationAllowsUndo == null) {
- if (other.migrationAllowsUndo!= null) {
+ if (migrationAllowUndo == null) {
+ if (other.migrationAllowUndo!= null) {
return false;
}
} else {
- if (!migrationAllowsUndo.equals(other.migrationAllowsUndo)) {
+ if (!migrationAllowUndo.equals(other.migrationAllowUndo)) {
+ return false;
+ }
+ }
+ if (migrationAllowInvalidCommits == null) {
+ if (other.migrationAllowInvalidCommits!= null) {
+ return false;
+ }
+ } else {
+ if (!migrationAllowInvalidCommits.equals(other.migrationAllowInvalidCommits)) {
return false;
}
}
@@ -12363,7 +12408,8 @@ public class Settings
result = ((prime*result)+((migrationDefaultSchema == null)? 0 :migrationDefaultSchema.hashCode()));
result = ((prime*result)+((migrationSchemataCreateSchemaIfNotExists == null)? 0 :migrationSchemataCreateSchemaIfNotExists.hashCode()));
result = ((prime*result)+((migrationDefaultContentType == null)? 0 :migrationDefaultContentType.hashCode()));
- result = ((prime*result)+((migrationAllowsUndo == null)? 0 :migrationAllowsUndo.hashCode()));
+ result = ((prime*result)+((migrationAllowUndo == null)? 0 :migrationAllowUndo.hashCode()));
+ result = ((prime*result)+((migrationAllowInvalidCommits == null)? 0 :migrationAllowInvalidCommits.hashCode()));
result = ((prime*result)+((migrationRevertUntracked == null)? 0 :migrationRevertUntracked.hashCode()));
result = ((prime*result)+((migrationAutoBaseline == null)? 0 :migrationAutoBaseline.hashCode()));
result = ((prime*result)+((migrationAutoVerification == null)? 0 :migrationAutoVerification.hashCode()));
diff --git a/jOOQ/src/main/java/org/jooq/impl/MigrationImpl.java b/jOOQ/src/main/java/org/jooq/impl/MigrationImpl.java
index a00146039a..70a2e38bee 100644
--- a/jOOQ/src/main/java/org/jooq/impl/MigrationImpl.java
+++ b/jOOQ/src/main/java/org/jooq/impl/MigrationImpl.java
@@ -199,9 +199,15 @@ final class MigrationImpl extends AbstractScope implements Migration {
validateCommitProvider(ctx, to());
revertUntracked(ctx, null, currentRecord);
- // [#9506] TODO: Better error handling helping the understand see their mistake
- if (!to().valid())
- throw new DataMigrationVerificationException("Commit is not a valid commit to migrate to: " + to());
+ if (!to().valid() && !TRUE.equals(ctx.settings().isMigrationAllowInvalidCommits()))
+ throw new DataMigrationVerificationException(
+ """
+ Commit is not a valid commit to migrate to: {commit}
+ Invalid commits include:
+ - Uncommitted or untracked changes in the GitCommitProvider
+ - Commits leading to inconsistent migration states due to editing of commit paths
+ """.replace("{commit}", to().id())
+ );
}
private final void validateCommitProvider(DefaultMigrationContext ctx, Commit commit) {
@@ -216,9 +222,7 @@ final class MigrationImpl extends AbstractScope implements Migration {
The commit referencing the schema: {commit}.
All schemas that are referenced from commits in a migration must be configured for
- inclusion in the migration
-
- TODO doclink
+ inclusion in the migration.
""".replace("{schema}", schema.toString())
.replace("{commit}", commit.toString())
);
diff --git a/jOOQ/src/main/resources/org/jooq/xsd/jooq-runtime-3.20.0.xsd b/jOOQ/src/main/resources/org/jooq/xsd/jooq-runtime-3.20.0.xsd
index d7fbb6eb60..c4a11f65cd 100644
--- a/jOOQ/src/main/resources/org/jooq/xsd/jooq-runtime-3.20.0.xsd
+++ b/jOOQ/src/main/resources/org/jooq/xsd/jooq-runtime-3.20.0.xsd
@@ -1548,10 +1548,14 @@ deployed on an RDBMS that does not.]]>