Spring boot - disable Liquibase at startup

Question

I want to have Liquibase configured with my Spring Boot application, so I added dependencies to pom.xml and set the path to master.xml in application.properties. This works fine and Spring Boot runs Liquibase at startup. The problem is that now I want to run Liquibase manually, not at startup of application. Should I completely disable auto-configuration for Liquibase or can I use it and only disable running evaluations at startup?

How will you run Liquibase Manually? – Shiva kumar Jun 06 '23 at 13:11 — Shiva kumar, Jun 06 '23 at 13:11

Alex Shesterov · Answer 1 · 2019-07-09T14:52:43.927

115

The relevant property name has changed between Spring versions:

For Spring 4.x.x: the liquibase.enabled=false application property disables Liquibase.
For Spring 5.x.x: the spring.liquibase.enabled=false application property disables Liquibase.

P.S. And for Flyway:

Spring 4.x.x: flyway.enabled=false
Spring 5.x.x: spring.flyway.enabled=false

edited Jul 09 '19 at 14:52

answered Mar 26 '18 at 18:15

Alex Shesterov

26,085
12
82
103

score 38 · Answer 2 · answered Jun 09 '16 at 04:07

38

Add liquibase.enabled=false in your application.properties file

Reference

But if you don't want to use liquibase from application anymore, remove liquibase starter altogether from pom.

answered Jun 09 '16 at 04:07

Sangram Jadhav

2,438
16
17

5

This property was migrated to `spring.liquibase.enabled`. – TJReinert Jul 13 '21 at 22:24

maruf571 · Answer 3 · 2018-03-09T08:32:12.797

34

If you see on the LiquibaseProperties, there is a prefix like

 prefix = "spring.liquibase"

So, My suggestion is to use

spring.liquibase.enabled=false

It solved my problem with spring boot 2.0.0.RC1

edited Mar 09 '18 at 08:32

answered Feb 18 '18 at 05:09

maruf571

1,836
2
21
18

spring.liquibase.enabled=false solved my problem too Spring 2.7.1 – Codigo Morsa Jul 05 '22 at 10:41

score 16 · Answer 4 · answered Feb 16 '18 at 16:28

16

I faced an issue where I wasn't able to disable Liquibase from properties for some reason, so this is how I disabled Liquibase with @Bean annotation:

@Bean
public SpringLiquibase liquibase() {
  SpringLiquibase liquibase = new SpringLiquibase();
  liquibase.setShouldRun(false);
  return liquibase;
}

answered Feb 16 '18 at 16:28

Dávid Elek

171
1
3

After this I've received `org.springframework.beans.factory.NoSuchBeanDefinitionException: No bean named 'liquibase' available` – TOUDIdel Jul 05 '19 at 10:55
1

This worked for me. It is the only solution that makes a SpringLiquibase bean available for autowiring without running on startup. Remember to put it in a @Configuration class. – David H May 27 '20 at 15:14

score 15 · Answer 5 · edited Sep 09 '20 at 06:11

15

There is one more programmatic approach.

@EnableAutoConfiguration(exclude = LiquibaseAutoConfiguration.class)

on Application main class

edited Sep 09 '20 at 06:11

Lennonry

345
1
7

answered Aug 12 '20 at 06:35

Abhishek Chatterjee

1,962
2
23
31

score 3 · Answer 6 · answered Jun 08 '16 at 19:30

3

If you want to run Liquibase manually, you could use the liquibase maven plugin. Just add something like this to your pom.xml:

  <plugin>
    <groupId>org.liquibase</groupId>
    <artifactId>liquibase-maven-plugin</artifactId>
    <version>${liquibase.version}</version>
    <configuration>
      <changeLogFile>src/main/liquibase/master.xml</changeLogFile>
      <propertyFile>src/main/liquibase/liquibase.properties</propertyFile>
      <promptOnNonLocalDatabase>false</promptOnNonLocalDatabase>
    </configuration>
  </plugin>

You can take a look at the plugin documentation for the configuration details.

And don't use the liquibase support from Spring Boot, as it is only meant to be used in runtime. Just remove the liquibase starter and/or any related dependencies as you'll only need the maven plugin.

answered Jun 08 '16 at 19:30

Cèsar

1,206
11
22

The problem with this is that when spring boot finds liquibase on the classpath it will try to execute on startup afaik. – Kevin Vasko Oct 20 '16 at 17:33
1

That's why you have to remove the liquibase starter, or any direct liquibase dependency if you added any. If you only have the liquibase maven plugin, liquibase is not in the application classpath. – Cèsar Oct 24 '16 at 06:22
If you disable it during the startup, how will we trigger to run the DB scripts which need to be run ? – Shiva kumar May 30 '23 at 13:30

score 3 · Answer 7 · answered Mar 15 '23 at 14:39

3

Another approach for application.yml:

spring:
  autoconfigure:
    exclude:
      - org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration

answered Mar 15 '23 at 14:39

Denis.Kipchakbaev

970
15
24

RJC · Answer 8 · 2023-01-18T09:04:13.503

1

Whilst the documented Spring Boot solution is spring.liquibase.enabled=false, it didn't work for me. To disable liquibase you can also use the following property:

liquibase.shouldRun=false

I passed this as a command line parameter when launching the Spring Boot jar

-Dliquibase.shouldRun=false

see https://docs.liquibase.com/parameters/should-run.html

edited Jan 18 '23 at 09:04

answered Jan 18 '23 at 08:48

RJC

375
4
11

score 0 · Answer 9 · answered Jan 12 '23 at 07:19

0

You can use the spring.liquibase.enabled=true/false

answered Jan 12 '23 at 07:19

EthanHunt007

26
1

1

Your answer could be improved with additional supporting information. Please [edit] to add further details, such as citations or documentation, so that others can confirm that your answer is correct. You can find more information on how to write good answers [in the help center](/help/how-to-answer). – Community Jan 13 '23 at 13:17

Spring boot - disable Liquibase at startup

9 Answers9

Linked