Merge pull request #42422 from lasteris/resolve-conflicts

Elasticsearch docs update
quarkusio · Sep 30, 2024 · 792033d · 792033d
2 parents df2846e + c679d63
commit 792033d
Show file tree

Hide file tree

Showing 11 changed files with 438 additions and 90 deletions.
diff --git a/docs/src/main/asciidoc/elasticsearch.adoc b/docs/src/main/asciidoc/elasticsearch.adoc
@@ -126,10 +126,13 @@ package org.acme.elasticsearch;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.stream.Collectors;
 
 import jakarta.enterprise.context.ApplicationScoped;
 import jakarta.inject.Inject;
 
+import org.apache.http.entity.ContentType;
+import org.apache.http.entity.StringEntity;
 import org.apache.http.util.EntityUtils;
 import org.elasticsearch.client.Request;
 import org.elasticsearch.client.Response;
@@ -151,13 +154,49 @@ public class FruitService {
         restClient.performRequest(request); //<4>
     }
 
+    public void index(List<Fruit> list) throws IOException {
+
+        var entityList = new ArrayList<JsonObject>();
+
+        for (var fruit : list) {
+
+            entityList.add(new JsonObject().put("index", new JsonObject()//<5>
+                    .put("_index", "fruits").put("_id", fruit.id)));
+            entityList.add(JsonObject.mapFrom(fruit));
+        }
+
+        Request request = new Request(
+                "POST", "fruits/_bulk?pretty");
+        request.setEntity(new StringEntity(
+                toNdJsonString(entityList),//<6>
+                ContentType.create("application/x-ndjson")));//<7>
+        restClient.performRequest(request);
+    }
+
+    public void delete(List<String> identityList) throws IOException {
+
+        var entityList = new ArrayList<JsonObject>();
+
+        for (var id : identityList) {
+            entityList.add(new JsonObject().put("delete",
+                    new JsonObject().put("_index", "fruits").put("_id", id)));//<8>
+        }
+
+        Request request = new Request(
+                "POST", "fruits/_bulk?pretty");
+        request.setEntity(new StringEntity(
+                toNdJsonString(entityList),
+                ContentType.create("application/x-ndjson")));
+        restClient.performRequest(request);
+    }
+
     public Fruit get(String id) throws IOException {
         Request request = new Request(
                 "GET",
                 "/fruits/_doc/" + id);
         Response response = restClient.performRequest(request);
         String responseBody = EntityUtils.toString(response.getEntity());
-        JsonObject json = new JsonObject(responseBody); //<5>
+        JsonObject json = new JsonObject(responseBody); //<9>
         return json.getJsonObject("_source").mapTo(Fruit.class);
     }
 
@@ -191,32 +230,63 @@ public class FruitService {
         }
         return results;
     }
+
+    private static String toNdJsonString(List<JsonObject> objects) {
+        return objects.stream()
+                .map(JsonObject::encode)
+                .collect(Collectors.joining("\n", "", "\n"));
+    }    
 }
 ----
 <1> We inject an Elasticsearch low level `RestClient` into our service.
 <2> We create an Elasticsearch request.
 <3> We use Vert.x `JsonObject` to serialize the object before sending it to Elasticsearch, you can use whatever you want to serialize your objects to JSON.
 <4> We send the request (indexing request here) to Elasticsearch.
-<5> In order to deserialize the object from Elasticsearch, we again use Vert.x `JsonObject`.
+<5> As we `index` collection of objects we should use `index`, `create` or `update` action.
+<6> We use `toNdJsonString(entityList)` call to produce output like below
++
+[source, json]
+----
+{"index", {"_index" : "fruits", "_id", "1"}}
+{"id": "1", "name": "apple", "color": "red"}
+...           ...             ...        ...
+{"create", {"_index" : "fruits", "_id", "N"}}
+{"id": "N", "name": "dragonfruit", "color": "pink"}
+
+----
+<7> Pass the content type that is expected by the search backend for bulk requests.
+<8> The bulk API's delete operation JSON already contains all the required information; hence, there is no request body following this operation in the Bulk API request body.
++
+[source, json]
+----
+{"delete", {"_index" : "fruits", "_id", "1"}}
+{"delete", {"_index" : "fruits", "_id", "2"}}
+...           ...             ...        ...
+{"delete", {"_index" : "fruits", "_id", "N"}}
+
+----
+<9> In order to deserialize the object from Elasticsearch, we again use Vert.x JsonObject.
 
 Now, create the `org.acme.elasticsearch.FruitResource` class as follows:
 
 [source,java]
 ----
 package org.acme.elasticsearch;
 
