Skip to content

Commit

Permalink
Allow params to be added to FacetedSearches (#1500) (#1808)
Browse files Browse the repository at this point in the history
(cherry picked from commit 2e22e0a)

Co-authored-by: Greg Reinbach <greg@reinbach.com>
  • Loading branch information
github-actions[bot] and reinbach committed Apr 29, 2024
1 parent 6e595c0 commit ecefb35
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
9 changes: 9 additions & 0 deletions elasticsearch_dsl/faceted_search_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,15 @@ def sort(self, search):
search = search.sort(*self._sort)
return search

def params(self, **kwargs):
"""
Specify query params to be used when executing the search. All the
keyword arguments will override the current values. See
https://elasticsearch-py.readthedocs.io/en/master/api.html#elasticsearch.Elasticsearch.search
for all available parameters.
"""
self._s = self._s.params(**kwargs)

def build_search(self):
"""
Construct the ``Search`` object.
Expand Down
7 changes: 7 additions & 0 deletions tests/_async/test_faceted_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,3 +192,10 @@ def test_date_histogram_no_interval_keyerror():
with pytest.raises(KeyError) as e:
dhf.get_value_filter(datetime.now())
assert str(e.value) == "'interval'"


def test_params_added_to_search():
bs = BlogSearch("python search")
assert bs._s._params == {}
bs.params(routing="42")
assert bs._s._params == {"routing": "42"}
7 changes: 7 additions & 0 deletions tests/_sync/test_faceted_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,3 +192,10 @@ def test_date_histogram_no_interval_keyerror():
with pytest.raises(KeyError) as e:
dhf.get_value_filter(datetime.now())
assert str(e.value) == "'interval'"


def test_params_added_to_search():
bs = BlogSearch("python search")
assert bs._s._params == {}
bs.params(routing="42")
assert bs._s._params == {"routing": "42"}

0 comments on commit ecefb35

Please sign in to comment.