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.11
2.4.x	2.4.11
2.5.x	2.5.15
2.6.x	2.6.22
3.0.x	3.0.12

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>3.0.12</version>
   </dependency>
  

• Gradle/Groovy

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

• Gradle/Kotlin

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

From v2.5.2, milvus Java SDK is split into two packages: milvus-sdk-java and milvus-sdk-java-bulkwriter, because BulkWriter requires quite a lot of dependencies. If you don't need BulkWriter tool, you can ignore the milvus-sdk-java-bulkwriter package. To use BulkWriter, import milvus-sdk-java-bulkwriter to your project.

• Apache Maven

```xml
 <dependency>
     <groupId>io.milvus</groupId>
     <artifactId>milvus-sdk-java-bulkwriter</artifactId>
     <version>3.0.12</version>
 </dependency>
```

• Gradle/Groovy

  implementation 'io.milvus:milvus-sdk-java-bulkwriter:3.0.12'
  

• Gradle/Kotlin

  implementation("io.milvus:milvus-sdk-java-bulkwriter:3.0.12")
  

For Spring Boot applications (Java 17+), the milvus-sdk-java-spring-boot-starter package auto-configures a MilvusClientV2 from milvus.* properties. See sdk-spring-boot-starter.

Examples

Please refer to examples folder for Java SDK examples.

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

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

  • Gradle/Groovy

    implementation 'org.slf4j:slf4j-api:1.7.36'
    

  • Gradle/Kotlin

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

Development

For developers interested in contributing to the Milvus Java SDK, please refer to our DEVELOPMENT.md file. This document provides detailed instructions on:

• Setting up your development environment
• Cloning the repository
• Building the SDK
• Updating Milvus proto files
• Running tests
• Contributing guidelines

We welcome contributions from the community!