Docs: Clarify that refresh on get/update/delete just refreshes the relevant shards

Closes #7359
This commit is contained in:
Clinton Gormley 2014-09-07 11:36:52 +02:00
parent 0578a703df
commit 51cec43d3c
3 changed files with 18 additions and 18 deletions

View File

@ -163,11 +163,11 @@ is the same).
[[bulk-refresh]] [[bulk-refresh]]
=== Refresh === Refresh
The `refresh` parameter can be set to `true` in order to refresh the The `refresh` parameter can be set to `true` in order to refresh the relevant
relevant shards immediately after the bulk operation has occurred and primary and replica shards immediately after the bulk operation has occurred
make it searchable, instead of waiting for the normal refresh interval and make it searchable, instead of waiting for the normal refresh interval to
to expire. Setting it to `true` can trigger additional load, and may expire. Setting it to `true` can trigger additional load, and may slow down
slow down indexing. indexing.
[float] [float]
[[bulk-update]] [[bulk-update]]

View File

@ -117,11 +117,11 @@ is the same).
[[delete-refresh]] [[delete-refresh]]
=== Refresh === Refresh
The `refresh` parameter can be set to `true` in order to refresh the The `refresh` parameter can be set to `true` in order to refresh the relevant
relevant shard after the delete operation has occurred and make it primary and replica shards after the delete operation has occurred and make it
searchable. Setting it to `true` should be done after careful thought searchable. Setting it to `true` should be done after careful thought and
and verification that this does not cause a heavy load on the system verification that this does not cause a heavy load on the system (and slows
(and slows down indexing). down indexing).
[float] [float]
[[delete-timeout]] [[delete-timeout]]

View File

@ -363,12 +363,12 @@ as soon as the operation succeeds on the primary shard.
[[index-refresh]] [[index-refresh]]
=== Refresh === Refresh
To refresh the index immediately after the operation occurs, so that the To refresh the shard (not the whole index) immediately after the operation
document appears in search results immediately, the `refresh` parameter occurs, so that the document appears in search results immediately, the
can be set to `true`. Setting this option to `true` should *ONLY* be `refresh` parameter can be set to `true`. Setting this option to `true` should
done after careful thought and verification that it does not lead to *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, poor performance, both from an indexing and a search standpoint. Note, getting
getting a document using the get API is completely realtime. a document using the get API is completely realtime.
[float] [float]
[[timeout]] [[timeout]]