milvus-sdk-java

Milvus Java SDK

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

Getting started

Prerequisites

-   Java 8 or higher
-   Apache Maven or Gradle

The following table shows compatibilities between Milvus and Java SDK.

Milvus version	Java SDK version
2.0	2.0.4
2.1	2.1.0-beta4
2.2.0 ~ 2.2.8	2.2.0 ~ 2.2.5
>= 2.2.9	2.2.7 ~ 2.2.15
2.3.x	2.3.9
2.4.x	2.4.3

Install 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

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

• Gradle/Kotlin

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

Examples

Please refer to examples folder for Java SDK examples.

Documentation

Troubleshooting

• 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

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

- Gradle/Groovy

     ```groovy
     compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.30'
     ```
- Gradle/Kotlin

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

Developer Guide

init project 101

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.