Added QueryStringQuery

Author: JuliaIlic

modules/library/src/main/scala/zio/elasticsearch/ElasticQuery.scala

@@ -899,6 +899,49 @@ object ElasticQuery {
   final def prefix(field: String, value: String): Prefix[Any] =
     Prefix(field = field, value = value, caseInsensitive = None)
 
+  /**
+   * Constructs a type-safe instance of [[zio.elasticsearch.query.QueryStringQuery]] using the specified
+   * parameters. [[zio.elasticsearch.query.QueryStringQuery]] supports query strings with simple syntax for
+   * searching multiple fields.
+   *
+   * @param fields
+   *   the type-safe fields to be searched
+   * @param query
+   *   the query string to search for
+   * @tparam S
+   *   the document type on which the query is executed
+   * @return
+   *   an instance of [[zio.elasticsearch.query.QueryStringQuery]] that represents the query to be performed.
+   */
+  final def queryStringQuery[S: Schema](query: String, fields: Field[S, _]*): QueryStringQuery[S] =
+    QueryString[S](
+      query = query,
+      fields = Chunk.fromIterable(fields.map(_.toString)),
+      defaultField = None,
+      boost = None,
+      minimumShouldMatch = None
+    )
+
+  /**
+   * Constructs an instance of [[zio.elasticsearch.query.QueryStringQuery]] using the specified parameters.
+   * [[zio.elasticsearch.query.QueryStringQuery]] supports query strings with simple syntax for searching multiple
+   * fields.
+   *
+   * @param query
+   *   the query string to search for
+   * @return
+   *   an instance of [[zio.elasticsearch.query.QueryStringQuery]] that represents the query to be performed.
+   */
+  final def queryStringQuery(query: String): QueryStringQuery[Any] =
+    QueryString(
+      query = query,
+      fields = Chunk.empty,
+      defaultField = None,
+      boost = None,
+      minimumShouldMatch = None
+    )
+
+
   /**
    * Constructs a type-safe unbounded instance of [[zio.elasticsearch.query.RangeQuery]] using the specified parameters.
    *

modules/library/src/main/scala/zio/elasticsearch/query/Queries.scala

@@ -22,7 +22,7 @@ import zio.elasticsearch.Field
 import zio.elasticsearch.query.options._
 import zio.elasticsearch.query.sort.options.HasFormat
 import zio.json.ast.Json
-import zio.json.ast.Json.{Arr, Obj}
+import zio.json.ast.Json.{Arr, Null, Obj, Str}
 import zio.schema.Schema
 
 sealed trait ElasticQuery[-S] { self =>
@@ -1016,6 +1016,53 @@ private[elasticsearch] final case class Prefix[S](
   }
 }
 
+sealed trait QueryStringQuery[S] extends ElasticQuery[S]
+  with HasFields[QueryStringQuery, S]
+  with HasBoost[QueryStringQuery[S]]
+  with HasMinimumShouldMatch[QueryStringQuery[S]]
+
+private[elasticsearch] final case class QueryString[S](
+  query: String,
+  fields: Chunk[String],
+  defaultField: Option[String],
+  boost: Option[Double],
+  minimumShouldMatch: Option[Int]
+) extends QueryStringQuery[S] { self =>
+
+  def fields(field: String, fields: String*): QueryStringQuery[S] =
+    copy(fields = Chunk.fromIterable(field +: fields))
+
+  def fields[S1 <: S: Schema](fields: Chunk[Field[S1, _]]): QueryStringQuery[S1] =
+    copy(fields = fields.map(_.toString))
+
+  def fields[S1 <: S: Schema](field: Field[S1, _], fields: Field[S1, _]*): QueryStringQuery[S1] =
+    self.copy(fields = Chunk.fromIterable((field +: fields).map(_.toString)))
+
+  def boost(value: Double): QueryStringQuery[S] =
+    self.copy(boost = Some(value))
+
+  def minimumShouldMatch(value: Int): QueryStringQuery[S] =
+    self.copy(minimumShouldMatch = Some(value))
+
+  override def toJson(fieldPath: Option[String]): Json = {
+
+    val fieldsJson = if (fields.nonEmpty) Some("fields" -> Arr(fields.map(_.toJson))) else None
+    Obj(
+      "query" -> Obj(
+        "query_string" -> Obj(
+          List(
+            Some("query" -> Str(query)),
+            defaultField.map(df => "default_field" -> Str(df)),
+            fieldsJson,
+            boost.map(b => "boost" -> Json.Num(b)),
+            minimumShouldMatch.map(msm => "minimum_should_match" -> Json.Num(msm))
+          ).flatten: _*
+        )
+      )
+    )
+  }
+}
+
 sealed trait RangeQuery[S, A, LB <: LowerBound, UB <: UpperBound]
     extends ElasticQuery[S]
     with HasBoost[RangeQuery[S, A, LB, UB]]
@@ -1280,7 +1327,8 @@ private[elasticsearch] final case class Wildcard[S](
   value: String,
   boost: Option[Double],
   caseInsensitive: Option[Boolean]
-) extends WildcardQuery[S] { self =>
+) extends WildcardQuery[S] {
+  self =>
 
   def boost(value: Double): WildcardQuery[S] =
     self.copy(boost = Some(value))

modules/library/src/test/scala/zio/elasticsearch/ElasticQuerySpec.scala

@@ -1514,6 +1514,13 @@ object ElasticQuerySpec extends ZIOSpecDefault {
             )
           )
         },
+        test("queryStringQuery"){
+          val query                    = range("testField")
+          val queryNoFields           = queryStringQuery("test")
+          val queryWithFields         = queryStringQuery("test").fields("stringField1", "stringField2")
+          val queryWithMinShouldMatch = queryNoFields.minimumShouldMatch(2)
+
+        },
         test("range") {
           val query                    = range("testField")
           val queryString              = range(TestDocument.stringField)