update index, update and delete client documentations

Author: fupelaqu

core/src/main/scala/app/softnetwork/elastic/client/DeleteApi.scala

@@ -65,6 +65,8 @@ trait DeleteApi extends ElasticClientHelpers { _: SettingsApi =>
     executeDelete(index, id, waitEnabled) match {
       case success @ ElasticSuccess(true) =>
         logger.info(s"✅ Successfully deleted document with id '$id' from index '$index'")
+        if (waitEnabled)
+          logger.info(s"Waiting for a refresh of index $index to happen")
         success
       case success @ ElasticSuccess(_) =>
         logger.info(s"✅ Document with id '$id' not found in index '$index'")
@@ -115,6 +117,8 @@ trait DeleteApi extends ElasticClientHelpers { _: SettingsApi =>
         s match {
           case success @ ElasticSuccess(true) =>
             logger.info(s"✅ Successfully deleted document with id '$id' from index '$index'")
+            if (waitEnabled)
+              logger.info(s"Waiting for a refresh of index $index to happen")
             promise.success(success)
           case success @ ElasticSuccess(_) =>
             logger.warn(s"❌ Document with id '$id' in index '$index' not deleted")

core/src/main/scala/app/softnetwork/elastic/client/ElasticClientDelegator.scala

@@ -29,7 +29,7 @@ import org.slf4j.{Logger, LoggerFactory}
 
 import scala.concurrent.{ExecutionContext, Future}
 import scala.language.implicitConversions
-import scala.reflect.{classTag, ClassTag}
+import scala.reflect.ClassTag
 
 trait ElasticClientDelegator extends ElasticClientApi with BulkTypes {
 
@@ -505,7 +505,7 @@ trait ElasticClientDelegator extends ElasticClientApi with BulkTypes {
     id: String,
     index: Option[String],
     maybeType: Option[String],
-    wait: Boolean
+    wait: Boolean = false
   )(implicit u: ClassTag[U], formats: Formats): ElasticResult[Boolean] =
     delegate.indexAs(entity, id, index, maybeType, wait)
 
@@ -524,9 +524,9 @@ trait ElasticClientDelegator extends ElasticClientApi with BulkTypes {
     index: JSONResults,
     id: JSONResults,
     source: JSONResults,
-    wait: Boolean
+    wait: Boolean = false
   ): ElasticResult[Boolean] =
-    delegate.index(index, id, source, false)
+    delegate.index(index, id, source, wait)
 
   /** Index an entity in the given index asynchronously.
     *
@@ -548,7 +548,7 @@ trait ElasticClientDelegator extends ElasticClientApi with BulkTypes {
     id: String,
     index: Option[String],
     maybeType: Option[String],
-    wait: Boolean
+    wait: Boolean = false
   )(implicit
     u: ClassTag[U],
     ec: ExecutionContext,
@@ -572,6 +572,7 @@ trait ElasticClientDelegator extends ElasticClientApi with BulkTypes {
   override def indexAsync(index: String, id: String, source: String, wait: Boolean)(implicit
     ec: ExecutionContext
   ): Future[ElasticResult[Boolean]] = delegate.indexAsync(index, id, source, wait)
+
   override private[client] def executeIndex(
     index: String,
     id: String,
@@ -610,7 +611,7 @@ trait ElasticClientDelegator extends ElasticClientApi with BulkTypes {
     id: String,
     source: String,
     upsert: Boolean,
-    wait: Boolean
+    wait: Boolean = false
   ): ElasticResult[Boolean] =
     delegate.update(index, id, source, upsert, wait)
 
@@ -637,7 +638,7 @@ trait ElasticClientDelegator extends ElasticClientApi with BulkTypes {
     index: Option[String],
     maybeType: Option[String],
     upsert: Boolean,
-    wait: Boolean
+    wait: Boolean = false
   )(implicit u: ClassTag[U], formats: Formats): ElasticResult[Boolean] =
     delegate.updateAs(entity, id, index, maybeType, upsert, wait)
 
@@ -661,7 +662,7 @@ trait ElasticClientDelegator extends ElasticClientApi with BulkTypes {
     id: String,
     source: String,
     upsert: Boolean,
-    wait: Boolean
+    wait: Boolean = false
   )(implicit
     ec: ExecutionContext
   ): Future[ElasticResult[Boolean]] =
@@ -690,7 +691,7 @@ trait ElasticClientDelegator extends ElasticClientApi with BulkTypes {
     index: Option[String],
     maybeType: Option[String],
     upsert: Boolean,
-    wait: Boolean
+    wait: Boolean = false
   )(implicit
     u: ClassTag[U],
     ec: ExecutionContext,
@@ -729,7 +730,7 @@ trait ElasticClientDelegator extends ElasticClientApi with BulkTypes {
     * @return
     *   true if the entity was deleted successfully, false otherwise
     */
-  override def delete(id: String, index: String, wait: Boolean): ElasticResult[Boolean] =
+  override def delete(id: String, index: String, wait: Boolean = false): ElasticResult[Boolean] =
     delegate.delete(id, index, wait)
 
   /** Delete an entity from the given index asynchronously.
@@ -743,7 +744,7 @@ trait ElasticClientDelegator extends ElasticClientApi with BulkTypes {
     * @return
     *   a Future that completes with true if the entity was deleted successfully, false otherwise
     */
-  override def deleteAsync(id: String, index: String, wait: Boolean)(implicit
+  override def deleteAsync(id: String, index: String, wait: Boolean = false)(implicit
     ec: ExecutionContext
   ): Future[ElasticResult[Boolean]] =
     delegate.deleteAsync(id, index, wait)

core/src/main/scala/app/softnetwork/elastic/client/IndexApi.scala

@@ -106,6 +106,8 @@ trait IndexApi extends ElasticClientHelpers { _: SettingsApi with SerializationA
     executeIndex(index, id, source, waitEnabled) match {
       case success @ ElasticSuccess(true) =>
         logger.info(s"✅ Document with id '$id' indexed successfully in index '$index'")
+        if (waitEnabled)
+          logger.info(s"Waiting for a refresh of index $index to happen")
         success
       case success @ ElasticSuccess(_) =>
         logger.info(s"✅ Document with id '$id' not indexed in index '$index'")
@@ -197,6 +199,8 @@ trait IndexApi extends ElasticClientHelpers { _: SettingsApi with SerializationA
         result match {
           case success @ ElasticSuccess(true) =>
             logger.info(s"✅ Successfully indexed document with id '$id' in index '$index'")
+            if (waitEnabled)
+              logger.info(s"Waiting for a refresh of index $index to happen")
             promise.success(success)
           case success @ ElasticSuccess(_) =>
             logger.info(s"✅ Document with id '$id' not indexed in index '$index'")

core/src/main/scala/app/softnetwork/elastic/client/UpdateApi.scala

@@ -90,6 +90,8 @@ trait UpdateApi extends ElasticClientHelpers { _: SettingsApi with Serialization
     executeUpdate(index, id, source, upsert, waitEnabled) match {
       case success @ ElasticSuccess(true) =>
         logger.info(s"✅ Successfully updated document with id '$id' in index '$index'")
+        if (waitEnabled)
+          logger.info(s"Waiting for a refresh of index $index to happen")
         success
       case ElasticSuccess(false) =>
         val error = s"Document with id '$id' in index '$index' not updated"
@@ -208,6 +210,8 @@ trait UpdateApi extends ElasticClientHelpers { _: SettingsApi with Serialization
         s match {
           case success @ ElasticSuccess(true) =>
             logger.info(s"✅ Successfully updated document with id '$id' in index '$index'")
+            if (waitEnabled)
+              logger.info(s"Waiting for a refresh of index $index to happen")
             promise.success(success)
           case success @ ElasticSuccess(_) =>
             logger.warn(s"❌ Document with id '$id' in index '$index' not updated")

documentation/client/delete.md

@@ -8,7 +8,7 @@ The **DeleteApi** trait provides functionality to delete documents from Elastics
 
 **Features:**
 - Synchronous and asynchronous document deletion
-- Automatic index refresh after deletion
+- Wait for a refresh to happen after deletion to happen if required
 - Index name validation
 - Comprehensive error handling and logging
 - Safe deletion with existence checking
@@ -24,7 +24,7 @@ The **DeleteApi** trait provides functionality to delete documents from Elastics
 - Deletes a document by its ID from a specific index
 - Returns `true` if document was deleted
 - Returns `false` if document doesn't exist (not an error)
-- Automatically refreshes index after successful deletion
+- Wait for a refresh to happen after deletion if required
 
 **Idempotency:**
 - Delete operations are idempotent
@@ -42,12 +42,13 @@ Deletes a document from an Elasticsearch index by ID.
 **Signature:**
 
 ```scala
-def delete(id: String, index: String): ElasticResult[Boolean]
+def delete(id: String, index: String, wait: Boolean): ElasticResult[Boolean]
 ```
 
 **Parameters:**
 - `id` - The document ID to delete
 - `index` - The index name containing the document
+- `wait` - If `true`, waits for a refresh to happen after deletion (default is `false`)
 
 **Returns:**
 - `ElasticSuccess[Boolean]` with `true` if document was deleted
@@ -58,8 +59,8 @@ def delete(id: String, index: String): ElasticResult[Boolean]
 - Index name format validation
 
 **Behavior:**
-- Automatically refreshes index after successful deletion
 - Logs success/failure with appropriate emoji indicators
+- Waits for a refresh to happen after successful deletion (disabled by default)
 - Returns success even if document doesn't exist (idempotent)
 
 **Examples:**
@@ -205,13 +206,15 @@ Asynchronously deletes a document from an Elasticsearch index.
 ```scala
 def deleteAsync(
   id: String,
-  index: String
+  index: String,
+  wait: Boolean
 )(implicit ec: ExecutionContext): Future[ElasticResult[Boolean]]
 ```
 
 **Parameters:**
 - `id` - The document ID to delete
 - `index` - The index name containing the document
+- `wait` - If `true`, waits for a refresh to happen after deletion (default is `false`)
 - `ec` - Implicit ExecutionContext for async execution
 
 **Returns:**
@@ -414,7 +417,8 @@ val result = Await.result(
 ```scala
 private[client] def executeDelete(
   index: String,
-  id: String
+  id: String,
+  wait: boolean
 ): ElasticResult[Boolean]
 ```
 
@@ -423,20 +427,26 @@ private[client] def executeDelete(
 ```scala
 private[client] def executeDelete(
   index: String,
-  id: String
+  id: String,
+  wait: Boolean
 ): ElasticResult[Boolean] = {
-  executeRestAction[DeleteResponse, Boolean](
+  executeRestAction[DeleteRequest, DeleteResponse, Boolean](
     operation = "delete",
-    index = Some(index)
+    index = Some(index),
+    retryable = false
   )(
-    action = {
-      val request = new DeleteRequest(index, id)
-      client.delete(request, RequestOptions.DEFAULT)
-    }
+    request = new DeleteRequest(index, id)
+      .setRefreshPolicy(
+        if (wait) WriteRequest.RefreshPolicy.WAIT_UNTIL else WriteRequest.RefreshPolicy.NONE
+      )
   )(
-    transformer = resp => {
-      resp.getResult == DocWriteResponse.Result.DELETED
-    }
+    executor = req => apply().delete(req, RequestOptions.DEFAULT)
+  )(
+    transformer = resp =>
+      resp.getResult match {
+        case DocWriteResponse.Result.DELETED | DocWriteResponse.Result.NOOP => true
+        case _                                                              => false
+      }
   )
 }
 ```
@@ -448,7 +458,8 @@ private[client] def executeDelete(
 ```scala
 private[client] def executeDeleteAsync(
   index: String,
-  id: String
+  id: String,
+  wait: Boolean
 )(implicit ec: ExecutionContext): Future[ElasticResult[Boolean]]
 ```
 
@@ -457,33 +468,27 @@ private[client] def executeDeleteAsync(
 ```scala
 private[client] def executeDeleteAsync(
   index: String,
-  id: String
+  id: String,
+  wait: Boolean
 )(implicit ec: ExecutionContext): Future[ElasticResult[Boolean]] = {
-  val promise = Promise[ElasticResult[Boolean]]()
-  
-  val request = new DeleteRequest(index, id)
-  
-  client.deleteAsync(
-    request,
-    RequestOptions.DEFAULT,
-    new ActionListener[DeleteResponse] {
-      override def onResponse(response: DeleteResponse): Unit = {
-        val deleted = response.getResult == DocWriteResponse.Result.DELETED
-        promise.success(ElasticSuccess(deleted))
-      }
-      
-      override def onFailure(e: Exception): Unit = {
-        promise.success(ElasticFailure(ElasticError(
-          message = s"Async delete failed: ${e.getMessage}",
-          operation = Some("deleteAsync"),
-          index = Some(index),
-          cause = Some(e)
-        )))
+  executeAsyncRestAction[DeleteRequest, DeleteResponse, Boolean](
+    operation = "deleteAsync",
+    index = Some(index),
+    retryable = false
+  )(
+    request = new DeleteRequest(index, id)
+      .setRefreshPolicy(
+        if (wait) WriteRequest.RefreshPolicy.WAIT_UNTIL else WriteRequest.RefreshPolicy.NONE
+      )
+  )(
+    executor = (req, listener) => apply().deleteAsync(req, RequestOptions.DEFAULT, listener)
+  )(
+    transformer = resp =>
+      resp.getResult match {
+        case DocWriteResponse.Result.DELETED | DocWriteResponse.Result.NOOP => true
+        case _                                                              => false
       }
-    }
   )
-  
-  promise.future
 }
 ```
 
@@ -866,10 +871,10 @@ def hardDeleteSession(id: String): ElasticResult[Boolean] = {
 
 ### Delete vs Update (Soft Delete)
 
-| Operation | Data Retained | Recoverable | Performance | Use Case |
-|-----------|---------------|-------------|-------------|----------|
-| **Hard Delete** | No | No | Fast | Temporary data, logs |
-| **Soft Delete** | Yes | Yes | Slower | User data, orders |
+| Operation       | Data Retained   | Recoverable  | Performance  | Use Case             |
+|-----------------|-----------------|--------------|--------------|----------------------|
+| **Hard Delete** | No              | No           | Fast         | Temporary data, logs |
+| **Soft Delete** | Yes             | Yes          | Slower       | User data, orders    |
 
 ```scala
 // Hard delete