Allow for explain to be set on a query #119
Closed
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
cebe
reviewed
Jan 7, 2017
| @@ -193,6 +193,14 @@ public function getHighlight() | |||
| } | |||
|
|
|||
| /** | |||
| * @return array|null An explanation for each hit on how its score was computed | |||
| */ | |||
| /** | ||
| * @var Enables explanation for each hit on how its score was computed. | ||
| * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-explain.html | ||
| */ |
| * @param $explain | ||
| * @return $this | ||
| * @see $explain | ||
| */ |
|
@cebe Okay I have updated the annotations and added in two simple test cases to check for the existence of |
|
looks good to me, thanks! If you add a CHANGLOG line I'll merge it right away. |
cebe
reviewed
Jan 9, 2017
| @@ -171,6 +171,12 @@ class Query extends Component implements QueryInterface | |||
| * @since 2.0.4 | |||
| */ | |||
| public $options = []; | |||
| /** | |||
| * @var Enables explanation for each hit on how its score was computed. | |||
There was a problem hiding this comment.
oh, missed that. this should include the type: @var bool
cebe
reviewed
Jan 9, 2017
|
|
||
| /** | ||
| * Explain for how the score of each document was computer | ||
| * @param $explain |
|
Done and not a problem! |
|
Merged, thank you! |
ghost
mentioned this pull request
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.
Allow for explain to be set on a query, so you can see how the score for a certain document is calculated.
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html
Can be used by
ElasticActiveRecord::find()->query(...)->explain(true)->all();.