(dsl): Support constantScore query
#307
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drmarjanovic
requested changes
Aug 22, 2023
dbulaja98
requested changes
Aug 23, 2023
| val query: ConstantScoreQuery = constantScore(matchPhrase(field = "name", value = "test")) | ||
| ``` | ||
|
|
||
| You can create a [type-safe](https://lambdaworks.github.io/zio-elasticsearch/overview/overview_zio_prelude_schema) `ConstantScore` query with arbitrary query(`MatchPhrase` in this example) using the `constantScore` method in the following manner: |
There was a problem hiding this comment.
Suggested change
| You can create a [type-safe](https://lambdaworks.github.io/zio-elasticsearch/overview/overview_zio_prelude_schema) `ConstantScore` query with arbitrary query(`MatchPhrase` in this example) using the `constantScore` method in the following manner: | |
| You can create a [type-safe](https://lambdaworks.github.io/zio-elasticsearch/overview/overview_zio_prelude_schema) `ConstantScore` query with arbitrary [type-safe](https://lambdaworks.github.io/zio-elasticsearch/overview/overview_zio_prelude_schema) query(`MatchPhrase` in this example) using the `constantScore` method in the following manner: |
|
|
||
| If you want to change the `boost`, you can use `boost` method: | ||
| ```scala | ||
| val queryWithBoost: ConstantScoreQuery = constantScore(matchPhrase(field = Document.name, value ="test")).boost(2.2) |
There was a problem hiding this comment.
Suggested change
| val queryWithBoost: ConstantScoreQuery = constantScore(matchPhrase(field = Document.name, value ="test")).boost(2.2) | |
| val queryWithBoost: ConstantScoreQuery = constantScore(matchPhrase(field = Document.name, value = "test")).boost(2.2) |
| ) | ||
| ).boost(2.1) | ||
| res <- Executor.execute(ElasticRequest.search(firstSearchIndex, query)).documentAs[TestDocument] | ||
| } yield assert(res)(Assertion.contains(document)) |
There was a problem hiding this comment.
Add if possible: assert(res)(!Assertion.contains(secondDocumentId).
Comment on lines
33
to
34
| * @param query | ||
| * query you wish to run |
There was a problem hiding this comment.
Maybe something like this:
query to be wrapped inside of constant score query? Or something similar.
| * @param query | ||
| * query you wish to run | ||
| * @tparam S | ||
| * document for which field query is executed. An implicit `Schema` instance must be in scope |
There was a problem hiding this comment.
Maybe
Suggested change
| * document for which field query is executed. An implicit `Schema` instance must be in scope | |
| * document for which field query is specified for. An implicit `Schema` instance must be in scope | |
| ```? |
| * that must satisfy the criteria. | ||
| */ | ||
| final def constantScore(query: ElasticQuery[Any]): ConstantScoreQuery[Any] = | ||
| ConstantScore[Any](query, boost = None) |
| * relevance score equal to the boost parameter value. | ||
| * | ||
| * @param query | ||
| * query you wish to run |
| * query you wish to run | ||
| * @return | ||
| * an instance of [[zio.elasticsearch.query.ConstantScoreQuery]] that represents the constant score query with query | ||
| * that must satisfy the criteria. |
Comment on lines
188
to
189
| extends ConstantScoreQuery[S] { self => | ||
| def boost(value: Double): ConstantScoreQuery[S] = |
There was a problem hiding this comment.
Put empty line between.
| @@ -1873,6 +1903,41 @@ object ElasticQuerySpec extends ZIOSpecDefault { | |||
| assert(queryWithAllParams.toJson(fieldPath = None))(equalTo(expectedWithAllParams.toJson)) | |||
| } | |||
| ), | |||
| test("constantScore") { | |||
There was a problem hiding this comment.
Some parameters are named, some are not.
dbulaja98
reviewed
Aug 28, 2023
| * @param query | ||
| * query to be wrapped inside of constant score query | ||
| * @tparam S | ||
| * document for which field query is specified for. An implicit `Schema` instance must be in scope |
There was a problem hiding this comment.
Suggested change
| * document for which field query is specified for. An implicit `Schema` instance must be in scope | |
| * document for which field query is specified for. An implicit `Schema` instance must be provided in the scope |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #64