Skip to content

milvus-io/milvus-sdk-java

Repository files navigation

Milvus Java SDK

Maven Central

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.6
2.4.x 2.4.0

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.0</version>
     </dependency>
  • Gradle/Groovy

    implementation 'io.milvus:milvus-sdk-java:2.4.0'
  • Gradle/Kotlin

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

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

       <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")