This is an automated email from the ASF dual-hosted git repository.
rahulgoswami pushed a commit to branch branch_9x
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/branch_9x by this push:
new b46a46c5754 SOLR-18219: Rename the CoreAdmin UPGRADECOREINDEX action
to UPGRADEINDEX for a cleaner API with reduced verbosity (#4387)
b46a46c5754 is described below
commit b46a46c57545efd35b1f2ccea76d87a9a6056099
Author: Rahul Goswami <[email protected]>
AuthorDate: Sat May 2 17:22:26 2026 -0400
SOLR-18219: Rename the CoreAdmin UPGRADECOREINDEX action to UPGRADEINDEX
for a cleaner API with reduced verbosity (#4387)
---
.../apache/solr/handler/admin/CoreAdminOperation.java | 4 ++--
.../apache/solr/handler/admin/UpgradeCoreIndexOp.java | 2 +-
.../apache/solr/handler/admin/api/UpgradeCoreIndex.java | 8 ++++----
.../solr/handler/admin/UpgradeCoreIndexActionTest.java | 14 +++++++-------
.../modules/configuration-guide/pages/coreadmin-api.adoc | 16 ++++++++--------
.../org/apache/solr/common/params/CoreAdminParams.java | 2 +-
6 files changed, 23 insertions(+), 23 deletions(-)
diff --git
a/solr/core/src/java/org/apache/solr/handler/admin/CoreAdminOperation.java
b/solr/core/src/java/org/apache/solr/handler/admin/CoreAdminOperation.java
index 7fe36f5092f..f987357eb40 100644
--- a/solr/core/src/java/org/apache/solr/handler/admin/CoreAdminOperation.java
+++ b/solr/core/src/java/org/apache/solr/handler/admin/CoreAdminOperation.java
@@ -40,7 +40,7 @@ import static
org.apache.solr.common.params.CoreAdminParams.CoreAdminAction.SPLI
import static
org.apache.solr.common.params.CoreAdminParams.CoreAdminAction.STATUS;
import static
org.apache.solr.common.params.CoreAdminParams.CoreAdminAction.SWAP;
import static
org.apache.solr.common.params.CoreAdminParams.CoreAdminAction.UNLOAD;
-import static
org.apache.solr.common.params.CoreAdminParams.CoreAdminAction.UPGRADECOREINDEX;
+import static
org.apache.solr.common.params.CoreAdminParams.CoreAdminAction.UPGRADEINDEX;
import static org.apache.solr.common.params.CoreAdminParams.REPLICA;
import static org.apache.solr.common.params.CoreAdminParams.REPLICA_TYPE;
import static org.apache.solr.common.params.CoreAdminParams.SHARD;
@@ -297,7 +297,7 @@ public enum CoreAdminOperation implements CoreAdminOp {
V2ApiUtils.squashIntoSolrResponseWithoutHeader(it.rsp, response);
}),
- UPGRADECOREINDEX_OP(UPGRADECOREINDEX, new UpgradeCoreIndexOp());
+ UPGRADEINDEX_OP(UPGRADEINDEX, new UpgradeCoreIndexOp());
final CoreAdminParams.CoreAdminAction action;
final CoreAdminOp fun;
diff --git
a/solr/core/src/java/org/apache/solr/handler/admin/UpgradeCoreIndexOp.java
b/solr/core/src/java/org/apache/solr/handler/admin/UpgradeCoreIndexOp.java
index 8fff5c93d31..350d07d9952 100644
--- a/solr/core/src/java/org/apache/solr/handler/admin/UpgradeCoreIndexOp.java
+++ b/solr/core/src/java/org/apache/solr/handler/admin/UpgradeCoreIndexOp.java
@@ -54,7 +54,7 @@ class UpgradeCoreIndexOp implements
CoreAdminHandler.CoreAdminOp {
if (it.handler.coreContainer.isZooKeeperAware()) {
throw new SolrException(
SolrException.ErrorCode.BAD_REQUEST,
- "action=UPGRADECOREINDEX is not supported in SolrCloud mode. As an
alternative, in order to upgrade index, configure
LatestVersionMergePolicyFactory in solrconfig.xml and reindex the data in your
collection.");
+ "action=UPGRADEINDEX is not supported in SolrCloud mode. As an
alternative, in order to upgrade index, configure
LatestVersionMergePolicyFactory in solrconfig.xml and reindex the data in your
collection.");
}
SolrParams params = it.req.getParams();
diff --git
a/solr/core/src/java/org/apache/solr/handler/admin/api/UpgradeCoreIndex.java
b/solr/core/src/java/org/apache/solr/handler/admin/api/UpgradeCoreIndex.java
index 01e00405320..d79be848c37 100644
--- a/solr/core/src/java/org/apache/solr/handler/admin/api/UpgradeCoreIndex.java
+++ b/solr/core/src/java/org/apache/solr/handler/admin/api/UpgradeCoreIndex.java
@@ -68,9 +68,9 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Implements the UPGRADECOREINDEX CoreAdmin action, which upgrades an
existing core's index
- * in-place by reindexing documents from segments belonging to older Lucene
versions, so that they
- * get written into latest version segments.
+ * Implements the UPGRADEINDEX CoreAdmin action, which upgrades an existing
core's index in-place by
+ * reindexing documents from segments belonging to older Lucene versions, so
that they get written
+ * into latest version segments.
*
* <p>The upgrade process:
*
@@ -153,7 +153,7 @@ public class UpgradeCoreIndex extends CoreAdminAPIBase {
if (indexContainsChildDocs(searcherRef.get())) {
throw new SolrException(
BAD_REQUEST,
- "UPGRADECOREINDEX does not support indexes containing
child/nested documents. "
+ "UPGRADEINDEX does not support indexes containing child/nested
documents. "
+ " Consider reindexing your data "
+ "from the original source.");
}
diff --git
a/solr/core/src/test/org/apache/solr/handler/admin/UpgradeCoreIndexActionTest.java
b/solr/core/src/test/org/apache/solr/handler/admin/UpgradeCoreIndexActionTest.java
index 44ce09c502d..33e4787a9d4 100644
---
a/solr/core/src/test/org/apache/solr/handler/admin/UpgradeCoreIndexActionTest.java
+++
b/solr/core/src/test/org/apache/solr/handler/admin/UpgradeCoreIndexActionTest.java
@@ -86,7 +86,7 @@ public class UpgradeCoreIndexActionTest extends
SolrTestCaseJ4 {
admin.handleRequestBody(
req(
CoreAdminParams.ACTION,
- CoreAdminParams.CoreAdminAction.UPGRADECOREINDEX.toString(),
+ CoreAdminParams.CoreAdminAction.UPGRADEINDEX.toString(),
CoreAdminParams.CORE,
coreName),
resp);
@@ -131,14 +131,14 @@ public class UpgradeCoreIndexActionTest extends
SolrTestCaseJ4 {
final Set<String> segmentsBeforeUpgrade = listSegmentNames(core);
- final String requestId = "upgradecoreindex_async_1";
+ final String requestId = "upgradeindex_async_1";
CoreAdminHandler admin = new CoreAdminHandler(h.getCoreContainer());
try {
SolrQueryResponse submitResp = new SolrQueryResponse();
admin.handleRequestBody(
req(
CoreAdminParams.ACTION,
- CoreAdminParams.CoreAdminAction.UPGRADECOREINDEX.toString(),
+ CoreAdminParams.CoreAdminAction.UPGRADEINDEX.toString(),
CoreAdminParams.CORE,
coreName,
CommonAdminParams.ASYNC,
@@ -212,7 +212,7 @@ public class UpgradeCoreIndexActionTest extends
SolrTestCaseJ4 {
admin.handleRequestBody(
req(
CoreAdminParams.ACTION,
- CoreAdminParams.CoreAdminAction.UPGRADECOREINDEX.toString(),
+ CoreAdminParams.CoreAdminAction.UPGRADEINDEX.toString(),
CoreAdminParams.CORE,
coreName),
resp);
@@ -375,7 +375,7 @@ public class UpgradeCoreIndexActionTest extends
SolrTestCaseJ4 {
admin.handleRequestBody(
req(
CoreAdminParams.ACTION,
-
CoreAdminParams.CoreAdminAction.UPGRADECOREINDEX.toString(),
+
CoreAdminParams.CoreAdminAction.UPGRADEINDEX.toString(),
CoreAdminParams.CORE,
coreName),
resp));
@@ -401,7 +401,7 @@ public class UpgradeCoreIndexActionTest extends
SolrTestCaseJ4 {
admin.handleRequestBody(
req(
CoreAdminParams.ACTION,
- CoreAdminParams.CoreAdminAction.UPGRADECOREINDEX.toString(),
+ CoreAdminParams.CoreAdminAction.UPGRADEINDEX.toString(),
CoreAdminParams.CORE,
coreName),
resp);
@@ -428,7 +428,7 @@ public class UpgradeCoreIndexActionTest extends
SolrTestCaseJ4 {
admin.handleRequestBody(
req(
CoreAdminParams.ACTION,
-
CoreAdminParams.CoreAdminAction.UPGRADECOREINDEX.toString(),
+
CoreAdminParams.CoreAdminAction.UPGRADEINDEX.toString(),
CoreAdminParams.CORE,
coreName),
resp));
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 4b4e48c6700..a9addf91072 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
@@ -780,10 +780,10 @@ This command is used as part of SolrCloud's
xref:deployment-guide:shard-manageme
When used against a core in a user-managed cluster without `split.key`
parameter, this action will split the source index and distribute its documents
alternately so that each split piece contains an equal number of documents.
If the `split.key` parameter is specified then only documents having the same
route key will be split from the source index.
-[[coreadmin-upgradecoreindex]]
-== UPGRADECOREINDEX
+[[coreadmin-upgradeindex]]
+== UPGRADEINDEX
-The `UPGRADECOREINDEX` action upgrades an existing core's index in-place after
a Solr major-version upgrade by reindexing documents from older-format segments.
+The `UPGRADEINDEX` action upgrades an existing core's index in-place after a
Solr major-version upgrade by reindexing documents from older-format segments.
If a core is upgraded by this action, it ensures index compatibility with the
next Solr major version (upon a future Solr upgrade) without having to
re-create the index from source.
This action is expensive and can take a while to complete on large indexes.
Consider running with `async` option in such cases.
@@ -797,7 +797,7 @@ Fields that are neither stored nor docValues-backed will
lose their data, unless
It is recommended to test on a copy and have a backup before running on
production data.
-=== UPGRADECOREINDEX Parameters
+=== UPGRADEINDEX Parameters
`core`::
+
@@ -828,7 +828,7 @@ Use <<coreadmin-requeststatus,REQUESTSTATUS>> with the
provided `requestid` to p
The update processor chain to use for reindexing.
If omitted, Solr uses the chain configured for the `/update` handler, or the
default update chain for the core (in that order).
-=== UPGRADECOREINDEX Response
+=== UPGRADEINDEX Response
On success, the response includes:
@@ -845,20 +845,20 @@ The number of segments successfully processed.
One of `UPGRADE_SUCCESSFUL` or `NO_UPGRADE_NEEDED`.
On failure, an exception is thrown with error details.
-=== UPGRADECOREINDEX Examples
+=== UPGRADEINDEX Examples
*Synchronous:*
[source,bash]
----
-http://localhost:8983/solr/admin/cores?action=UPGRADECOREINDEX&core=techproducts
+http://localhost:8983/solr/admin/cores?action=UPGRADEINDEX&core=techproducts
----
*Asynchronous (recommended for large cores):*
[source,bash]
----
-http://localhost:8983/solr/admin/cores?action=UPGRADECOREINDEX&core=techproducts&async=upgrade_1
+http://localhost:8983/solr/admin/cores?action=UPGRADEINDEX&core=techproducts&async=upgrade_1
----
Then poll status:
diff --git
a/solr/solrj/src/java/org/apache/solr/common/params/CoreAdminParams.java
b/solr/solrj/src/java/org/apache/solr/common/params/CoreAdminParams.java
index 4385d9a2ee4..dddd36240ee 100644
--- a/solr/solrj/src/java/org/apache/solr/common/params/CoreAdminParams.java
+++ b/solr/solrj/src/java/org/apache/solr/common/params/CoreAdminParams.java
@@ -189,7 +189,7 @@ public abstract class CoreAdminParams {
CREATESNAPSHOT,
DELETESNAPSHOT,
LISTSNAPSHOTS,
- UPGRADECOREINDEX;
+ UPGRADEINDEX;
public final boolean isRead;
