From 51cec43d3c4aa71e8c5b77456eea0f5bf8129ac3 Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Sun, 7 Sep 2014 11:36:52 +0200 Subject: [PATCH] Docs: Clarify that refresh on get/update/delete just refreshes the relevant shards Closes #7359 --- docs/reference/docs/bulk.asciidoc | 10 +++++----- docs/reference/docs/delete.asciidoc | 14 +++++++------- docs/reference/docs/index_.asciidoc | 12 ++++++------ 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/reference/docs/bulk.asciidoc b/docs/reference/docs/bulk.asciidoc index 36d77c97157..2760a125ff8 100644 --- a/docs/reference/docs/bulk.asciidoc +++ b/docs/reference/docs/bulk.asciidoc @@ -163,11 +163,11 @@ is the same). [[bulk-refresh]] === Refresh -The `refresh` parameter can be set to `true` in order to refresh the -relevant shards immediately after the bulk operation has occurred and -make it searchable, instead of waiting for the normal refresh interval -to expire. Setting it to `true` can trigger additional load, and may -slow down indexing. +The `refresh` parameter can be set to `true` in order to refresh the relevant +primary and replica shards immediately after the bulk operation has occurred +and make it searchable, instead of waiting for the normal refresh interval to +expire. Setting it to `true` can trigger additional load, and may slow down +indexing. [float] [[bulk-update]] diff --git a/docs/reference/docs/delete.asciidoc b/docs/reference/docs/delete.asciidoc index c1db8b5fe48..b9c65959796 100644 --- a/docs/reference/docs/delete.asciidoc +++ b/docs/reference/docs/delete.asciidoc @@ -65,7 +65,7 @@ setting the routing parameter. Note that deleting a parent document does not automatically delete its children. One way of deleting all child documents given a parent's id is -to perform a <> on the child +to perform a <> on the child index with the automatically generated (and indexed) field _parent, which is in the format parent_type#parent_id. @@ -74,7 +74,7 @@ field _parent, which is in the format parent_type#parent_id. === Automatic index creation The delete operation automatically creates an index if it has not been -created before (check out the <> +created before (check out the <> for manually creating an index), and also automatically creates a dynamic type mapping for the specific type if it has not been created before (check out the <> @@ -117,11 +117,11 @@ is the same). [[delete-refresh]] === Refresh -The `refresh` parameter can be set to `true` in order to refresh the -relevant shard after the delete operation has occurred and make it -searchable. Setting it to `true` should be done after careful thought -and verification that this does not cause a heavy load on the system -(and slows down indexing). +The `refresh` parameter can be set to `true` in order to refresh the relevant +primary and replica shards after the delete operation has occurred and make it +searchable. Setting it to `true` should be done after careful thought and +verification that this does not cause a heavy load on the system (and slows +down indexing). [float] [[delete-timeout]] diff --git a/docs/reference/docs/index_.asciidoc b/docs/reference/docs/index_.asciidoc index 56749f0640b..bfb6dad35d5 100644 --- a/docs/reference/docs/index_.asciidoc +++ b/docs/reference/docs/index_.asciidoc @@ -363,12 +363,12 @@ as soon as the operation succeeds on the primary shard. [[index-refresh]] === Refresh -To refresh the index immediately after the operation occurs, so that the -document appears in search results immediately, the `refresh` parameter -can be set to `true`. Setting this option to `true` should *ONLY* be -done after careful thought and verification that it does not lead to -poor performance, both from an indexing and a search standpoint. Note, -getting a document using the get API is completely realtime. +To refresh the shard (not the whole index) immediately after the operation +occurs, so that the document appears in search results immediately, the +`refresh` parameter can be set to `true`. Setting this option to `true` should +*ONLY* be done after careful thought and verification that it does not lead to +poor performance, both from an indexing and a search standpoint. Note, getting +a document using the get API is completely realtime. [float] [[timeout]]