How to use multiple liquibase files in a module?

bgevam · June 2, 2015, 1:46pm

I am currently developing an openmrs module. Like in every module i have a liquibase file, where the data i want to add to the database is specified. Here’s my question:

In the openmrs-core there are several liquibase files. There is a great seperation into liquibase-core-data.xml (setup the database content) and liquibase-schema-only.xml (set up the database schema).

In my module i want to do the same approach for setting up my tables, so the module setup works similar to openmrs-core.

But only files named exact “liquibase.xml” are executed.

How can I make it work? Or is this separation in modules complete nonsense? Is it better way to do it in a single file?

Thank you for your support!

darius · June 2, 2015, 2:49pm

I have not seen anyone try to do this. In practice modules rarely create many database tables, so this would be rarely worthwhile. (Also there is sometimes benefit for someone else debugging your module to look at just one file and see the liquibase changesets in order.)

The limitation is in openmrs-core code, around here:

github.com

openmrs/openmrs-core/blob/8bd9b8379dce862861c1b3b913793250dd12d22d/api/src/main/java/org/openmrs/module/ModuleFactory.java#L986


			
		}
		
	}
	
	/**
	 * Execute all unrun changeSets in liquibase.xml for the given module
	 * 
	 * @param module the module being executed on
	 */
	private static void runLiquibase(Module module) {
		JarFile jarFile = null;
		boolean liquibaseFileExists = false;
		
		try {
			try {
				jarFile = new JarFile(module.getFile());
			}
			catch (IOException e) {
				throw new ModuleException("Unable to get jar file", module.getName(), e);
			}

So, it would require a change to openmrs-core to support this (PRs welcome!) but my personal recommendation would be to just go with the single liquibase.xml file.

bgevam · June 10, 2015, 7:18am

Thank you for your response! I think i will stick to the single file solution. Thanks again