(dsl): Support `Terms set` query #355

vanjaftn · 2023-11-06T09:54:24Z

Part of #91

dbulaja98 · 2023-11-07T08:30:28Z

docs/overview/queries/elastic_query_terms_set.md

+title: "Terms Set Query"
+---
+
+The `TermsSet` query returns documents that contain the minimum amount of exact terms in a provided field. The terms set query is the same as [[zio.elasticsearch.query.TermsQuery]], except you can define the number of matching terms required to return a document.


Suggested change

The `TermsSet` query returns documents that contain the minimum amount of exact terms in a provided field. The terms set query is the same as [[zio.elasticsearch.query.TermsQuery]], except you can define the number of matching terms required to return a document.

The `TermsSet` query returns documents that contain the minimum amount of exact terms in a provided field. The Terms set query is the same as [[zio.elasticsearch.query.TermsQuery]], except you can define the number of matching terms required to return a document.

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

dbulaja98 · 2023-11-08T23:50:46Z

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

@@ -936,7 +936,7 @@ object ElasticQuery {
   * @tparam A


Can you put A before S in scaladoc?

dbulaja98 · 2023-11-08T23:53:28Z

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

+  final def termsSet[S, A: ElasticPrimitive](
+    field: Field[S, A],
+    minimumShouldMatchField: String,
+    terms: A*


Can there be zero terms?

dbulaja98 · 2023-11-09T00:04:57Z

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

+   */
+  final def termsSetScript[A: ElasticPrimitive](
+    field: String,
+    minimumShouldMatchScript: zio.elasticsearch.script.Script,


Why with prefix?

dbulaja98 · 2023-11-09T00:17:02Z

modules/integration/src/test/scala/zio/elasticsearch/HttpExecutorSpec.scala

@@ -1477,7 +1551,7 @@ object HttpExecutorSpec extends IntegrationSpec {
            Executor.execute(ElasticRequest.createIndex(firstSearchIndex)),
            Executor.execute(ElasticRequest.deleteIndex(firstSearchIndex)).orDie
          ),
-          test("search for a document using script query") {
+          test("search for a document using should without satisfying minimumShouldMatch condition") {


Can you omit: without satisfying minimumShouldMatch condition? If that makes sense.

dbulaja98 · 2023-11-09T00:18:58Z

modules/integration/src/test/scala/zio/elasticsearch/HttpExecutorSpec.scala

@@ -1342,6 +1342,80 @@ object HttpExecutorSpec extends IntegrationSpec {
            Executor.execute(ElasticRequest.createIndex(firstSearchIndex)),
            Executor.execute(ElasticRequest.deleteIndex(firstSearchIndex)).orDie
          ),
+          test("search for a document using a terms set query with minimumShouldMatchField") {


Maybe put 2 in intField, and make one of them not passing the check.

dbulaja98 · 2023-11-09T00:19:22Z

modules/integration/src/test/scala/zio/elasticsearch/HttpExecutorSpec.scala

+            Executor.execute(ElasticRequest.createIndex(firstSearchIndex)),
+            Executor.execute(ElasticRequest.deleteIndex(firstSearchIndex)).orDie
+          ),
+          test("search for a document using a terms set query with minimumShouldMatchScript") {


dbulaja98 · 2023-11-09T00:21:57Z

docs/overview/queries/elastic_query_terms_set.md

+
+You can create a [type-safe](https://lambdaworks.github.io/zio-elasticsearch/overview/overview_zio_prelude_schema) `TermsSet` query with defined `minimumShouldMatchField` using the `termsSet` method this way:
+```scala
+val query: TermsSetQuery = termsSet(field = Document.name, minimumShouldMatchField = "intField", terms = 1, 2, 3)


Check if minimumShouldMatchField can be type-safe too.

dbulaja98 · 2023-11-09T00:23:01Z

docs/overview/queries/elastic_query_terms_set.md

+```scala
+val query: TermsSetQuery = termsSetScript(field = "stringField", minimumShouldMatchScript = Script("doc['intField'].value"), terms = 1, 2, 3)


Put Script import here.

Also because of stringField, consider changing 1,2,3 to something else (everywhere here)

dbulaja98 · 2023-11-12T14:02:22Z

docs/overview/queries/elastic_query_terms_set.md

+val query: TermsSetQuery = termsSet(field = Document.name, minimumShouldMatchField = Document.field, terms = "a", "b", "c")
+```


Suggested change

val query: TermsSetQuery = termsSet(field = Document.name, minimumShouldMatchField = Document.field, terms = "a", "b", "c")

```

val query: TermsSetQuery = termsSet(field = Document.name, minimumShouldMatchField = Document.intField, terms = "a", "b", "c")

dbulaja98 · 2023-11-12T14:09:09Z

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

+      terms = Chunk.fromIterable(terms),
+      minimumShouldMatchField = Some(minimumShouldMatchField),
+      minimumShouldMatchScript = None,
+      boost = None


Put boost before minimumShouldMatchField and minimumShouldMatchScript.

dbulaja98 · 2023-11-12T14:16:19Z

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

+  terms: Chunk[A],
+  minimumShouldMatchField: Option[String],
+  minimumShouldMatchScript: Option[zio.elasticsearch.script.Script],
+  boost: Option[Double]


Put boost before minimumShouldMatchField an minimumShouldMatchScript.

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

dbulaja98 · 2023-11-13T14:44:04Z

docs/overview/queries/elastic_query_terms_set.md

+val queryWithBoost: TermsSetQuery = termsSet(field = "booleanField", minimumShouldMatchField = "intField", terms = true, false).boost(2.0)
+val queryWithBoost: TermsSetQuery = termsSetScript(field = "booleanField", minimumShouldMatchScript = Script("doc['intField'].value"), terms = true, false).boost(2.0)


Give them different names.

dbulaja98 · 2023-11-13T14:49:40Z

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

+              terms = "a",
+              "b",
+              "c"


Can you put this all in the same line?

Same question for every situation like this in new tests you have added.

dbulaja98 · 2023-11-13T14:49:49Z

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

+            terms = "a",
+            "b",
+            "c"


Can you put this all in the same line?

dbulaja98 changed the title ~~(dsl): Support Terms Set query~~ (dsl): Support Terms set query Nov 7, 2023

dbulaja98 requested changes Nov 9, 2023

View reviewed changes

dbulaja98 requested changes Nov 12, 2023

View reviewed changes

dbulaja98 requested changes Nov 13, 2023

View reviewed changes

vanjaftn force-pushed the task-support-terms-set-query branch from 7a42c09 to 8b4906e Compare November 13, 2023 15:28

vanjaftn added 8 commits November 13, 2023 16:30

Implement Terms query

df12e82

Implement Terms Set query

b61f3aa

Fix code remarks

9ed9341

Implement Terms query

0e941f6

Implement Terms Set query

6532ed7

Implement changes to Terms set query

2b39a48

Fix code remarks

36ebcab

Fix code remarks

c5f9916

vanjaftn force-pushed the task-support-terms-set-query branch from 8b4906e to c5f9916 Compare November 13, 2023 15:30

dbulaja98 merged commit dbeb4b0 into lambdaworks:main Nov 14, 2023
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(dsl): Support `Terms set` query #355

(dsl): Support `Terms set` query #355

vanjaftn commented Nov 6, 2023 •

edited by dbulaja98

dbulaja98 Nov 7, 2023

dbulaja98 Nov 8, 2023

dbulaja98 Nov 8, 2023

dbulaja98 Nov 9, 2023

dbulaja98 Nov 9, 2023

dbulaja98 Nov 9, 2023

dbulaja98 Nov 9, 2023

dbulaja98 Nov 9, 2023

dbulaja98 Nov 9, 2023

dbulaja98 Nov 9, 2023

dbulaja98 Nov 12, 2023

dbulaja98 Nov 12, 2023

dbulaja98 Nov 12, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

	The `TermsSet` query returns documents that contain the minimum amount of exact terms in a provided field. The terms set query is the same as [[zio.elasticsearch.query.TermsQuery]], except you can define the number of matching terms required to return a document.
	The `TermsSet` query returns documents that contain the minimum amount of exact terms in a provided field. The Terms set query is the same as [[zio.elasticsearch.query.TermsQuery]], except you can define the number of matching terms required to return a document.

		```scala
		val query: TermsSetQuery = termsSetScript(field = "stringField", minimumShouldMatchScript = Script("doc['intField'].value"), terms = 1, 2, 3)

		val query: TermsSetQuery = termsSet(field = Document.name, minimumShouldMatchField = Document.field, terms = "a", "b", "c")
		```

		val queryWithBoost: TermsSetQuery = termsSet(field = "booleanField", minimumShouldMatchField = "intField", terms = true, false).boost(2.0)
		val queryWithBoost: TermsSetQuery = termsSetScript(field = "booleanField", minimumShouldMatchScript = Script("doc['intField'].value"), terms = true, false).boost(2.0)

(dsl): Support Terms set query #355

(dsl): Support Terms set query #355

Conversation

vanjaftn commented Nov 6, 2023 • edited by dbulaja98

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

(dsl): Support `Terms set` query #355

(dsl): Support `Terms set` query #355

vanjaftn commented Nov 6, 2023 •

edited by dbulaja98