Browse Source

Docs: Add links to client helper classes for bulk/scroll/reindexing

Clinton Gormley 11 years ago
parent
commit
6a7a77eada
2 changed files with 38 additions and 3 deletions
  1. 21 3
      docs/reference/docs/bulk.asciidoc
  2. 17 0
      docs/reference/search/request/scroll.asciidoc

+ 21 - 3
docs/reference/docs/bulk.asciidoc

@@ -2,8 +2,26 @@
 == Bulk API
 == Bulk API
 
 
 The bulk API makes it possible to perform many index/delete operations
 The bulk API makes it possible to perform many index/delete operations
-in a single API call. This can greatly increase the indexing speed. The
-REST API endpoint is `/_bulk`, and it expects the following JSON
+in a single API call. This can greatly increase the indexing speed.
+
+.Client support for bulk requests
+*********************************************
+
+Some of the officially supported clients provide helpers to assist with
+bulk requests and reindexing of documents from one index to another:
+
+Perl::
+
+    See https://metacpan.org/pod/Search::Elasticsearch::Bulk[Search::Elasticsearch::Bulk]
+    and https://metacpan.org/pod/Search::Elasticsearch::Scroll[Search::Elasticsearch::Scroll]
+
+Python::
+
+    See http://elasticsearch-py.readthedocs.org/en/master/helpers.html[elasticsearch.helpers.*]
+
+*********************************************
+
+The REST API endpoint is `/_bulk`, and it expects the following JSON
 structure:
 structure:
 
 
 [source,js]
 [source,js]
@@ -19,7 +37,7 @@ optional_source\n
 
 
 *NOTE*: the final line of data must end with a newline character `\n`.
 *NOTE*: the final line of data must end with a newline character `\n`.
 
 
-The possible actions are `index`, `create`, `delete` and `update`. 
+The possible actions are `index`, `create`, `delete` and `update`.
 `index` and `create` expect a source on the next
 `index` and `create` expect a source on the next
 line, and have the same semantics as the `op_type` parameter to the
 line, and have the same semantics as the `op_type` parameter to the
 standard index API (i.e. create will fail if a document with the same
 standard index API (i.e. create will fail if a document with the same

+ 17 - 0
docs/reference/search/request/scroll.asciidoc

@@ -10,6 +10,23 @@ Scrolling is not intended for real time user requests, but rather for
 processing large amounts of data, e.g. in order to reindex the contents of one
 processing large amounts of data, e.g. in order to reindex the contents of one
 index into a new index with a different configuration.
 index into a new index with a different configuration.
 
 
+.Client support for scrolling and reindexing
+*********************************************
+
+Some of the officially supported clients provide helpers to assist with
+scrolled searches and reindexing of documents from one index to another:
+
+Perl::
+
+    See https://metacpan.org/pod/Search::Elasticsearch::Bulk[Search::Elasticsearch::Bulk]
+    and https://metacpan.org/pod/Search::Elasticsearch::Scroll[Search::Elasticsearch::Scroll]
+
+Python::
+
+    See http://elasticsearch-py.readthedocs.org/en/master/helpers.html[elasticsearch.helpers.*]
+
+*********************************************
+
 NOTE: The results that are returned from a scroll request reflect the state of
 NOTE: The results that are returned from a scroll request reflect the state of
 the index at the time that the initial `search` request was  made, like a
 the index at the time that the initial `search` request was  made, like a
 snapshot in time. Subsequent changes to documents (index, update or delete)
 snapshot in time. Subsequent changes to documents (index, update or delete)