honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference/docs/bulk.asciidoc
View File

@ -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]]

14
docs/reference/docs/delete.asciidoc
View File

@ -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 <<docs-delete-by-query,delete by query>> on the child
to perform a <<docs-delete-by-query,delete by query>> 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 <<indices-create-index,create index API>>
created before (check out the <<indices-create-index,create index API>>
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 <<indices-put-mapping,put mapping>>
@ -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]]

12
docs/reference/docs/index_.asciidoc
View File

@ -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]]