diff --git a/misc/UpdatingDatabaseSchema.md b/misc/UpdatingDatabaseSchema.md index 375d909c1f..d0277a0261 100644 --- a/misc/UpdatingDatabaseSchema.md +++ b/misc/UpdatingDatabaseSchema.md @@ -17,17 +17,15 @@ Creating a JPA change-set ------------------------- We use Liquibase to support updating the database. The change-sets are located in -`connections/jpa-liquibase/src/main/resources/META-INF`. There's a separate file for each release that requires database -changes. +[`model/jpa/src/main/resources/META-INF`](../model/jpa/src/main/resources/META-INF). +There's a separate file for each release that requires database changes. To manually create a change-set add a new file in the above location with the name `jpa-changelog-.xml`. This file should contain a single `change-set` with `id` equal to the next version to be released and `author` set to your email -address. Then look at Liquibase documentation on how to write this file. Add a reference to this file in `jpa-changelog-master.xml`. +address. Then look at Liquibase documentation on how to write this file. Add a reference to this file in +[`jpa-changelog-master.xml`](../model/jpa/src/main/resources/META-INF/jpa-changelog-master.xml). The file should have a single change-set and the id of the change-set should be the next version to be released. -You also need to update `org.keycloak.connections.jpa.updater.JpaUpdaterProvider#LAST_VERSION`. This -is used by Keycloak to quickly determine if the database is up to date or not. - You can also have Liquibase and Hibernate create one for you. To do this follow these steps: 1. Delete existing databases diff --git a/model/jpa/src/main/java/org/keycloak/connections/jpa/updater/JpaUpdaterProvider.java b/model/jpa/src/main/java/org/keycloak/connections/jpa/updater/JpaUpdaterProvider.java index 37228e3e52..ae6745086e 100755 --- a/model/jpa/src/main/java/org/keycloak/connections/jpa/updater/JpaUpdaterProvider.java +++ b/model/jpa/src/main/java/org/keycloak/connections/jpa/updater/JpaUpdaterProvider.java @@ -27,14 +27,45 @@ import java.sql.Connection; */ public interface JpaUpdaterProvider extends Provider { + /** + * Status of database up-to-dateness + */ enum Status { - VALID, EMPTY, OUTDATED + /** + * Database is valid and up to date + */ + VALID, + /** + * No database exists. + */ + EMPTY, + /** + * Database needs to be updated + */ + OUTDATED } + /** + * Updates the Keycloak database + * @param connection DB connection + * @param defaultSchema DB connection + */ void update(Connection connection, String defaultSchema); + /** + * Checks whether Keycloak database is up to date with the most recent changesets + * @param connection DB connection + * @param defaultSchema DB schema to use + * @return + */ Status validate(Connection connection, String defaultSchema); + /** + * Exports the SQL update script into the given File. + * @param connection DB connection + * @param defaultSchema DB schema to use + * @param file File to write to + */ void export(Connection connection, String defaultSchema, File file); } diff --git a/model/jpa/src/main/java/org/keycloak/connections/jpa/updater/liquibase/LiquibaseJpaUpdaterProvider.java b/model/jpa/src/main/java/org/keycloak/connections/jpa/updater/liquibase/LiquibaseJpaUpdaterProvider.java index b4a50a9c4d..957c79a328 100755 --- a/model/jpa/src/main/java/org/keycloak/connections/jpa/updater/liquibase/LiquibaseJpaUpdaterProvider.java +++ b/model/jpa/src/main/java/org/keycloak/connections/jpa/updater/liquibase/LiquibaseJpaUpdaterProvider.java @@ -37,6 +37,7 @@ import java.lang.reflect.Method; import java.sql.Connection; import java.util.List; import java.util.Set; +import liquibase.LabelExpression; /** * @author Stian Thorgersen @@ -95,7 +96,7 @@ public class LiquibaseJpaUpdaterProvider implements JpaUpdaterProvider { protected void updateChangeSet(Liquibase liquibase, String changelog, File exportFile) throws LiquibaseException, IOException { - List changeSets = liquibase.listUnrunChangeSets((Contexts) null); + List changeSets = liquibase.listUnrunChangeSets((Contexts) null, new LabelExpression()); if (!changeSets.isEmpty()) { List ranChangeSets = liquibase.getDatabase().getRanChangeSetList(); if (ranChangeSets.isEmpty()) { @@ -159,7 +160,7 @@ public class LiquibaseJpaUpdaterProvider implements JpaUpdaterProvider { } protected Status validateChangeSet(Liquibase liquibase, String changelog) throws LiquibaseException { - List changeSets = liquibase.listUnrunChangeSets((Contexts) null); + List changeSets = liquibase.listUnrunChangeSets((Contexts) null, new LabelExpression()); if (!changeSets.isEmpty()) { if (changeSets.size() == liquibase.getDatabaseChangeLog().getChangeSets().size()) { return Status.EMPTY; diff --git a/model/jpa/src/main/resources/META-INF/jpa-changelog-1.6.1.xml b/model/jpa/src/main/resources/META-INF/jpa-changelog-1.6.1.xml index 3871de2fee..4b2066f4c8 100644 --- a/model/jpa/src/main/resources/META-INF/jpa-changelog-1.6.1.xml +++ b/model/jpa/src/main/resources/META-INF/jpa-changelog-1.6.1.xml @@ -19,7 +19,7 @@ - + @@ -84,7 +84,7 @@ - + @@ -101,7 +101,7 @@ - +