(dsl): Support `Disjunction max` query #360

vanjaftn · 2023-11-10T10:20:22Z

Part of #91

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

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

+   *   an instance of [[zio.elasticsearch.query.DisjunctionMax]] that represents the `disjunction max` query to be
+   *   performed.
+   */
+  final def disjunctionMax[S](queries: Chunk[ElasticQuery[S]]): DisjunctionMaxQuery[S] =


Can you implement raw method also? You can look at bool query as a reference (filter methods for example)

Also, check if [S: Schema] is required.

Can there be zero queries? If so, you can use ElasticQuery[S]* maybe.

I think that there must be at least one query, as it is a required field.

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

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

+   * Constructs an instance of [[zio.elasticsearch.query.DisjunctionMax]] using the specified parameters.
+   *
+   * @param queries
+   *   the type-safe [[ElasticQuery]] object to be wrapped inside of disjunction max query


There are more than one query.

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

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

+   * @param allQueries
+   *   the queries to be added
+   * @tparam S1
+   *   the type of the sub-queries, for which an implicit [[zio.schema.Schema]] is required
+   * @return
+   *   an instance of the [[zio.elasticsearch.query.DisjunctionMaxQuery]] with queries added.
+   */
+  def queries[S1 <: S: Schema](allQueries: ElasticQuery[S1]*): DisjunctionMaxQuery[S1]
+
+  /**
+   * Adds specified queries to the [[zio.elasticsearch.query.DisjunctionMaxQuery]]. Returned documents must match one or
+   * more of these queries.
+   *
+   * @param allQueries
+   *   the queries to be added
+   * @return
+   *   an instance of the [[zio.elasticsearch.query.DisjunctionMaxQuery]] with queries added.
+   */
+  def queries(allQueries: ElasticQuery[Any]*): DisjunctionMaxQuery[S]


I think you can remove these two methods, as we already ask user for queries within the creation of query.

dbulaja98 · 2023-11-12T14:29:20Z

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

+   * @param value
+   *   a number to set `tieBreaker` parameter to
+   * @return
+   *   a new instance of the [[zio.elasticsearch.query.DisjunctionMaxQuery]] with the `tieBreaker` value set.


Suggested change

* a new instance of the [[zio.elasticsearch.query.DisjunctionMaxQuery]] with the `tieBreaker` value set.

* an instance of the [[zio.elasticsearch.query.DisjunctionMaxQuery]] enriched with the `tieBreaker` parameter.

dbulaja98 · 2023-11-12T14:33:45Z

docs/overview/queries/elastic_query_disjunction_max.md

+title: "Disjunction max Query"
+---
+
+The `Disjunction max` query returns documents  that match one or more query clauses. For documents that match multiple query clauses, the relevance score is set to the highest relevance score from all matching query clauses. When the relevance scores of the returned documents are identical, tie breaker parameter gives more weight to documents that match multiple query clauses.


Suggested change

The `Disjunction max` query returns documents that match one or more query clauses. For documents that match multiple query clauses, the relevance score is set to the highest relevance score from all matching query clauses. When the relevance scores of the returned documents are identical, tie breaker parameter gives more weight to documents that match multiple query clauses.

The `Disjunction max` query returns documents that match one or more query clauses. For documents that match multiple query clauses, the relevance score is set to the highest relevance score from all matching query clauses. When the relevance scores of the returned documents are identical, tie breaker parameter can be used for giving more weight to documents that match multiple query clauses.

dbulaja98 · 2023-11-12T14:34:45Z

docs/overview/queries/elastic_query_disjunction_max.md

+You can create a `Disjunction max` query using the `disjunctionMax` method this way:
+```scala
+val query: DisjunctionMaxQuery = disjunctionMax( queries = Chunk( term( field = "stringField", value = "test"), exists( field = "intField")))
+```


Suggested change

You can create a `Disjunction max` query using the `disjunctionMax` method this way:

```scala

val query: DisjunctionMaxQuery = disjunctionMax( queries = Chunk( term( field = "stringField", value = "test"), exists( field = "intField")))

```

You can create a `Disjunction max` query using the `disjunctionMax` method this way:

```scala

val query: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(term(field = "stringField", value = "test"), exists(field = "intField")))

When you update public api for this query, update this also.

dbulaja98 · 2023-11-12T14:35:59Z

docs/overview/queries/elastic_query_disjunction_max.md

+```scala
+val queryWithPrefixLength: DisjunctionMaxQuery = disjunctionMax( queries = Chunk( queries = Chunk( exists("existsField"), ids("1", "2", "3"))).tieBreaker(0.5f))
+```


Suggested change

```scala

val queryWithPrefixLength: DisjunctionMaxQuery = disjunctionMax( queries = Chunk( queries = Chunk( exists("existsField"), ids("1", "2", "3"))).tieBreaker(0.5f))

```

```scala

val queryWithPrefixLength: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(queries = Chunk(exists("existsField"), ids("1", "2", "3"))).tieBreaker(0.5f))

Also, something seems off with these Chunks.

dbulaja98 · 2023-11-12T14:41:08Z

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

+                    firstDocument.copy(stringField = s"this is a ${firstDocument.stringField} test.")
+                  secondDocumentUpdated =
+                    secondDocument.copy(stringField =
+                      s"this is not a ${firstDocument.stringField} test. It is a ${secondDocument.stringField} test, but not ${firstDocument.stringField}"


Can you put something more meaningful here?

dbulaja98 · 2023-11-13T14:25:24Z

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

+  final def disjunctionMax[S: Schema](queries: Chunk[ElasticQuery[S]]): DisjunctionMaxQuery[S] =
+    DisjunctionMax[S](queries = queries, tieBreaker = None)


Can you use this instead: queries: ElasticQuery[S]*?

dbulaja98 · 2023-11-13T14:25:37Z

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

+  final def disjunctionMax(queries: Chunk[ElasticQuery[Any]]): DisjunctionMaxQuery[Any] =
+    DisjunctionMax[Any](queries = queries, tieBreaker = None)


Can you use this instead: queries: ElasticQuery[Any]*?

dbulaja98 · 2023-11-13T14:26:53Z

docs/overview/queries/elastic_query_disjunction_max.md

+
+You can create a `Disjunction max` query using the `disjunctionMax` method this way:
+```scala
+val query: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(term(field = "stringField", value = "test"), exists( field = "intField")))


Suggested change

val query: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(term(field = "stringField", value = "test"), exists( field = "intField")))

val query: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(term(field = "stringField", value = "test"), exists(field = "intField")))

dbulaja98 · 2023-11-13T14:27:15Z

docs/overview/queries/elastic_query_disjunction_max.md

+val queryWithPrefixLength: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(exists("existsField"), ids("1", "2", "3"))).tieBreaker(0.5f)
+```


Suggested change

val queryWithPrefixLength: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(exists("existsField"), ids("1", "2", "3"))).tieBreaker(0.5f)

```

val queryWithTieBreaker: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(exists("existsField"), ids("1", "2", "3"))).tieBreaker(0.5f)

dbulaja98 · 2023-11-13T14:27:46Z

docs/overview/queries/elastic_query_disjunction_max.md

+```
+
+You can find more information about `Disjunction max` query [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html).
+


Is there one or two empty lines at the end? If there is two, omit one please.

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

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

+   * Constructs a type-safe instance of [[zio.elasticsearch.query.DisjunctionMax]] using the specified parameters.
+   *
+   * @param queries
+   *   the type-safe [[ElasticQuery]] objects to be wrapped inside of disjunction max query


Suggested change

* the type-safe [[ElasticQuery]] objects to be wrapped inside of disjunction max query

* a list of queries to be wrapped inside of disjunction max query

dbulaja98 · 2023-11-13T14:29:22Z

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

+   * Constructs an instance of [[zio.elasticsearch.query.DisjunctionMax]] using the specified parameters.
+   *
+   * @param queries
+   *   the [[ElasticQuery]] objects to be wrapped inside of disjunction max query


Suggested change

* the [[ElasticQuery]] objects to be wrapped inside of disjunction max query

* a list of queries to be wrapped inside of disjunction max query

dbulaja98 · 2023-11-16T13:50:36Z

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

+   *   performed.
+   */
+  final def disjunctionMax[S: Schema](query: ElasticQuery[S], queries: ElasticQuery[S]*): DisjunctionMaxQuery[S] =
+    DisjunctionMax[S](query = query, queries = Chunk.fromIterable(queries), tieBreaker = None)


Can you merge query and queries here?
queries = Chunk.fromIterable(queries).prepended(query) or something like this?

So then we will not have both query and queries in DisjunctionMax.

dbulaja98 · 2023-11-16T13:51:17Z

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

+   *   performed.
+   */
+  final def disjunctionMax(query: ElasticQuery[Any], queries: ElasticQuery[Any]*): DisjunctionMaxQuery[Any] =
+    DisjunctionMax[Any](query = query, queries = Chunk.fromIterable(queries), tieBreaker = None)


dbulaja98 · 2023-11-16T13:52:47Z

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

+  query: ElasticQuery[S],
+  queries: Chunk[ElasticQuery[S]],


