Java SDK for Milvus. To contribute to this project, please read our contribution guidelines first.

-   Java 8 or higher
-   Apache Maven or Gradle

The following table shows compatibilities between Milvus and Java SDK.

You can use Apache Maven or Gradle add Milvus SDK to your project.

• Apache Maven

   <dependency>
       <groupId>io.milvus</groupId>
       <artifactId>milvus-sdk-java</artifactId>
       <version>2.4.3</version>
   </dependency>

• Gradle/Groovy

  implementation 'io.milvus:milvus-sdk-java:2.4.3'

• Gradle/Kotlin

  implementation("io.milvus:milvus-sdk-java:2.4.3")

Please refer to examples folder for Java SDK examples.

• If you encounter the following error when running your application:

  Exception in thread "main" java.lang.NoClassDefFoundError: org/slf4j/LoggerFactory
  

  This is because SLF4J jar files need to be added into your application's classpath. SLF4J is required by Java SDK for logging purpose.

  To fix this issue, you can use Apache Maven or Gradle to download the required jar files.

  • Apache Maven

     <dependency>
         <groupId>org.slf4j</groupId>
         <artifactId>slf4j-api</artifactId>
         <version>1.7.30</version>
     </dependency>

  • Gradle/Groovy

    compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.30'

  • Gradle/Kotlin

    implementation("org.slf4j:slf4j-api:1.7.30")

This guide is for developers who want to contribute to this project.

1. fork & clone this project
2. init submodule

   git submodule update --init

3. Reload Maven Project (#479)
   • if you use Idea, go to Project Root in Idea, right click on milvus-sdk-java and select Maven -> Reload Project

Note: For now, current project do not support JDK 21+. The minimal Lombok version compatible with JDK 21 is 1.18.30.