Adding SAP HanaDB as a vector store. #535

rahulmitt · 2024-04-02T12:31:34Z

Thank you for taking time to contribute this pull request!
You might have already read the [contributor guide][1], but as a reminder, please make sure to:

* Sign the contributor license agreement
* Rebase your changes on the latest main branch and squash your commits
* Add/Update unit tests as needed
* Run a build and make sure all tests pass prior to submission

tzolov

Thanks for the contribution @rahulmitt !
I left few review comments in the code.
In addition you have to

add the vector store dependency to the spring-bom.
will consider adding auto-configuration and spring-boot for it? This is the primary way to use the vector stores.

tzolov · 2024-04-04T10:00:23Z

...g-ai-hanadb-store/src/main/java/org/springframework/ai/vectorstore/HanaCloudVectorStore.java

+package org.springframework.ai.vectorstore;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import lombok.extern.slf4j.Slf4j;


Please don't use the lombok in the vector store implementation.
Later might be fine for end user applications, but because of multiple technical and compatibility issues is inappropriate for utilities/libraries such as spring-ai.

tzolov · 2024-04-04T10:00:40Z

vector-stores/spring-ai-hanadb-store/pom.xml

+            <version>2.20.11</version>
+        </dependency>
+
+        <dependency>


Please don't use the lombok in the vector store implementation.
Later might be fine for end user applications, but because of multiple technical and compatibility issues is inappropriate for utilities/libraries such as spring-ai.

tzolov · 2024-04-04T10:02:00Z

vector-stores/spring-ai-hanadb-store/pom.xml

+        <dependency>
+            <groupId>com.sap.cloud.db.jdbc</groupId>
+            <artifactId>ngdbc</artifactId>
+            <version>2.20.11</version>


Move the version as a property in the parent pom.

tzolov · 2024-04-04T10:05:23Z

vector-stores/spring-ai-hanadb-store/README.md

@@ -0,0 +1,284 @@
+# SpringAI using SAP HANA Cloud vector engine


Please convert the README into an adoc under the vectordbs and add a link to the nav.adoc.
The README can contain a single line link to the adoc documentation

tzolov · 2024-04-04T10:11:12Z

...g-ai-hanadb-store/src/main/java/org/springframework/ai/vectorstore/HanaCloudVectorStore.java

+	}
+
+	@Override
+	public List<Document> similaritySearch(SearchRequest request) {


Most of the VectorStore integrations provide support for the Metadata Expression Filtering.
Please consider adding filtering support. Otherwise you should throw and exception that the feature is not supported like this.

…ana.adoc

…na.adoc

tzolov

Great job! Thanks @rahulmitt
LGTM, will merge it soon.

tzolov · 2024-04-06T11:08:20Z

@rahulmitt when i try to run the ITs locally ./mvnw clean install -pl vector-stores/spring-ai-hanadb-store -Pintegration-tests it fails with:

        ... 33 more
Caused by: org.springframework.beans.BeanInstantiationException: Failed to instantiate [com.zaxxer.hikari.HikariDataSource]: Factory method 'dataSource' threw exception with message: Failed to determine a suitable driver class
        at org.springframework.beans.factory.support.SimpleInstantiationStrategy.instantiate(SimpleInstantiationStrategy.java:177)
        at org.springframework.beans.factory.support.ConstructorResolver.instantiate(ConstructorResolver.java:644)
        ... 47 more
Caused by: org.springframework.boot.autoconfigure.jdbc.DataSourceProperties$DataSourceBeanCreationException: Failed to determine a suitable driver class
        at org.springframework.boot.autoconfigure.jdbc.DataSourceProperties.determineDriverClassName(DataSourceProperties.java:186)
        at org.springframework.boot.autoconfigure.jdbc.PropertiesJdbcConnectionDetails.getDriverClassName(PropertiesJdbcConnectionDetails.java:49)
        at org.springframework.boot.autoconfigure.jdbc.DataSourceConfiguration.createDataSource(DataSourceConfiguration.java:55)
        at org.springframework.boot.autoconfigure.jdbc.DataSourceConfiguration$Hikari.dataSource(DataSourceConfiguration.java:117)
        at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
        at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
        at java.base/java.lang.reflect.Method.invoke(Method.java:568)
        at org.springframework.beans.factory.support.SimpleInstantiationStrategy.instantiate(SimpleInstantiationStrategy.java:140)
        ... 48 more

tzolov · 2024-04-06T15:01:50Z

vector-stores/spring-ai-hanadb-store/pom.xml

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


Ah, I missed this.
Please try to replace the boot starter with the relevant data jpa dependency.
We should not use starters here, not even for the testing.
(P.S. I know that we leaked the logging starter in some places that we will have to fix)

Good catch! Should be fixed now. Thanks

…na.adoc

tzolov · 2024-04-06T21:19:44Z

Hi @rahulmitt , thank you for the updates.
I've noticed that you have not provided auto-configuration test, so i though i can add one myself. But apparently getting a test/try account for SAP HANA Cloud is not that obvious.
Cloud you please update your documentation to explain where and how one can obtain SAP HANA Cloud access and how to configure its Vector Store capabilities?.

Also:

Add an Auto-configuration integration test. You can check the other Vectors Stores for sample auto-config tests.
run ./mvnw license:format -Plicense to fix the license headers issues
run ./mvnw javadoc:javadoc -pl vector-stores/spring-ai-hanadb-store -Pjavadoc to fix the javadocs issues.
run ./mvnw spring-javaformat:apply to fix any code formatting issues.

rahulmitt · 2024-04-07T07:50:11Z

Hi @tzolov - thanks for your kind reviews. Let me work on the following:

Add unit test for HanaCloudVectorStoreProperties.java
Add IT for HanaCloudVectorStoreAutoConfiguration.java
Write documentation to provision a SAP BTP trial account and create SAP Hana Cloud instance
Run ./mvnw license:format -Plicense to fix the license headers issues
Run ./mvnw javadoc:javadoc -pl vector-stores/spring-ai-hanadb-store -Pjavadoc to fix the javadocs issues.
Run ./mvnw spring-javaformat:apply to fix any code formatting issues.

Will update the status here.

… to create a BTP trial account and provision an instance for SAP Hana Cloud db

rahulmitt · 2024-04-07T11:59:03Z

Hi @tzolov - I attempted to write the IT for HanaCloudVectorStoreAutoConfiguration. However, it is failing with below error. So, checked in as disabled for now.

java.io.FileNotFoundException: class path resource [org/springframework/data/jdbc/repository/config/AbstractJdbcConfiguration.class] cannot be opened because it does not exist

If I add the following dependency to spring-ai-spring-boot-autoconfigure/pom.xml, the above error is resolved.

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

However, it starts complaining about:

org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'org.springframework.ai.vectorstore.HanaVectorRepository<org.springframework.ai.vectorstore.HanaVectorEntity>' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}

