Add docs for filter_path global parameter

This commit is contained in:
Garrett-R
2016-02-09 00:07:28 -08:00
parent 271376f850
commit 4ed675aa3c
+13
View File
@@ -63,6 +63,19 @@ connection class::
.. py:module:: elasticsearch
Response Filtering
~~~~~~~~~~~~~~~~~~
The `filter_path` parameter is used to reduce the response returned by
elasticsearch. For example, to only return `_id` and `_type`, do::
es.search(index='test-index', filter_path=['hits.hits._id', 'hits.hits._type'])
It also supports the `*` wildcard character to match any field or part of a
field's name::
es.search(index='test-index', filter_path=['hits.hits._*'])
Elasticsearch
-------------