diff --git a/docs/reference/docs/refresh.asciidoc b/docs/reference/docs/refresh.asciidoc index 3e5153341c8..dd829e19bc3 100644 --- a/docs/reference/docs/refresh.asciidoc +++ b/docs/reference/docs/refresh.asciidoc @@ -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: