From 0d3d541d62fa3145f696a1849a66bf512482d192 Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Sat, 11 Oct 2014 16:22:24 +0200 Subject: [PATCH] Docs: Tidied the upgrade indices docs --- docs/reference/indices/upgrade.asciidoc | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/reference/indices/upgrade.asciidoc b/docs/reference/indices/upgrade.asciidoc index 67d9fd8ddc2..55df42f94b3 100644 --- a/docs/reference/indices/upgrade.asciidoc +++ b/docs/reference/indices/upgrade.asciidoc @@ -5,32 +5,38 @@ The upgrade API allows to upgrade one or more indices to the latest format through an API. The upgrade process converts any segments written with previous formats. -[source,js] +[float] === Start an upgrade + +[source,sh] -------------------------------------------------- $ curl -XPOST 'http://localhost:9200/twitter/_upgrade' -------------------------------------------------- -Note that upgrading is an I/O intensive operation, and is limited to processing -a single shard per node at a time. It also is not allowed to run at the same time -as optimize. +NOTE: Upgrading is an I/O intensive operation, and is limited to processing a +single shard per node at a time. It also is not allowed to run at the same +time as optimize. [float] [[upgrade-parameters]] ==== Request Parameters -The upgrade API accepts the following request parameters: +The `upgrade` API accepts the following request parameters: [horizontal] `wait_for_completion`:: Should the request wait the upgrade to complete. Defaults to `false`. +[float] === Check upgrade status + Use a `GET` request to monitor how much of an index is upgraded. This can also be used prior to starting an upgrade to identify which indices you want to upgrade at the same time. + +[source,sh] -------------------------------------------------- -$ curl 'http://localhost:9200/twitter/_upgrade?human' +curl 'http://localhost:9200/twitter/_upgrade?human' -------------------------------------------------- [source,js]