I am looking for pointers on how to fix this. Do you mind taking a look pls?

tzolov · 2024-04-09T10:42:04Z

@rahulmitt thank you for the contribution.
I applied some fixes to the docs and the Autoconfiguraiton you can review (in the merged code)

tzolov · 2024-04-09T10:42:32Z

Rebased, squashed and merged at 466b824

Additional changes
 - add @AutoConfiguration(after = { JpaRepositoriesAutoConfiguration.class })
 - update the handa docs structure.

markpollack · 2025-04-23T14:28:41Z

@rahulmitt This is an old issue and hope you see this. We have not been able to gain access to SAP HANA to see if this functionality still works. Can you help?

rahulmitt · 2025-04-23T14:35:20Z

Hi - see if this documentation helps.

rahulmitt added 2 commits April 2, 2024 18:00

Adding SAP HanaDB as a vector store.

7cdb1bd

Adding SAP HanaDB as a vector store.

036a9d0

tzolov requested changes Apr 4, 2024

View reviewed changes

rahulmitt added 4 commits April 5, 2024 08:10

Merge branch 'spring-projects:main' into main

e3752a6

Removed Lombok dependency and moved documentation from README.md to h…

68555c6

…ana.adoc

Removed Lombok dependency and moved documentation from REAME.md to ha…

5f2f7c2

…na.adoc

Removed Lombok dependency and moved documentation from REAME.md to ha…

4804c8c

…na.adoc

rahulmitt requested a review from tzolov April 6, 2024 09:34

Removed Lombok dependency and moved documentation from REAME.md to ha…

329a0a8

…na.adoc

tzolov reviewed Apr 6, 2024

View reviewed changes

tzolov approved these changes Apr 6, 2024

View reviewed changes

tzolov reviewed Apr 6, 2024

View reviewed changes

Removed Lombok dependency and moved documentation from REAME.md to ha…

2923aad

…na.adoc

rahulmitt requested a review from tzolov April 6, 2024 18:56

rahulmitt added 5 commits April 7, 2024 00:50

Removed Lombok dependency and moved documentation from REAME.md to ha…

60bf93f

…na.adoc

updated hana.adoc

f90417e

updated hana.adoc

6fad1fa

updated hana.adoc

abcf652

updated hana.adoc

76f06c2

rahulmitt added 4 commits April 7, 2024 13:22

added junit for HanaCloudVectorStoreProperties.java and documentation…

3de1684

… to create a BTP trial account and provision an instance for SAP Hana Cloud db

updated license, formatting and javadoc

e7dd2ad

updated license, formatting and javadoc

eb0acd7

IT for HanaCloudVectorStoreAutoConfiguration

9bbf2f8

rahulmitt added 2 commits April 7, 2024 17:48

IT for HanaCloudVectorStoreAutoConfiguration

1405a81

Merge branch 'spring-projects:main' into main

e140448

tzolov self-assigned this Apr 8, 2024

tzolov added enhancement New feature or request vector store labels Apr 8, 2024

tzolov added this to the 1.0.0-M1 milestone Apr 8, 2024

tzolov closed this Apr 9, 2024

		@@ -0,0 +1,284 @@
		# SpringAI using SAP HANA Cloud vector engine

Adding SAP HanaDB as a vector store. #535

Adding SAP HanaDB as a vector store. #535

Uh oh!

Conversation

rahulmitt commented Apr 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tzolov left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tzolov Apr 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tzolov left a comment

Choose a reason for hiding this comment

Uh oh!

tzolov commented Apr 6, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tzolov commented Apr 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rahulmitt commented Apr 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rahulmitt commented Apr 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tzolov commented Apr 9, 2024

Uh oh!

tzolov commented Apr 9, 2024

Uh oh!

markpollack commented Apr 23, 2025

Uh oh!

rahulmitt commented Apr 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rahulmitt commented Apr 2, 2024 •

edited

Loading

tzolov left a comment •

edited

Loading

tzolov Apr 4, 2024 •

edited

Loading

tzolov commented Apr 6, 2024 •

edited

Loading

rahulmitt commented Apr 7, 2024 •

edited

Loading

rahulmitt commented Apr 7, 2024 •

edited

Loading