This is an automated email from the ASF dual-hosted git repository.
rahulgoswami pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/main by this push:
new 3039f309712 Add instructions for index upgrade in SolrCloud mode
(#4424)
3039f309712 is described below
commit 3039f309712f1d9d116c2fb8253f74650843d621
Author: Rahul Goswami <[email protected]>
AuthorDate: Wed May 13 23:19:46 2026 -0400
Add instructions for index upgrade in SolrCloud mode (#4424)
The UPGRADEINDEX API is currently only available in standalone mode as a
CoreAdmin API. However, it is possible to achieve the same goal (i.e. upgrade
the index in-place for future Solr major version upgrade) in SolrCloud with the
recently introduced LatestVersionMergePolicyFactory. This commit details the
steps for the same.
---
.../configuration-guide/pages/coreadmin-api.adoc | 32 +++++++++++++++++++++-
1 file changed, 31 insertions(+), 1 deletion(-)
diff --git
a/solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc
b/solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc
index 349ff1e47c4..a7dff995ee3 100644
--- a/solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc
+++ b/solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc
@@ -792,7 +792,7 @@ Note:
* Only stored fields and fields with docValues enabled can be preserved during
upgrade.
Fields that are neither stored nor docValues-backed will lose their data,
unless they are `copyField` targets.
-* Not supported in SolrCloud mode. In order to achieve the same purpose in
SolrCloud mode (aka upgrade index for compatibility with next Solr version),
configure the `LatestVersionMergePolicyFactory` for the collection and reindex
all documents through a client utility.
+* Not supported in SolrCloud mode; see <<Upgrading an Index in SolrCloud
Mode>> below for the equivalent procedure.
* Indexes containing child/nested documents are not supported.
It is recommended to test on a copy and have a backup before running on
production data.
@@ -868,6 +868,36 @@ Then poll status:
http://localhost:8983/solr/admin/cores?action=REQUESTSTATUS&requestid=upgrade_1
----
+=== Upgrading an Index in SolrCloud Mode
+
+Currently, a corresponding Collections API `UPGRADEINDEX` action for SolrCloud
is not available.
+However, the equivalent goal -- making the index compatible with the next Solr
major version -- can be achieved by reindexing all documents while
`LatestVersionMergePolicyFactory` is the active merge policy on the collection.
+
+The procedure below avoids reprocessing documents that have already been
reindexed, including across restarts:
+
+. *Prepare a configset that uses `LatestVersionMergePolicyFactory`.*
+Copy the collection's current xref:config-sets.adoc[configset] so the original
is not modified, and edit `solrconfig.xml` in the copy to set the
xref:index-segments-merging.adoc#mergepolicyfactory[`<mergePolicyFactory>`] to
`org.apache.solr.index.LatestVersionMergePolicyFactory`.
+. *Point the collection at the new configset.*
+Use the
xref:deployment-guide:collection-management.adoc#modifycollection[MODIFYCOLLECTION]
Collections API action to set the `collection.configName` property to the name
of the new configset.
+. *Reload the collection* with the
xref:deployment-guide:collection-management.adoc#reload[RELOAD] Collections API
action so the new merge policy takes effect.
+. *Record the current highest `\_version_` value in the index.*
+Query the collection sorting by `\_version_` descending and note the top
value, for example:
++
+[source,bash]
+----
+http://localhost:8983/solr/_collection_/select?q=*:*&sort=_version_+desc&rows=1&fl=_version_
+----
+. *Reindex only the documents at or below that version.*
+Have your client reindex all docs where `\_version_ \<= <highest_version>`
(substituting the recorded value).
++
+Reusing the same `<highest_version>` value across restarts ensures continuity:
Documents that have already been reindexed -- as well as any newly indexed
documents -- will have a `\_version_` greater than the recorded value and will
fall outside the range, so no work is duplicated.
+. *Issue a commit once reindexing is complete* to clear any older version
segments:
++
+[source,bash]
+----
+http://localhost:8983/solr/_collection_/update?commit=true
+----
+
[[coreadmin-requeststatus]]
== REQUESTSTATUS
