README.md 2.5 KB

Milvus Java SDK

Maven Central

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

Getting started

Prerequisites

-   Java 8 or higher
-   Apache Maven or Gradle/Grails

The following table shows compatibilities between Milvus and Java SDK.

| Milvus version | SDK version | | :------------: | :---------: | | 0.5.0 | 0.2.2 | | 0.5.1 | 0.2.2 | | 0.5.2 | 0.2.2 | | 0.5.3 | 0.3.0 | | 0.6.0 | 0.4.1 | | 0.7.0 | 0.5.0 | | 0.7.1 | 0.6.0 | | 0.8.0 | 0.7.0 | | 0.9.0 | 0.8.0 |

Install Java SDK

You can use Apache Maven or Gradle/Grails to download the SDK.

  • Apache Maven

        <dependency>
            <groupId>io.milvus</groupId>
            <artifactId>milvus-sdk-java</artifactId>
            <version>0.7.0</version>
        </dependency>
    
  • Gradle/Grails

    ```gradle
    compile 'io.milvus:milvus-sdk-java:0.7.0'
    ```
    

Examples

Please refer to examples folder for Java example programs.

Documentation

Additional information

  • The Java source code is formatted using google-java-format.
  • If you receive the following error when running your application:

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

    This is because SLF4J jar file needs to be added into your application's classpath.

To fix this issue, you can use Apache Maven or Gradle/Grails 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/Grails

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