Merge branch 'openGemini:main' into main

Author: castlighting

.github/workflows/java_unit_tests.yml

@@ -32,6 +32,6 @@ jobs:
           java-version: '17'
           distribution: 'temurin'
       - name: setup OpenGemini
-        uses: shoothzj/setup-opengemini-action@main
+        uses: hezhangjian/setup-opengemini-action@main
       - name: unit tests
         run: mvn -B clean test

.github/workflows/license_lint.yml

@@ -24,6 +24,6 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: licenselint
-        uses: shoothzj/licenselint@main
+        uses: hezhangjian/licenselint@main
         with:
           author: openGemini Authors

.github/workflows/line_lint.yml

@@ -24,4 +24,4 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: linelint
-        uses: shoothzj/linelint@main
+        uses: hezhangjian/linelint@main

README.md

@@ -46,7 +46,7 @@ docker run -p 8086:8086 --name opengemini --rm opengeminidb/opengemini-server
 
 ### HTTP Engine Selection
 
-By default, the client uses the built-in HTTP engine provided by the JDK. It automatically selects the appropriate implementation based on the Java version, supporting both Java 8 and Java 11+. If needed, you can configure a different HTTP engine by specifying the `.engine` option in the `HttpClientConfig`. Please note, if a different engine is chosen, you will need to manually include the corresponding dependencies.
+OpenGeminiClient supports multiple [HTTP engines](https://github.com/openfacade/http-facade?tab=readme-ov-file#httpclient-support-engines) by leveraging [http-facade](https://github.com/openfacade/http-facade). By default, the client uses the built-in HTTP engine provided by the JDK. It automatically selects the appropriate implementation based on the Java version, supporting both Java 8 and Java 11+. If needed, you can configure a different HTTP engine by specifying the `.engine` option in the `HttpClientConfig`. Please note, if a different engine is chosen, you will need to manually include the corresponding dependencies.
 
 ## Quick Start
 

README_CN.md

@@ -46,7 +46,7 @@ docker run -p 8086:8086 --name opengemini --rm opengeminidb/opengemini-server
 
 ### HTTP 引擎选择
 
-默认情况下，客户端使用 JDK 自带的 HTTP 引擎，并根据 Java 版本自动选择合适的实现，支持 Java 8 和 Java 11+。如果有需要，你可以在 `HttpClientConfig` 中通过 `.engine` 选项配置不同的 HTTP 引擎。请注意，若选择不同的引擎，则需要手动添加相应的依赖。
+OpenGeminiClient利用 [http-façade](https://github.com/openfacade/http-façade) 支持了多个 [HTTP 引擎](https://github.com/openfacade/http-façade?tab=readme-ov-file#httpclient-support-engines)。默认情况下，客户端使用 JDK 自带的 HTTP 引擎，并根据 Java 版本自动选择合适的实现，支持 Java 8 和 Java 11+。如果有需要，你可以在 `HttpClientConfig` 中通过 `.engine` 选项配置不同的 HTTP 引擎。请注意，若选择不同的引擎，则需要手动添加相应的依赖。
 
 ## 快速上手
 

ci/spotbugs/exclude.xml

@@ -42,4 +42,8 @@
         <Bug pattern="URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD"/>
     </Match>
 
+    <!-- Exclude gRPC auto-generated classes -->
+    <Match>
+        <Package name="io.opengemini.client.proto"/>
+    </Match>
 </FindBugsFilter>

opengemini-client-common/pom.xml

@@ -32,6 +32,16 @@
             <artifactId>opengemini-client-api</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.xerial.snappy</groupId>
+            <artifactId>snappy-java</artifactId>
+            <version>${snappy.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.github.luben</groupId>
+            <artifactId>zstd-jni</artifactId>
+            <version>${zstd.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-lang3</artifactId>

opengemini-client/src/main/java/io/opengemini/client/impl/OpenGeminiClient.java

@@ -101,7 +101,7 @@ protected CompletableFuture<Pong> executePing() {
                 .orElse(null)).thenApply(Pong::new);
     }
 
-    private <T> @NotNull CompletableFuture<T> convertResponse(HttpResponse response, Class<T> type) {
+    private @NotNull <T> CompletableFuture<T> convertResponse(HttpResponse response, Class<T> type) {
         if (response.statusCode() >= 200 && response.statusCode() < 300) {
             try {
                 T resp = JacksonService.toObject(response.body(), type);

opengemini-client/src/main/proto/write.proto

@@ -0,0 +1,61 @@
+syntax = "proto3";
+package proto;
+option java_multiple_files = true;
+option java_package = "io.opengemini.client.proto";
+option java_outer_classname = "WriteProto";
+
+// WriteService represents a openGemini RPC write service.
+service WriteService {
+  // Write writes the given records to the specified database and retention policy.
+  rpc Write (WriteRequest) returns (WriteResponse) {}
+  // Ping is used to check if the server is alive
+  rpc Ping(PingRequest) returns (PingResponse) {}
+}
+
+message WriteRequest {
+  uint32 version = 1;
+  string database = 2;
+  string retention_policy = 3;
+  string username = 4;
+  string password = 5;
+  repeated Record records = 6;
+}
+
+message WriteResponse {
+  ResponseCode code = 1;
+}
+
+message Record {
+  string measurement = 1;
+  int64 min_time = 2;
+  int64 max_time = 3;
+  CompressMethod compress_method = 4;
+  bytes block = 5;
+}
+
+enum CompressMethod {
+  UNCOMPRESSED = 0;
+  LZ4_FAST = 1;
+  ZSTD_FAST = 2;
+  SNAPPY = 3;
+}
+
+enum ResponseCode {
+  Success = 0;
+  Partial = 1;
+  Failed = 2;
+}
+
+message PingRequest {
+  string client_id = 1;
+}
+
+enum ServerStatus {
+  Up = 0;
+  Down = 1;
+  Unknown = 99;
+}
+
+message PingResponse {
+  ServerStatus status = 1;
+}

opengemini-client/src/test/java/io/opengemini/client/impl/OpenGeminiClientTest.java

@@ -57,9 +57,9 @@ class OpenGeminiClientTest extends TestBase {
 
     protected List<OpenGeminiClient> clientList() throws OpenGeminiException {
         List<HttpClientEngine> engines = new ArrayList<>();
-        engines.add(HttpClientEngine.AsyncHttpClient);
-        engines.add(HttpClientEngine.JAVA);
-        engines.add(HttpClientEngine.JAVA8);
+        engines.add(HttpClientEngine.Async);
+        engines.add(HttpClientEngine.Java);
+        engines.add(HttpClientEngine.Java8);
         engines.add(HttpClientEngine.OkHttp);
         List<OpenGeminiClient> clients = new ArrayList<>();
         for (HttpClientEngine engine : engines) {
@@ -68,10 +68,12 @@ protected List<OpenGeminiClient> clientList() throws OpenGeminiException {
                     .connectTimeout(Duration.ofSeconds(3))
                     .timeout(Duration.ofSeconds(3))
                     .build();
-            Configuration configuration = Configuration.builder()
-                    .addresses(Collections.singletonList(new Address("127.0.0.1", 8086)))
-                    .httpConfig(httpConfig)
-                    .build();
+            Configuration configuration =
+                Configuration.builder()
+                             .addresses(Collections.singletonList(new Address("127.0.0.1", 8086)))
+                             .httpConfig(httpConfig)
+                             .gzipEnabled(false)
+                             .build();
             clients.add(OpenGeminiClientFactory.create(configuration));
         }
         return clients;
@@ -89,6 +91,7 @@ void setUp() {
                 .addresses(Collections.singletonList(new Address("127.0.0.1", 8086)))
                 .httpConfig(httpConfig)
                 .authConfig(new AuthConfig(AuthType.PASSWORD, "test", "testPwd123@".toCharArray(), null))
+                .gzipEnabled(false)
                 .build();
         this.openGeminiClient = new OpenGeminiClient(configuration);
     }
@@ -261,6 +264,7 @@ void query_should_throws_exception_when_address_is_wrong() throws IOException {
         Configuration configuration = Configuration.builder()
                 .addresses(Collections.singletonList(new Address("127.0.0.1", 28086)))
                 .httpConfig(new HttpClientConfig.Builder().build())
+                .gzipEnabled(false)
                 .build();
 
         try (OpenGeminiClient wrongClient = new OpenGeminiClient(configuration)) {