diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 0fca4946e..020ea4ce0 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -21,8 +21,6 @@ $ git submodule update --init If you are using 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. - ## Building Milvus java SDK Call the following command to generate protobuf related code @@ -30,23 +28,8 @@ Call the following command to generate protobuf related code $ mvn install ``` -## Update Milvus proto files -Milvus proto files are managed by a submodule project under the directory: sdk-core/src/main/milvus-proto -Before developing new interfaces, you need to get the latest proto files by the following command: -```shell -$ git submodule update --remote -``` - -## Building Milvus -See detailed information at: -https://github.com/milvus-io/milvus/blob/master/DEVELOPMENT.md - -## Start a Milvus cluster -You need to start a latest milvus cluster to test the java SDK, see instructions at: -https://milvus.io/docs/v2.0.0/install_standalone-docker.md - ### Unit Tests -All unit test is under director src/test +Unit tests are under sdk-core/src/test and sdk-bulkwriter/src/test ## GitHub Flow Milvus SDK repo follows the same git work flow as milvus main repo, see diff --git a/README.md b/README.md index 7a696513f..c59fbc220 100644 --- a/README.md +++ b/README.md @@ -79,10 +79,6 @@ To use BulkWriter, import milvus-sdk-java-bulkwriter to your project. Please refer to [examples](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples) folder for Java SDK examples. -### Documentation - - - ### Troubleshooting - If you encounter the following error when running your application: @@ -99,19 +95,19 @@ Please refer to [examples](https://github.com/milvus-io/milvus-sdk-java/tree/mas org.slf4j slf4j-api - 1.7.30 + 1.7.36 ``` - Gradle/Groovy ```groovy - compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.30' + implementation 'org.slf4j:slf4j-api:1.7.36' ``` - Gradle/Kotlin ```kotlin - implementation("org.slf4j:slf4j-api:1.7.30") + implementation("org.slf4j:slf4j-api:1.7.36") ``` ### Development diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 000000000..c9e1f19c2 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,33 @@ +# Milvus Java SDK Examples + +This is a standalone Maven project containing example code for the Milvus Java SDK. It is **not** part of the main SDK build — it has its own `pom.xml` and runs independently. + +## Prerequisites + +- Java 8 or higher +- Apache Maven +- A running Milvus instance (default: `localhost:19530`) + +## Build + +```shell +cd examples +mvn compile +``` + +## Run an example + +```shell +mvn exec:java -Dexec.mainClass="io.milvus.v2.SimpleExample" +``` + +## Project structure + +- `src/main/java/io/milvus/v2/` — Examples using the V2 SDK (`MilvusClientV2`) +- `src/main/java/io/milvus/v1/` — Examples using the V1 SDK (`MilvusServiceClient`) +- `src/main/java/io/milvus/v2/bulkwriter/` — BulkWriter examples + +## Notes + +- This project depends on `milvus-sdk-java` and `milvus-sdk-java-bulkwriter` from your local Maven repository. If you've made local changes to the SDK, run `mvn install -DskipTests` from the project root first. +- Some examples require additional services (e.g., MinIO for BulkWriter, external table examples). Check the comments at the top of each example file for specific requirements. diff --git a/pom.xml b/pom.xml index 8c14a6523..cf8f7ecf3 100644 --- a/pom.xml +++ b/pom.xml @@ -81,6 +81,60 @@ + + + + io.grpc + grpc-bom + ${grpc.version} + pom + import + + + org.slf4j + slf4j-api + ${slf4j.api.version} + + + com.google.guava + guava + ${guava.version} + + + com.google.errorprone + error_prone_annotations + ${errorprone.version} + + + org.jetbrains.kotlin + kotlin-stdlib-jdk8 + ${kotlin.version} + + + org.jetbrains.kotlin + kotlin-stdlib-common + ${kotlin.version} + + + org.jetbrains.kotlin + kotlin-stdlib + ${kotlin.version} + + + org.testcontainers + testcontainers-bom + ${testcontainers.version} + pom + import + + + org.xerial.snappy + snappy-java + ${snappy.version} + + + + 2.6.17 8 @@ -93,8 +147,6 @@ 3.25.5 3.25.5 4.3 - 2.8.2 - 3.2.1 1.2 1.10.0 1.7.36 @@ -121,14 +173,12 @@ 2.38.0 - 3.0.24 3.3.6 - 1.2.0 1.13.1 3.13.10 1.1.10.5 1.12.687 - 8.5.7 + 8.5.7 12.25.3 1.10.1 @@ -156,8 +206,6 @@ maven-javadoc-plugin ${maven.javadoc.plugin.version} - /usr/bin/javadoc - -Xdoclint:none diff --git a/sdk-bulkwriter/pom.xml b/sdk-bulkwriter/pom.xml index 48c9cd2d6..5edad1952 100644 --- a/sdk-bulkwriter/pom.xml +++ b/sdk-bulkwriter/pom.xml @@ -19,60 +19,6 @@ false - - - - io.grpc - grpc-bom - ${grpc.version} - pom - import - - - org.slf4j - slf4j-api - ${slf4j.api.version} - - - com.google.guava - guava - ${guava.version} - - - com.google.errorprone - error_prone_annotations - ${errorprone.version} - - - org.jetbrains.kotlin - kotlin-stdlib-jdk8 - ${kotlin.version} - - - org.jetbrains.kotlin - kotlin-stdlib-common - ${kotlin.version} - - - org.jetbrains.kotlin - kotlin-stdlib - ${kotlin.version} - - - org.xerial.snappy - snappy-java - ${snappy.version} - - - org.testcontainers - testcontainers-bom - ${testcontainers.version} - pom - import - - - - io.milvus @@ -168,7 +114,7 @@ io.minio minio - ${minio-java-sdk.veresion} + ${minio-java-sdk.version} com.azure diff --git a/sdk-core/pom.xml b/sdk-core/pom.xml index 9f834fdc8..fab0875d9 100644 --- a/sdk-core/pom.xml +++ b/sdk-core/pom.xml @@ -19,55 +19,6 @@ false - - - - io.grpc - grpc-bom - ${grpc.version} - pom - import - - - org.slf4j - slf4j-api - ${slf4j.api.version} - - - com.google.guava - guava - ${guava.version} - - - com.google.errorprone - error_prone_annotations - ${errorprone.version} - - - org.jetbrains.kotlin - kotlin-stdlib-jdk8 - ${kotlin.version} - - - org.jetbrains.kotlin - kotlin-stdlib-common - ${kotlin.version} - - - org.jetbrains.kotlin - kotlin-stdlib - ${kotlin.version} - - - org.testcontainers - testcontainers-bom - ${testcontainers.version} - pom - import - - - - org.mockito