Add flexible support for multiple database variations in JdbcChatMemory

Add SQL Server dialect support with new SqlServerChatMemoryDialect class

Create schema-sqlserver.sql script for SQL Server table creation

Refactor database schema initialization with new JdbcChatMemorySchemaInitializer

Standardize table names across databases to SPRING_AI_CHAT_MEMORY

Implement ChatMemoryDialect abstraction for database-specific operations

Add dialect implementations for PostgreSQL, MySQL/MariaDB, HSQLDB

Update configuration properties with more flexible schema initialization options

Enhance documentation with detailed information about dialect support and configuration

Add integration tests for HSQLDB and SQL Server

Signed-off-by: Mark Pollack <[email protected]>

Author: markpollack

auto-configurations/models/chat/memory/spring-ai-autoconfigure-model-chat-memory-jdbc/pom.xml

@@ -78,6 +78,23 @@
 			<artifactId>postgresql</artifactId>
 			<scope>test</scope>
 		</dependency>
+
+		<dependency>
+			<groupId>com.microsoft.sqlserver</groupId>
+			<artifactId>mssql-jdbc</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>org.testcontainers</groupId>
+			<artifactId>mssqlserver</artifactId>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.hsqldb</groupId>
+			<artifactId>hsqldb</artifactId>
+			<scope>runtime</scope>
+		</dependency>
 	</dependencies>
 
 </project>

auto-configurations/models/chat/memory/spring-ai-autoconfigure-model-chat-memory-jdbc/src/main/java/org/springframework/ai/model/chat/memory/jdbc/autoconfigure/JdbcChatMemoryDataSourceScriptDatabaseInitializer.java

@@ -14,19 +14,19 @@
  * limitations under the License.
  */
 
-package org.springframework.ai.model.chat.memory.jdbc.autoconfigure;
+package org.springframework.ai.model.chat.memory.repository.jdbc.autoconfigure;
 
 import javax.sql.DataSource;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import org.springframework.ai.chat.memory.jdbc.JdbcChatMemoryDialect;
 import org.springframework.ai.chat.memory.jdbc.JdbcChatMemoryRepository;
 import org.springframework.ai.model.chat.memory.autoconfigure.ChatMemoryAutoConfiguration;
 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.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
@@ -39,24 +39,23 @@
  */
 @AutoConfiguration(after = JdbcTemplateAutoConfiguration.class, before = ChatMemoryAutoConfiguration.class)
 @ConditionalOnClass({ JdbcChatMemoryRepository.class, DataSource.class, JdbcTemplate.class })
