# Milvus Java SDK

[![Maven Central](https://img.shields.io/maven-central/v/io.milvus/milvus-sdk-java.svg)](https://search.maven.org/artifact/io.milvus/milvus-sdk-java/)

Java SDK for [Milvus](https://github.com/milvus-io/milvus). To contribute to this project, please read our [contribution guidelines](https://github.com/milvus-io/milvus/blob/master/CONTRIBUTING.md) first.

## Getting started

### Prerequisites

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

The following table shows compatibilities between Milvus and Java SDK.

| Milvus version | Java SDK version |
| :------------: | :--------------: |
|     0.11.0     |    0.9.1         |
|     0.10.4<br>0.10.3     |    0.8.5         |
|     0.10.2     |    0.8.4         |
|     0.10.1     |    0.8.3         |
|     0.10.0     |    0.8.2         |
|     0.9.1      |    0.8.1         |
|     0.9.0      |    0.8.0         |
|     0.8.0      |    0.7.0         |
|     0.7.1      |    0.6.0         |

### Install Java SDK

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

   - Apache Maven

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

   - Gradle/Grails

        ```gradle
        compile group: 'io.milvus', name: 'milvus-sdk-java', version: '0.9.2'
        ```

### Examples

Please refer to [examples](https://github.com/milvus-io/milvus-sdk-java/tree/0.9.2/examples) folder for Java SDK examples.

### Documentation

- [Javadoc](https://milvus-io.github.io/milvus-sdk-java/javadoc/index.html)

### Troubleshooting

- If you encounter the following error when running your application:
    ```
    SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
    SLF4J: Defaulting to no-operation (NOP) logger implementation
    SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
    ```
  This is because SLF4J jar files need to be added into your application's classpath. SLF4J is used by Java SDK for logging purpose.
  
  To fix this issue, you can download the required jar files.
                                                                                                         
    - Apache Maven
    
        ```xml
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-simple</artifactId>
             <version>1.7.30</version>
             <scope>test</scope>
         </dependency>
        ```
    
    - Gradle/Grails
    
         ```gradle
         test compile group: 'org.slf4j', name: 'slf4j-simple', version: '1.7.30'
         ```