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

[docs] Flow the refresh docs 

They were making multiple pages but that is silly. They should all
be one page.
This commit is contained in:
Nik Everett 2016-06-10 10:42:23 -04:00
parent 6d8692576e
commit 25fde039fd
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/reference/docs/refresh.asciidoc
View File

@ -28,6 +28,7 @@ APIs that support it.
Take no refresh related actions. The changes made by this request will be made
visible at some point after the request returns.
[float]
=== Choosing which setting to use
Unless you have a good reason to wait for the change to become visible always
@ -60,6 +61,7 @@ refresh immediately, `refresh=true` will affect other ongoing request. In
general, if you have a running system you don't wish to disturb then
`refresh=wait_for` is a smaller modification.
[float]
=== `refresh=wait_for` Can Force a Refresh
If a `refresh=wait_for` request comes in when there are already
@ -74,6 +76,7 @@ contain `"forced_refresh": true`.
Bulk requests only take up one slot on each shard that they touch no matter how
many times they modify the shard.
[float]
=== Examples
These will create a document and immediately refresh the index so it is visible: