Separate R2DBC and JDBC database initialization

Co-authored-by: Phillip Webb <[email protected]>

Author: wilkinsona

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/jdbc/DataSourcePoolMetricsAutoConfigurationTests.java

@@ -33,7 +33,7 @@
 import org.springframework.boot.actuate.autoconfigure.metrics.test.MetricsRun;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
-import org.springframework.boot.autoconfigure.sql.init.SqlInitializationAutoConfiguration;
+import org.springframework.boot.autoconfigure.jdbc.DataSourceInitializationAutoConfiguration;
 import org.springframework.boot.jdbc.DataSourceBuilder;
 import org.springframework.boot.jdbc.metadata.DataSourcePoolMetadataProvider;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
@@ -123,8 +123,8 @@ void autoConfiguredHikariDataSourceIsInstrumented() {
 	@Test
 	void autoConfiguredHikariDataSourceIsInstrumentedWhenUsingDataSourceInitialization() {
 		this.contextRunner.withPropertyValues("spring.sql.init.schema:db/create-custom-schema.sql")
-			.withConfiguration(
-					AutoConfigurations.of(DataSourceAutoConfiguration.class, SqlInitializationAutoConfiguration.class))
+			.withConfiguration(AutoConfigurations.of(DataSourceAutoConfiguration.class,
+					DataSourceInitializationAutoConfiguration.class))
 			.run((context) -> {
 				context.getBean(DataSource.class).getConnection();
 				MeterRegistry registry = context.getBean(MeterRegistry.class);

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/orm/jpa/HibernateMetricsAutoConfigurationTests.java

@@ -35,9 +35,9 @@
 import org.springframework.boot.actuate.autoconfigure.metrics.test.MetricsRun;
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
+import org.springframework.boot.autoconfigure.jdbc.DataSourceInitializationAutoConfiguration;
 import org.springframework.boot.autoconfigure.orm.jpa.EntityManagerFactoryBuilderCustomizer;
 import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
-import org.springframework.boot.autoconfigure.sql.init.SqlInitializationAutoConfiguration;
 import org.springframework.boot.orm.jpa.EntityManagerFactoryBuilder;
 import org.springframework.boot.test.context.FilteredClassLoader;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
@@ -154,7 +154,7 @@ void entityManagerFactoryInstrumentationDoesNotDeadlockWithDeferredInitializatio
 		this.contextRunner
 			.withPropertyValues("spring.jpa.properties.hibernate.generate_statistics:true",
 					"spring.sql.init.schema-locations:city-schema.sql", "spring.sql.init.data-locations=city-data.sql")
-			.withConfiguration(AutoConfigurations.of(SqlInitializationAutoConfiguration.class))
+			.withConfiguration(AutoConfigurations.of(DataSourceInitializationAutoConfiguration.class))
 			.withBean(EntityManagerFactoryBuilderCustomizer.class,
 					() -> (builder) -> builder.setBootstrapExecutor(new SimpleAsyncTaskExecutor()))
 			.run((context) -> {

spring-boot-project/spring-boot-autoconfigure-all/src/main/java/org/springframework/boot/autoconfigure/sql/init/SqlDataSourceScriptDatabaseInitializer.java renamed to spring-boot-project/spring-boot-autoconfigure-all/src/main/java/org/springframework/boot/autoconfigure/jdbc/ApplicationDataSourceScriptDatabaseInitializer.java

@@ -14,13 +14,14 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.autoconfigure.sql.init;
+package org.springframework.boot.autoconfigure.jdbc;
 
 import javax.sql.DataSource;
 
+import org.springframework.boot.autoconfigure.sql.init.ApplicationScriptDatabaseInitializer;
+import org.springframework.boot.autoconfigure.sql.init.SqlInitializationProperties;
 import org.springframework.boot.jdbc.init.DataSourceScriptDatabaseInitializer;
 import org.springframework.boot.sql.init.DatabaseInitializationSettings;
-import org.springframework.context.annotation.ImportRuntimeHints;
 
 /**
  * {@link DataSourceScriptDatabaseInitializer} for the primary SQL database. May be
@@ -30,39 +31,27 @@
  * @author Phillip Webb
  * @since 2.6.0
  */
-@ImportRuntimeHints(SqlInitializationScriptsRuntimeHints.class)
-public class SqlDataSourceScriptDatabaseInitializer extends DataSourceScriptDatabaseInitializer {
+public class ApplicationDataSourceScriptDatabaseInitializer extends DataSourceScriptDatabaseInitializer
+		implements ApplicationScriptDatabaseInitializer {
 
 	/**
-	 * Create a new {@link SqlDataSourceScriptDatabaseInitializer} instance.
+	 * Create a new {@link ApplicationDataSourceScriptDatabaseInitializer} instance.
 	 * @param dataSource the primary SQL data source
 	 * @param properties the SQL initialization properties
-	 * @see #getSettings
 	 */
-	public SqlDataSourceScriptDatabaseInitializer(DataSource dataSource, SqlInitializationProperties properties) {
-		this(dataSource, getSettings(properties));
+	public ApplicationDataSourceScriptDatabaseInitializer(DataSource dataSource,
+			SqlInitializationProperties properties) {
+		this(dataSource, ApplicationScriptDatabaseInitializer.getSettings(properties));
 	}
 
 	/**
-	 * Create a new {@link SqlDataSourceScriptDatabaseInitializer} instance.
+	 * Create a new {@link ApplicationDataSourceScriptDatabaseInitializer} instance.
 	 * @param dataSource the primary SQL data source
 	 * @param settings the database initialization settings
-	 * @see #getSettings
 	 */
-	public SqlDataSourceScriptDatabaseInitializer(DataSource dataSource, DatabaseInitializationSettings settings) {
+	public ApplicationDataSourceScriptDatabaseInitializer(DataSource dataSource,
+			DatabaseInitializationSettings settings) {
 		super(dataSource, settings);
 	}
 
-	/**
-	 * Adapts {@link SqlInitializationProperties SQL initialization properties} to
-	 * {@link DatabaseInitializationSettings}.
-	 * @param properties the SQL initialization properties
-	 * @return a new {@link DatabaseInitializationSettings} instance
-	 * @see #SqlDataSourceScriptDatabaseInitializer(DataSource,
-	 * DatabaseInitializationSettings)
-	 */
-	public static DatabaseInitializationSettings getSettings(SqlInitializationProperties properties) {
-		return SettingsCreator.createFrom(properties);
-	}
-
 }

spring-boot-project/spring-boot-autoconfigure-all/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceAutoConfiguration.java

@@ -30,7 +30,6 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
 import org.springframework.boot.autoconfigure.jdbc.metadata.DataSourcePoolMetadataProvidersConfiguration;
-import org.springframework.boot.autoconfigure.sql.init.SqlInitializationAutoConfiguration;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.jdbc.DataSourceBuilder;
 import org.springframework.boot.jdbc.EmbeddedDatabaseConnection;
@@ -56,7 +55,7 @@
  * @author Olga Maciaszek-Sharma
  * @since 1.0.0
  */
-@AutoConfiguration(before = SqlInitializationAutoConfiguration.class)
+@AutoConfiguration(before = DataSourceInitializationAutoConfiguration.class)
 @ConditionalOnClass({ DataSource.class, EmbeddedDatabaseType.class })
 @ConditionalOnMissingBean(type = "io.r2dbc.spi.ConnectionFactory")
 @EnableConfigurationProperties(DataSourceProperties.class)

spring-boot-project/spring-boot-autoconfigure-all/src/main/java/org/springframework/boot/autoconfigure/sql/init/DataSourceInitializationConfiguration.java renamed to spring-boot-project/spring-boot-autoconfigure-all/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceInitializationAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,30 +14,46 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.autoconfigure.sql.init;
+package org.springframework.boot.autoconfigure.jdbc;
 
 import javax.sql.DataSource;
 
+import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;
+import org.springframework.boot.autoconfigure.sql.init.ApplicationScriptDatabaseInitializer;
+import org.springframework.boot.autoconfigure.sql.init.ConditionalOnSqlInitialization;
+import org.springframework.boot.autoconfigure.sql.init.SqlInitializationProperties;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.jdbc.DataSourceBuilder;
+import org.springframework.boot.sql.init.dependency.DatabaseInitializationDependencyConfigurer;
 import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
 import org.springframework.jdbc.datasource.SimpleDriverDataSource;
 import org.springframework.jdbc.datasource.init.DatabasePopulator;
 import org.springframework.util.StringUtils;
 
-@Configuration(proxyBeanMethods = false)
-@ConditionalOnMissingBean({ SqlDataSourceScriptDatabaseInitializer.class, SqlR2dbcScriptDatabaseInitializer.class })
+/**
+ * Auto-configuration for {@link DataSource} initialization.
+ *
+ * @author Andy Wilkinson
+ * @author Phillip Webb
+ * @since 4.0.0
+ */
+@AutoConfiguration
+@ConditionalOnMissingBean(ApplicationScriptDatabaseInitializer.class)
 @ConditionalOnSingleCandidate(DataSource.class)
 @ConditionalOnClass(DatabasePopulator.class)
-class DataSourceInitializationConfiguration {
+@Import(DatabaseInitializationDependencyConfigurer.class)
+@EnableConfigurationProperties(SqlInitializationProperties.class)
+@ConditionalOnSqlInitialization
+public class DataSourceInitializationAutoConfiguration {
 
 	@Bean
-	SqlDataSourceScriptDatabaseInitializer dataSourceScriptDatabaseInitializer(DataSource dataSource,
+	ApplicationDataSourceScriptDatabaseInitializer dataSourceScriptDatabaseInitializer(DataSource dataSource,
 			SqlInitializationProperties properties) {
-		return new SqlDataSourceScriptDatabaseInitializer(
+		return new ApplicationDataSourceScriptDatabaseInitializer(
 				determineDataSource(dataSource, properties.getUsername(), properties.getPassword()), properties);
 	}
 

spring-boot-project/spring-boot-autoconfigure-all/src/main/java/org/springframework/boot/autoconfigure/sql/init/SqlR2dbcScriptDatabaseInitializer.java renamed to spring-boot-project/spring-boot-autoconfigure-all/src/main/java/org/springframework/boot/autoconfigure/r2dbc/ApplicationR2dbcScriptDatabaseInitializer.java

@@ -14,14 +14,16 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.autoconfigure.sql.init;
+package org.springframework.boot.autoconfigure.r2dbc;
 
 import io.r2dbc.spi.ConnectionFactory;
 
 import org.springframework.boot.autoconfigure.batch.BatchDataSourceScriptDatabaseInitializer;
+import org.springframework.boot.autoconfigure.jdbc.ApplicationDataSourceScriptDatabaseInitializer;
+import org.springframework.boot.autoconfigure.sql.init.ApplicationScriptDatabaseInitializer;
+import org.springframework.boot.autoconfigure.sql.init.SqlInitializationProperties;
 import org.springframework.boot.r2dbc.init.R2dbcScriptDatabaseInitializer;
 import org.springframework.boot.sql.init.DatabaseInitializationSettings;
-import org.springframework.context.annotation.ImportRuntimeHints;
 
 /**
  * {@link R2dbcScriptDatabaseInitializer} for the primary SQL database. May be registered
@@ -31,41 +33,27 @@
  * @author Phillip Webb
  * @since 2.6.0
  */
-@ImportRuntimeHints(SqlInitializationScriptsRuntimeHints.class)
-public class SqlR2dbcScriptDatabaseInitializer extends R2dbcScriptDatabaseInitializer {
+public class ApplicationR2dbcScriptDatabaseInitializer extends R2dbcScriptDatabaseInitializer
+		implements ApplicationScriptDatabaseInitializer {
 
 	/**
-	 * Create a new {@link SqlDataSourceScriptDatabaseInitializer} instance.
+	 * Create a new {@link ApplicationDataSourceScriptDatabaseInitializer} instance.
 	 * @param connectionFactory the primary SQL connection factory
 	 * @param properties the SQL initialization properties
-	 * @see #getSettings
 	 */
-	public SqlR2dbcScriptDatabaseInitializer(ConnectionFactory connectionFactory,
+	public ApplicationR2dbcScriptDatabaseInitializer(ConnectionFactory connectionFactory,
 			SqlInitializationProperties properties) {
-		super(connectionFactory, getSettings(properties));
+		super(connectionFactory, ApplicationScriptDatabaseInitializer.getSettings(properties));
 	}
 
 	/**
 	 * Create a new {@link BatchDataSourceScriptDatabaseInitializer} instance.
 	 * @param connectionFactory the primary SQL connection factory
 	 * @param settings the database initialization settings
-	 * @see #getSettings
 	 */
-	public SqlR2dbcScriptDatabaseInitializer(ConnectionFactory connectionFactory,
+	public ApplicationR2dbcScriptDatabaseInitializer(ConnectionFactory connectionFactory,
 			DatabaseInitializationSettings settings) {
 		super(connectionFactory, settings);
 	}
 
-	/**
-	 * Adapts {@link SqlInitializationProperties SQL initialization properties} to
-	 * {@link DatabaseInitializationSettings}.
-	 * @param properties the SQL initialization properties
-	 * @return a new {@link DatabaseInitializationSettings} instance
-	 * @see #SqlR2dbcScriptDatabaseInitializer(ConnectionFactory,
-	 * DatabaseInitializationSettings)
-	 */
-	public static DatabaseInitializationSettings getSettings(SqlInitializationProperties properties) {
-		return SettingsCreator.createFrom(properties);
-	}
-
 }

spring-boot-project/spring-boot-autoconfigure-all/src/main/java/org/springframework/boot/autoconfigure/r2dbc/R2dbcAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -31,7 +31,6 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnResource;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
-import org.springframework.boot.autoconfigure.sql.init.SqlInitializationAutoConfiguration;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Import;
@@ -44,7 +43,7 @@
  * @author Stephane Nicoll
  * @since 2.3.0
  */
-@AutoConfiguration(before = { DataSourceAutoConfiguration.class, SqlInitializationAutoConfiguration.class })
+@AutoConfiguration(before = { DataSourceAutoConfiguration.class, R2dbcInitializationAutoConfiguration.class })
 @ConditionalOnClass(ConnectionFactory.class)
 @ConditionalOnResource(resources = "classpath:META-INF/services/io.r2dbc.spi.ConnectionFactoryProvider")
 @EnableConfigurationProperties(R2dbcProperties.class)

spring-boot-project/spring-boot-autoconfigure-all/src/main/java/org/springframework/boot/autoconfigure/sql/init/R2dbcInitializationConfiguration.java renamed to spring-boot-project/spring-boot-autoconfigure-all/src/main/java/org/springframework/boot/autoconfigure/r2dbc/R2dbcInitializationAutoConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,35 +14,47 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.autoconfigure.sql.init;
+package org.springframework.boot.autoconfigure.r2dbc;
 
 import io.r2dbc.spi.ConnectionFactory;
 
+import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;
+import org.springframework.boot.autoconfigure.jdbc.ApplicationDataSourceScriptDatabaseInitializer;
+import org.springframework.boot.autoconfigure.sql.init.ConditionalOnSqlInitialization;
+import org.springframework.boot.autoconfigure.sql.init.SqlInitializationProperties;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.boot.r2dbc.ConnectionFactoryBuilder;
+import org.springframework.boot.sql.init.dependency.DatabaseInitializationDependencyConfigurer;
 import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
 import org.springframework.r2dbc.connection.init.DatabasePopulator;
 import org.springframework.util.StringUtils;
 
 /**
- * Configuration for initializing an SQL database accessed through an R2DBC
+ * Auto-configuration for initializing an SQL database accessed through an R2DBC
  * {@link ConnectionFactory}.
  *
  * @author Andy Wilkinson
+ * @author Phillip Webb
+ * @since 4.0.0
  */
-@Configuration(proxyBeanMethods = false)
+@AutoConfiguration
 @ConditionalOnClass({ ConnectionFactory.class, DatabasePopulator.class })
 @ConditionalOnSingleCandidate(ConnectionFactory.class)
-@ConditionalOnMissingBean({ SqlR2dbcScriptDatabaseInitializer.class, SqlDataSourceScriptDatabaseInitializer.class })
-class R2dbcInitializationConfiguration {
+@ConditionalOnMissingBean({ ApplicationR2dbcScriptDatabaseInitializer.class,
+		ApplicationDataSourceScriptDatabaseInitializer.class })
+@ConditionalOnSqlInitialization
+@Import(DatabaseInitializationDependencyConfigurer.class)
+@EnableConfigurationProperties(SqlInitializationProperties.class)
+public class R2dbcInitializationAutoConfiguration {
 
 	@Bean
-	SqlR2dbcScriptDatabaseInitializer r2dbcScriptDatabaseInitializer(ConnectionFactory connectionFactory,
+	ApplicationR2dbcScriptDatabaseInitializer r2dbcScriptDatabaseInitializer(ConnectionFactory connectionFactory,
 			SqlInitializationProperties properties) {
-		return new SqlR2dbcScriptDatabaseInitializer(
+		return new ApplicationR2dbcScriptDatabaseInitializer(
 				determineConnectionFactory(connectionFactory, properties.getUsername(), properties.getPassword()),
 				properties);
 	}

spring-boot-project/spring-boot-autoconfigure-all/src/main/java/org/springframework/boot/autoconfigure/sql/init/ApplicationScriptDatabaseInitializer.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2012-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.autoconfigure.sql.init;
+
+import org.springframework.boot.sql.init.AbstractScriptDatabaseInitializer;
+import org.springframework.boot.sql.init.DatabaseInitializationSettings;
+import org.springframework.context.annotation.ImportRuntimeHints;
+
+/**
+ * Marker interface for a script-based database initializer that initializes the
+ * application's database.
+ *
+ * @author Andy Wilkinson
+ * @author Phillip Webb
+ * @since 4.0.0
+ * @see AbstractScriptDatabaseInitializer
+ */
+@ImportRuntimeHints(SqlInitializationScriptsRuntimeHints.class)
+public interface ApplicationScriptDatabaseInitializer {
+
+	/**
+	 * Adapts {@link SqlInitializationProperties} to
+	 * {@link DatabaseInitializationSettings}.
+	 * @param properties the properties to adapt
+	 * @return the settings
+	 */
+	static DatabaseInitializationSettings getSettings(SqlInitializationProperties properties) {
+		return SettingsCreator.createFrom(properties);
+	}
+
+}