If you apply change I have asked, then we will have only queries here.

vanjaftn changed the title ~~(dsl): Support Disjunction max query~~ (dsl): Support Disjunction max query Nov 10, 2023

dbulaja98 requested changes Nov 12, 2023

View reviewed changes

vanjaftn force-pushed the task-support-disjunction-max-query branch from f04af37 to 5f14e97 Compare November 13, 2023 09:50

dbulaja98 requested changes Nov 13, 2023

View reviewed changes

vanjaftn force-pushed the task-support-disjunction-max-query branch 2 times, most recently from d680a2f to 98c8137 Compare November 15, 2023 14:42

dbulaja98 requested changes Nov 16, 2023

View reviewed changes

vanjaftn added 6 commits November 17, 2023 12:21

Support Disjunction max query

f796a8c

Fix code remarks

f14b4b1

Fix code remarks

3bb2062

Implement changes in Disjunction max query

0061a6e

Implement changes in Disjunction max query docs

5911c70

Fix code remarks

b04fca9

vanjaftn force-pushed the task-support-disjunction-max-query branch from 3deeabe to b04fca9 Compare November 17, 2023 11:21

Resolve conflict

201a491

dbulaja98 approved these changes Nov 17, 2023

View reviewed changes

dbulaja98 merged commit fa1f343 into lambdaworks:main Nov 17, 2023
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(dsl): Support `Disjunction max` query #360

(dsl): Support `Disjunction max` query #360

vanjaftn commented Nov 10, 2023 •

edited by dbulaja98

dbulaja98 Nov 12, 2023

dbulaja98 Nov 12, 2023

dbulaja98 Nov 12, 2023

vanjaftn Nov 13, 2023

dbulaja98 Nov 12, 2023

dbulaja98 Nov 12, 2023

dbulaja98 Nov 12, 2023

dbulaja98 Nov 12, 2023

dbulaja98 Nov 12, 2023

dbulaja98 Nov 12, 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

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 16, 2023

dbulaja98 Nov 16, 2023

dbulaja98 Nov 16, 2023

dbulaja98 Nov 16, 2023

	* a new instance of the [[zio.elasticsearch.query.DisjunctionMaxQuery]] with the `tieBreaker` value set.
	* an instance of the [[zio.elasticsearch.query.DisjunctionMaxQuery]] enriched with the `tieBreaker` parameter.

	The `Disjunction max` query returns documents that match one or more query clauses. For documents that match multiple query clauses, the relevance score is set to the highest relevance score from all matching query clauses. When the relevance scores of the returned documents are identical, tie breaker parameter gives more weight to documents that match multiple query clauses.
	The `Disjunction max` query returns documents that match one or more query clauses. For documents that match multiple query clauses, the relevance score is set to the highest relevance score from all matching query clauses. When the relevance scores of the returned documents are identical, tie breaker parameter can be used for giving more weight to documents that match multiple query clauses.

		final def disjunctionMax[S: Schema](queries: Chunk[ElasticQuery[S]]): DisjunctionMaxQuery[S] =
		DisjunctionMax[S](queries = queries, tieBreaker = None)

		final def disjunctionMax(queries: Chunk[ElasticQuery[Any]]): DisjunctionMaxQuery[Any] =
		DisjunctionMax[Any](queries = queries, tieBreaker = None)

	val query: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(term(field = "stringField", value = "test"), exists( field = "intField")))
	val query: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(term(field = "stringField", value = "test"), exists(field = "intField")))

		val queryWithPrefixLength: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(exists("existsField"), ids("1", "2", "3"))).tieBreaker(0.5f)
		```

	val queryWithPrefixLength: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(exists("existsField"), ids("1", "2", "3"))).tieBreaker(0.5f)
	```
	val queryWithTieBreaker: DisjunctionMaxQuery = disjunctionMax(queries = Chunk(exists("existsField"), ids("1", "2", "3"))).tieBreaker(0.5f)

		```

		You can find more information about `Disjunction max` query [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html).

	* the type-safe [[ElasticQuery]] objects to be wrapped inside of disjunction max query
	* a list of queries to be wrapped inside of disjunction max query

	* the [[ElasticQuery]] objects to be wrapped inside of disjunction max query
	* a list of queries to be wrapped inside of disjunction max query

(dsl): Support Disjunction max query #360

(dsl): Support Disjunction max query #360

Conversation

vanjaftn commented Nov 10, 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

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 `Disjunction max` query #360

(dsl): Support `Disjunction max` query #360

vanjaftn commented Nov 10, 2023 •

edited by dbulaja98