actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Document that 'index' may also be a list of strings for most methods (#921)

Browse Source 
I discovered whilst researching https://github.com/scoutapp/scout_apm_python/issues/150 that the index parameter for all methods also supports a list of strings, but this isn't documented here. For example `elasticsearch-dsl-py` [always passes a list of strings](https://github.com/elastic/elasticsearch-dsl-py/blob/master/elasticsearch_dsl/search.py#L100).

It's [`_make_path`](https://github.com/elastic/elasticsearch-py/blob/master/elasticsearch/client/utils.py#L44) that allows this to happen.

This updates the relevant methods' documentation to indicate that it is supported.
This commit is contained in:
Adam Johnson
2019-03-29 13:33:03 -06:00
committed by Nick Lang
parent f4c163dbc6
commit cf1e946323
1 changed files with 23 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
elasticsearch/client/__init__.py
+23 -14
View File
@@ -710,7 +710,8 @@ class Elasticsearch(object):
Execute a search query and get back search hits that match the query. Execute a search query and get back search hits that match the query.
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html>`_ `<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html>`_
:arg index: A comma-separated list of index names to search; use `_all` :arg index: A list of index names to search, or a string containing a
comma-separated list of index names to search; use `_all`
or empty string to perform the operation on all indices or empty string to perform the operation on all indices
:arg body: The search definition using the Query DSL :arg body: The search definition using the Query DSL
:arg _source: True or false to return the _source field or not, or a :arg _source: True or false to return the _source field or not, or a
@@ -853,8 +854,9 @@ class Elasticsearch(object):
Perform an update on all documents matching a query. Perform an update on all documents matching a query.
`<https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html>`_ `<https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html>`_
:arg index: A comma-separated list of index names to search; use `_all` :arg index: A list of index names to search, or a string containing a
or empty string to perform the operation on all indices comma-separated list of index names to search; use `_all` or the
empty string to perform the operation on all indices
:arg body: The search definition using the Query DSL :arg body: The search definition using the Query DSL
:arg _source: True or false to return the _source field or not, or a :arg _source: True or false to return the _source field or not, or a
list of fields to return list of fields to return
@@ -1024,8 +1026,9 @@ class Elasticsearch(object):
Delete all documents matching a query. Delete all documents matching a query.
`<https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html>`_ `<https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html>`_
:arg index: A comma-separated list of index names to search; use `_all` :arg index: A list of index names to search, or a string containing a
or empty string to perform the operation on all indices comma-separated list of index names to search; use `_all` or the
empty string to perform the operation on all indices
:arg body: The search definition using the Query DSL :arg body: The search definition using the Query DSL
:arg _source: True or false to return the _source field or not, or a :arg _source: True or false to return the _source field or not, or a
list of fields to return list of fields to return
@@ -1115,8 +1118,9 @@ class Elasticsearch(object):
out issues or planning optimizations with routing and shard preferences. out issues or planning optimizations with routing and shard preferences.
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html>`_ `<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html>`_
:arg index: A comma-separated list of index names to search; use `_all` :arg index: A list of index names to search, or a string containing a
or empty string to perform the operation on all indices comma-separated list of index names to search; use `_all` or the
empty string to perform the operation on all indices
:arg allow_no_indices: Whether to ignore if a wildcard indices :arg allow_no_indices: Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes `_all` expression resolves into no concrete indices. (This includes `_all`
string or when no indices have been specified) string or when no indices have been specified)
@@ -1153,8 +1157,9 @@ class Elasticsearch(object):
fill in template parameters. fill in template parameters.
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html>`_ `<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html>`_
:arg index: A comma-separated list of index names to search; use `_all` :arg index: A list of index names to search, or a string containing a
or empty string to perform the operation on all indices comma-separated list of index names to search; use `_all` or the
empty string to perform the operation on all indices
:arg body: The search definition template and its params :arg body: The search definition template and its params
:arg allow_no_indices: Whether to ignore if a wildcard indices :arg allow_no_indices: Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes `_all` expression resolves into no concrete indices. (This includes `_all`
@@ -1347,7 +1352,8 @@ class Elasticsearch(object):
Execute a query and get the number of matches for that query. Execute a query and get the number of matches for that query.
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html>`_ `<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html>`_
:arg index: A comma-separated list of indices to restrict the results :arg index: A list of index names or a string containing a
comma-separated list of index names to restrict the results to
:arg body: A query to restrict the results specified with the Query DSL :arg body: A query to restrict the results specified with the Query DSL
(optional) (optional)
:arg allow_no_indices: Whether to ignore if a wildcard indices :arg allow_no_indices: Whether to ignore if a wildcard indices
@@ -1453,7 +1459,8 @@ class Elasticsearch(object):
:arg body: The request definitions (metadata-search request definition :arg body: The request definitions (metadata-search request definition
pairs), separated by newlines pairs), separated by newlines
:arg index: A comma-separated list of index names to use as default :arg index: A list of index names, or a string containing a
comma-separated list of index names, to use as the default
:arg max_concurrent_searches: Controls the maximum number of concurrent :arg max_concurrent_searches: Controls the maximum number of concurrent
searches the multi search api will execute searches the multi search api will execute
:arg pre_filter_shard_size: A threshold that enforces a pre-filter :arg pre_filter_shard_size: A threshold that enforces a pre-filter
@@ -1672,7 +1679,8 @@ class Elasticsearch(object):
:arg body: The request definitions (metadata-search request definition :arg body: The request definitions (metadata-search request definition
pairs), separated by newlines pairs), separated by newlines
:arg index: A comma-separated list of index names to use as default :arg index: A list of index names, or a string containing a
comma-separated list of index names, to use as the default
:arg max_concurrent_searches: Controls the maximum number of concurrent :arg max_concurrent_searches: Controls the maximum number of concurrent
searches the multi search api will execute searches the multi search api will execute
:arg search_type: Search operation type, valid choices are: :arg search_type: Search operation type, valid choices are:
@@ -1699,8 +1707,9 @@ class Elasticsearch(object):
The field capabilities API allows to retrieve the capabilities of fields among multiple indices. The field capabilities API allows to retrieve the capabilities of fields among multiple indices.
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html>`_ `<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html>`_
:arg index: A comma-separated list of index names; use `_all` or empty :arg index: A list of index names, or a string containing a
string to perform the operation on all indices comma-separated list of index names; use `_all` or the empty string
to perform the operation on all indices
:arg body: Field json objects containing an array of field names :arg body: Field json objects containing an array of field names
:arg allow_no_indices: Whether to ignore if a wildcard indices :arg allow_no_indices: Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes `_all` expression resolves into no concrete indices. (This includes `_all`