-@EnableConfigurationProperties(JdbcChatMemoryProperties.class)
-public class JdbcChatMemoryAutoConfiguration {
+@EnableConfigurationProperties(JdbcChatMemoryRepositoryProperties.class)
+public class JdbcChatMemoryRepositoryAutoConfiguration {
 
-	private static final Logger logger = LoggerFactory.getLogger(JdbcChatMemoryAutoConfiguration.class);
+	private static final Logger logger = LoggerFactory.getLogger(JdbcChatMemoryRepositoryAutoConfiguration.class);
 
 	@Bean
 	@ConditionalOnMissingBean
-	JdbcChatMemoryRepository chatMemoryRepository(JdbcTemplate jdbcTemplate) {
-		return JdbcChatMemoryRepository.builder().jdbcTemplate(jdbcTemplate).build();
+	JdbcChatMemoryRepository chatMemoryRepository(JdbcTemplate jdbcTemplate, DataSource dataSource) {
+		JdbcChatMemoryDialect dialect = JdbcChatMemoryDialect.from(dataSource);
+		return JdbcChatMemoryRepository.builder().jdbcTemplate(jdbcTemplate).dialect(dialect).build();
 	}
 
 	@Bean
 	@ConditionalOnMissingBean
-	@ConditionalOnProperty(prefix = JdbcChatMemoryProperties.CONFIG_PREFIX, name = "initialize-schema",
-			havingValue = "true", matchIfMissing = true)
-	JdbcChatMemoryDataSourceScriptDatabaseInitializer jdbcChatMemoryScriptDatabaseInitializer(DataSource dataSource) {
-		logger.debug("Initializing schema for JdbcChatMemoryRepository");
-		return new JdbcChatMemoryDataSourceScriptDatabaseInitializer(dataSource);
+	JdbcChatMemoryRepositorySchemaInitializer jdbcChatMemoryScriptDatabaseInitializer(DataSource dataSource,
+			JdbcChatMemoryRepositoryProperties properties) {
+		return new JdbcChatMemoryRepositorySchemaInitializer(dataSource, properties);
 	}
 
 }

auto-configurations/models/chat/memory/spring-ai-autoconfigure-model-chat-memory-jdbc/src/main/java/org/springframework/ai/model/chat/memory/jdbc/autoconfigure/JdbcChatMemoryProperties.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright 2024-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.ai.model.chat.memory.repository.jdbc.autoconfigure;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+/**
+ * @author Jonathan Leijendekker
+ * @author Thomas Vitale
+ * @since 1.0.0
+ */
+@ConfigurationProperties(JdbcChatMemoryRepositoryProperties.CONFIG_PREFIX)
+public class JdbcChatMemoryRepositoryProperties {
+
+	public static final String CONFIG_PREFIX = "spring.ai.chat.memory.repository.jdbc";
+
+	/**
+	 * Whether to initialize the schema on startup. Values: embedded, always, never.
+	 * Default is embedded.
+	 */
+	private DatabaseInitializationMode initializeSchema = DatabaseInitializationMode.EMBEDDED;
+
+	/**
+	 * Locations of schema (DDL) scripts. Supports comma-separated list. Default is
+	 * classpath:org/springframework/ai/chat/memory/jdbc/schema-@@platform@@.sql
+	 */
+	private String schema = "classpath:org/springframework/ai/chat/memory/jdbc/schema-@@platform@@.sql";
+
+	public DatabaseInitializationMode getInitializeSchema() {
+		return this.initializeSchema;
+	}
+
+	public void setInitializeSchema(DatabaseInitializationMode initializeSchema) {
+		this.initializeSchema = initializeSchema;
+	}
+
+	public String getSchema() {
+		return this.schema;
+	}
+
+	public void setSchema(String schema) {
+		this.schema = schema;
+	}
+
+	public enum DatabaseInitializationMode {
+
+		/**
+		 * Always initialize the database.
+		 */
+		ALWAYS,
+
+		/**
+		 * Only initialize an embedded database.
+		 */
+		EMBEDDED,
+
+		/**
+		 * Never initialize the database.
+		 */
+		NEVER
+
+	}
+
+}

auto-configurations/models/chat/memory/spring-ai-autoconfigure-model-chat-memory-jdbc/src/main/java/org/springframework/ai/model/chat/memory/jdbc/autoconfigure/JdbcChatMemoryAutoConfiguration.java renamed to auto-configurations/models/chat/memory/spring-ai-autoconfigure-model-chat-memory-jdbc/src/main/java/org/springframework/ai/model/chat/memory/repository/jdbc/autoconfigure/JdbcChatMemoryRepositoryAutoConfiguration.java

@@ -0,0 +1,92 @@
+/*
+ * Copyright 2024-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.ai.model.chat.memory.repository.jdbc.autoconfigure;
+
+import java.util.List;
+
+import javax.sql.DataSource;
+
+import org.springframework.boot.jdbc.init.DataSourceScriptDatabaseInitializer;
+import org.springframework.boot.jdbc.init.PlatformPlaceholderDatabaseDriverResolver;
+import org.springframework.boot.sql.init.DatabaseInitializationMode;
+import org.springframework.boot.sql.init.DatabaseInitializationSettings;
+import org.springframework.util.StringUtils;
+
+/**
+ * Performs database initialization for the JDBC Chat Memory Repository.
+ *
+ * @author Mark Pollack
+ * @since 1.0.0
+ */
+class JdbcChatMemoryRepositorySchemaInitializer extends DataSourceScriptDatabaseInitializer {
+
+	private static final String DEFAULT_SCHEMA_LOCATION = "classpath:org/springframework/ai/chat/memory/jdbc/schema-@@platform@@.sql";
+
+	JdbcChatMemoryRepositorySchemaInitializer(DataSource dataSource, JdbcChatMemoryRepositoryProperties properties) {
+		super(dataSource, getSettings(dataSource, properties));
+	}
+
+	static DatabaseInitializationSettings getSettings(DataSource dataSource,
+			JdbcChatMemoryRepositoryProperties properties) {
+		var settings = new DatabaseInitializationSettings();
+
+		// Determine schema locations
+		String schemaProp = properties.getSchema();
+		List<String> schemaLocations;
+		PlatformPlaceholderDatabaseDriverResolver resolver = new PlatformPlaceholderDatabaseDriverResolver();
+		try {
+			String url = dataSource.getConnection().getMetaData().getURL().toLowerCase();
+			if (url.contains("hsqldb")) {
+				schemaLocations = List.of("classpath:org/springframework/ai/chat/memory/jdbc/schema-hsqldb.sql");
+			}
+			else if (StringUtils.hasText(schemaProp)) {
+				schemaLocations = resolver.resolveAll(dataSource, schemaProp);
+			}
+			else {
+				schemaLocations = resolver.resolveAll(dataSource, DEFAULT_SCHEMA_LOCATION);
+			}
+		}
+		catch (Exception e) {
+			// fallback to default
+			if (StringUtils.hasText(schemaProp)) {
+				schemaLocations = resolver.resolveAll(dataSource, schemaProp);
+			}
+			else {
+				schemaLocations = resolver.resolveAll(dataSource, DEFAULT_SCHEMA_LOCATION);
+			}
+		}
+		settings.setSchemaLocations(schemaLocations);
+
+		// Determine initialization mode
+		JdbcChatMemoryRepositoryProperties.DatabaseInitializationMode init = properties.getInitializeSchema();
+		DatabaseInitializationMode mode;
+		if (JdbcChatMemoryRepositoryProperties.DatabaseInitializationMode.ALWAYS.equals(init)) {
+			mode = DatabaseInitializationMode.ALWAYS;
+		}
+		else if (JdbcChatMemoryRepositoryProperties.DatabaseInitializationMode.NEVER.equals(init)) {
+			mode = DatabaseInitializationMode.NEVER;
+		}
+		else {
+			// embedded or default
+			mode = DatabaseInitializationMode.EMBEDDED;
+		}
+		settings.setMode(mode);
+		settings.setContinueOnError(true);
+		return settings;
+	}
+
+}

auto-configurations/models/chat/memory/spring-ai-autoconfigure-model-chat-memory-jdbc/src/main/java/org/springframework/ai/model/chat/memory/repository/jdbc/autoconfigure/JdbcChatMemoryRepositoryProperties.java

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-org.springframework.ai.model.chat.memory.jdbc.autoconfigure.JdbcChatMemoryAutoConfiguration
+org.springframework.ai.model.chat.memory.repository.jdbc.autoconfigure.JdbcChatMemoryRepositoryAutoConfiguration