-import jakarta.inject.Inject;
-import jakarta.ws.rs.BadRequestException;
-import jakarta.ws.rs.GET;
-import jakarta.ws.rs.POST;
-import jakarta.ws.rs.Path;
-import jakarta.ws.rs.core.Response;
 import java.io.IOException;
 import java.net.URI;
 import java.util.List;
 import java.util.UUID;
 
-import org.jboss.resteasy.reactive.RestQuery;
+import jakarta.inject.Inject;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.DELETE;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.QueryParam;
+import jakarta.ws.rs.core.Response;
+import jakarta.ws.rs.BadRequestException;
 
 @Path("/fruits")
 public class FruitResource {
@@ -233,6 +303,20 @@ public class FruitResource {
         return Response.created(URI.create("/fruits/" + fruit.id)).build();
     }
 
+    @Path("bulk")
+    @DELETE
+    public Response delete(List<String> identityList) throws IOException {
+        fruitService.delete(identityList);
+        return Response.ok().build();
+    }
+
+    @Path("bulk")
+    @POST
+    public Response index(List<Fruit> list) throws IOException {
+        fruitService.index(list);
+        return Response.ok().build();
+    }
+
     @GET
     @Path("/{id}")
     public Fruit get(String id) throws IOException {
@@ -384,18 +468,26 @@ Here is a version of the `FruitService` using the Elasticsearch Java Client inst
 
 [source,java]
 ----
+import java.io.IOException;
+import java.io.StringReader;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.inject.Inject;
+
 import co.elastic.clients.elasticsearch.ElasticsearchClient;
+import co.elastic.clients.elasticsearch.core.IndexRequest;
 import co.elastic.clients.elasticsearch._types.FieldValue;
 import co.elastic.clients.elasticsearch._types.query_dsl.QueryBuilders;
-import co.elastic.clients.elasticsearch.core.*;
+import co.elastic.clients.elasticsearch.core.search.Hit;
 import co.elastic.clients.elasticsearch.core.search.HitsMetadata;
-import jakarta.enterprise.context.ApplicationScoped;
-import jakarta.inject.Inject;
-import org.acme.elasticsearch.Fruit;
-
-import java.io.IOException;
-import java.util.List;
-import java.util.stream.Collectors;
+import co.elastic.clients.elasticsearch.core.GetRequest;
+import co.elastic.clients.elasticsearch.core.GetResponse;
+import co.elastic.clients.elasticsearch.core.SearchRequest;
+import co.elastic.clients.elasticsearch.core.SearchResponse;
+import co.elastic.clients.elasticsearch.core.BulkRequest;
+import co.elastic.clients.elasticsearch.core.BulkResponse;
 
 @ApplicationScoped
 public class FruitService {
@@ -410,6 +502,37 @@ public class FruitService {
         client.index(request);  // <4>
     }
 
+    public void index(List<Fruit> list) throws IOException {
+
+        BulkRequest.Builder br = new BulkRequest.Builder();
+
+        for (var fruit : list) {
+            br.operations(op -> op
+                    .index(idx -> idx.index("fruits").id(fruit.id).document(fruit)));
+        }
+
+        BulkResponse result = client.bulk(br.build());
+
+        if (result.errors()) {
+            throw new RuntimeException("The indexing operation encountered errors.");
+        }
+    }
+
+    public void delete(List<String> list) throws IOException {
+
+        BulkRequest.Builder br = new BulkRequest.Builder();
+
+        for (var id : list) {
+            br.operations(op -> op.delete(idx -> idx.index("fruits").id(id)));
+        }
+
+        BulkResponse result = client.bulk(br.build());
+
+        if (result.errors()) {
+            throw new RuntimeException("The indexing operation encountered errors.");
+        }
+    }
+
     public Fruit get(String id) throws IOException {
         GetRequest getRequest = GetRequest.of(
             b -> b.index("fruits")

diff --git a/integration-tests/elasticsearch-java-client/pom.xml b/integration-tests/elasticsearch-java-client/pom.xml
@@ -37,6 +37,16 @@
             <artifactId>rest-assured</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.awaitility</groupId>
+            <artifactId>awaitility</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <scope>test</scope>
+        </dependency>
 
         <!-- Minimal test dependencies to *-deployment artifacts for consistent build order -->
         <dependency>

diff --git a/...tests/elasticsearch-java-client/src/main/java/io/quarkus/it/elasticsearch/java/Fruit.java b/...tests/elasticsearch-java-client/src/main/java/io/quarkus/it/elasticsearch/java/Fruit.java
@@ -1,7 +1,23 @@
 package io.quarkus.it.elasticsearch.java;
 
+import java.util.Objects;
+
 public class Fruit {
     public String id;
     public String name;
     public String color;
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o)
+            return true;
+        if (!(o instanceof Fruit fruit))
+            return false;
+        return Objects.equals(id, fruit.id) && Objects.equals(name, fruit.name) && Objects.equals(color, fruit.color);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(id, name, color);
+    }
 }
diff --git a/...asticsearch-java-client/src/main/java/io/quarkus/it/elasticsearch/java/FruitResource.java b/...asticsearch-java-client/src/main/java/io/quarkus/it/elasticsearch/java/FruitResource.java
@@ -7,14 +7,20 @@
 
 import jakarta.inject.Inject;
 import jakarta.ws.rs.BadRequestException;
+import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.DELETE;
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.POST;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.Produces;
 import jakarta.ws.rs.QueryParam;
+import jakarta.ws.rs.core.MediaType;
 import jakarta.ws.rs.core.Response;
 
 @Path("/fruits")
+@Produces(MediaType.APPLICATION_JSON)
+@Consumes(MediaType.APPLICATION_JSON)
 public class FruitResource {
     @Inject
     FruitService fruitService;
@@ -54,4 +60,18 @@ public List<Fruit> searchUnsafe(@QueryParam("json") String json) throws IOExcept
         return fruitService.searchWithJson(json);
     }
 
+    @Path("bulk")
+    @DELETE
+    public Response delete(List<String> identityList) throws IOException {
+        fruitService.delete(identityList);
+        return Response.ok().build();
+    }
+
+    @Path("bulk")
+    @POST
+    public Response index(List<Fruit> list) throws IOException {
+        fruitService.index(list);
+        return Response.ok().build();
+    }
+
 }
diff --git a/...lasticsearch-java-client/src/main/java/io/quarkus/it/elasticsearch/java/FruitService.java b/...lasticsearch-java-client/src/main/java/io/quarkus/it/elasticsearch/java/FruitService.java
@@ -11,7 +11,14 @@
 import co.elastic.clients.elasticsearch.ElasticsearchClient;
 import co.elastic.clients.elasticsearch._types.FieldValue;
 import co.elastic.clients.elasticsearch._types.query_dsl.QueryBuilders;
-import co.elastic.clients.elasticsearch.core.*;
+import co.elastic.clients.elasticsearch.core.BulkRequest;
+import co.elastic.clients.elasticsearch.core.BulkResponse;
+import co.elastic.clients.elasticsearch.core.GetRequest;
+import co.elastic.clients.elasticsearch.core.GetResponse;
+import co.elastic.clients.elasticsearch.core.IndexRequest;
+import co.elastic.clients.elasticsearch.core.SearchRequest;
+import co.elastic.clients.elasticsearch.core.SearchResponse;
+import co.elastic.clients.elasticsearch.core.search.Hit;
 import co.elastic.clients.elasticsearch.core.search.HitsMetadata;
 
 @ApplicationScoped
@@ -53,7 +60,7 @@ private List<Fruit> search(String term, String match) throws IOException {
 
         SearchResponse<Fruit> searchResponse = client.search(searchRequest, Fruit.class);
         HitsMetadata<Fruit> hits = searchResponse.hits();
-        return hits.hits().stream().map(hit -> hit.source()).collect(Collectors.toList());
+        return hits.hits().stream().map(Hit::source).collect(Collectors.toList());
     }
 
     public List<Fruit> searchWithJson(String json) throws IOException {
@@ -63,6 +70,37 @@ public List<Fruit> searchWithJson(String json) throws IOException {
         }
         SearchResponse<Fruit> searchResponse = client.search(searchRequest, Fruit.class);
         HitsMetadata<Fruit> hits = searchResponse.hits();
-        return hits.hits().stream().map(hit -> hit.source()).collect(Collectors.toList());
+        return hits.hits().stream().map(Hit::source).collect(Collectors.toList());
+    }
+
+    public void index(List<Fruit> list) throws IOException {
+
+        BulkRequest.Builder br = new BulkRequest.Builder();
+
+        for (var fruit : list) {
+            br.operations(op -> op
+                    .index(idx -> idx.index("fruits").id(fruit.id).document(fruit)));
+        }
+
+        BulkResponse result = client.bulk(br.build());
+
+        if (result.errors()) {
+            throw new RuntimeException("The indexing operation encountered errors.");
+        }
+    }
+
+    public void delete(List<String> list) throws IOException {
+
+        BulkRequest.Builder br = new BulkRequest.Builder();
+
+        for (var id : list) {
+            br.operations(op -> op.delete(idx -> idx.index("fruits").id(id)));
+        }
+
+        BulkResponse result = client.bulk(br.build());
+
+        if (result.errors()) {
+            throw new RuntimeException("The indexing operation encountered errors.");
+        }
     }
 }