Pass request-params as is in supported operations #649
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
For all operations the `request-params` property, allow passing any parameter without requiring that its explicitly supported by the respective Elasticsearch Py API. Closes elastic#302
dliappis
added
:Track Management
|
Note: this PR requires some changes in the tracks repo as well as github.com/elastic/rally-eventdata-track to ensure there are no uses of json booleans with request-params. Therefore marking it as WiP for now. |
docs/track.rst
Outdated
| * ``request-params`` (optional): A structure containing arbitrary request parameters. The supported parameters names are documented in the `Python ES client API docs <http://elasticsearch-py.readthedocs.io/en/master/api.html#elasticsearch.Elasticsearch.search>`_. Parameters that are implicitly set by Rally (e.g. `body` or `request_cache`) are not supported (i.e. you should not try to set them and if so expect unspecified behavior). | ||
| * ``request-params`` (optional): A structure containing arbitrary request parameters. The supported parameters names are documented in the `Search URI Request docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html#_parameters_3>`_. | ||
|
|
||
| NOTE: |
There was a problem hiding this comment.
Should we use the RST formatting approach for notes here? I.e.:
.. note::
There was a problem hiding this comment.
I didn't elect to use .. note:: because I was unsure if it can be indented (the note applies for request-params only). It appears this is possible, so I addressed it in 70639ce
and add a test case to ensure that if cache has been set it is properly propagated inside request-params.
esrally/driver/runner.py
Outdated
| @@ -593,7 +593,7 @@ def __call__(self, es, params): | |||
| def request_body_query(self, es, params): | |||
| request_params = params.get("request-params", {}) | |||
| if "cache" in params: | |||
| request_params["request_cache"] = params["cache"] | |||
| request_params["request_cache"] = str(params["cache"]).lower() if isinstance(params["cache"], bool) else params["cache"] | |||
There was a problem hiding this comment.
simplify the right hand side to str(params["cache"]).lower()?
There was a problem hiding this comment.
Addressed in b0d6c41
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.
For all operations the
request-paramsproperty, allow passing anyparameter without requiring that its explicitly supported by the
respective Elasticsearch Py API.
Closes #302