Disable all Database related auto configuration in Spring Boot

Question

I am using Spring Boot to develop two applications, one serves as the server and other one is a client app. However, both of them are the same app that function differently based on the active profile. I am using auto configuration feature of Spring Boot to configure my applications.

I want to disable all the database related auto configuration on client app, since it won't be requiring database connection. Application should not try to establish connection with the database, nor try to use any of the Spring Data or Hibernate features. The enabling or disabling of the database auto configuration should be conditional and based on the active profile of the app.

Can I achieve this by creating two different application.properties files for respective profiles?

I tried adding this to my properties file,

spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration\
  org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration\
org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration\
  org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration

But, the application still tries to connect to the database on start. Are those exclusions sufficient for achieving my requirement?

You can also use your build tool profiles and add the data related dependencies only on one of your profiles. If your package your app using the other profile, since it hasn't the required starter packages present on the classpath, it won't be auto-configured — Ali Dehghani
– Ali Dehghani, Commented Apr 3, 2016 at 18:02

starball · Accepted Answer · 2022-12-24 20:58:55Z

156

The way I would do similar thing is:

@Configuration
@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class, DataSourceTransactionManagerAutoConfiguration.class, HibernateJpaAutoConfiguration.class})
@Profile ("client_app_profile_name")
public class ClientAppConfiguration {
    //it can be left blank
}

Write similar one for the server app (without excludes).

Last step is to disable Auto Configuration from main spring boot class:

@SpringBootApplication
public class SomeApplication extends SpringBootServletInitializer {

    public static void main(String[] args) {
        SpringApplication.run(SomeApplication.class);
    }

    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(SomeApplication.class);
    }
}

Change: @SpringBootApplication into:

@Configuration 
@ComponentScan

This should do the job. Now, the dependencies that I excluded in the example might be incomplete. They were enough for me, but im not sure if its all to completely disable database related libraries. Check the list below to be sure:

http://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#auto-configuration-classes

edited Dec 24, 2022 at 20:58

starball♦

59.5k52 gold badges312 silver badges1k bronze badges

answered Apr 4, 2016 at 12:57

patrykos91

3,7362 gold badges28 silver badges30 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Abhijit Sarkar Over a year ago

@SpringBootApplication has an exclude property, no need for ClientAppConfiguration.

patrykos91 Over a year ago

Can you do that exclude conditional based on active profile without using ClientAppConfiguration?

Abhijit Sarkar Over a year ago

Yes. You'd exclude in the @SpringBootApplication, and then in the specific package, create a @Configuration class which does an @Import of the relevant classes and is dependent on @Profile or @Conditional. That way, you can test each application layer without the autoconfig leaking all over the app. Wanna test DB? Just scan the DB package, configure a mock DB, and you're good to go.

Stefan Falk Over a year ago

I am using flyway.. My server fails because it's not able to initialize flyway because of the missing configuration. I tried to add FlywayAutoConfiguration.FlywayConfiguration.class but it's not working. Any ideas? ^^

Seth Falco · Accepted Answer · 2023-09-07 00:27:20Z

156

To disable all the database related autoconfiguration and exit from:

Cannot determine embedded database driver class for database type NONE

Using Annotations

@SpringBootApplication
@EnableAutoConfiguration(exclude = {
    DataSourceAutoConfiguration.class,
    DataSourceTransactionManagerAutoConfiguration.class,
    HibernateJpaAutoConfiguration.class})
public class Application {
   
    public static void main(String[] args) {
        SpringApplication.run(PayPalApplication.class, args);
    }
}

Using `application.properties`

spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration

Using `application.yml`

spring:
  autoconfigure:
    exclude:
      - org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
      - org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration

edited Sep 7, 2023 at 0:27

Seth Falco

6941 gold badge11 silver badges25 bronze badges

answered May 16, 2017 at 2:14

Jorge López

1,9591 gold badge13 silver badges8 bronze badges

5 Comments

Gustavo Rodrigues Over a year ago

the use of Application.properties with Spring Boot 2+ is preferable over the annotation.

Betlista Over a year ago

@GustavoRodrigues can you share some documentation to support your statement? Thanks!

Andrew Alcock Over a year ago

@Betlista This is because the change that disables the DataSource autoconfiguration can occur in the version of application.properties you use for development. The production application.properties defines the DataSource. Thus the code is identical in development and production.

Simon Logic Over a year ago

@GustavoRodrigues you can't disable with property because DataSourceAutoconfigurationCondition is triggered on DataSource class available on classpath.

Jackie Over a year ago

How come when I try the annotation I get "Attributes should be specified via @SpringBootApplication"

Julien May · Accepted Answer · 2016-08-25 18:24:37Z

Seems like you just forgot the comma to separate the classes. So based on your configuration the following will work:

spring.autoconfigure.exclude=org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\
    org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\
    org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,\
    org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration

Alternatively you could also define it as follow:

spring.autoconfigure.exclude[0]=org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
spring.autoconfigure.exclude[1]=org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration
spring.autoconfigure.exclude[2]=org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration
spring.autoconfigure.exclude[3]=org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration

naXa stands with Ukraine · Accepted Answer · 2018-03-14 11:10:53Z

28

There's a way to exclude specific auto-configuration classes using @SpringBootApplication annotation.

@Import(MyPersistenceConfiguration.class)
@SpringBootApplication(exclude = {
        DataSourceAutoConfiguration.class, 
        DataSourceTransactionManagerAutoConfiguration.class,
        HibernateJpaAutoConfiguration.class})
public class MySpringBootApplication {         
    public static void main(String[] args) {
        SpringApplication.run(MySpringBootApplication.class, args);
    }
}

@SpringBootApplication#exclude attribute is an alias for @EnableAutoConfiguration#exclude attribute and I find it rather handy and useful.
I added @Import(MyPersistenceConfiguration.class) to the example to demonstrate how you can apply your custom database configuration.

answered Mar 14, 2018 at 11:10

naXa stands with Ukraine

38.6k25 gold badges208 silver badges278 bronze badges

1 Comment

Joshua Davis Over a year ago

Thanks! This is the most modern answer. Linked to it here: konstructcomputers.blogspot.com/2018/10/…

Bojan Vukasovic · Accepted Answer · 2021-10-24 18:55:27Z

12

If using application.yml:

spring:
  autoconfigure:
    exclude:
      - org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
      - org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration
      - org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration
      - org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration

answered Oct 24, 2021 at 18:55

Bojan Vukasovic

2,2881 gold badge30 silver badges58 bronze badges

Comments

ryzhman · Accepted Answer · 2016-10-27 08:39:26Z

10

Way out for me was to add

@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class, DataSourceTransactionManagerAutoConfiguration.class, HibernateJpaAutoConfiguration.class})

annotation to class running Spring boot (marked with `@SpringBootApplication).

Finally, it looks like:

@SpringBootApplication
@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class, DataSourceTransactionManagerAutoConfiguration.class, HibernateJpaAutoConfiguration.class})
public class Application{

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
 }

answered Oct 27, 2016 at 8:39

ryzhman

67410 silver badges23 bronze badges

Comments

D-rk · Accepted Answer · 2019-04-09 11:37:11Z

9

Another way to control it via Profiles is this:

// note: no @SpringApplication annotation here
@Import(DatabaseConfig.class)
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

@Configuration
@Import({DatabaseConfig.WithDB.class, DatabaseConfig.WithoutDB.class})
public class DatabaseConfig {

    @Profile("!db")
    @EnableAutoConfiguration(
            exclude = {DataSourceAutoConfiguration.class,   DataSourceTransactionManagerAutoConfiguration.class,
                HibernateJpaAutoConfiguration.class})
    static class WithoutDB {

    }

    @Profile("db")
    @EnableAutoConfiguration
    static class WithDB {

    }
}

answered Apr 9, 2019 at 11:37

D-rk

6,0152 gold badges44 silver badges62 bronze badges

1 Comment

ankur pramanik Over a year ago

Can you tell me how to put a logger inside WithoutDB and WithDB class so that when I start the application print somemessage. Thank you

Sylvain · Accepted Answer · 2020-03-23 22:54:45Z

4

I had the same problem here, solved like this:

Just add another application-{yourprofile}.yml where "yourprofile" could be "client".

In my case I just wanted to remove Redis in a Dev profile, so I added a application-dev.yml next to the main application.yml and it did the job.

In this file I put:

spring.autoconfigure.exclude: org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration

this should work with properties files as well.

I like the fact that there is no need to change the application code to do that.

answered Mar 23, 2020 at 22:54

Sylvain

6495 silver badges26 bronze badges

Comments

user9869932 · Accepted Answer · 2022-03-01 11:57:18Z

2

In my case the spring-boot-starter-jpa dependency was being loaded from other dependency. I did this to disable the DataSource:

Check the dependency tree with mvn dependency:tree

[INFO] com.backend.app:crud-manager:jar:0.1-SNAPSHOT
[INFO] +- ...
[INFO] \- com.backend.app:crud-libraries:jar:0.1-SNAPSHOT:compile
[INFO]    +- org.springframework.boot:spring-boot-starter.data-jpa:jar:2.1.6.RELEASE:compile
[INFO]    +- ....

There was a sub-dependency. Add an exclusion

<dependency>
  <groupId>com.backend.app</groupId>
  <artifactId>crud-libraries</artifactId>
  <exclusions>
    <exclusion> 
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-data-jpa</artifactId>
    <exclusion>
  </exclusions>
</dependency>

Exclude DataSourceAutoConfiguration.class in the Application file

import org.springframework.boot.autoconfigure.jdbc. DataSourceAutoConfiguration;

// add exclude
@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
public class ...

Ensure there is no spring-boot-starter-jpa in pom.xml

** Apart, in case you also need to make it work with spring-boot-starter-batch

In the BatchConfig file:

// add extends DefaultBatchConfig
public class BatchConfig extends DefaultBatchConfig {

//add override
@Override
public void setDataSource(DataSource dataSource) {}

answered Mar 1, 2022 at 11:57

user9869932

7,4873 gold badges62 silver badges52 bronze badges

1 Comment

Tobias Hochgürtel Over a year ago

with mvn dependency:tree you can add exclusions to the spring-data-jpa-starter dependency, to exclude H2 in a project.

Cássia Chagas · Accepted Answer · 2019-10-23 16:33:41Z

I add in myApp.java, after @SpringBootApplication

@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class, DataSourceTransactionManagerAutoConfiguration.class, HibernateJpaAutoConfiguration.class})

And changed

@SpringBootApplication => @Configuration

So, I have this in my main class (myApp.java)

package br.com.company.project.app;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration;
import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableAutoConfiguration(exclude = {DataSourceAutoConfiguration.class, DataSourceTransactionManagerAutoConfiguration.class, HibernateJpaAutoConfiguration.class})
public class SomeApplication {

public static void main(String[] args) {
    SpringApplication.run(SomeApplication.class, args);
}

}

And work for me! =)

Tadele Ayelegn · Accepted Answer · 2018-01-16 03:14:37Z

0

I was getting this error even if I did all the solutions mentioned above.

 by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'dataSource' defined in class path resource [org/springframework/boot/autoconfigure/jdbc/DataSourceConfig ...

At some point when i look up the POM there was this dependency in it

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>

And the Pojo class had the following imports

import javax.persistence.Entity; import javax.persistence.GeneratedValue; import javax.persistence.Id;

Which clearly shows the application was expecting a datasource.

What I did was I removed the JPA dependency from pom and replaced the imports for the pojo with the following once

import org.springframework.data.annotation.Id; import org.springframework.data.mongodb.core.mapping.Document;

Finally I got SUCCESSFUL build. Check it out you might have run into the same problem

answered Jan 16, 2018 at 3:14

Tadele Ayelegn

4,8622 gold badges39 silver badges32 bronze badges

2 Comments

cvnew Over a year ago

This is not a solution to the problem discussed. The issue is not about removing the JPA support from the application all together but rather enable/disable it based on a condition (such as a Spring profile) - without changing the code or Maven project configuration. You were getting the data source related error because, apparently, you forgot to define and activate the Spring profile that would load the "no-datasource" configuration instead of loading the DS/JPA-related classes. The JPA libraries should still remain in the distribution.

Tadele Ayelegn Over a year ago

I do not think you read my post completely. On the last line i am suggesting it may be similiar issue but not saying that is the answer

Vity · Accepted Answer · 2020-09-11 12:24:23Z

0

Also if you use Spring Actuator org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthContributorAutoConfiguration might be initializing DataSource as well.

answered Sep 11, 2020 at 12:24

Vity

3724 silver badges17 bronze badges

Comments

Netsab612 · Accepted Answer · 2024-12-02 11:34:23Z

0

Also, if you are using mongoDB, the configuration is :

spring:
  autoconfigure:
    exclude:
      - org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration
      - org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration
      - org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration

answered Dec 2, 2024 at 11:34

Netsab612

1132 silver badges11 bronze badges

Collectives™ on Stack Overflow

Disable all Database related auto configuration in Spring Boot

13 Answers 13

4 Comments

Using Annotations

Using `application.properties`

Using `application.yml`

5 Comments

Comments

1 Comment

Comments

Comments

1 Comment

Comments

1 Comment

Comments

2 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

13 Answers 13

4 Comments

Using Annotations

Using application.properties

Using application.yml

5 Comments

Comments

1 Comment

Comments

Comments

1 Comment

Comments

1 Comment

Comments

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related

Using `application.properties`

Using `application.yml`