Add note about reindex API to the reindex helper

2016-10-17 14:01:26 +02:00
parent cd8aaf2c5e
commit aa3a7431ff
1 changed files with 6 additions and 0 deletions
@@ -327,6 +327,12 @@ def reindex(client, source_index, target_index, query=None, target_client=None,
    to another, potentially (if `target_client` is specified) on a different cluster.
    If you don't specify the query you will reindex all the documents.

+    Since ``2.3`` a :meth:`~elasticsearch.Elasticsearch.reindex` api is
+    available as part of elasticsearch itself. It is recommended to use the api
+    instead of this helper wherever possible. The helper is here mostly for
+    backwards compatibility and for situations where more flexibility is
+    needed.
+
    .. note::

        This helper doesn't transfer mappings, just the data.